appliance update pending: question
The
question structure describes a item of information that must be provided by the user in order to install the update. This structure was added in vSphere API 6.7.Representation:
{
"allowed_values" : [
"string",
"string"
],
"regexp" : "string",
"description" : {
"args" : [
"string",
"string"
],
"default_message" : "string",
"localized" : "string",
"id" : "string",
"params" : {
"<string>" : {
"dt" : "2015-01-01T22:13:05.651Z",
"s" : "string",
"d" : 1.5,
"precision" : 1,
"format" : "SHORT_DATE",
"i" : 1,
"l" : {
"id" : "string",
"params" : {
"<string>" : {
"dt" : "2015-01-01T22:13:05.651Z",
"s" : "string",
"d" : 1.5,
"precision" : 1,
"format" : "SHORT_DATE",
"i" : 1,
"l" : {
"id" : "string",
"params" : {}
}
}
}
}
}
}
},
"data_item" : "obj-103",
"default_answer" : "string",
"text" : {
"args" : [
"string",
"string"
],
"default_message" : "string",
"localized" : "string",
"id" : "string",
"params" : {
"<string>" : {
"dt" : "2015-01-01T22:13:05.651Z",
"s" : "string",
"d" : 1.5,
"precision" : 1,
"format" : "SHORT_DATE",
"i" : 1,
"l" : {
"id" : "string",
"params" : {
"<string>" : {
"dt" : "2015-01-01T22:13:05.651Z",
"s" : "string",
"d" : 1.5,
"precision" : 1,
"format" : "SHORT_DATE",
"i" : 1,
"l" : {
"id" : "string",
"params" : {}
}
}
}
}
}
}
},
"type" : "PLAIN_TEXT"
}
"allowed_values" : [
"string",
"string"
],
"regexp" : "string",
"description" : {
"args" : [
"string",
"string"
],
"default_message" : "string",
"localized" : "string",
"id" : "string",
"params" : {
"<string>" : {
"dt" : "2015-01-01T22:13:05.651Z",
"s" : "string",
"d" : 1.5,
"precision" : 1,
"format" : "SHORT_DATE",
"i" : 1,
"l" : {
"id" : "string",
"params" : {
"<string>" : {
"dt" : "2015-01-01T22:13:05.651Z",
"s" : "string",
"d" : 1.5,
"precision" : 1,
"format" : "SHORT_DATE",
"i" : 1,
"l" : {
"id" : "string",
"params" : {}
}
}
}
}
}
}
},
"data_item" : "obj-103",
"default_answer" : "string",
"text" : {
"args" : [
"string",
"string"
],
"default_message" : "string",
"localized" : "string",
"id" : "string",
"params" : {
"<string>" : {
"dt" : "2015-01-01T22:13:05.651Z",
"s" : "string",
"d" : 1.5,
"precision" : 1,
"format" : "SHORT_DATE",
"i" : 1,
"l" : {
"id" : "string",
"params" : {
"<string>" : {
"dt" : "2015-01-01T22:13:05.651Z",
"s" : "string",
"d" : 1.5,
"precision" : 1,
"format" : "SHORT_DATE",
"i" : 1,
"l" : {
"id" : "string",
"params" : {}
}
}
}
}
}
}
},
"type" : "PLAIN_TEXT"
}
{
"allowed_values" : [
"string",
"string"
],
"regexp" : "string",
"description" : {
"args" : [
"string",
"string"
],
"default_message" : "string",
"localized" : "string",
"id" : "string",
"params" : [
{
"value" : {
"dt" : "2015-01-01T22:13:05.651Z",
"s" : "string",
"d" : 1.5,
"precision" : 1,
"format" : "SHORT_DATE",
"i" : 1,
"l" : {
"id" : "string",
"params" : [
{
"value" : {
"dt" : "2015-01-01T22:13:05.651Z",
"s" : "string",
"d" : 1.5,
"precision" : 1,
"format" : "SHORT_DATE",
"i" : 1,
"l" : {
"id" : "string",
"params" : [
{
"key" : "string"
}
]
}
},
"key" : "string"
}
]
}
},
"key" : "string"
}
]
},
"data_item" : "obj-103",
"default_answer" : "string",
"text" : {
"args" : [
"string",
"string"
],
"default_message" : "string",
"localized" : "string",
"id" : "string",
"params" : [
{
"value" : {
"dt" : "2015-01-01T22:13:05.651Z",
"s" : "string",
"d" : 1.5,
"precision" : 1,
"format" : "SHORT_DATE",
"i" : 1,
"l" : {
"id" : "string",
"params" : [
{
"value" : {
"dt" : "2015-01-01T22:13:05.651Z",
"s" : "string",
"d" : 1.5,
"precision" : 1,
"format" : "SHORT_DATE",
"i" : 1,
"l" : {
"id" : "string",
"params" : [
{
"key" : "string"
}
]
}
},
"key" : "string"
}
]
}
},
"key" : "string"
}
]
},
"type" : "PLAIN_TEXT"
}
"allowed_values" : [
"string",
"string"
],
"regexp" : "string",
"description" : {
"args" : [
"string",
"string"
],
"default_message" : "string",
"localized" : "string",
"id" : "string",
"params" : [
{
"value" : {
"dt" : "2015-01-01T22:13:05.651Z",
"s" : "string",
"d" : 1.5,
"precision" : 1,
"format" : "SHORT_DATE",
"i" : 1,
"l" : {
"id" : "string",
"params" : [
{
"value" : {
"dt" : "2015-01-01T22:13:05.651Z",
"s" : "string",
"d" : 1.5,
"precision" : 1,
"format" : "SHORT_DATE",
"i" : 1,
"l" : {
"id" : "string",
"params" : [
{
"key" : "string"
}
]
}
},
"key" : "string"
}
]
}
},
"key" : "string"
}
]
},
"data_item" : "obj-103",
"default_answer" : "string",
"text" : {
"args" : [
"string",
"string"
],
"default_message" : "string",
"localized" : "string",
"id" : "string",
"params" : [
{
"value" : {
"dt" : "2015-01-01T22:13:05.651Z",
"s" : "string",
"d" : 1.5,
"precision" : 1,
"format" : "SHORT_DATE",
"i" : 1,
"l" : {
"id" : "string",
"params" : [
{
"value" : {
"dt" : "2015-01-01T22:13:05.651Z",
"s" : "string",
"d" : 1.5,
"precision" : 1,
"format" : "SHORT_DATE",
"i" : 1,
"l" : {
"id" : "string",
"params" : [
{
"key" : "string"
}
]
}
},
"key" : "string"
}
]
}
},
"key" : "string"
}
]
},
"type" : "PLAIN_TEXT"
}
Attributes:
| Name | Type | Description |
|---|---|---|
| Required | ||
| -.data_item | string | ID of the data item. This attribute was added in vSphere API 6.7. When clients pass a value of this structure as a parameter, the field must be an identifier for the resource type: com.vmware.applicance.update.pending.dataitem. When operations return a value of this structure as a result, the field will be an identifier for the resource type: com.vmware.applicance.update.pending.dataitem. |
| -.text | localizable_message | Label for the item to be used in GUI/CLI. This attribute was added in vSphere API 6.7. |
| -.text.id | string | Unique identifier of the localizable string or message template. This identifier is typically used to retrieve a locale-specific string or message template from a message catalog. |
| -.text.default_message | string | The value of this localizable string or message template in the en_US (English) locale. If vapi.std.localizable_message.id refers to a message template, the default message will contain the substituted arguments. This value can be used by clients that do not need to display strings and messages in the native language of the user. It could also be used as a fallback if a client is unable to access the appropriate message catalog. |
| -.text.args | string[] | Positional arguments to be substituted into the message template. This list will be empty if the message uses named arguments or has no arguments. |
| -.description | localizable_message | Description of the item. This attribute was added in vSphere API 6.7. |
| -.description.id | string | Unique identifier of the localizable string or message template. This identifier is typically used to retrieve a locale-specific string or message template from a message catalog. |
| -.description.default_message | string | The value of this localizable string or message template in the en_US (English) locale. If vapi.std.localizable_message.id refers to a message template, the default message will contain the substituted arguments. This value can be used by clients that do not need to display strings and messages in the native language of the user. It could also be used as a fallback if a client is unable to access the appropriate message catalog. |
| -.description.args | string[] | Positional arguments to be substituted into the message template. This list will be empty if the message uses named arguments or has no arguments. |
| -.type | string | How this field shoudl be represented in GUI or CLI. This attribute was added in vSphere API 6.7. Defines representation of field fields in GUI or CLI. This enumeration was added in vSphere API 6.7. Value is one of: PLAIN_TEXT: plain text answer. This constant was added in vSphere API 6.7. BOOLEAN: Yes/No,On/Off,Checkbox answer. This constant was added in vSphere API 6.7. PASSWORD: Password (masked) answer. This constant was added in vSphere API 6.7. |
| Optional | ||
| -.text.params | object | Named arguments to be substituted into the message template. This attribute was added in vSphere API 7.0.0.0. Optional. Unset means that the message template requires no arguments or positional arguments are used. |
| -.text.localized | string | Localized string value as per request requirements. This attribute was added in vSphere API 7.0.0.0. Optional. when the client has not requested specific locale the implementation may not populate this field to conserve resources. |
| -.description.params | object | Named arguments to be substituted into the message template. This attribute was added in vSphere API 7.0.0.0. Optional. Unset means that the message template requires no arguments or positional arguments are used. |
| -.description.localized | string | Localized string value as per request requirements. This attribute was added in vSphere API 7.0.0.0. Optional. when the client has not requested specific locale the implementation may not populate this field to conserve resources. |
| -.allowed_values | string[] | List of allowed values. This attribute was added in vSphere API 6.7. Optional. It is only relevant when type has value [PLAIN_TEXT]. allowedValues If unset any value is valid. |
| -.regexp | string | Regexp to validate the input. This attribute was added in vSphere API 6.7. Optional. It is only relevant when type has value [PLAIN_TEXT]. regexp If unset no validation will be performed. |
| -.default_answer | string | Default answer. This attribute was added in vSphere API 6.7. Optional. It is only relevant when type has value [PLAIN_TEXT]. defaultAnswer If unset then there is no default answer, so an explicit answer must be provided. |
Attributes:
| Name | Type | Description |
|---|---|---|
| Required | ||
| data_item | string | ID of the data item. This attribute was added in vSphere API 6.7. When clients pass a value of this structure as a parameter, the field must be an identifier for the resource type: com.vmware.applicance.update.pending.dataitem. When operations return a value of this structure as a result, the field will be an identifier for the resource type: com.vmware.applicance.update.pending.dataitem. |
| text | localizable_message | Label for the item to be used in GUI/CLI. This attribute was added in vSphere API 6.7. |
| text.id | string | Unique identifier of the localizable string or message template. This identifier is typically used to retrieve a locale-specific string or message template from a message catalog. |
| text.default_message | string | The value of this localizable string or message template in the en_US (English) locale. If vapi.std.localizable_message.id refers to a message template, the default message will contain the substituted arguments. This value can be used by clients that do not need to display strings and messages in the native language of the user. It could also be used as a fallback if a client is unable to access the appropriate message catalog. |
| text.args | string[] | Positional arguments to be substituted into the message template. This list will be empty if the message uses named arguments or has no arguments. |
| description | localizable_message | Description of the item. This attribute was added in vSphere API 6.7. |
| description.id | string | Unique identifier of the localizable string or message template. This identifier is typically used to retrieve a locale-specific string or message template from a message catalog. |
| description.default_message | string | The value of this localizable string or message template in the en_US (English) locale. If vapi.std.localizable_message.id refers to a message template, the default message will contain the substituted arguments. This value can be used by clients that do not need to display strings and messages in the native language of the user. It could also be used as a fallback if a client is unable to access the appropriate message catalog. |
| description.args | string[] | Positional arguments to be substituted into the message template. This list will be empty if the message uses named arguments or has no arguments. |
| type | string | How this field shoudl be represented in GUI or CLI. This attribute was added in vSphere API 6.7. Defines representation of field fields in GUI or CLI. This enumeration was added in vSphere API 6.7. Value is one of: PLAIN_TEXT: plain text answer. This constant was added in vSphere API 6.7. BOOLEAN: Yes/No,On/Off,Checkbox answer. This constant was added in vSphere API 6.7. PASSWORD: Password (masked) answer. This constant was added in vSphere API 6.7. |
| Optional | ||
| text.params | list | Named arguments to be substituted into the message template. This attribute was added in vSphere API 7.0.0.0. Optional. Unset means that the message template requires no arguments or positional arguments are used. |
| text.localized | string | Localized string value as per request requirements. This attribute was added in vSphere API 7.0.0.0. Optional. when the client has not requested specific locale the implementation may not populate this field to conserve resources. |
| description.params | list | Named arguments to be substituted into the message template. This attribute was added in vSphere API 7.0.0.0. Optional. Unset means that the message template requires no arguments or positional arguments are used. |
| description.localized | string | Localized string value as per request requirements. This attribute was added in vSphere API 7.0.0.0. Optional. when the client has not requested specific locale the implementation may not populate this field to conserve resources. |
| allowed_values | string[] | List of allowed values. This attribute was added in vSphere API 6.7. Optional. It is only relevant when type has value [PLAIN_TEXT]. allowedValues If unset any value is valid. |
| regexp | string | Regexp to validate the input. This attribute was added in vSphere API 6.7. Optional. It is only relevant when type has value [PLAIN_TEXT]. regexp If unset no validation will be performed. |
| default_answer | string | Default answer. This attribute was added in vSphere API 6.7. Optional. It is only relevant when type has value [PLAIN_TEXT]. defaultAnswer If unset then there is no default answer, so an explicit answer must be provided. |