public static final class TagTypes.CreateSpec extends java.lang.Object implements java.io.Serializable, StaticStructure
CreateSpec
class describes a tag.
Use the Tag.create(com.vmware.cis.tagging.TagTypes.CreateSpec)
method to create a tag defined by the create
specification.
Modifier and Type | Class and Description |
---|---|
static class |
TagTypes.CreateSpec.Builder
Builder class for
TagTypes.CreateSpec . |
Modifier and Type | Field and Description |
---|---|
protected StructValue |
__dynamicStructureFields |
Modifier | Constructor and Description |
---|---|
|
TagTypes.CreateSpec()
Default constructor.
|
protected |
TagTypes.CreateSpec(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 that the runtime type name matches the type name from the binding
class.
|
static TagTypes.CreateSpec |
_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. |
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.lang.String |
getCategoryId()
The unique identifier of the parent category in which this tag will be created.
|
java.lang.String |
getDescription()
The description of the tag.
|
java.lang.String |
getName()
The display name of the tag.
|
java.lang.String |
getTagId()
This property was added in vSphere API 6.7.
|
int |
hashCode() |
void |
setCategoryId(java.lang.String categoryId)
The unique identifier of the parent category in which this tag will be created.
|
void |
setDescription(java.lang.String description)
The description of the tag.
|
void |
setName(java.lang.String name)
The display name of the tag.
|
void |
setTagId(java.lang.String tagId)
This property was added in vSphere API 6.7.
|
java.lang.String |
toString()
Returns a string representation of this structure.
|
protected final StructValue __dynamicStructureFields
public TagTypes.CreateSpec()
protected TagTypes.CreateSpec(StructValue __dynamicStructureFields)
public java.lang.String getName()
public void setName(java.lang.String name)
name
- New value for the property.public java.lang.String getDescription()
public void setDescription(java.lang.String description)
description
- New value for the property.public java.lang.String getCategoryId()
com.vmware.cis.tagging.Category
. When
methods return a value of this class as a return value, the property will be an
identifier for the resource type: com.vmware.cis.tagging.Category
.public void setCategoryId(java.lang.String categoryId)
categoryId
- New value for the property.
When clients pass a value of this class as a parameter, the property must be an
identifier for the resource type: com.vmware.cis.tagging.Category
. When
methods return a value of this class as a return value, the property will be an
identifier for the resource type: com.vmware.cis.tagging.Category
.public java.lang.String getTagId()
null
an identifier will be generated by the servercom.vmware.cis.tagging.Tag
. When
methods return a value of this class as a return value, the property will be an
identifier for the resource type: com.vmware.cis.tagging.Tag
.public void setTagId(java.lang.String tagId)
null
an identifier will be generated by the servertagId
- New value for the property.
When clients pass a value of this class as a parameter, the property must be an
identifier for the resource type: com.vmware.cis.tagging.Tag
. When
methods return a value of this class as a return value, the property will be an
identifier for the resource type: com.vmware.cis.tagging.Tag
.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
_hasTypeNameOf
in interface Structure
clazz
- type of the result structure. cannot 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 TagTypes.CreateSpec _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