com.google.api.services.servicenetworking.v1beta.model

Class BatchingSettingsProto

java.lang.Object

java.util.AbstractMap<String,Object>

com.google.api.client.util.GenericData

com.google.api.client.json.GenericJson

com.google.api.services.servicenetworking.v1beta.model.BatchingSettingsProto

All Implemented Interfaces:

Cloneable, Map<String,Object>

public final class BatchingSettingsProto
extends com.google.api.client.json.GenericJson

`BatchingSettingsProto` specifies a set of batching thresholds, each of which acts as a trigger to send a batch of messages as a request. At least one threshold must be positive nonzero.

This is the Java data model class that specifies how to parse/serialize into the JSON that is transmitted over HTTP when working with the Service Networking API. For a detailed explanation see: https://developers.google.com/api-client-library/java/google-http-java-client/json

Author:

Google, Inc.

Nested Class Summary

Nested classes/interfaces inherited from class com.google.api.client.util.GenericData

com.google.api.client.util.GenericData.Flags

Nested classes/interfaces inherited from class java.util.AbstractMap

AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>

Nested classes/interfaces inherited from interface java.util.Map

Map.Entry<K,V>

Constructor Summary

Constructors

Constructor and Description
BatchingSettingsProto()

Method Summary

Modifier and Type	Method and Description
BatchingSettingsProto	clone()
String	getDelayThreshold() The duration after which a batch should be sent, starting from the addition of the first message to that batch.
Integer	getElementCountLimit() The maximum number of elements collected in a batch that could be accepted by server.
Integer	getElementCountThreshold() The number of elements of a field collected into a batch which, if exceeded, causes the batch to be sent.
Integer	getFlowControlByteLimit() The maximum size of data allowed by flow control.
Integer	getFlowControlElementLimit() The maximum number of elements allowed by flow control.
String	getFlowControlLimitExceededBehavior() The behavior to take when the flow control limit is exceeded.
Integer	getRequestByteLimit() The maximum size of the request that could be accepted by server.
Long	getRequestByteThreshold() The aggregated size of the batched field which, if exceeded, causes the batch to be sent.
BatchingSettingsProto	set(String fieldName, Object value)
BatchingSettingsProto	setDelayThreshold(String delayThreshold) The duration after which a batch should be sent, starting from the addition of the first message to that batch.
BatchingSettingsProto	setElementCountLimit(Integer elementCountLimit) The maximum number of elements collected in a batch that could be accepted by server.
BatchingSettingsProto	setElementCountThreshold(Integer elementCountThreshold) The number of elements of a field collected into a batch which, if exceeded, causes the batch to be sent.
BatchingSettingsProto	setFlowControlByteLimit(Integer flowControlByteLimit) The maximum size of data allowed by flow control.
BatchingSettingsProto	setFlowControlElementLimit(Integer flowControlElementLimit) The maximum number of elements allowed by flow control.
BatchingSettingsProto	setFlowControlLimitExceededBehavior(String flowControlLimitExceededBehavior) The behavior to take when the flow control limit is exceeded.
BatchingSettingsProto	setRequestByteLimit(Integer requestByteLimit) The maximum size of the request that could be accepted by server.
BatchingSettingsProto	setRequestByteThreshold(Long requestByteThreshold) The aggregated size of the batched field which, if exceeded, causes the batch to be sent.

Methods inherited from class com.google.api.client.json.GenericJson

getFactory, setFactory, toPrettyString, toString

Methods inherited from class com.google.api.client.util.GenericData

entrySet, equals, get, getClassInfo, getUnknownKeys, hashCode, put, putAll, remove, setUnknownKeys

Methods inherited from class java.util.AbstractMap

clear, containsKey, containsValue, isEmpty, keySet, size, values

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map

compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

Constructor Detail

BatchingSettingsProto

public BatchingSettingsProto()

Method Detail

getDelayThreshold

public String getDelayThreshold()

The duration after which a batch should be sent, starting from the addition of the first message to that batch.

Returns:

value or null for none

setDelayThreshold

public BatchingSettingsProto setDelayThreshold(String delayThreshold)

The duration after which a batch should be sent, starting from the addition of the first message to that batch.

Parameters:

delayThreshold - delayThreshold or null for none

getElementCountLimit

public Integer getElementCountLimit()

The maximum number of elements collected in a batch that could be accepted by server.

Returns:

value or null for none

setElementCountLimit

public BatchingSettingsProto setElementCountLimit(Integer elementCountLimit)

The maximum number of elements collected in a batch that could be accepted by server.

Parameters:

elementCountLimit - elementCountLimit or null for none

getElementCountThreshold

public Integer getElementCountThreshold()

The number of elements of a field collected into a batch which, if exceeded, causes the batch to be sent.

Returns:

value or null for none

setElementCountThreshold

public BatchingSettingsProto setElementCountThreshold(Integer elementCountThreshold)

The number of elements of a field collected into a batch which, if exceeded, causes the batch to be sent.

Parameters:

elementCountThreshold - elementCountThreshold or null for none

getFlowControlByteLimit

public Integer getFlowControlByteLimit()

The maximum size of data allowed by flow control.

Returns:

value or null for none

setFlowControlByteLimit

public BatchingSettingsProto setFlowControlByteLimit(Integer flowControlByteLimit)

The maximum size of data allowed by flow control.

Parameters:

flowControlByteLimit - flowControlByteLimit or null for none

getFlowControlElementLimit

public Integer getFlowControlElementLimit()

The maximum number of elements allowed by flow control.

Returns:

value or null for none

setFlowControlElementLimit

public BatchingSettingsProto setFlowControlElementLimit(Integer flowControlElementLimit)

The maximum number of elements allowed by flow control.

Parameters:

flowControlElementLimit - flowControlElementLimit or null for none

getFlowControlLimitExceededBehavior

public String getFlowControlLimitExceededBehavior()

The behavior to take when the flow control limit is exceeded.

Returns:

value or null for none

setFlowControlLimitExceededBehavior

public BatchingSettingsProto setFlowControlLimitExceededBehavior(String flowControlLimitExceededBehavior)

The behavior to take when the flow control limit is exceeded.

Parameters:

flowControlLimitExceededBehavior - flowControlLimitExceededBehavior or null for none

getRequestByteLimit

public Integer getRequestByteLimit()

The maximum size of the request that could be accepted by server.

Returns:

value or null for none

setRequestByteLimit

public BatchingSettingsProto setRequestByteLimit(Integer requestByteLimit)

The maximum size of the request that could be accepted by server.

Parameters:

requestByteLimit - requestByteLimit or null for none

getRequestByteThreshold

public Long getRequestByteThreshold()

The aggregated size of the batched field which, if exceeded, causes the batch to be sent. This size is computed by aggregating the sizes of the request field to be batched, not of the entire request message.

Returns:

value or null for none

setRequestByteThreshold

public BatchingSettingsProto setRequestByteThreshold(Long requestByteThreshold)

The aggregated size of the batched field which, if exceeded, causes the batch to be sent. This size is computed by aggregating the sizes of the request field to be batched, not of the entire request message.

Parameters:

requestByteThreshold - requestByteThreshold or null for none

set

public BatchingSettingsProto set(String fieldName,
                                 Object value)

Overrides:

set in class com.google.api.client.json.GenericJson

clone

public BatchingSettingsProto clone()

Overrides:

clone in class com.google.api.client.json.GenericJson