ALBHTTPRedirectAction (Java SDK for NSX Global Policy API 4.1.0.2.0)

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

All Implemented Interfaces:

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

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class ALBHTTPRedirectAction.Builder
Builder class for ALBHTTPRedirectAction.

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

Field Summary

Fields
Modifier and Type	Field and Description
`protected com.vmware.vapi.data.StructValue`	`__dynamicStructureFields`
`static java.lang.String`	`PROTOCOL_HTTP`
`static java.lang.String`	`PROTOCOL_HTTPS`
`static java.lang.String`	`STATUS_CODE_301`
`static java.lang.String`	`STATUS_CODE_302`
`static java.lang.String`	`STATUS_CODE_307`

Constructor Summary

Constructors
Modifier	Constructor and Description
	`ALBHTTPRedirectAction()` Default constructor.
`protected`	`ALBHTTPRedirectAction(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 ALBHTTPRedirectAction`	`_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 ALBHTTPRedirectAction`	`_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)`
`ALBURIParam`	`getHost()`
`java.lang.Boolean`	`getKeepQuery()` Keep or drop the query of the incoming request URI in the redirected URI.
`ALBURIParam`	`getPath()`
`java.lang.Long`	`getPort()` Port to which redirect the request.
`java.lang.String`	`getProtocol()` Possible values are: `PROTOCOL_HTTP` `PROTOCOL_HTTPS` Protocol type.
`java.lang.String`	`getStatusCode()` Possible values are: `STATUS_CODE_301` `STATUS_CODE_302` `STATUS_CODE_307` HTTP redirect status code.
`int`	`hashCode()`
`void`	`setHost(ALBURIParam host)`
`void`	`setKeepQuery(java.lang.Boolean keepQuery)` Keep or drop the query of the incoming request URI in the redirected URI.
`void`	`setPath(ALBURIParam path)`
`void`	`setPort(java.lang.Long port)` Port to which redirect the request.
`void`	`setProtocol(java.lang.String protocol)` Possible values are: `PROTOCOL_HTTP` `PROTOCOL_HTTPS` Protocol type.
`void`	`setStatusCode(java.lang.String statusCode)` Possible values are: `STATUS_CODE_301` `STATUS_CODE_302` `STATUS_CODE_307` HTTP redirect status code.
`java.lang.String`	`toString()`

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

- Field Detail
  - PROTOCOL_HTTP
```
public static final java.lang.String PROTOCOL_HTTP
```
    See Also:
    
    Constant Field Values
  - PROTOCOL_HTTPS
```
public static final java.lang.String PROTOCOL_HTTPS
```
    See Also:
    
    Constant Field Values
  - STATUS_CODE_301
```
public static final java.lang.String STATUS_CODE_301
```
    See Also:
    
    Constant Field Values
  - STATUS_CODE_302
```
public static final java.lang.String STATUS_CODE_302
```
    See Also:
    
    Constant Field Values
  - STATUS_CODE_307
```
public static final java.lang.String STATUS_CODE_307
```
    See Also:
    
    Constant Field Values
  - __dynamicStructureFields
```
protected com.vmware.vapi.data.StructValue __dynamicStructureFields
```
- Constructor Detail
  - ALBHTTPRedirectAction
```
public ALBHTTPRedirectAction()
```
    Default constructor.
  - ALBHTTPRedirectAction
```
protected ALBHTTPRedirectAction(com.vmware.vapi.data.StructValue __dynamicStructureFields)
```
- Method Detail
  - getHost
```
public ALBURIParam getHost()
```
    Returns:
    
    The current value of the property.
  - setHost
```
public void setHost(ALBURIParam host)
```
    Parameters:
    
    host - New value for the property.
  - getKeepQuery
```
public java.lang.Boolean getKeepQuery()
```
    Keep or drop the query of the incoming request URI in the redirected URI. Default value when not specified in API or module is interpreted by ALB Controller as true.
    
    Returns:
    
    The current value of the property.
  - setKeepQuery
```
public void setKeepQuery(java.lang.Boolean keepQuery)
```
    Keep or drop the query of the incoming request URI in the redirected URI. Default value when not specified in API or module is interpreted by ALB Controller as true.
    
    Parameters:
    
    keepQuery - New value for the property.
  - getPath
```
public ALBURIParam getPath()
```
    Returns:
    
    The current value of the property.
  - setPath
```
public void setPath(ALBURIParam path)
```
    Parameters:
    
    path - New value for the property.
  - getPort
```
public java.lang.Long getPort()
```
    Port to which redirect the request. Allowed values are 1-65535. format: int64
    
    Returns:
    
    The current value of the property.
  - setPort
```
public void setPort(java.lang.Long port)
```
    Port to which redirect the request. Allowed values are 1-65535. format: int64
    
    Parameters:
    
    port - New value for the property.
  - getProtocol
```
public java.lang.String getProtocol()
```
    Possible values are:
    - PROTOCOL_HTTP
    - PROTOCOL_HTTPS
    Protocol type. Enum options - HTTP, HTTPS.
    Returns:
    
    The current value of the property.
  - setProtocol
```
public void setProtocol(java.lang.String protocol)
```
    Possible values are:
    - PROTOCOL_HTTP
    - PROTOCOL_HTTPS
    Protocol type. Enum options - HTTP, HTTPS.
    Parameters:
    
    protocol - New value for the property.
  - getStatusCode
```
public java.lang.String getStatusCode()
```
    Possible values are:
    HTTP redirect status code. Enum options - HTTP_REDIRECT_STATUS_CODE_301, HTTP_REDIRECT_STATUS_CODE_302, HTTP_REDIRECT_STATUS_CODE_307. Default value when not specified in API or module is interpreted by ALB Controller as HTTP_REDIRECT_STATUS_CODE_302.
    Returns:
    
    The current value of the property.
  - setStatusCode
```
public void setStatusCode(java.lang.String statusCode)
```
    Possible values are:
    HTTP redirect status code. Enum options - HTTP_REDIRECT_STATUS_CODE_301, HTTP_REDIRECT_STATUS_CODE_302, HTTP_REDIRECT_STATUS_CODE_307. Default value when not specified in API or module is interpreted by ALB Controller as HTTP_REDIRECT_STATUS_CODE_302.
    Parameters:
    
    statusCode - 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 ALBHTTPRedirectAction _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 ALBHTTPRedirectAction _newInstance2(com.vmware.vapi.data.StructValue structValue)
```
    WARNING: Internal method, subject to change in future versions.
    Serves as a versioning mechanism.

Class ALBHTTPRedirectAction

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

PROTOCOL_HTTP

PROTOCOL_HTTPS

STATUS_CODE_301

STATUS_CODE_302

STATUS_CODE_307

__dynamicStructureFields

Constructor Detail

ALBHTTPRedirectAction

ALBHTTPRedirectAction

Method Detail

getHost

setHost

getKeepQuery

setKeepQuery

getPath

setPath

getPort

setPort

getProtocol

setProtocol

getStatusCode

setStatusCode

_getType

_getDataValue

_updateDataValue

_validate

equals

hashCode

toString

_hasTypeNameOf

_convertTo

_setDynamicField

_getDynamicField

_getDynamicFieldNames

_getClassType

_getCanonicalName

_getCanonicalTypeName

_newInstance

_newInstance2