public static final class LibraryItemTypes.OvfSummary extends java.lang.Object implements java.io.Serializable, StaticStructure
OvfSummary
class defines the result of the filter()
method.
See LibraryItem.filter(java.lang.String, com.vmware.vcenter.ovf.LibraryItemTypes.DeploymentTarget)
. The properties in the
class describe parameterizable information in the OVF descriptor, with respect
to a deployment target, for the deploy()
method. See LibraryItem.deploy(java.lang.String, java.lang.String, com.vmware.vcenter.ovf.LibraryItemTypes.DeploymentTarget, com.vmware.vcenter.ovf.LibraryItemTypes.ResourcePoolDeploymentSpec)
.Modifier and Type | Class and Description |
---|---|
static class |
LibraryItemTypes.OvfSummary.Builder
Builder class for
LibraryItemTypes.OvfSummary . |
Modifier and Type | Field and Description |
---|---|
protected StructValue |
__dynamicStructureFields |
Modifier | Constructor and Description |
---|---|
|
OvfSummary()
Default constructor.
|
protected |
OvfSummary(StructValue __dynamicStructureFields) |
Modifier and Type | Method and Description |
---|---|
<T extends Structure> |
_convertTo(java.lang.Class<T> clazz)
Converts this structure into an instance of the provided class structure
if possible.
|
java.lang.String |
_getCanonicalName()
Returns the canonical name of the structure.
|
static java.lang.String |
_getCanonicalTypeName()
Returns the canonical type name.
|
static com.vmware.vapi.bindings.type.StructType |
_getClassType()
WARNING: Internal method, subject to change in future versions.
|
StructValue |
_getDataValue()
Returns this
Structure represented in the dynamic
DataValue model. |
DataValue |
_getDynamicField(java.lang.String fieldName)
Get dynamic filed value.
|
java.util.Set<java.lang.String> |
_getDynamicFieldNames()
Get the names of the dynamic fields in the structure.
|
com.vmware.vapi.bindings.type.StructType |
_getType()
WARNING: Internal method, subject to change in future versions.
|
boolean |
_hasTypeNameOf(java.lang.Class<? extends Structure> clazz)
Checks if the runtime type name of this structure matches the type
represented by the specified binding class.
|
static LibraryItemTypes.OvfSummary |
_newInstance(StructValue structValue)
WARNING: Internal method, subject to change in future versions.
Returns new instance of this binding class and injects the provided data value. WARNING: The returned object is not fully initialized. |
static LibraryItemTypes.OvfSummary |
_newInstance2(StructValue structValue)
WARNING: Internal method, subject to change in future versions.
Serves as a versioning mechanism. |
void |
_setDynamicField(java.lang.String fieldName,
DataValue fieldValue)
Sets a dynamic field value.
|
protected void |
_updateDataValue(StructValue structValue) |
void |
_validate()
Validates the state of the discriminated unions and HasFieldsOf
restrictions (if any) in this Java language binding
Structure . |
boolean |
equals(java.lang.Object obj) |
java.util.List<Structure> |
getAdditionalParams()
Additional OVF parameters which can be specified for the deployment target.
|
java.lang.String |
getAnnotation()
Default annotation for the virtual machine or virtual appliance.
|
java.util.List<java.lang.String> |
getEULAs()
End User License Agreements specified in the OVF descriptor.
|
java.lang.String |
getName()
Default name for the virtual machine or virtual appliance.
|
java.util.List<java.lang.String> |
getNetworks()
Section identifiers for sections of type ovf:NetworkSection in the OVF
descriptor.
|
java.util.List<java.lang.String> |
getStorageGroups()
Section identifiers for sections of type vmw:StorageGroupSection in the OVF
descriptor.
|
int |
hashCode() |
void |
setAdditionalParams(java.util.List<Structure> additionalParams)
Additional OVF parameters which can be specified for the deployment target.
|
void |
setAnnotation(java.lang.String annotation)
Default annotation for the virtual machine or virtual appliance.
|
void |
setEULAs(java.util.List<java.lang.String> eULAs)
End User License Agreements specified in the OVF descriptor.
|
void |
setName(java.lang.String name)
Default name for the virtual machine or virtual appliance.
|
void |
setNetworks(java.util.List<java.lang.String> networks)
Section identifiers for sections of type ovf:NetworkSection in the OVF
descriptor.
|
void |
setStorageGroups(java.util.List<java.lang.String> storageGroups)
Section identifiers for sections of type vmw:StorageGroupSection in the OVF
descriptor.
|
java.lang.String |
toString()
Returns a string representation of this structure.
|
protected StructValue __dynamicStructureFields
public OvfSummary()
protected OvfSummary(StructValue __dynamicStructureFields)
public java.lang.String getName()
null
, the OVF descriptor did not specify a name.public void setName(java.lang.String name)
null
, the OVF descriptor did not specify a name.name
- New value for the property.public java.lang.String getAnnotation()
null
, the OVF descriptor did not specify an annotation.public void setAnnotation(java.lang.String annotation)
null
, the OVF descriptor did not specify an annotation.annotation
- New value for the property.public java.util.List<java.lang.String> getEULAs()
deploy()
method to
succeed. See LibraryItemTypes.ResourcePoolDeploymentSpec.getAcceptAllEULA()
.public void setEULAs(java.util.List<java.lang.String> eULAs)
deploy()
method to
succeed. See LibraryItemTypes.ResourcePoolDeploymentSpec.getAcceptAllEULA()
.eULAs
- New value for the property.public java.util.List<java.lang.String> getNetworks()
LibraryItemTypes.ResourcePoolDeploymentSpec.getNetworkMappings()
.
If null
, the OVF descriptor did not specify any networks.public void setNetworks(java.util.List<java.lang.String> networks)
LibraryItemTypes.ResourcePoolDeploymentSpec.getNetworkMappings()
.
If null
, the OVF descriptor did not specify any networks.networks
- New value for the property.public java.util.List<java.lang.String> getStorageGroups()
LibraryItemTypes.ResourcePoolDeploymentSpec.getStorageMappings()
.
If null
, the OVF descriptor did not specify any storage groups.public void setStorageGroups(java.util.List<java.lang.String> storageGroups)
LibraryItemTypes.ResourcePoolDeploymentSpec.getStorageMappings()
.
If null
, the OVF descriptor did not specify any storage groups.storageGroups
- New value for the property.public java.util.List<Structure> getAdditionalParams()
LibraryItemTypes.ResourcePoolDeploymentSpec.getAdditionalParameters()
for the deploy()
method.
If null
, the OVF descriptor does not require addtional parameters or
does not have additional parameters suitable for the deployment target.public void setAdditionalParams(java.util.List<Structure> additionalParams)
LibraryItemTypes.ResourcePoolDeploymentSpec.getAdditionalParameters()
for the deploy()
method.
If null
, the OVF descriptor does not require addtional parameters or
does not have additional parameters suitable for the deployment target.additionalParams
- New value for the property.
When clients pass a value of this class as a parameter, the property must
contain all the properties defined in OvfParams
.
When methods return a value of this class as a return value, the property will
contain all the properties defined in OvfParams
.public com.vmware.vapi.bindings.type.StructType _getType()
StaticStructure
StructType
instance representing the static bindings
type for this Structure
._getType
in interface StaticStructure
StructType
public StructValue _getDataValue()
Structure
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.
_getDataValue
in interface Structure
StructValue
representing this structureprotected void _updateDataValue(StructValue structValue)
public void _validate()
StaticStructure
Structure
.
More precisely, for each union: given value of the discriminant/tag
field (@UnionTag
in the IDL) of an union in this structure,
validates that:
_validate
in interface StaticStructure
public boolean equals(java.lang.Object obj)
equals
in class java.lang.Object
public int hashCode()
hashCode
in class java.lang.Object
public java.lang.String toString()
StaticStructure
In general no code should depend on the format of the resulting string. E.g. there must be no attempts to parse for re-creation of the original instance.
toString
in interface StaticStructure
toString
in class java.lang.Object
public boolean _hasTypeNameOf(java.lang.Class<? extends Structure> clazz)
Structure
This can be used as efficient check to determine if this instance
can be successfully converted
to the target
type.
_hasTypeNameOf
in interface Structure
clazz
- bindings class for the target structure; must not be null
public <T extends Structure> T _convertTo(java.lang.Class<T> clazz)
Structure
_convertTo
in interface Structure
clazz
- type of the result structure. cannot be null.CoreException
is thrown otherwise.public void _setDynamicField(java.lang.String fieldName, DataValue fieldValue)
StaticStructure
_setDynamicField
in interface StaticStructure
fieldName
- canonical name of the dynamic field to setfieldValue
- the value of the fieldpublic DataValue _getDynamicField(java.lang.String fieldName)
StaticStructure
_getDynamicField
in interface StaticStructure
fieldName
- the canonical name of the dynamic fieldDataValue
of the dynamic fieldpublic java.util.Set<java.lang.String> _getDynamicFieldNames()
StaticStructure
_getDynamicFieldNames
in interface StaticStructure
public static com.vmware.vapi.bindings.type.StructType _getClassType()
StructType
instance representing the static bindings
type for this Structure
.public java.lang.String _getCanonicalName()
Structure
org.example.FooBar
would turn into
org.example.foo_bar
._getCanonicalName
in interface Structure
public static java.lang.String _getCanonicalTypeName()
_getCanonicalName()
.public static LibraryItemTypes.OvfSummary _newInstance(StructValue structValue)
structValue
- the source of the data contained in the binding object. Could
contain more data than fields of this class can describe i.e.
newer version of the binding object. Could be null.StructType
public static LibraryItemTypes.OvfSummary _newInstance2(StructValue structValue)