# Data Object - LocalizableMessage(vmodl.LocalizableMessage)

Property of
  AnswerFileStatusError, AnswerFileUpdateFailure, ApplyHostProfileConfigurationSpec, ClusterComputeResourceValidationResultBase, ClusterPowerContext, ClusterRecommendation, ComplianceFailure, FolderFailedHostResult, GatewayConnectFault, HostProfileManagerCompositionResult, HostProfileManagerCompositionResultResultElement, HostProfileManagerCompositionValidationResult, HostProfileManagerCompositionValidationResultResultElement, HostProfileManagerConfigTaskList, HostTpmAttestationInfo, HostTrustAuthorityAttestationInfo, HostVsanInternalSystemDeleteVsanObjectsResult, HostVsanInternalSystemVsanObjectOperationResult, LifecyclePreCheckResult, MethodFault, OvfOptionInfo, ProfileDescriptionSection, ProfileExecuteError, ProfileMetadataProfileOperationMessage, ProfileUpdateFailedUpdateFailure, TaskInfo, VchaClusterHealth, VsanClusterConfigPrecheckItem, VsanClusterHealthAction, VsanCompatibilityCheckResult, VsanDitEncryptionHealthSummary, VSANEntityCompatibilityResult, VsanHostAbortWipeDiskStatus, VsanHostWipeDiskStatus, VsanIODiagnosticsFailedCheck, VsanMountPrecheckItem, VsanPolicySatisfiability, VsanResourceCheckResult
Parameter to
  SetTaskDescription
Extends
  DynamicData
See also
  KeyAnyValue
Since
  vSphere API 4.0

## Data Object Description

Message data which is intended to be displayed according to the locale of a client.

A LocalizableMessage contains both a formatted, localized version of the text and the data needed to perform localization in conjunction with localization catalogs.

Clients of the VIM API may use vim.SessionManager.setLocale() to cause the server to emit a localized message, or may perform client-side localization based on message catalogs provided by the server.

- If the substition variable is a string, no further lookup is required.
  - arg = [("address" = "127.0.0.1")]
  - CATALOG(locmsg, key) = "IP address is {address}"
  - ==> message = "IP address is 127.0.0.1"
- If the substitution variable is an integer, value is a lookup key.
  - arg = [("1" = "button.cancel"), ("2" = "msg.revert")]
  - CATALOG(locmsg, key) = "Select '{1}' to {2}"
  - CATALOG(locmsg, button.cancel) = "Cancel"
  - CATALOG(locmsg, msg.revert) = "revert"
  - ==> message = "Select 'Cancel' to revert"
- If the variable contains '@', value is a label lookup in another catalog, where {name.@CATALOG.prefix} looks up prefix.arg[name].label in CATALOG.
  - arg = [("field" = "queued")]
  - CATALOG(locmsg, key) = "State is {field.@enum.TaskInfo.State}"
  - CATALOG(enum, TaskInfo.State.queued.label) is "Queued"
  - ==> message = "State is Queued"

Properties

Name | Type | Description
--- | --- | ---
arg* | KeyAnyValue[] | Substitution arguments for variables in the localized message.
key | xsd:string | Unique key identifying the message in the localized message catalog.
message* | xsd:string | Message in session locale. Use vim.SessionManager.setLocale() to change the session locale.
Properties inherited from DynamicData
None

*Need not be set
Show WSDL type definition
<complexType xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vsan="urn:vsan" name="LocalizableMessage"> <complexContent> <extension base="vsan:DynamicData"> <sequence> <element name="key" type="xsd:string"/> <element name="arg" type="vsan:KeyAnyValue" minOccurs="0" maxOccurs="unbounded"/> <element name="message" type="xsd:string" minOccurs="0"/> </sequence> </extension> </complexContent> </complexType>