ALBClientLogStreamingConfig (Java SDK for NSX Global Policy API 4.1.0.2.0)

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

All Implemented Interfaces:

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

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class ALBClientLogStreamingConfig.Builder
Builder class for ALBClientLogStreamingConfig.

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

Field Summary

Fields
Modifier and Type	Field and Description
`protected com.vmware.vapi.data.StructValue`	`__dynamicStructureFields`
`static java.lang.String`	`LOG_TYPES_TO_SEND_ALL`
`static java.lang.String`	`LOG_TYPES_TO_SEND_SIGNIFICANT_ONLY`
`static java.lang.String`	`LOG_TYPES_TO_SEND_UDF_ONLY`
`static java.lang.String`	`LOG_TYPES_TO_SEND_UDF_SIGNIFICANT`
`static java.lang.String`	`PROTOCOL_RAW_OVER_UDP`
`static java.lang.String`	`PROTOCOL_SYSLOG_OVER_TCP`
`static java.lang.String`	`PROTOCOL_SYSLOG_OVER_TLS`
`static java.lang.String`	`PROTOCOL_SYSLOG_OVER_UDP`
`static java.lang.String`	`PROTOCOL_TCP`
`static java.lang.String`	`PROTOCOL_TLS`
`static java.lang.String`	`PROTOCOL_UDP`

Constructor Summary

Constructors
Modifier	Constructor and Description
	`ALBClientLogStreamingConfig()` Default constructor.
`protected`	`ALBClientLogStreamingConfig(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 ALBClientLogStreamingConfig`	`_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 ALBClientLogStreamingConfig`	`_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`	`getExternalServer()` IP address or hostnames (FQDNs) of destination servers.
`java.lang.Long`	`getExternalServerPort()` The service port to use for the external servers.
`ALBClientLogStreamingFormat`	`getFormatConfig()`
`java.lang.String`	`getLogTypesToSend()` Possible values are: `LOG_TYPES_TO_SEND_SIGNIFICANT_ONLY` `LOG_TYPES_TO_SEND_UDF_ONLY` `LOG_TYPES_TO_SEND_UDF_SIGNIFICANT` `LOG_TYPES_TO_SEND_ALL` Type of logs to stream to the external server.
`java.lang.Long`	`getMaxLogsPerSecond()` Maximum number of logs per second streamed to the remote server.
`java.lang.String`	`getProtocol()` Possible values are: `PROTOCOL_UDP` `PROTOCOL_SYSLOG_OVER_UDP` `PROTOCOL_TCP` `PROTOCOL_SYSLOG_OVER_TCP` `PROTOCOL_RAW_OVER_UDP` `PROTOCOL_TLS` `PROTOCOL_SYSLOG_OVER_TLS` Protocol to use for streaming logs.
`ALBStreamingSyslogConfig`	`getSyslogConfig()`
`int`	`hashCode()`
`void`	`setExternalServer(java.lang.String externalServer)` IP address or hostnames (FQDNs) of destination servers.
`void`	`setExternalServerPort(java.lang.Long externalServerPort)` The service port to use for the external servers.
`void`	`setFormatConfig(ALBClientLogStreamingFormat formatConfig)`
`void`	`setLogTypesToSend(java.lang.String logTypesToSend)` Possible values are: `LOG_TYPES_TO_SEND_SIGNIFICANT_ONLY` `LOG_TYPES_TO_SEND_UDF_ONLY` `LOG_TYPES_TO_SEND_UDF_SIGNIFICANT` `LOG_TYPES_TO_SEND_ALL` Type of logs to stream to the external server.
`void`	`setMaxLogsPerSecond(java.lang.Long maxLogsPerSecond)` Maximum number of logs per second streamed to the remote server.
`void`	`setProtocol(java.lang.String protocol)` Possible values are: `PROTOCOL_UDP` `PROTOCOL_SYSLOG_OVER_UDP` `PROTOCOL_TCP` `PROTOCOL_SYSLOG_OVER_TCP` `PROTOCOL_RAW_OVER_UDP` `PROTOCOL_TLS` `PROTOCOL_SYSLOG_OVER_TLS` Protocol to use for streaming logs.
`void`	`setSyslogConfig(ALBStreamingSyslogConfig syslogConfig)`
`java.lang.String`	`toString()`

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

- Field Detail
  - LOG_TYPES_TO_SEND_SIGNIFICANT_ONLY
```
public static final java.lang.String LOG_TYPES_TO_SEND_SIGNIFICANT_ONLY
```
    See Also:
    
    Constant Field Values
  - LOG_TYPES_TO_SEND_UDF_ONLY
```
public static final java.lang.String LOG_TYPES_TO_SEND_UDF_ONLY
```
    See Also:
    
    Constant Field Values
  - LOG_TYPES_TO_SEND_UDF_SIGNIFICANT
```
public static final java.lang.String LOG_TYPES_TO_SEND_UDF_SIGNIFICANT
```
    See Also:
    
    Constant Field Values
  - LOG_TYPES_TO_SEND_ALL
```
public static final java.lang.String LOG_TYPES_TO_SEND_ALL
```
    See Also:
    
    Constant Field Values
  - PROTOCOL_UDP
```
public static final java.lang.String PROTOCOL_UDP
```
    See Also:
    
    Constant Field Values
  - PROTOCOL_SYSLOG_OVER_UDP
```
public static final java.lang.String PROTOCOL_SYSLOG_OVER_UDP
```
    See Also:
    
    Constant Field Values
  - PROTOCOL_TCP
```
public static final java.lang.String PROTOCOL_TCP
```
    See Also:
    
    Constant Field Values
  - PROTOCOL_SYSLOG_OVER_TCP
```
public static final java.lang.String PROTOCOL_SYSLOG_OVER_TCP
```
    See Also:
    
    Constant Field Values
  - PROTOCOL_RAW_OVER_UDP
```
public static final java.lang.String PROTOCOL_RAW_OVER_UDP
```
    See Also:
    
    Constant Field Values
  - PROTOCOL_TLS
```
public static final java.lang.String PROTOCOL_TLS
```
    See Also:
    
    Constant Field Values
  - PROTOCOL_SYSLOG_OVER_TLS
```
public static final java.lang.String PROTOCOL_SYSLOG_OVER_TLS
```
    See Also:
    
    Constant Field Values
  - __dynamicStructureFields
```
protected com.vmware.vapi.data.StructValue __dynamicStructureFields
```
- Constructor Detail
  - ALBClientLogStreamingConfig
```
public ALBClientLogStreamingConfig()
```
    Default constructor.
  - ALBClientLogStreamingConfig
```
protected ALBClientLogStreamingConfig(com.vmware.vapi.data.StructValue __dynamicStructureFields)
```
- Method Detail
  - getExternalServer
```
public java.lang.String getExternalServer()
```
    IP address or hostnames (FQDNs) of destination servers. If an FQDN is provided, this should be resolvable on Avi Service Engines. Multiple servers are supported by furnishing a comma-separated list of IP addresses or host names, for example, 11.11.11.11,23.12.12.4. Optionally, a separate port can be specified for each external server in the list, for example, 11.11.11.11 234,12.12.12.12 343.
    
    Returns:
    
    The current value of the property.
  - setExternalServer
```
public void setExternalServer(java.lang.String externalServer)
```
    IP address or hostnames (FQDNs) of destination servers. If an FQDN is provided, this should be resolvable on Avi Service Engines. Multiple servers are supported by furnishing a comma-separated list of IP addresses or host names, for example, 11.11.11.11,23.12.12.4. Optionally, a separate port can be specified for each external server in the list, for example, 11.11.11.11 234,12.12.12.12 343.
    
    Parameters:
    
    externalServer - New value for the property.
  - getExternalServerPort
```
public java.lang.Long getExternalServerPort()
```
    The service port to use for the external servers. If multiple external servers have been specified, the single port number specified here will apply to all those servers for which an explicit port number has not been specified in the external server list. Default value when not specified in API or module is interpreted by ALB Controller as 514. format: int64
    
    Returns:
    
    The current value of the property.
  - setExternalServerPort
```
public void setExternalServerPort(java.lang.Long externalServerPort)
```
    The service port to use for the external servers. If multiple external servers have been specified, the single port number specified here will apply to all those servers for which an explicit port number has not been specified in the external server list. Default value when not specified in API or module is interpreted by ALB Controller as 514. format: int64
    
    Parameters:
    
    externalServerPort - New value for the property.
  - getFormatConfig
```
public ALBClientLogStreamingFormat getFormatConfig()
```
    Returns:
    
    The current value of the property.
  - setFormatConfig
```
public void setFormatConfig(ALBClientLogStreamingFormat formatConfig)
```
    Parameters:
    
    formatConfig - New value for the property.
  - getLogTypesToSend
```
public java.lang.String getLogTypesToSend()
```
    Possible values are:
    Type of logs to stream to the external server. Default is LOGS_ALL, i.e., send all logs. Enum options - LOGS_SIGNIFICANT_ONLY, LOGS_UDF_ONLY, LOGS_UDF_SIGNIFICANT, LOGS_ALL. Default value when not specified in API or module is interpreted by ALB Controller as LOGS_ALL.
    Returns:
    
    The current value of the property.
  - setLogTypesToSend
```
public void setLogTypesToSend(java.lang.String logTypesToSend)
```
    Possible values are:
    Type of logs to stream to the external server. Default is LOGS_ALL, i.e., send all logs. Enum options - LOGS_SIGNIFICANT_ONLY, LOGS_UDF_ONLY, LOGS_UDF_SIGNIFICANT, LOGS_ALL. Default value when not specified in API or module is interpreted by ALB Controller as LOGS_ALL.
    Parameters:
    
    logTypesToSend - New value for the property.
  - getMaxLogsPerSecond
```
public java.lang.Long getMaxLogsPerSecond()
```
    Maximum number of logs per second streamed to the remote server. By default, 100 logs per second are streamed. Set this to zero(0) to not enforce any limit. Default value when not specified in API or module is interpreted by ALB Controller as 100. format: int64
    
    Returns:
    
    The current value of the property.
  - setMaxLogsPerSecond
```
public void setMaxLogsPerSecond(java.lang.Long maxLogsPerSecond)
```
    Maximum number of logs per second streamed to the remote server. By default, 100 logs per second are streamed. Set this to zero(0) to not enforce any limit. Default value when not specified in API or module is interpreted by ALB Controller as 100. format: int64
    
    Parameters:
    
    maxLogsPerSecond - New value for the property.
  - getProtocol
```
public java.lang.String getProtocol()
```
    Possible values are:
    Protocol to use for streaming logs. Enum options - LOG_STREAMING_PROTOCOL_UDP, LOG_STREAMING_PROTOCOL_SYSLOG_OVER_UDP, LOG_STREAMING_PROTOCOL_TCP, LOG_STREAMING_PROTOCOL_SYSLOG_OVER_TCP, LOG_STREAMING_PROTOCOL_RAW_OVER_UDP, LOG_STREAMING_PROTOCOL_TLS, LOG_STREAMING_PROTOCOL_SYSLOG_OVER_TLS. Default value when not specified in API or module is interpreted by ALB Controller as LOG_STREAMING_PROTOCOL_UDP.
    Returns:
    
    The current value of the property.
  - setProtocol
```
public void setProtocol(java.lang.String protocol)
```
    Possible values are:
    Protocol to use for streaming logs. Enum options - LOG_STREAMING_PROTOCOL_UDP, LOG_STREAMING_PROTOCOL_SYSLOG_OVER_UDP, LOG_STREAMING_PROTOCOL_TCP, LOG_STREAMING_PROTOCOL_SYSLOG_OVER_TCP, LOG_STREAMING_PROTOCOL_RAW_OVER_UDP, LOG_STREAMING_PROTOCOL_TLS, LOG_STREAMING_PROTOCOL_SYSLOG_OVER_TLS. Default value when not specified in API or module is interpreted by ALB Controller as LOG_STREAMING_PROTOCOL_UDP.
    Parameters:
    
    protocol - New value for the property.
  - getSyslogConfig
```
public ALBStreamingSyslogConfig getSyslogConfig()
```
    Returns:
    
    The current value of the property.
  - setSyslogConfig
```
public void setSyslogConfig(ALBStreamingSyslogConfig syslogConfig)
```
    Parameters:
    
    syslogConfig - 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 ALBClientLogStreamingConfig _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 ALBClientLogStreamingConfig _newInstance2(com.vmware.vapi.data.StructValue structValue)
```
    WARNING: Internal method, subject to change in future versions.
    Serves as a versioning mechanism.

Class ALBClientLogStreamingConfig

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

LOG_TYPES_TO_SEND_SIGNIFICANT_ONLY

LOG_TYPES_TO_SEND_UDF_ONLY

LOG_TYPES_TO_SEND_UDF_SIGNIFICANT

LOG_TYPES_TO_SEND_ALL

PROTOCOL_UDP

PROTOCOL_SYSLOG_OVER_UDP

PROTOCOL_TCP

PROTOCOL_SYSLOG_OVER_TCP

PROTOCOL_RAW_OVER_UDP

PROTOCOL_TLS

PROTOCOL_SYSLOG_OVER_TLS

__dynamicStructureFields

Constructor Detail

ALBClientLogStreamingConfig

ALBClientLogStreamingConfig

Method Detail

getExternalServer

setExternalServer

getExternalServerPort

setExternalServerPort

getFormatConfig

setFormatConfig

getLogTypesToSend

setLogTypesToSend

getMaxLogsPerSecond

setMaxLogsPerSecond

getProtocol

setProtocol

getSyslogConfig

setSyslogConfig

_getType

_getDataValue

_updateDataValue

_validate

equals

hashCode

toString

_hasTypeNameOf

_convertTo

_setDynamicField

_getDynamicField

_getDynamicFieldNames

_getClassType

_getCanonicalName

_getCanonicalTypeName

_newInstance

_newInstance2