UrlAlias (Java SDK for NSX Manager API 4.1.2.0.0)

java.lang.Object
- com.vmware.nsx.model.UrlAlias

All Implemented Interfaces:

com.vmware.vapi.bindings.StaticStructure, com.vmware.vapi.bindings.Structure, java.io.Serializable
```
public final class UrlAlias
extends java.lang.Object
implements java.io.Serializable, com.vmware.vapi.bindings.StaticStructure
```
Short name or alias of a url. It is used to represent the url.

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class UrlAlias.Builder
Builder class for UrlAlias.

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

Field Summary

Fields
Modifier and Type	Field and Description
`protected com.vmware.vapi.data.StructValue`	`__dynamicStructureFields`
`static java.lang.String`	`REQUEST_METHOD_GET`
`static java.lang.String`	`REQUEST_METHOD_POST`

Constructor Summary

Constructors
Modifier Constructor and Description

UrlAlias()
Default constructor.

protected UrlAlias(com.vmware.vapi.data.StructValue __dynamicStructureFields)

Constructors
Modifier	Constructor and Description
	`UrlAlias()` Default constructor.
`protected`	`UrlAlias(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 UrlAlias`	`_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 UrlAlias`	`_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`	`getAlias()`
`KeyStoreInfo`	`getKeystoreInfo()`
`java.lang.String`	`getQuery()` Search query to be applied, if any.
`com.vmware.vapi.bindings.Structure`	`getRequestBody()` A raw request body in the form json format for a given url.
`com.vmware.vapi.bindings.Structure`	`getRequestHeaders()` A raw request header in the form json format for a given url.
`java.lang.String`	`getRequestMethod()` Possible values are: `REQUEST_METHOD_GET` `REQUEST_METHOD_POST` Type of the http method (Get, Post) to be used while invoking the given url through dashboard datasource framework.
`java.lang.String`	`getUrl()` Url to fetch data from.
`int`	`hashCode()`
`void`	`setAlias(java.lang.String alias)`
`void`	`setKeystoreInfo(KeyStoreInfo keystoreInfo)`
`void`	`setQuery(java.lang.String query)` Search query to be applied, if any.
`void`	`setRequestBody(com.vmware.vapi.bindings.Structure requestBody)` A raw request body in the form json format for a given url.
`void`	`setRequestHeaders(com.vmware.vapi.bindings.Structure requestHeaders)` A raw request header in the form json format for a given url.
`void`	`setRequestMethod(java.lang.String requestMethod)` Possible values are: `REQUEST_METHOD_GET` `REQUEST_METHOD_POST` Type of the http method (Get, Post) to be used while invoking the given url through dashboard datasource framework.
`void`	`setUrl(java.lang.String url)` Url to fetch data from.
`java.lang.String`	`toString()`

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

- Field Detail
  - REQUEST_METHOD_GET
```
public static final java.lang.String REQUEST_METHOD_GET
```
    See Also:
    
    Constant Field Values
  - REQUEST_METHOD_POST
```
public static final java.lang.String REQUEST_METHOD_POST
```
    See Also:
    
    Constant Field Values
  - __dynamicStructureFields
```
protected com.vmware.vapi.data.StructValue __dynamicStructureFields
```
- Constructor Detail
  - UrlAlias
```
public UrlAlias()
```
    Default constructor.
  - UrlAlias
```
protected UrlAlias(com.vmware.vapi.data.StructValue __dynamicStructureFields)
```
- Method Detail
  - getAlias
```
public java.lang.String getAlias()
```
    Returns:
    
    The current value of the property.
  - setAlias
```
public void setAlias(java.lang.String alias)
```
    Parameters:
    
    alias - New value for the property.
  - getKeystoreInfo
```
public KeyStoreInfo getKeystoreInfo()
```
    Returns:
    
    The current value of the property.
  - setKeystoreInfo
```
public void setKeystoreInfo(KeyStoreInfo keystoreInfo)
```
    Parameters:
    
    keystoreInfo - New value for the property.
  - getQuery
```
public java.lang.String getQuery()
```
    Search query to be applied, if any. If query string is not provided, it will be ignored.
    
    Returns:
    
    The current value of the property.
  - setQuery
```
public void setQuery(java.lang.String query)
```
    Search query to be applied, if any. If query string is not provided, it will be ignored.
    
    Parameters:
    
    query - New value for the property.
  - getRequestBody
```
public com.vmware.vapi.bindings.Structure getRequestBody()
```
    A raw request body in the form json format for a given url. This request body will be submitted along with request while giving a post api call.
    
    Returns:
    
    The current value of the property.
  - setRequestBody
```
public void setRequestBody(com.vmware.vapi.bindings.Structure requestBody)
```
    A raw request body in the form json format for a given url. This request body will be submitted along with request while giving a post api call.
    
    Parameters:
    
    requestBody - New value for the property.
  - getRequestHeaders
```
public com.vmware.vapi.bindings.Structure getRequestHeaders()
```
    A raw request header in the form json format for a given url. This request header will be submitted along with request while giving a api call.
    
    Returns:
    
    The current value of the property.
  - setRequestHeaders
```
public void setRequestHeaders(com.vmware.vapi.bindings.Structure requestHeaders)
```
    A raw request header in the form json format for a given url. This request header will be submitted along with request while giving a api call.
    
    Parameters:
    
    requestHeaders - New value for the property.
  - getRequestMethod
```
public java.lang.String getRequestMethod()
```
    Possible values are:
    - REQUEST_METHOD_GET
    - REQUEST_METHOD_POST
    Type of the http method (Get, Post) to be used while invoking the given url through dashboard datasource framework.
    Returns:
    
    The current value of the property.
  - setRequestMethod
```
public void setRequestMethod(java.lang.String requestMethod)
```
    Possible values are:
    - REQUEST_METHOD_GET
    - REQUEST_METHOD_POST
    Type of the http method (Get, Post) to be used while invoking the given url through dashboard datasource framework.
    Parameters:
    
    requestMethod - New value for the property.
  - getUrl
```
public java.lang.String getUrl()
```
    Url to fetch data from.
    
    Returns:
    
    The current value of the property.
  - setUrl
```
public void setUrl(java.lang.String url)
```
    Url to fetch data from.
    
    Parameters:
    
    url - 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 UrlAlias _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 UrlAlias _newInstance2(com.vmware.vapi.data.StructValue structValue)
```
    WARNING: Internal method, subject to change in future versions.
    Serves as a versioning mechanism.

Class UrlAlias

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

REQUEST_METHOD_GET

REQUEST_METHOD_POST

__dynamicStructureFields

Constructor Detail

UrlAlias

UrlAlias

Method Detail

getAlias

setAlias

getKeystoreInfo

setKeystoreInfo

getQuery

setQuery

getRequestBody

setRequestBody

getRequestHeaders

setRequestHeaders

getRequestMethod

setRequestMethod

getUrl

setUrl

_getType

_getDataValue

_updateDataValue

_validate

equals

hashCode

toString

_hasTypeNameOf

_convertTo

_setDynamicField

_getDynamicField

_getDynamicFieldNames

_getClassType

_getCanonicalName

_getCanonicalTypeName

_newInstance

_newInstance2