OdsRunbookStringParameter (NSX Policy API 4.1.2.0.0)

java.lang.Object
- com.vmware.nsx_policy.model.OdsRunbookStringParameter

All Implemented Interfaces:

com.vmware.vapi.bindings.StaticStructure, com.vmware.vapi.bindings.Structure, java.io.Serializable
```
public final class OdsRunbookStringParameter
extends java.lang.Object
implements java.io.Serializable, com.vmware.vapi.bindings.StaticStructure
```
Online Diagnostic System runbook parameter of string type.

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class OdsRunbookStringParameter.Builder
Builder class for OdsRunbookStringParameter.

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

Field Summary

Fields
Modifier and Type	Field and Description
`protected com.vmware.vapi.data.StructValue`	`__dynamicStructureFields`
`static java.lang.String`	`_TYPE_IDENTIFIER` Identifier denoting this class, when it is used in polymorphic context.

Constructor Summary

Constructors
Modifier	Constructor and Description
	`OdsRunbookStringParameter()` Default constructor.
`protected`	`OdsRunbookStringParameter(com.vmware.vapi.data.StructValue __dynamicStructureFields)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`<T extends com.vmware.vapi.bindings.Structure> T`	`_convertTo(java.lang.Class<T> clazz)`
`java.lang.String`	`_getCanonicalName()`
`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.
`com.vmware.vapi.data.StructValue`	`_getDataValue()`
`com.vmware.vapi.data.DataValue`	`_getDynamicField(java.lang.String fieldName)`
`java.util.Set<java.lang.String>`	`_getDynamicFieldNames()`
`com.vmware.vapi.bindings.type.StructType`	`_getType()`
`boolean`	`_hasTypeNameOf(java.lang.Class<? extends com.vmware.vapi.bindings.Structure> clazz)`
`static OdsRunbookStringParameter`	`_newInstance(com.vmware.vapi.data.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 OdsRunbookStringParameter`	`_newInstance2(com.vmware.vapi.data.StructValue structValue)` WARNING: Internal method, subject to change in future versions. Serves as a versioning mechanism.
`void`	`_setDynamicField(java.lang.String fieldName, com.vmware.vapi.data.DataValue fieldValue)`
`protected void`	`_updateDataValue(com.vmware.vapi.data.StructValue structValue)`
`void`	`_validate()`
`boolean`	`equals(java.lang.Object obj)`
`java.lang.String`	`getDefaultValue()` Runbook argument will be set to this value if not provided.
`java.lang.String`	`getMax()` Runbook argument is not allowed to set value bigger than this.
`java.lang.String`	`getMin()` Runbook argument is not allowed to set value smaller than this.
`java.lang.String`	`getName()` Runbook argument name.
`java.lang.Boolean`	`getOptional()` The flag that indicates whether the argument is optional.
`java.lang.String`	`getParameterType()` Possible values are: `OdsRunbookParameter.PARAMETER_TYPE_INTEGER` `OdsRunbookParameter.PARAMETER_TYPE_STRING` `OdsRunbookParameter.PARAMETER_TYPE_ENUM` `OdsRunbookParameter.PARAMETER_TYPE_PATTERN` `OdsRunbookParameter.PARAMETER_TYPE_COMPOUND` `OdsRunbookParameter.PARAMETER_TYPE_BOOLEAN` `OdsRunbookParameter.PARAMETER_TYPE_FLOAT` Runbook parameter type.
`int`	`hashCode()`
`void`	`setDefaultValue(java.lang.String defaultValue)` Runbook argument will be set to this value if not provided.
`void`	`setMax(java.lang.String max)` Runbook argument is not allowed to set value bigger than this.
`void`	`setMin(java.lang.String min)` Runbook argument is not allowed to set value smaller than this.
`void`	`setName(java.lang.String name)` Runbook argument name.
`void`	`setOptional(java.lang.Boolean optional)` The flag that indicates whether the argument is optional.
`java.lang.String`	`toString()`

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

- Field Detail
  - _TYPE_IDENTIFIER
```
public static final java.lang.String _TYPE_IDENTIFIER
```
    Identifier denoting this class, when it is used in polymorphic context.
    This value should be assigned to the property which is used to discriminate the actual type used in the polymorphic context.
    
    See Also:
    
    Constant Field Values
  - __dynamicStructureFields
```
protected com.vmware.vapi.data.StructValue __dynamicStructureFields
```
- Constructor Detail
  - OdsRunbookStringParameter
```
public OdsRunbookStringParameter()
```
    Default constructor.
  - OdsRunbookStringParameter
```
protected OdsRunbookStringParameter(com.vmware.vapi.data.StructValue __dynamicStructureFields)
```
- Method Detail
  - getDefaultValue
```
public java.lang.String getDefaultValue()
```
    Runbook argument will be set to this value if not provided. This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
    
    Returns:
    
    The current value of the property.
  - setDefaultValue
```
public void setDefaultValue(java.lang.String defaultValue)
```
    Runbook argument will be set to this value if not provided. This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
    
    Parameters:
    
    defaultValue - New value for the property.
  - getMax
```
public java.lang.String getMax()
```
    Runbook argument is not allowed to set value bigger than this. This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
    
    Returns:
    
    The current value of the property.
  - setMax
```
public void setMax(java.lang.String max)
```
    Runbook argument is not allowed to set value bigger than this. This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
    
    Parameters:
    
    max - New value for the property.
  - getMin
```
public java.lang.String getMin()
```
    Runbook argument is not allowed to set value smaller than this. This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
    
    Returns:
    
    The current value of the property.
  - setMin
```
public void setMin(java.lang.String min)
```
    Runbook argument is not allowed to set value smaller than this. This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
    
    Parameters:
    
    min - New value for the property.
  - getName
```
public java.lang.String getName()
```
    Runbook argument name. This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
    
    Returns:
    
    The current value of the property.
  - setName
```
public void setName(java.lang.String name)
```
    Runbook argument name. This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
    
    Parameters:
    
    name - New value for the property.
  - getOptional
```
public java.lang.Boolean getOptional()
```
    The flag that indicates whether the argument is optional. This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
    
    Returns:
    
    The current value of the property.
  - setOptional
```
public void setOptional(java.lang.Boolean optional)
```
    The flag that indicates whether the argument is optional. This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
    
    Parameters:
    
    optional - New value for the property.
  - getParameterType
```
public java.lang.String getParameterType()
```
    Possible values are:
    Runbook parameter type. INTEGER - integer STRING - string ENUM - enumeration PATTERN - string that matches certain regular expression COMPOUND - string that is accepted by the validation of runbook BOOLEAN - boolean FLOAT - float The value of this property is automatically populated to "OdsRunbookStringParameter". This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
    Returns:
    
    The current value of the property.
  - _getType
```
public com.vmware.vapi.bindings.type.StructType _getType()
```
    Specified by:
    
    _getType in interface com.vmware.vapi.bindings.StaticStructure
  - _getDataValue
```
public com.vmware.vapi.data.StructValue _getDataValue()
```
    Specified by:
    
    _getDataValue in interface com.vmware.vapi.bindings.Structure
  - _updateDataValue
```
protected void _updateDataValue(com.vmware.vapi.data.StructValue structValue)
```
  - _validate
```
public void _validate()
```
    Specified by:
    
    _validate in interface com.vmware.vapi.bindings.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()
```
    Specified by:
    
    toString in interface com.vmware.vapi.bindings.StaticStructure
    
    Overrides:
    
    toString in class java.lang.Object
  - _hasTypeNameOf
```
public boolean _hasTypeNameOf(java.lang.Class<? extends com.vmware.vapi.bindings.Structure> clazz)
```
    Specified by:
    
    _hasTypeNameOf in interface com.vmware.vapi.bindings.Structure
  - _convertTo
```
public <T extends com.vmware.vapi.bindings.Structure> T _convertTo(java.lang.Class<T> clazz)
```
    Specified by:
    
    _convertTo in interface com.vmware.vapi.bindings.Structure
  - _setDynamicField
```
public void _setDynamicField(java.lang.String fieldName,
                             com.vmware.vapi.data.DataValue fieldValue)
```
    Specified by:
    
    _setDynamicField in interface com.vmware.vapi.bindings.StaticStructure
  - _getDynamicField
```
public com.vmware.vapi.data.DataValue _getDynamicField(java.lang.String fieldName)
```
    Specified by:
    
    _getDynamicField in interface com.vmware.vapi.bindings.StaticStructure
  - _getDynamicFieldNames
```
public java.util.Set<java.lang.String> _getDynamicFieldNames()
```
    Specified by:
    
    _getDynamicFieldNames in interface com.vmware.vapi.bindings.StaticStructure
  - _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()
```
    Specified by:
    
    _getCanonicalName in interface com.vmware.vapi.bindings.Structure
  - _getCanonicalTypeName
```
public static java.lang.String _getCanonicalTypeName()
```
    Returns the canonical type name. See _getCanonicalName().
    
    Returns:
    
    canonical type name
  - _newInstance
```
public static OdsRunbookStringParameter _newInstance(com.vmware.vapi.data.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
  - _newInstance2
```
public static OdsRunbookStringParameter _newInstance2(com.vmware.vapi.data.StructValue structValue)
```
    WARNING: Internal method, subject to change in future versions.
    Serves as a versioning mechanism.

Class OdsRunbookStringParameter

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

_TYPE_IDENTIFIER

__dynamicStructureFields

Constructor Detail

OdsRunbookStringParameter

OdsRunbookStringParameter

Method Detail

getDefaultValue

setDefaultValue

getMax

setMax

getMin

setMin

getName

setName

getOptional

setOptional

getParameterType

_getType

_getDataValue

_updateDataValue

_validate

equals

hashCode

toString

_hasTypeNameOf

_convertTo

_setDynamicField

_getDynamicField

_getDynamicFieldNames

_getClassType

_getCanonicalName

_getCanonicalTypeName

_newInstance

_newInstance2