ALBRateLimiterAction (Java SDK for NSX Global Policy API 4.1.0.2.0)

java.lang.Object
- com.vmware.nsx_global_policy.model.ALBRateLimiterAction

All Implemented Interfaces:

com.vmware.vapi.bindings.StaticStructure, com.vmware.vapi.bindings.Structure, java.io.Serializable
```
public final class ALBRateLimiterAction
extends java.lang.Object
implements java.io.Serializable, com.vmware.vapi.bindings.StaticStructure
```
Advanced load balancer RateLimiterAction object

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class ALBRateLimiterAction.Builder
Builder class for ALBRateLimiterAction.

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

Field Summary

Fields
Modifier and Type	Field and Description
`protected com.vmware.vapi.data.StructValue`	`__dynamicStructureFields`
`static java.lang.String`	`STATUS_CODE_200`
`static java.lang.String`	`STATUS_CODE_204`
`static java.lang.String`	`STATUS_CODE_403`
`static java.lang.String`	`STATUS_CODE_404`
`static java.lang.String`	`STATUS_CODE_429`
`static java.lang.String`	`STATUS_CODE_501`
`static java.lang.String`	`TYPE_CLOSE_CONN`
`static java.lang.String`	`TYPE_DROP_CONN`
`static java.lang.String`	`TYPE_LOCAL_RSP`
`static java.lang.String`	`TYPE_NONE`
`static java.lang.String`	`TYPE_REDIRECT`
`static java.lang.String`	`TYPE_RESET_CONN`

Constructor Summary

Constructors
Modifier	Constructor and Description
	`ALBRateLimiterAction()` Default constructor.
`protected`	`ALBRateLimiterAction(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 ALBRateLimiterAction`	`_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 ALBRateLimiterAction`	`_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)`
`ALBHTTPLocalFile`	`getFile()`
`ALBHTTPRedirectAction`	`getRedirect()`
`java.lang.String`	`getStatusCode()` Possible values are: `STATUS_CODE_200` `STATUS_CODE_204` `STATUS_CODE_403` `STATUS_CODE_404` `STATUS_CODE_429` `STATUS_CODE_501` HTTP status code for Local Response rate limit action.
`java.lang.String`	`getType()` Possible values are: `TYPE_NONE` `TYPE_DROP_CONN` `TYPE_RESET_CONN` `TYPE_CLOSE_CONN` `TYPE_LOCAL_RSP` `TYPE_REDIRECT` Type of action to be enforced upon hitting the rate limit.
`int`	`hashCode()`
`void`	`setFile(ALBHTTPLocalFile file)`
`void`	`setRedirect(ALBHTTPRedirectAction redirect)`
`void`	`setStatusCode(java.lang.String statusCode)` Possible values are: `STATUS_CODE_200` `STATUS_CODE_204` `STATUS_CODE_403` `STATUS_CODE_404` `STATUS_CODE_429` `STATUS_CODE_501` HTTP status code for Local Response rate limit action.
`void`	`setType(java.lang.String type)` Possible values are: `TYPE_NONE` `TYPE_DROP_CONN` `TYPE_RESET_CONN` `TYPE_CLOSE_CONN` `TYPE_LOCAL_RSP` `TYPE_REDIRECT` Type of action to be enforced upon hitting the rate limit.
`java.lang.String`	`toString()`

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

- Field Detail
  - STATUS_CODE_200
```
public static final java.lang.String STATUS_CODE_200
```
    See Also:
    
    Constant Field Values
  - STATUS_CODE_204
```
public static final java.lang.String STATUS_CODE_204
```
    See Also:
    
    Constant Field Values
  - STATUS_CODE_403
```
public static final java.lang.String STATUS_CODE_403
```
    See Also:
    
    Constant Field Values
  - STATUS_CODE_404
```
public static final java.lang.String STATUS_CODE_404
```
    See Also:
    
    Constant Field Values
  - STATUS_CODE_429
```
public static final java.lang.String STATUS_CODE_429
```
    See Also:
    
    Constant Field Values
  - STATUS_CODE_501
```
public static final java.lang.String STATUS_CODE_501
```
    See Also:
    
    Constant Field Values
  - TYPE_NONE
```
public static final java.lang.String TYPE_NONE
```
    See Also:
    
    Constant Field Values
  - TYPE_DROP_CONN
```
public static final java.lang.String TYPE_DROP_CONN
```
    See Also:
    
    Constant Field Values
  - TYPE_RESET_CONN
```
public static final java.lang.String TYPE_RESET_CONN
```
    See Also:
    
    Constant Field Values
  - TYPE_CLOSE_CONN
```
public static final java.lang.String TYPE_CLOSE_CONN
```
    See Also:
    
    Constant Field Values
  - TYPE_LOCAL_RSP
```
public static final java.lang.String TYPE_LOCAL_RSP
```
    See Also:
    
    Constant Field Values
  - TYPE_REDIRECT
```
public static final java.lang.String TYPE_REDIRECT
```
    See Also:
    
    Constant Field Values
  - __dynamicStructureFields
```
protected com.vmware.vapi.data.StructValue __dynamicStructureFields
```
- Constructor Detail
  - ALBRateLimiterAction
```
public ALBRateLimiterAction()
```
    Default constructor.
  - ALBRateLimiterAction
```
protected ALBRateLimiterAction(com.vmware.vapi.data.StructValue __dynamicStructureFields)
```
- Method Detail
  - getFile
```
public ALBHTTPLocalFile getFile()
```
    Returns:
    
    The current value of the property.
  - setFile
```
public void setFile(ALBHTTPLocalFile file)
```
    Parameters:
    
    file - New value for the property.
  - getRedirect
```
public ALBHTTPRedirectAction getRedirect()
```
    Returns:
    
    The current value of the property.
  - setRedirect
```
public void setRedirect(ALBHTTPRedirectAction redirect)
```
    Parameters:
    
    redirect - New value for the property.
  - getStatusCode
```
public java.lang.String getStatusCode()
```
    Possible values are:
    HTTP status code for Local Response rate limit action. Enum options - HTTP_LOCAL_RESPONSE_STATUS_CODE_200, HTTP_LOCAL_RESPONSE_STATUS_CODE_204, HTTP_LOCAL_RESPONSE_STATUS_CODE_403, HTTP_LOCAL_RESPONSE_STATUS_CODE_404, HTTP_LOCAL_RESPONSE_STATUS_CODE_429, HTTP_LOCAL_RESPONSE_STATUS_CODE_501. Default value when not specified in API or module is interpreted by ALB Controller as HTTP_LOCAL_RESPONSE_STATUS_CODE_429.
    Returns:
    
    The current value of the property.
  - setStatusCode
```
public void setStatusCode(java.lang.String statusCode)
```
    Possible values are:
    HTTP status code for Local Response rate limit action. Enum options - HTTP_LOCAL_RESPONSE_STATUS_CODE_200, HTTP_LOCAL_RESPONSE_STATUS_CODE_204, HTTP_LOCAL_RESPONSE_STATUS_CODE_403, HTTP_LOCAL_RESPONSE_STATUS_CODE_404, HTTP_LOCAL_RESPONSE_STATUS_CODE_429, HTTP_LOCAL_RESPONSE_STATUS_CODE_501. Default value when not specified in API or module is interpreted by ALB Controller as HTTP_LOCAL_RESPONSE_STATUS_CODE_429.
    Parameters:
    
    statusCode - New value for the property.
  - getType
```
public java.lang.String getType()
```
    Possible values are:
    Type of action to be enforced upon hitting the rate limit. Enum options - RL_ACTION_NONE, RL_ACTION_DROP_CONN, RL_ACTION_RESET_CONN, RL_ACTION_CLOSE_CONN, RL_ACTION_LOCAL_RSP, RL_ACTION_REDIRECT. Default value when not specified in API or module is interpreted by ALB Controller as RL_ACTION_NONE.
    Returns:
    
    The current value of the property.
  - setType
```
public void setType(java.lang.String type)
```
    Possible values are:
    Type of action to be enforced upon hitting the rate limit. Enum options - RL_ACTION_NONE, RL_ACTION_DROP_CONN, RL_ACTION_RESET_CONN, RL_ACTION_CLOSE_CONN, RL_ACTION_LOCAL_RSP, RL_ACTION_REDIRECT. Default value when not specified in API or module is interpreted by ALB Controller as RL_ACTION_NONE.
    Parameters:
    
    type - 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 ALBRateLimiterAction _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 ALBRateLimiterAction _newInstance2(com.vmware.vapi.data.StructValue structValue)
```
    WARNING: Internal method, subject to change in future versions.
    Serves as a versioning mechanism.

Class ALBRateLimiterAction

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

STATUS_CODE_200

STATUS_CODE_204

STATUS_CODE_403

STATUS_CODE_404

STATUS_CODE_429

STATUS_CODE_501

TYPE_NONE

TYPE_DROP_CONN

TYPE_RESET_CONN

TYPE_CLOSE_CONN

TYPE_LOCAL_RSP

TYPE_REDIRECT

__dynamicStructureFields

Constructor Detail

ALBRateLimiterAction

ALBRateLimiterAction

Method Detail

getFile

setFile

getRedirect

setRedirect

getStatusCode

setStatusCode

getType

setType

_getType

_getDataValue

_updateDataValue

_validate

equals

hashCode

toString

_hasTypeNameOf

_convertTo

_setDynamicField

_getDynamicField

_getDynamicFieldNames

_getClassType

_getCanonicalName

_getCanonicalTypeName

_newInstance

_newInstance2