IngressRateLimiter (Java SDK for NSX Global Policy API 4.1.0.2.0)

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

All Implemented Interfaces:

com.vmware.vapi.bindings.StaticStructure, com.vmware.vapi.bindings.Structure, java.io.Serializable
```
public final class IngressRateLimiter
extends java.lang.Object
implements java.io.Serializable, com.vmware.vapi.bindings.StaticStructure
```
A shaper that specifies ingress rate properties in Mb/s

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class IngressRateLimiter.Builder
Builder class for IngressRateLimiter.

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

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

IngressRateLimiter()
Default constructor.

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

Constructors
Modifier	Constructor and Description
	`IngressRateLimiter()` Default constructor.
`protected`	`IngressRateLimiter(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 IngressRateLimiter`	`_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 IngressRateLimiter`	`_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.Long`	`getAverageBandwidth()` You can use the average bandwidth to reduce network congestion.
`java.lang.Long`	`getBurstSize()` The burst duration is set in the burst size setting.
`java.lang.Boolean`	`getEnabled()`
`java.lang.Long`	`getPeakBandwidth()` The peak bandwidth rate is used to support burst traffic.
`java.lang.String`	`getResourceType()` Possible values are: `QosBaseRateLimiter.RESOURCE_TYPE_INGRESSRATELIMITER` `QosBaseRateLimiter.RESOURCE_TYPE_INGRESSBROADCASTRATELIMITER` `QosBaseRateLimiter.RESOURCE_TYPE_EGRESSRATELIMITER` Type rate limiter The value of this property is automatically populated to `"IngressRateLimiter"`.
`int`	`hashCode()`
`void`	`setAverageBandwidth(java.lang.Long averageBandwidth)` You can use the average bandwidth to reduce network congestion.
`void`	`setBurstSize(java.lang.Long burstSize)` The burst duration is set in the burst size setting.
`void`	`setEnabled(java.lang.Boolean enabled)`
`void`	`setPeakBandwidth(java.lang.Long peakBandwidth)` The peak bandwidth rate is used to support burst traffic.
`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
  - IngressRateLimiter
```
public IngressRateLimiter()
```
    Default constructor.
  - IngressRateLimiter
```
protected IngressRateLimiter(com.vmware.vapi.data.StructValue __dynamicStructureFields)
```
- Method Detail
  - getAverageBandwidth
```
public java.lang.Long getAverageBandwidth()
```
    You can use the average bandwidth to reduce network congestion. format: int32
    
    Returns:
    
    The current value of the property.
  - setAverageBandwidth
```
public void setAverageBandwidth(java.lang.Long averageBandwidth)
```
    You can use the average bandwidth to reduce network congestion. format: int32
    
    Parameters:
    
    averageBandwidth - New value for the property.
  - getBurstSize
```
public java.lang.Long getBurstSize()
```
    The burst duration is set in the burst size setting. format: int32
    
    Returns:
    
    The current value of the property.
  - setBurstSize
```
public void setBurstSize(java.lang.Long burstSize)
```
    The burst duration is set in the burst size setting. format: int32
    
    Parameters:
    
    burstSize - New value for the property.
  - getPeakBandwidth
```
public java.lang.Long getPeakBandwidth()
```
    The peak bandwidth rate is used to support burst traffic. format: int32
    
    Returns:
    
    The current value of the property.
  - setPeakBandwidth
```
public void setPeakBandwidth(java.lang.Long peakBandwidth)
```
    The peak bandwidth rate is used to support burst traffic. format: int32
    
    Parameters:
    
    peakBandwidth - New value for the property.
  - getEnabled
```
public java.lang.Boolean getEnabled()
```
    Returns:
    
    The current value of the property.
  - setEnabled
```
public void setEnabled(java.lang.Boolean enabled)
```
    Parameters:
    
    enabled - New value for the property.
  - getResourceType
```
public java.lang.String getResourceType()
```
    Possible values are:
    Type rate limiter The value of this property is automatically populated to "IngressRateLimiter".
    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 IngressRateLimiter _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 IngressRateLimiter _newInstance2(com.vmware.vapi.data.StructValue structValue)
```
    WARNING: Internal method, subject to change in future versions.
    Serves as a versioning mechanism.

Class IngressRateLimiter

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

_TYPE_IDENTIFIER

__dynamicStructureFields

Constructor Detail

IngressRateLimiter

IngressRateLimiter

Method Detail

getAverageBandwidth

setAverageBandwidth

getBurstSize

setBurstSize

getPeakBandwidth

setPeakBandwidth

getEnabled

setEnabled

getResourceType

_getType

_getDataValue

_updateDataValue

_validate

equals

hashCode

toString

_hasTypeNameOf

_convertTo

_setDynamicField

_getDynamicField

_getDynamicFieldNames

_getClassType

_getCanonicalName

_getCanonicalTypeName

_newInstance

_newInstance2