ALBAnalyticsPolicy (Java SDK for NSX Global Policy API 4.1.0.2.0)

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

All Implemented Interfaces:

com.vmware.vapi.bindings.StaticStructure, com.vmware.vapi.bindings.Structure, java.io.Serializable
```
public final class ALBAnalyticsPolicy
extends java.lang.Object
implements java.io.Serializable, com.vmware.vapi.bindings.StaticStructure
```
Advanced load balancer AnalyticsPolicy object

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class ALBAnalyticsPolicy.Builder
Builder class for ALBAnalyticsPolicy.

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

Field Summary

Fields
Modifier and Type	Field and Description
`protected com.vmware.vapi.data.StructValue`	`__dynamicStructureFields`
`static java.lang.String`	`CLIENT_INSIGHTS_ACTIVE`
`static java.lang.String`	`CLIENT_INSIGHTS_NO_INSIGHTS`
`static java.lang.String`	`CLIENT_INSIGHTS_PASSIVE`

Constructor Summary

Constructors
Modifier Constructor and Description

ALBAnalyticsPolicy()
Default constructor.

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

Constructors
Modifier	Constructor and Description
	`ALBAnalyticsPolicy()` Default constructor.
`protected`	`ALBAnalyticsPolicy(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 ALBAnalyticsPolicy`	`_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 ALBAnalyticsPolicy`	`_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.Boolean`	`getAllHeaders()` Log all headers.
`java.lang.String`	`getClientInsights()` Possible values are: `CLIENT_INSIGHTS_NO_INSIGHTS` `CLIENT_INSIGHTS_PASSIVE` `CLIENT_INSIGHTS_ACTIVE` Gain insights from sampled client to server HTTP requests and responses.
`ALBClientInsightsSampling`	`getClientInsightsSampling()`
`java.util.List<ALBClientLogFilter>`	`getClientLogFilters()` Placeholder for description of property client_log_filters of obj type AnalyticsPolicy field type str type array.
`ALBFullClientLogs`	`getFullClientLogs()`
`ALBMetricsRealTimeUpdate`	`getMetricsRealtimeUpdate()`
`java.lang.Long`	`getSignificantLogThrottle()` This setting limits the number of significant logs generated per second for this VS on each SE.
`java.lang.Long`	`getUdfLogThrottle()` This setting limits the total number of UDF logs generated per second for this VS on each SE.
`int`	`hashCode()`
`void`	`setAllHeaders(java.lang.Boolean allHeaders)` Log all headers.
`void`	`setClientInsights(java.lang.String clientInsights)` Possible values are: `CLIENT_INSIGHTS_NO_INSIGHTS` `CLIENT_INSIGHTS_PASSIVE` `CLIENT_INSIGHTS_ACTIVE` Gain insights from sampled client to server HTTP requests and responses.
`void`	`setClientInsightsSampling(ALBClientInsightsSampling clientInsightsSampling)`
`void`	`setClientLogFilters(java.util.List<ALBClientLogFilter> clientLogFilters)` Placeholder for description of property client_log_filters of obj type AnalyticsPolicy field type str type array.
`void`	`setFullClientLogs(ALBFullClientLogs fullClientLogs)`
`void`	`setMetricsRealtimeUpdate(ALBMetricsRealTimeUpdate metricsRealtimeUpdate)`
`void`	`setSignificantLogThrottle(java.lang.Long significantLogThrottle)` This setting limits the number of significant logs generated per second for this VS on each SE.
`void`	`setUdfLogThrottle(java.lang.Long udfLogThrottle)` This setting limits the total number of UDF logs generated per second for this VS on each SE.
`java.lang.String`	`toString()`

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

- Field Detail
  - CLIENT_INSIGHTS_NO_INSIGHTS
```
public static final java.lang.String CLIENT_INSIGHTS_NO_INSIGHTS
```
    See Also:
    
    Constant Field Values
  - CLIENT_INSIGHTS_PASSIVE
```
public static final java.lang.String CLIENT_INSIGHTS_PASSIVE
```
    See Also:
    
    Constant Field Values
  - CLIENT_INSIGHTS_ACTIVE
```
public static final java.lang.String CLIENT_INSIGHTS_ACTIVE
```
    See Also:
    
    Constant Field Values
  - __dynamicStructureFields
```
protected com.vmware.vapi.data.StructValue __dynamicStructureFields
```
- Constructor Detail
  - ALBAnalyticsPolicy
```
public ALBAnalyticsPolicy()
```
    Default constructor.
  - ALBAnalyticsPolicy
```
protected ALBAnalyticsPolicy(com.vmware.vapi.data.StructValue __dynamicStructureFields)
```
- Method Detail
  - getAllHeaders
```
public java.lang.Boolean getAllHeaders()
```
    Log all headers. Default value when not specified in API or module is interpreted by ALB Controller as false.
    
    Returns:
    
    The current value of the property.
  - setAllHeaders
```
public void setAllHeaders(java.lang.Boolean allHeaders)
```
    Log all headers. Default value when not specified in API or module is interpreted by ALB Controller as false.
    
    Parameters:
    
    allHeaders - New value for the property.
  - getClientInsights
```
public java.lang.String getClientInsights()
```
    Possible values are:
    Gain insights from sampled client to server HTTP requests and responses. Enum options - NO_INSIGHTS, PASSIVE, ACTIVE. Default value when not specified in API or module is interpreted by ALB Controller as NO_INSIGHTS.
    Returns:
    
    The current value of the property.
  - setClientInsights
```
public void setClientInsights(java.lang.String clientInsights)
```
    Possible values are:
    Gain insights from sampled client to server HTTP requests and responses. Enum options - NO_INSIGHTS, PASSIVE, ACTIVE. Default value when not specified in API or module is interpreted by ALB Controller as NO_INSIGHTS.
    Parameters:
    
    clientInsights - New value for the property.
  - getClientInsightsSampling
```
public ALBClientInsightsSampling getClientInsightsSampling()
```
    Returns:
    
    The current value of the property.
  - setClientInsightsSampling
```
public void setClientInsightsSampling(ALBClientInsightsSampling clientInsightsSampling)
```
    Parameters:
    
    clientInsightsSampling - New value for the property.
  - getClientLogFilters
```
public java.util.List<ALBClientLogFilter> getClientLogFilters()
```
    Placeholder for description of property client_log_filters of obj type AnalyticsPolicy field type str type array.
    
    Returns:
    
    The current value of the property.
  - setClientLogFilters
```
public void setClientLogFilters(java.util.List<ALBClientLogFilter> clientLogFilters)
```
    Placeholder for description of property client_log_filters of obj type AnalyticsPolicy field type str type array.
    
    Parameters:
    
    clientLogFilters - New value for the property.
  - getFullClientLogs
```
public ALBFullClientLogs getFullClientLogs()
```
    Returns:
    
    The current value of the property.
  - setFullClientLogs
```
public void setFullClientLogs(ALBFullClientLogs fullClientLogs)
```
    Parameters:
    
    fullClientLogs - New value for the property.
  - getMetricsRealtimeUpdate
```
public ALBMetricsRealTimeUpdate getMetricsRealtimeUpdate()
```
    Returns:
    
    The current value of the property.
  - setMetricsRealtimeUpdate
```
public void setMetricsRealtimeUpdate(ALBMetricsRealTimeUpdate metricsRealtimeUpdate)
```
    Parameters:
    
    metricsRealtimeUpdate - New value for the property.
  - getSignificantLogThrottle
```
public java.lang.Long getSignificantLogThrottle()
```
    This setting limits the number of significant logs generated per second for this VS on each SE. Default is 10 logs per second. Set it to zero (0) to deactivate throttling. Unit is PER_SECOND. Default value when not specified in API or module is interpreted by ALB Controller as 10. format: int64
    
    Returns:
    
    The current value of the property.
  - setSignificantLogThrottle
```
public void setSignificantLogThrottle(java.lang.Long significantLogThrottle)
```
    This setting limits the number of significant logs generated per second for this VS on each SE. Default is 10 logs per second. Set it to zero (0) to deactivate throttling. Unit is PER_SECOND. Default value when not specified in API or module is interpreted by ALB Controller as 10. format: int64
    
    Parameters:
    
    significantLogThrottle - New value for the property.
  - getUdfLogThrottle
```
public java.lang.Long getUdfLogThrottle()
```
    This setting limits the total number of UDF logs generated per second for this VS on each SE. UDF logs are generated due to the configured client log filters or the rules with logging enabled. Default is 10 logs per second. Set it to zero (0) to deactivate throttling. Unit is PER_SECOND. Default value when not specified in API or module is interpreted by ALB Controller as 10. format: int64
    
    Returns:
    
    The current value of the property.
  - setUdfLogThrottle
```
public void setUdfLogThrottle(java.lang.Long udfLogThrottle)
```
    This setting limits the total number of UDF logs generated per second for this VS on each SE. UDF logs are generated due to the configured client log filters or the rules with logging enabled. Default is 10 logs per second. Set it to zero (0) to deactivate throttling. Unit is PER_SECOND. Default value when not specified in API or module is interpreted by ALB Controller as 10. format: int64
    
    Parameters:
    
    udfLogThrottle - 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 ALBAnalyticsPolicy _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 ALBAnalyticsPolicy _newInstance2(com.vmware.vapi.data.StructValue structValue)
```
    WARNING: Internal method, subject to change in future versions.
    Serves as a versioning mechanism.

Class ALBAnalyticsPolicy

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

CLIENT_INSIGHTS_NO_INSIGHTS

CLIENT_INSIGHTS_PASSIVE

CLIENT_INSIGHTS_ACTIVE

__dynamicStructureFields

Constructor Detail

ALBAnalyticsPolicy

ALBAnalyticsPolicy

Method Detail

getAllHeaders

setAllHeaders

getClientInsights

setClientInsights

getClientInsightsSampling

setClientInsightsSampling

getClientLogFilters

setClientLogFilters

getFullClientLogs

setFullClientLogs

getMetricsRealtimeUpdate

setMetricsRealtimeUpdate

getSignificantLogThrottle

setSignificantLogThrottle

getUdfLogThrottle

setUdfLogThrottle

_getType

_getDataValue

_updateDataValue

_validate

equals

hashCode

toString

_hasTypeNameOf

_convertTo

_setDynamicField

_getDynamicField

_getDynamicFieldNames

_getClassType

_getCanonicalName

_getCanonicalTypeName

_newInstance

_newInstance2