OspfAuthenticationConfig (NSX Policy API 4.1.2.0.0)

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

All Implemented Interfaces:

com.vmware.vapi.bindings.StaticStructure, com.vmware.vapi.bindings.Structure, java.io.Serializable
```
public final class OspfAuthenticationConfig
extends java.lang.Object
implements java.io.Serializable, com.vmware.vapi.bindings.StaticStructure
```
Enables OSPF authentication with specified mode and password.

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class OspfAuthenticationConfig.Builder
Builder class for OspfAuthenticationConfig.

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

Field Summary

Fields
Modifier and Type	Field and Description
`protected com.vmware.vapi.data.StructValue`	`__dynamicStructureFields`
`static java.lang.String`	`MODE_MD5`
`static java.lang.String`	`MODE_NONE`
`static java.lang.String`	`MODE_PASSWORD`

Constructor Summary

Constructors
Modifier	Constructor and Description
	`OspfAuthenticationConfig()` Default constructor.
`protected`	`OspfAuthenticationConfig(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 OspfAuthenticationConfig`	`_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 OspfAuthenticationConfig`	`_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.Long`	`getKeyId()` Authentication secret key id is mandatory for type md5 with min value of 1 and max value 255.
`java.lang.String`	`getMode()` Possible values are: `MODE_NONE` `MODE_PASSWORD` `MODE_MD5` If mode is MD5 or PASSWORD, Authentication secret key is mandatory if mode is NONE, then authentication is deactivated.
`java.lang.String`	`getSecretKey()` Authentication secret is mandatory for type password and md5 with min length of 1 and max length 8.
`int`	`hashCode()`
`void`	`setKeyId(java.lang.Long keyId)` Authentication secret key id is mandatory for type md5 with min value of 1 and max value 255.
`void`	`setMode(java.lang.String mode)` Possible values are: `MODE_NONE` `MODE_PASSWORD` `MODE_MD5` If mode is MD5 or PASSWORD, Authentication secret key is mandatory if mode is NONE, then authentication is deactivated.
`void`	`setSecretKey(java.lang.String secretKey)` Authentication secret is mandatory for type password and md5 with min length of 1 and max length 8.
`java.lang.String`	`toString()`

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

- Field Detail
  - MODE_NONE
```
public static final java.lang.String MODE_NONE
```
    See Also:
    
    Constant Field Values
  - MODE_PASSWORD
```
public static final java.lang.String MODE_PASSWORD
```
    See Also:
    
    Constant Field Values
  - MODE_MD5
```
public static final java.lang.String MODE_MD5
```
    See Also:
    
    Constant Field Values
  - __dynamicStructureFields
```
protected com.vmware.vapi.data.StructValue __dynamicStructureFields
```
- Constructor Detail
  - OspfAuthenticationConfig
```
public OspfAuthenticationConfig()
```
    Default constructor.
  - OspfAuthenticationConfig
```
protected OspfAuthenticationConfig(com.vmware.vapi.data.StructValue __dynamicStructureFields)
```
- Method Detail
  - getKeyId
```
public java.lang.Long getKeyId()
```
    Authentication secret key id is mandatory for type md5 with min value of 1 and max value 255. format: int64
    
    Returns:
    
    The current value of the property.
  - setKeyId
```
public void setKeyId(java.lang.Long keyId)
```
    Authentication secret key id is mandatory for type md5 with min value of 1 and max value 255. format: int64
    
    Parameters:
    
    keyId - New value for the property.
  - getMode
```
public java.lang.String getMode()
```
    Possible values are:
    If mode is MD5 or PASSWORD, Authentication secret key is mandatory if mode is NONE, then authentication is deactivated.
    Returns:
    
    The current value of the property.
  - setMode
```
public void setMode(java.lang.String mode)
```
    Possible values are:
    If mode is MD5 or PASSWORD, Authentication secret key is mandatory if mode is NONE, then authentication is deactivated.
    Parameters:
    
    mode - New value for the property.
  - getSecretKey
```
public java.lang.String getSecretKey()
```
    Authentication secret is mandatory for type password and md5 with min length of 1 and max length 8.
    
    Returns:
    
    The current value of the property.
  - setSecretKey
```
public void setSecretKey(java.lang.String secretKey)
```
    Authentication secret is mandatory for type password and md5 with min length of 1 and max length 8.
    
    Parameters:
    
    secretKey - New value for 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 OspfAuthenticationConfig _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 OspfAuthenticationConfig _newInstance2(com.vmware.vapi.data.StructValue structValue)
```
    WARNING: Internal method, subject to change in future versions.
    Serves as a versioning mechanism.

Class OspfAuthenticationConfig

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

MODE_NONE

MODE_PASSWORD

MODE_MD5

__dynamicStructureFields

Constructor Detail

OspfAuthenticationConfig

OspfAuthenticationConfig

Method Detail

getKeyId

setKeyId

getMode

setMode

getSecretKey

setSecretKey

_getType

_getDataValue

_updateDataValue

_validate

equals

hashCode

toString

_hasTypeNameOf

_convertTo

_setDynamicField

_getDynamicField

_getDynamicFieldNames

_getClassType

_getCanonicalName

_getCanonicalTypeName

_newInstance

_newInstance2