AdvertiseRule (Java SDK for NSX Manager API 4.1.2.0.0)

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

All Implemented Interfaces:

com.vmware.vapi.bindings.StaticStructure, com.vmware.vapi.bindings.Structure, java.io.Serializable
```
public final class AdvertiseRule
extends java.lang.Object
implements java.io.Serializable, com.vmware.vapi.bindings.StaticStructure
```
See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class AdvertiseRule.Builder
Builder class for AdvertiseRule.

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

Field Summary

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

Constructor Summary

Constructors
Modifier Constructor and Description

AdvertiseRule()
Default constructor.

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

Constructors
Modifier	Constructor and Description
	`AdvertiseRule()` Default constructor.
`protected`	`AdvertiseRule(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 AdvertiseRule`	`_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 AdvertiseRule`	`_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`	`getAction()` Possible values are: `ACTION_DENY` `ACTION_ALLOW` ALLOW action enables the advertisment and DENY action disables the advertisement of a filtered routes to the connected TIER0 router.
`java.lang.String`	`getDescription()` Description
`java.lang.String`	`getDisplayName()` Display name
`java.util.List<java.lang.String>`	`getNetworks()` network(CIDR) to be routed format: ip-cidr-block
`AdvertisementRuleFilter`	`getRuleFilter()`
`int`	`hashCode()`
`void`	`setAction(java.lang.String action)` Possible values are: `ACTION_DENY` `ACTION_ALLOW` ALLOW action enables the advertisment and DENY action disables the advertisement of a filtered routes to the connected TIER0 router.
`void`	`setDescription(java.lang.String description)` Description
`void`	`setDisplayName(java.lang.String displayName)` Display name
`void`	`setNetworks(java.util.List<java.lang.String> networks)` network(CIDR) to be routed format: ip-cidr-block
`void`	`setRuleFilter(AdvertisementRuleFilter ruleFilter)`
`java.lang.String`	`toString()`

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

- Field Detail
  - ACTION_DENY
```
public static final java.lang.String ACTION_DENY
```
    See Also:
    
    Constant Field Values
  - ACTION_ALLOW
```
public static final java.lang.String ACTION_ALLOW
```
    See Also:
    
    Constant Field Values
  - __dynamicStructureFields
```
protected com.vmware.vapi.data.StructValue __dynamicStructureFields
```
- Constructor Detail
  - AdvertiseRule
```
public AdvertiseRule()
```
    Default constructor.
  - AdvertiseRule
```
protected AdvertiseRule(com.vmware.vapi.data.StructValue __dynamicStructureFields)
```
- Method Detail
  - getAction
```
public java.lang.String getAction()
```
    Possible values are:
    - ACTION_DENY
    - ACTION_ALLOW
    ALLOW action enables the advertisment and DENY action disables the advertisement of a filtered routes to the connected TIER0 router.
    Returns:
    
    The current value of the property.
  - setAction
```
public void setAction(java.lang.String action)
```
    Possible values are:
    - ACTION_DENY
    - ACTION_ALLOW
    ALLOW action enables the advertisment and DENY action disables the advertisement of a filtered routes to the connected TIER0 router.
    Parameters:
    
    action - New value for the property.
  - getDescription
```
public java.lang.String getDescription()
```
    Description
    
    Returns:
    
    The current value of the property.
  - setDescription
```
public void setDescription(java.lang.String description)
```
    Description
    
    Parameters:
    
    description - New value for the property.
  - getDisplayName
```
public java.lang.String getDisplayName()
```
    Display name
    
    Returns:
    
    The current value of the property.
  - setDisplayName
```
public void setDisplayName(java.lang.String displayName)
```
    Display name
    
    Parameters:
    
    displayName - New value for the property.
  - getNetworks
```
public java.util.List<java.lang.String> getNetworks()
```
    network(CIDR) to be routed format: ip-cidr-block
    
    Returns:
    
    The current value of the property.
  - setNetworks
```
public void setNetworks(java.util.List<java.lang.String> networks)
```
    network(CIDR) to be routed format: ip-cidr-block
    
    Parameters:
    
    networks - New value for the property.
  - getRuleFilter
```
public AdvertisementRuleFilter getRuleFilter()
```
    Returns:
    
    The current value of the property.
  - setRuleFilter
```
public void setRuleFilter(AdvertisementRuleFilter ruleFilter)
```
    Parameters:
    
    ruleFilter - 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 AdvertiseRule _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 AdvertiseRule _newInstance2(com.vmware.vapi.data.StructValue structValue)
```
    WARNING: Internal method, subject to change in future versions.
    Serves as a versioning mechanism.

Class AdvertiseRule

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

ACTION_DENY

ACTION_ALLOW

__dynamicStructureFields

Constructor Detail

AdvertiseRule

AdvertiseRule

Method Detail

getAction

setAction

getDescription

setDescription

getDisplayName

setDisplayName

getNetworks

setNetworks

getRuleFilter

setRuleFilter

_getType

_getDataValue

_updateDataValue

_validate

equals

hashCode

toString

_hasTypeNameOf

_convertTo

_setDynamicField

_getDynamicField

_getDynamicFieldNames

_getClassType

_getCanonicalName

_getCanonicalTypeName

_newInstance

_newInstance2