CommandTypes.OptionInfo (VMware-vSphere-Automation-SDK-Java)

java.lang.Object
- com.vmware.vapi.metadata.cli.CommandTypes.OptionInfo

All Implemented Interfaces:

StaticStructure, Structure, java.io.Serializable

Enclosing interface:

CommandTypes
```
public static final class CommandTypes.OptionInfo
extends java.lang.Object
implements java.io.Serializable, StaticStructure
```
The OptionInfo class describes information about a specific input option of a command.

See Also:
Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class CommandTypes.OptionInfo.Builder
Builder class for CommandTypes.OptionInfo.

Nested Classes
Modifier and Type	Class and Description
`static class`	`CommandTypes.OptionInfo.Builder` Builder class for `CommandTypes.OptionInfo`.

Field Summary

Fields
Modifier and Type Field and Description

protected StructValue __dynamicStructureFields

Fields
Modifier and Type	Field and Description
`protected StructValue`	`__dynamicStructureFields`

Constructor Summary

Constructors
Modifier Constructor and Description

CommandTypes.OptionInfo()
Default constructor.

protected CommandTypes.OptionInfo(StructValue __dynamicStructureFields)

Constructors
Modifier	Constructor and Description
	`CommandTypes.OptionInfo()` Default constructor.
`protected`	`CommandTypes.OptionInfo(StructValue __dynamicStructureFields)`

Method Summary

Methods
Modifier and Type	Method and Description
`<T extends Structure> T`	`_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 CommandTypes.OptionInfo`	`_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`	`getDescription()` The description of the option to be displayed to the user when they request usage information for a CLI command.
`java.lang.String`	`getFieldName()` The fully qualified name of the option referred to by the operation element in `CommandTypes.Info.getOperationId()`.
`CommandTypes.GenericType`	`getGeneric()` This is used to tell the user whether the option is required or optional, or whether they can specify the option multiple times.
`java.lang.String`	`getLongOption()` The long option name of the parameter as used by the user.
`java.lang.String`	`getShortOption()` The single character value option name.
`java.lang.String`	`getType()` The type of option.
`int`	`hashCode()`
`void`	`setDescription(java.lang.String description)` The description of the option to be displayed to the user when they request usage information for a CLI command.
`void`	`setFieldName(java.lang.String fieldName)` The fully qualified name of the option referred to by the operation element in `CommandTypes.Info.getOperationId()`.
`void`	`setGeneric(CommandTypes.GenericType generic)` This is used to tell the user whether the option is required or optional, or whether they can specify the option multiple times.
`void`	`setLongOption(java.lang.String longOption)` The long option name of the parameter as used by the user.
`void`	`setShortOption(java.lang.String shortOption)` The single character value option name.
`void`	`setType(java.lang.String type)` The type of option.
`java.lang.String`	`toString()` Returns a string representation of this structure.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - __dynamicStructureFields
```
protected final StructValue __dynamicStructureFields
```
- Constructor Detail
  - CommandTypes.OptionInfo
```
public CommandTypes.OptionInfo()
```
    Default constructor.
  - CommandTypes.OptionInfo
```
protected CommandTypes.OptionInfo(StructValue __dynamicStructureFields)
```
- Method Detail
  - getLongOption
```
public java.lang.String getLongOption()
```
    The long option name of the parameter as used by the user.
    
    Returns:
    The current value of the property.
  - setLongOption
```
public void setLongOption(java.lang.String longOption)
```
    The long option name of the parameter as used by the user.
    
    Parameters:
    longOption - New value for the property.
  - getShortOption
```
public java.lang.String getShortOption()
```
    The single character value option name. If not present, there's no single character option for the parameter.
    
    Returns:
    The current value of the property.
  - setShortOption
```
public void setShortOption(java.lang.String shortOption)
```
    The single character value option name. If not present, there's no single character option for the parameter.
    
    Parameters:
    shortOption - New value for the property.
  - getFieldName
```
public java.lang.String getFieldName()
```
    The fully qualified name of the option referred to by the operation element in CommandTypes.Info.getOperationId().
    
    Returns:
    The current value of the property.
  - setFieldName
```
public void setFieldName(java.lang.String fieldName)
```
    The fully qualified name of the option referred to by the operation element in CommandTypes.Info.getOperationId().
    
    Parameters:
    fieldName - New value for the property.
  - getDescription
```
public java.lang.String getDescription()
```
    The description of the option to be displayed to the user when they request usage information for a CLI command.
    
    Returns:
    The current value of the property.
  - setDescription
```
public void setDescription(java.lang.String description)
```
    The description of the option to be displayed to the user when they request usage information for a CLI command.
    
    Parameters:
    description - New value for the property.
  - getType
```
public java.lang.String getType()
```
    The type of option. This is used to display information about what kind of data is expected (string, number, boolean, etc.) for the option when they request usage information for a CLI command. For enumeration class this stores the fully qualified enumeration class id.
    
    Returns:
    The current value of the property.
  - setType
```
public void setType(java.lang.String type)
```
    The type of option. This is used to display information about what kind of data is expected (string, number, boolean, etc.) for the option when they request usage information for a CLI command. For enumeration class this stores the fully qualified enumeration class id.
    
    Parameters:
    type - New value for the property.
  - getGeneric
```
public CommandTypes.GenericType getGeneric()
```
    This is used to tell the user whether the option is required or optional, or whether they can specify the option multiple times.
    
    Returns:
    The current value of the property.
  - setGeneric
```
public void setGeneric(CommandTypes.GenericType generic)
```
    This is used to tell the user whether the option is required or optional, or whether they can specify the option multiple times.
    
    Parameters:
    generic - New value for the property.
  - _getType
```
public com.vmware.vapi.bindings.type.StructType _getType()
```
    Description copied from interface: StaticStructure
    
    WARNING: Internal method, subject to change in future versions. Returns StructType instance representing the static bindings type for this Structure.
    
    Specified by:
    
    _getType in interface StaticStructure
    
    Returns:
    the static bindings StructType
  - _getDataValue
```
public StructValue _getDataValue()
```
    Description copied from interface: Structure
    
    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.
    
    Specified by:
    
    _getDataValue in interface Structure
    
    Returns:
    StructValue representing this structure
  - _updateDataValue
```
protected void _updateDataValue(StructValue structValue)
```
  - _validate
```
public void _validate()
```
    Description copied from interface: StaticStructure
    
    Validates the state of the discriminated unions and HasFieldsOf restrictions (if any) in this Java language binding 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:
  - all fields of the union required for that value of the discriminant are set
  - fields of the union that are not allowed for that value of the discriminant are not set
  - any other fields of the structure (not participating in the union) do not affect the validation result

Specified by:: _validate in interface StaticStructure

equals

public boolean equals(java.lang.Object obj)

Overrides:: equals in class java.lang.Object

hashCode
```
public int hashCode()
```
Overrides:

hashCode in class java.lang.Object

toString
```
public java.lang.String toString()
```
Description copied from interface: StaticStructure

Returns a string representation of this structure. The result is pretty printed in order to be easy to read. It is intended to be used for different debugging/tracing purposes, e.g. dumping structures into logging traces.
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.

Specified by:

toString in interface StaticStructure

Overrides:

toString in class java.lang.Object

Returns:
a string representation of this static structure instance

_hasTypeNameOf
```
public boolean _hasTypeNameOf(java.lang.Class<? extends Structure> clazz)
```
Description copied from interface: Structure

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

Specified by:

_hasTypeNameOf in interface Structure

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
```
public <T extends Structure> T _convertTo(java.lang.Class<T> clazz)
```
Description copied from interface: Structure

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.

Specified by:

_convertTo in interface 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.

_setDynamicField
```
public void _setDynamicField(java.lang.String fieldName,
                    DataValue fieldValue)
```
Description copied from interface: StaticStructure

Sets a dynamic field value. The dynamic filed is extra filed that is not part of the static fields of the structure.

Specified by:

_setDynamicField in interface StaticStructure

Parameters:
fieldName - canonical name of the dynamic field to set
fieldValue - the value of the field

_getDynamicField
```
public DataValue _getDynamicField(java.lang.String fieldName)
```
Description copied from interface: StaticStructure

Get dynamic filed value. Works only on dynamic fields.

Specified by:

_getDynamicField in interface StaticStructure

Parameters:
fieldName - the canonical name of the dynamic field

Returns:
the DataValue of the dynamic field

_getDynamicFieldNames
```
public java.util.Set<java.lang.String> _getDynamicFieldNames()
```
Description copied from interface: StaticStructure

Get the names of the dynamic fields in the structure.

Specified by:

_getDynamicFieldNames in interface StaticStructure

Returns:
set of the canonical field names for the dynamic fields

_getClassType
```
public static com.vmware.vapi.bindings.type.StructType _getClassType()
```
WARNING: Internal method, subject to change in future versions.

Returns:
StructType instance representing the static bindings type for this Structure.

_getCanonicalName
```
public java.lang.String _getCanonicalName()
```
Description copied from interface: Structure

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.

Specified by:

_getCanonicalName in interface Structure

Returns:
canonical name

_getCanonicalTypeName
```
public static java.lang.String _getCanonicalTypeName()
```
Returns the canonical type name. See _getCanonicalName().

Returns:
canonical type name

_newInstance
```
public static CommandTypes.OptionInfo _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.

Parameters:
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.

Returns:
the static bindings StructType

Class CommandTypes.OptionInfo

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

__dynamicStructureFields

Constructor Detail

CommandTypes.OptionInfo

CommandTypes.OptionInfo

Method Detail

getLongOption

setLongOption

getShortOption

setShortOption

getFieldName

setFieldName

getDescription

setDescription

getType

setType

getGeneric

setGeneric

_getType

_getDataValue

_updateDataValue

_validate

equals

hashCode

toString

_hasTypeNameOf

_convertTo

_setDynamicField

_getDynamicField

_getDynamicFieldNames

_getClassType

_getCanonicalName

_getCanonicalTypeName

_newInstance