com.vmware.vapi.bindings

Interface Structure

All Known Subinterfaces:

DynamicStructure, StaticStructure

All Known Implementing Classes:

AlreadyExists, AlreadyInDesiredState, ApiError, ArgumentLocations, AuthenticationInfo, AuthenticationScheme, BackupTypes.BackupRequest, BackupTypes.LocalizableMessage, BackupTypes.ReturnResult, BootTypes.CreateSpec, BootTypes.Info, BootTypes.UpdateSpec, Canceled, CategoryModel, CategoryTypes.CreateSpec, CategoryTypes.UpdateSpec, CdromTypes.BackingInfo, CdromTypes.BackingSpec, CdromTypes.CreateSpec, CdromTypes.Info, CdromTypes.Summary, CdromTypes.UpdateSpec, CertificateParams, ClusterTypes.FilterSpec, ClusterTypes.Info, ClusterTypes.Summary, CommandTypes.Identity, CommandTypes.Info, CommandTypes.OptionInfo, CommandTypes.OutputFieldInfo, CommandTypes.OutputInfo, ComponentData, ComponentData, ComponentData, ComponentInfo, ComponentInfo, ComponentInfo, ConcurrentChange, ConfigurationModel, ConnectionCreateSpec, ConnectionInfo, ConnectionUpdateSpec, ConstantInfo, ConstantValue, CpuTypes.Info, CpuTypes.UpdateSpec, DatacenterTypes.CreateSpec, DatacenterTypes.FilterSpec, DatacenterTypes.Info, DatacenterTypes.Summary, DatastoreTypes.FilterSpec, DatastoreTypes.Info, DatastoreTypes.Info, DatastoreTypes.Summary, DeploymentOption, DeploymentOptionParams, DeviceTypes.Entry, DeviceTypes.EntryCreateSpec, DiskTypes.BackingInfo, DiskTypes.BackingSpec, DiskTypes.CreateSpec, DiskTypes.Info, DiskTypes.Summary, DiskTypes.UpdateSpec, DiskTypes.VmdkCreateSpec, DownloadSessionModel, DynamicID, DynamicStructureImpl, ElementMap, ElementValue, EnumerationInfo, EnumerationValueInfo, Error, ErrorInfo, EthernetTypes.BackingInfo, EthernetTypes.BackingSpec, EthernetTypes.CreateSpec, EthernetTypes.Info, EthernetTypes.Summary, EthernetTypes.UpdateSpec, ExportFlagTypes.Info, ExtraConfig, ExtraConfigParams, FeatureInUse, FieldInfo, FileLocations, FileTypes.AddSpec, FileTypes.ChecksumInfo, FileTypes.Info, FileTypes.Info, FileTypes.Info, FileTypes.ValidationError, FileTypes.ValidationResult, FloppyTypes.BackingInfo, FloppyTypes.BackingSpec, FloppyTypes.CreateSpec, FloppyTypes.Info, FloppyTypes.Summary, FloppyTypes.UpdateSpec, FolderTypes.FilterSpec, FolderTypes.Summary, GenericInstantiation, HardwareTypes.Info, HardwareTypes.UpdateSpec, HostnameTypes.Message, HostnameTypes.TestStatusInfo, HostTypes.CreateSpec, HostTypes.FilterSpec, HostTypes.Summary, IdeAddressInfo, IdeAddressSpec, ImportFlagTypes.Info, InboundTypes.DeleteFirewallRule, InboundTypes.FirewallAddressRule, InterfacesTypes.InterfaceInfo, InternalServerError, InvalidArgument, InvalidElementConfiguration, InvalidElementType, InvalidRequest, IpAllocationParams, Ipv4Types.IPv4Config, Ipv4Types.IPv4ConfigReadOnly, Ipv6Types.IPv6Address, Ipv6Types.IPv6AddressReadOnly, Ipv6Types.IPv6Config, Ipv6Types.IPv6ConfigReadOnly, ItemModel, ItemTypes.FindSpec, JobTypes.BackupJobStatus, JobTypes.BackupRequest, JobTypes.LocalizableMessage, JobTypes.LocalizableMessage, JobTypes.RestoreJobStatus, JobTypes.RestoreRequest, JobTypes.ReturnResult, JobTypes.ReturnResult, LibraryItemTypes.CreateResult, LibraryItemTypes.CreateSpec, LibraryItemTypes.CreateTarget, LibraryItemTypes.DeployableIdentity, LibraryItemTypes.DeploymentResult, LibraryItemTypes.DeploymentTarget, LibraryItemTypes.OvfSummary, LibraryItemTypes.ResourcePoolDeploymentSpec, LibraryItemTypes.ResultInfo, LibraryItemTypes.StorageGroupMapping, LibraryModel, LibraryTypes.FindSpec, LocalizableMessage, MemoryTypes.Info, MemoryTypes.UpdateSpec, MonitoringTypes.MonitoredItem, MonitoringTypes.MonitoredItemData, MonitoringTypes.MonitoredItemDataRequest, NamespaceTypes.Identity, NamespaceTypes.Info, NetworkTypes.FilterSpec, NetworkTypes.Info, NetworkTypes.Summary, NotAllowedInCurrentState, NotFound, NtpTypes.Message, NtpTypes.NTPConfig, NtpTypes.TestStatusInfo, OperationInfo, OperationInfo, OperationInfo, OperationNotFound, OperationResultInfo, OptimizationInfo, OvfError, OvfInfo, OvfMessage, OvfParams, OvfWarning, PackageInfo, PackageInfo, PackageInfo, ParallelTypes.BackingInfo, ParallelTypes.BackingSpec, ParallelTypes.CreateSpec, ParallelTypes.Info, ParallelTypes.Summary, ParallelTypes.UpdateSpec, ParseIssue, PartsTypes.LocalizableMessage, PartsTypes.Part, PowerTypes.Info, PrimitiveValue, PrivilegeInfo, Property, PropertyParams, ProxyTypes.Message, ProxyTypes.ProxyConfig, ProxyTypes.ProxyConfigMultiple, ProxyTypes.ProxyConfigTest, ProxyTypes.TestStatusInfo, PublishInfo, ResourceBusy, ResourceInaccessible, ResourceInUse, ResourcePoolTypes.FilterSpec, ResourcePoolTypes.Info, ResourcePoolTypes.Summary, RestoreTypes.LocalizableMessage, RestoreTypes.Metadata, RestoreTypes.RestoreRequest, RoutesTypes.Message, RoutesTypes.Route, RoutesTypes.RouteReadOnly, RoutesTypes.TestStatusInfo, SataAddressInfo, SataAddressSpec, SataTypes.CreateSpec, SataTypes.Info, SataTypes.Summary, ScaleOutGroup, ScaleOutParams, ScsiAddressInfo, ScsiAddressSpec, ScsiTypes.CreateSpec, ScsiTypes.Info, ScsiTypes.Summary, ScsiTypes.UpdateSpec, SerialTypes.BackingInfo, SerialTypes.BackingSpec, SerialTypes.CreateSpec, SerialTypes.Info, SerialTypes.Summary, SerialTypes.UpdateSpec, ServersTypes.DNSServerConfig, ServersTypes.Message, ServersTypes.TestStatusInfo, ServiceInfo, ServiceInfo, ServiceInfo, ServicesTypes.ServiceInfo, ServiceTypes.Info, ServiceTypes.UpdateSpec, ServiceUnavailable, SessionTypes.Info, ShellTypes.ShellConfig, ShutdownTypes.ShutdownConfig, ShutdownTypes.ShutdownGetConfig, SizeParams, SnmpTypes.SNMPConfig, SnmpTypes.SNMPConfigReadOnly, SnmpTypes.SNMPHashConfig, SnmpTypes.SNMPHashResults, SnmpTypes.SNMPLimits, SnmpTypes.SNMPRemoteUser, SnmpTypes.SNMPStats, SnmpTypes.SNMPTestResults, SnmpTypes.SNMPUser, SnmpTypes.SNMPv1TrapTarget, SnmpTypes.SNMPv3Target, SourceCreateSpec, SourceInfo, SourceTypes.CreateSpec, SourceTypes.CreateSpec, SourceTypes.CreateSpec, SourceTypes.CreateSpec, SourceTypes.Info, SourceTypes.Info, SourceTypes.Info, SourceTypes.Info, StorageBacking, StorageTypes.Info, StorageTypes.StorageMapping, StructureInfo, SubscribedLibraryTypes.ProbeResult, SubscriptionInfo, TagAssociationTypes.BatchResult, TagAssociationTypes.ObjectToTags, TagAssociationTypes.TagToObjects, TagModel, TagTypes.CreateSpec, TagTypes.UpdateSpec, TimedOut, TimesyncTypes.TimeSyncConfig, TimeTypes.SystemTimeStruct, TransferEndpoint, TransientIndication, Type, TypeTypes.Info, UnableToAllocateResource, Unauthenticated, Unauthorized, UnexpectedInput, UnknownSection, UnknownSectionParams, UnresolvedError, Unsupported, UpdateSessionModel, UpdateTypes.UpdateStructGet, UpdateTypes.UpdateStructSet, UserDefinedType, UserTypes.NewUserConfig, UserTypes.UserConfig, UserTypes.UserConfigGet, VcenterExtensionParams, VersionTypes.VersionStruct, VMTypes.CreateSpec, VMTypes.FilterSpec, VMTypes.Info, VMTypes.PlacementSpec, VMTypes.Summary

public interface Structure

Base interface that represents a Java language bindings structure.
WARNING: Users are not expected to implement this interface because new methods might be added in the future.

Method Summary

Methods

Modifier and Type	Method and Description
<T extends Structure> T	_convertTo(Class<T> clazz) Converts this structure into an instance of the provided class structure if possible.
String	_getCanonicalName() Returns the canonical name of the structure.
StructValue	_getDataValue() Returns this Structure represented in the dynamic DataValue model.
boolean	_hasTypeNameOf(Class<? extends Structure> clazz) Checks that the runtime type name matches the type name from the binding class.

Method Detail

_getDataValue

StructValue _getDataValue()

Returns this Structure represented in the dynamic DataValue model.

Attempts to change the returned StructValue representation are not required to change the state of this structure. Actually the behavior is implementation dependent and is unspecified. In general the returned value shouldn't be changed.

Returns:

StructValue representing this structure

_hasTypeNameOf

boolean _hasTypeNameOf(Class<? extends Structure> clazz)

Checks that the runtime type name matches the type name from the binding class.

Parameters:

clazz - type of the result structure. cannot be null.

Returns:

true if this structures type name matches exactly the provided class type name.

_convertTo

<T extends Structure> T _convertTo(Class<T> clazz)

Converts this structure into an instance of the provided class structure if possible. A conversion will be possible if the requested structure's fields are all present in this structure.

Parameters:

clazz - type of the result structure. cannot be null.

Returns:

an instance of the requested type if conversion is possible. CoreException is thrown otherwise.

_getCanonicalName

String _getCanonicalName()

Returns the canonical name of the structure. By default the canonical name is derived from the fully-qualified IDL name by converting to lower case and inserting underscores between words. For example org.example.FooBar would turn into org.example.foo_bar.

Returns:

canonical name