PolicyAttributes (NSX Policy API 4.1.2.0.0)

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

All Implemented Interfaces:

com.vmware.vapi.bindings.StaticStructure, com.vmware.vapi.bindings.Structure, java.io.Serializable
```
public final class PolicyAttributes
extends java.lang.Object
implements java.io.Serializable, com.vmware.vapi.bindings.StaticStructure
```
Policy Attributes data holder

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class PolicyAttributes.Builder
Builder class for PolicyAttributes.

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

Field Summary

Fields
Modifier and Type	Field and Description
`protected com.vmware.vapi.data.StructValue`	`__dynamicStructureFields`
`static java.lang.String`	`ATTRIBUTE_SOURCE_CUSTOM`
`static java.lang.String`	`ATTRIBUTE_SOURCE_SYSTEM`
`static java.lang.String`	`DATATYPE_STRING`
`static java.lang.String`	`KEY_APP_ID`
`static java.lang.String`	`KEY_CUSTOM_URL`
`static java.lang.String`	`KEY_DOMAIN_NAME`
`static java.lang.String`	`KEY_URL_CATEGORY`
`static java.lang.String`	`KEY_URL_REPUTATION`

Constructor Summary

Constructors
Modifier Constructor and Description

PolicyAttributes()
Default constructor.

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

Constructors
Modifier	Constructor and Description
	`PolicyAttributes()` Default constructor.
`protected`	`PolicyAttributes(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 PolicyAttributes`	`_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 PolicyAttributes`	`_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`	`getAttributeSource()` Possible values are: `ATTRIBUTE_SOURCE_SYSTEM` `ATTRIBUTE_SOURCE_CUSTOM` Source of attribute value i.e whether system defined or custom value
`java.lang.Boolean`	`getCustomUrlPartialMatch()` True value for this flag will be treated as a partial match for custom url
`java.lang.String`	`getDatatype()` Possible values are: `DATATYPE_STRING` Datatype for attribute
`java.lang.String`	`getDescription()` Description for attribute value
`java.lang.Boolean`	`getIsALGType()` Describes whether the APP_ID value is ALG type or not.
`java.lang.String`	`getKey()` Possible values are: `KEY_APP_ID` `KEY_DOMAIN_NAME` `KEY_URL_CATEGORY` `KEY_URL_REPUTATION` `KEY_CUSTOM_URL` URL_Reputation is currently not available.
`java.util.List<ContextProfileAttributesMetadata>`	`getMetadata()` This is optional part that can hold additional data about the attribute key/values.
`java.util.List<PolicySubAttributes>`	`getSubAttributes()` Reference to sub attributes for the attribute
`java.util.List<java.lang.String>`	`getValue()` Multiple attribute values can be specified as elements of array.
`int`	`hashCode()`
`void`	`setAttributeSource(java.lang.String attributeSource)` Possible values are: `ATTRIBUTE_SOURCE_SYSTEM` `ATTRIBUTE_SOURCE_CUSTOM` Source of attribute value i.e whether system defined or custom value
`void`	`setCustomUrlPartialMatch(java.lang.Boolean customUrlPartialMatch)` True value for this flag will be treated as a partial match for custom url
`void`	`setDatatype(java.lang.String datatype)` Possible values are: `DATATYPE_STRING` Datatype for attribute
`void`	`setDescription(java.lang.String description)` Description for attribute value
`void`	`setIsALGType(java.lang.Boolean isALGType)` Describes whether the APP_ID value is ALG type or not.
`void`	`setKey(java.lang.String key)` Possible values are: `KEY_APP_ID` `KEY_DOMAIN_NAME` `KEY_URL_CATEGORY` `KEY_URL_REPUTATION` `KEY_CUSTOM_URL` URL_Reputation is currently not available.
`void`	`setMetadata(java.util.List<ContextProfileAttributesMetadata> metadata)` This is optional part that can hold additional data about the attribute key/values.
`void`	`setSubAttributes(java.util.List<PolicySubAttributes> subAttributes)` Reference to sub attributes for the attribute
`void`	`setValue(java.util.List<java.lang.String> value)` Multiple attribute values can be specified as elements of array.
`java.lang.String`	`toString()`

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

- Field Detail
  - ATTRIBUTE_SOURCE_SYSTEM
```
public static final java.lang.String ATTRIBUTE_SOURCE_SYSTEM
```
    See Also:
    
    Constant Field Values
  - ATTRIBUTE_SOURCE_CUSTOM
```
public static final java.lang.String ATTRIBUTE_SOURCE_CUSTOM
```
    See Also:
    
    Constant Field Values
  - DATATYPE_STRING
```
public static final java.lang.String DATATYPE_STRING
```
    See Also:
    
    Constant Field Values
  - KEY_APP_ID
```
public static final java.lang.String KEY_APP_ID
```
    See Also:
    
    Constant Field Values
  - KEY_DOMAIN_NAME
```
public static final java.lang.String KEY_DOMAIN_NAME
```
    See Also:
    
    Constant Field Values
  - KEY_URL_CATEGORY
```
public static final java.lang.String KEY_URL_CATEGORY
```
    See Also:
    
    Constant Field Values
  - KEY_URL_REPUTATION
```
public static final java.lang.String KEY_URL_REPUTATION
```
    See Also:
    
    Constant Field Values
  - KEY_CUSTOM_URL
```
public static final java.lang.String KEY_CUSTOM_URL
```
    See Also:
    
    Constant Field Values
  - __dynamicStructureFields
```
protected com.vmware.vapi.data.StructValue __dynamicStructureFields
```
- Constructor Detail
  - PolicyAttributes
```
public PolicyAttributes()
```
    Default constructor.
  - PolicyAttributes
```
protected PolicyAttributes(com.vmware.vapi.data.StructValue __dynamicStructureFields)
```
- Method Detail
  - getAttributeSource
```
public java.lang.String getAttributeSource()
```
    Possible values are:
    - ATTRIBUTE_SOURCE_SYSTEM
    - ATTRIBUTE_SOURCE_CUSTOM
    Source of attribute value i.e whether system defined or custom value
    Returns:
    
    The current value of the property.
  - setAttributeSource
```
public void setAttributeSource(java.lang.String attributeSource)
```
    Possible values are:
    - ATTRIBUTE_SOURCE_SYSTEM
    - ATTRIBUTE_SOURCE_CUSTOM
    Source of attribute value i.e whether system defined or custom value
    Parameters:
    
    attributeSource - New value for the property.
  - getCustomUrlPartialMatch
```
public java.lang.Boolean getCustomUrlPartialMatch()
```
    True value for this flag will be treated as a partial match for custom url
    
    Returns:
    
    The current value of the property.
  - setCustomUrlPartialMatch
```
public void setCustomUrlPartialMatch(java.lang.Boolean customUrlPartialMatch)
```
    True value for this flag will be treated as a partial match for custom url
    
    Parameters:
    
    customUrlPartialMatch - New value for the property.
  - getDatatype
```
public java.lang.String getDatatype()
```
    Possible values are:
    - DATATYPE_STRING
    Datatype for attribute
    Returns:
    
    The current value of the property.
  - setDatatype
```
public void setDatatype(java.lang.String datatype)
```
    Possible values are:
    - DATATYPE_STRING
    Datatype for attribute
    Parameters:
    
    datatype - New value for the property.
  - getDescription
```
public java.lang.String getDescription()
```
    Description for attribute value
    
    Returns:
    
    The current value of the property.
  - setDescription
```
public void setDescription(java.lang.String description)
```
    Description for attribute value
    
    Parameters:
    
    description - New value for the property.
  - getIsALGType
```
public java.lang.Boolean getIsALGType()
```
    Describes whether the APP_ID value is ALG type or not.
    
    Returns:
    
    The current value of the property.
  - setIsALGType
```
public void setIsALGType(java.lang.Boolean isALGType)
```
    Describes whether the APP_ID value is ALG type or not.
    
    Parameters:
    
    isALGType - New value for the property.
  - getKey
```
public java.lang.String getKey()
```
    Possible values are:
    URL_Reputation is currently not available. Please do not use it in Attribute Key while creating context profile
    Returns:
    
    The current value of the property.
  - setKey
```
public void setKey(java.lang.String key)
```
    Possible values are:
    URL_Reputation is currently not available. Please do not use it in Attribute Key while creating context profile
    Parameters:
    
    key - New value for the property.
  - getMetadata
```
public java.util.List<ContextProfileAttributesMetadata> getMetadata()
```
    This is optional part that can hold additional data about the attribute key/values. Example - For URL CATEGORY key , it specified super category for url category value. This is generic array and can hold multiple meta information about key/values in future
    
    Returns:
    
    The current value of the property.
  - setMetadata
```
public void setMetadata(java.util.List<ContextProfileAttributesMetadata> metadata)
```
    This is optional part that can hold additional data about the attribute key/values. Example - For URL CATEGORY key , it specified super category for url category value. This is generic array and can hold multiple meta information about key/values in future
    
    Parameters:
    
    metadata - New value for the property.
  - getSubAttributes
```
public java.util.List<PolicySubAttributes> getSubAttributes()
```
    Reference to sub attributes for the attribute
    
    Returns:
    
    The current value of the property.
  - setSubAttributes
```
public void setSubAttributes(java.util.List<PolicySubAttributes> subAttributes)
```
    Reference to sub attributes for the attribute
    
    Parameters:
    
    subAttributes - New value for the property.
  - getValue
```
public java.util.List<java.lang.String> getValue()
```
    Multiple attribute values can be specified as elements of array.
    
    Returns:
    
    The current value of the property.
  - setValue
```
public void setValue(java.util.List<java.lang.String> value)
```
    Multiple attribute values can be specified as elements of array.
    
    Parameters:
    
    value - 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 PolicyAttributes _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 PolicyAttributes _newInstance2(com.vmware.vapi.data.StructValue structValue)
```
    WARNING: Internal method, subject to change in future versions.
    Serves as a versioning mechanism.

Class PolicyAttributes

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

ATTRIBUTE_SOURCE_SYSTEM

ATTRIBUTE_SOURCE_CUSTOM

DATATYPE_STRING

KEY_APP_ID

KEY_DOMAIN_NAME

KEY_URL_CATEGORY

KEY_URL_REPUTATION

KEY_CUSTOM_URL

__dynamicStructureFields

Constructor Detail

PolicyAttributes

PolicyAttributes

Method Detail

getAttributeSource

setAttributeSource

getCustomUrlPartialMatch

setCustomUrlPartialMatch

getDatatype

setDatatype

getDescription

setDescription

getIsALGType

setIsALGType

getKey

setKey

getMetadata

setMetadata

getSubAttributes

setSubAttributes

getValue

setValue

_getType

_getDataValue

_updateDataValue

_validate

equals

hashCode

toString

_hasTypeNameOf

_convertTo

_setDynamicField

_getDynamicField

_getDynamicFieldNames

_getClassType

_getCanonicalName

_getCanonicalTypeName

_newInstance

_newInstance2