LBHttpRedirectAction (NSX Policy API 4.1.2.0.0)

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

All Implemented Interfaces:

com.vmware.vapi.bindings.StaticStructure, com.vmware.vapi.bindings.Structure, java.io.Serializable
```
public final class LBHttpRedirectAction
extends java.lang.Object
implements java.io.Serializable, com.vmware.vapi.bindings.StaticStructure
```
This action is used to redirect HTTP request messages to a new URL. The reply_status value specified in this action is used as the status code of HTTP response message which is sent back to client (Normally a browser). The HTTP status code for redirection is 3xx, for example, 301, 302, 303, 307, etc. The redirect_url is the new URL that the HTTP request message is redirected to. Normally browser will send another HTTP request to the new URL after receiving a redirection response message. Captured variables and built-in variables can be used in redirect_url field. For example, to redirect all HTTP requests to HTTPS requests for a virtual server. We create an LBRule without any conditions, add an LBHttpRedirectAction to the rule. Set the redirect_url field of the LBHttpRedirectAction to: https://$_host$_request_uri And set redirect_status to \"302\", which means found. This rule will redirect all HTTP requests to HTTPS server port on the same host.

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class LBHttpRedirectAction.Builder
Builder class for LBHttpRedirectAction.

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

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
	`LBHttpRedirectAction()` Default constructor.
`protected`	`LBHttpRedirectAction(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 LBHttpRedirectAction`	`_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 LBHttpRedirectAction`	`_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`	`getRedirectStatus()` HTTP response status code.
`java.lang.String`	`getRedirectUrl()` The URL that the HTTP request is redirected to.
`java.lang.String`	`getType()` Possible values are: `LBRuleAction.TYPE_LBSELECTPOOLACTION` `LBRuleAction.TYPE_LBHTTPREQUESTURIREWRITEACTION` `LBRuleAction.TYPE_LBHTTPREQUESTHEADERREWRITEACTION` `LBRuleAction.TYPE_LBHTTPREJECTACTION` `LBRuleAction.TYPE_LBHTTPREDIRECTACTION` `LBRuleAction.TYPE_LBHTTPRESPONSEHEADERREWRITEACTION` `LBRuleAction.TYPE_LBHTTPREQUESTHEADERDELETEACTION` `LBRuleAction.TYPE_LBHTTPRESPONSEHEADERDELETEACTION` `LBRuleAction.TYPE_LBVARIABLEASSIGNMENTACTION` `LBRuleAction.TYPE_LBVARIABLEPERSISTENCEONACTION` `LBRuleAction.TYPE_LBVARIABLEPERSISTENCELEARNACTION` `LBRuleAction.TYPE_LBJWTAUTHACTION` `LBRuleAction.TYPE_LBSSLMODESELECTIONACTION` `LBRuleAction.TYPE_LBCONNECTIONDROPACTION` The property identifies the load balancer rule action type.
`int`	`hashCode()`
`void`	`setRedirectStatus(java.lang.String redirectStatus)` HTTP response status code.
`void`	`setRedirectUrl(java.lang.String redirectUrl)` The URL that the HTTP request is redirected to.
`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
  - LBHttpRedirectAction
```
public LBHttpRedirectAction()
```
    Default constructor.
  - LBHttpRedirectAction
```
protected LBHttpRedirectAction(com.vmware.vapi.data.StructValue __dynamicStructureFields)
```
- Method Detail
  - getRedirectStatus
```
public java.lang.String getRedirectStatus()
```
    HTTP response status code.
    
    Returns:
    
    The current value of the property.
  - setRedirectStatus
```
public void setRedirectStatus(java.lang.String redirectStatus)
```
    HTTP response status code.
    
    Parameters:
    
    redirectStatus - New value for the property.
  - getRedirectUrl
```
public java.lang.String getRedirectUrl()
```
    The URL that the HTTP request is redirected to.
    
    Returns:
    
    The current value of the property.
  - setRedirectUrl
```
public void setRedirectUrl(java.lang.String redirectUrl)
```
    The URL that the HTTP request is redirected to.
    
    Parameters:
    
    redirectUrl - New value for the property.
  - getType
```
public java.lang.String getType()
```
    Possible values are:
    The property identifies the load balancer rule action type. The value of this property is automatically populated to "LBHttpRedirectAction".
    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 LBHttpRedirectAction _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 LBHttpRedirectAction _newInstance2(com.vmware.vapi.data.StructValue structValue)
```
    WARNING: Internal method, subject to change in future versions.
    Serves as a versioning mechanism.

Class LBHttpRedirectAction

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

_TYPE_IDENTIFIER

__dynamicStructureFields

Constructor Detail

LBHttpRedirectAction

LBHttpRedirectAction

Method Detail

getRedirectStatus

setRedirectStatus

getRedirectUrl

setRedirectUrl

getType

_getType

_getDataValue

_updateDataValue

_validate

equals

hashCode

toString

_hasTypeNameOf

_convertTo

_setDynamicField

_getDynamicField

_getDynamicFieldNames

_getClassType

_getCanonicalName

_getCanonicalTypeName

_newInstance

_newInstance2