public static final class FolderTypes.FilterSpec extends java.lang.Object implements java.io.Serializable, StaticStructure
FilterSpec
class contains properties used to filter the results when
listing folders (see Folder.list(com.vmware.vcenter.FolderTypes.FilterSpec)
). If multiple
properties are specified, only folders matching all of the properties match the
filter.Modifier and Type | Class and Description |
---|---|
static class |
FolderTypes.FilterSpec.Builder
Builder class for
FolderTypes.FilterSpec . |
Modifier and Type | Field and Description |
---|---|
protected StructValue |
__dynamicStructureFields |
Modifier | Constructor and Description |
---|---|
|
FolderTypes.FilterSpec()
Default constructor.
|
protected |
FolderTypes.FilterSpec(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 FolderTypes.FilterSpec |
_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.util.Set<java.lang.String> |
getDatacenters()
Datacenters that must contain the folder for the folder to match the filter.
|
java.util.Set<java.lang.String> |
getFolders()
Identifiers of folders that can match the filter.
|
java.util.Set<java.lang.String> |
getNames()
Names that folders must have to match the filter (see
FolderTypes.Summary.getName() ). |
java.util.Set<java.lang.String> |
getParentFolders()
Folders that must contain the folder for the folder to match the filter.
|
FolderTypes.Type |
getType()
Type that folders must have to match the filter (see
FolderTypes.Summary.getType() ). |
int |
hashCode() |
void |
setDatacenters(java.util.Set<java.lang.String> datacenters)
Datacenters that must contain the folder for the folder to match the filter.
|
void |
setFolders(java.util.Set<java.lang.String> folders)
Identifiers of folders that can match the filter.
|
void |
setNames(java.util.Set<java.lang.String> names)
Names that folders must have to match the filter (see
FolderTypes.Summary.getName() ). |
void |
setParentFolders(java.util.Set<java.lang.String> parentFolders)
Folders that must contain the folder for the folder to match the filter.
|
void |
setType(FolderTypes.Type type)
Type that folders must have to match the filter (see
FolderTypes.Summary.getType() ). |
java.lang.String |
toString()
Returns a string representation of this structure.
|
protected final StructValue __dynamicStructureFields
public FolderTypes.FilterSpec()
protected FolderTypes.FilterSpec(StructValue __dynamicStructureFields)
public java.util.Set<java.lang.String> getFolders()
null
or empty, folders with any identifier match the filter.Folder
. When methods return a
value of this class as a return value, the property will contain identifiers for
the resource type: Folder
.public void setFolders(java.util.Set<java.lang.String> folders)
null
or empty, folders with any identifier match the filter.folders
- New value for the property.
When clients pass a value of this class as a parameter, the property must
contain identifiers for the resource type: Folder
. When methods return a
value of this class as a return value, the property will contain identifiers for
the resource type: Folder
.public java.util.Set<java.lang.String> getNames()
FolderTypes.Summary.getName()
).
If null
or empty, folders with any name match the filter.public void setNames(java.util.Set<java.lang.String> names)
FolderTypes.Summary.getName()
).
If null
or empty, folders with any name match the filter.names
- New value for the property.public FolderTypes.Type getType()
FolderTypes.Summary.getType()
).
If null
, folders with any type match the filter.public void setType(FolderTypes.Type type)
FolderTypes.Summary.getType()
).
If null
, folders with any type match the filter.type
- New value for the property.public java.util.Set<java.lang.String> getParentFolders()
null
or empty, folder in any folder match the filter.Folder
. When methods return a
value of this class as a return value, the property will contain identifiers for
the resource type: Folder
.public void setParentFolders(java.util.Set<java.lang.String> parentFolders)
null
or empty, folder in any folder match the filter.parentFolders
- New value for the property.
When clients pass a value of this class as a parameter, the property must
contain identifiers for the resource type: Folder
. When methods return a
value of this class as a return value, the property will contain identifiers for
the resource type: Folder
.public java.util.Set<java.lang.String> getDatacenters()
null
or empty, folder in any datacenter match the filter.Datacenter
. When methods
return a value of this class as a return value, the property will contain
identifiers for the resource type: Datacenter
.public void setDatacenters(java.util.Set<java.lang.String> datacenters)
null
or empty, folder in any datacenter match the filter.datacenters
- New value for the property.
When clients pass a value of this class as a parameter, the property must
contain identifiers for the resource type: Datacenter
. When methods
return a value of this class as a return value, the property will contain
identifiers for the resource type: Datacenter
.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 FolderTypes.FilterSpec _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