com.google.api.services.compute.model

Class SubnetworkLogConfig

java.lang.Object

java.util.AbstractMap<String,Object>

com.google.api.client.util.GenericData

com.google.api.client.json.GenericJson

com.google.api.services.compute.model.SubnetworkLogConfig

All Implemented Interfaces:

Cloneable, Map<String,Object>

public final class SubnetworkLogConfig
extends GenericJson

The available logging options for this subnetwork.

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 Compute Engine 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

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
SubnetworkLogConfig()

Method Summary

Modifier and Type	Method and Description
SubnetworkLogConfig	clone()
String	getAggregationInterval() Can only be specified if VPC flow logging for this subnetwork is enabled.
Boolean	getEnable() Whether to enable flow logging for this subnetwork.
String	getFilterExpr() Can only be specified if VPC flow logs for this subnetwork is enabled.
Float	getFlowSampling() Can only be specified if VPC flow logging for this subnetwork is enabled.
String	getMetadata() Can only be specified if VPC flow logs for this subnetwork is enabled.
List<String>	getMetadataFields() Can only be specified if VPC flow logs for this subnetwork is enabled and "metadata" was set to CUSTOM_METADATA.
SubnetworkLogConfig	set(String fieldName, Object value)
SubnetworkLogConfig	setAggregationInterval(String aggregationInterval) Can only be specified if VPC flow logging for this subnetwork is enabled.
SubnetworkLogConfig	setEnable(Boolean enable) Whether to enable flow logging for this subnetwork.
SubnetworkLogConfig	setFilterExpr(String filterExpr) Can only be specified if VPC flow logs for this subnetwork is enabled.
SubnetworkLogConfig	setFlowSampling(Float flowSampling) Can only be specified if VPC flow logging for this subnetwork is enabled.
SubnetworkLogConfig	setMetadata(String metadata) Can only be specified if VPC flow logs for this subnetwork is enabled.
SubnetworkLogConfig	setMetadataFields(List<String> metadataFields) Can only be specified if VPC flow logs for this subnetwork is enabled and "metadata" was set to CUSTOM_METADATA.

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

SubnetworkLogConfig

public SubnetworkLogConfig()

Method Detail

getAggregationInterval

public String getAggregationInterval()

Can only be specified if VPC flow logging for this subnetwork is enabled. Toggles the aggregation interval for collecting flow logs. Increasing the interval time will reduce the amount of generated flow logs for long lasting connections. Default is an interval of 5 seconds per connection.

Returns:

value or null for none

setAggregationInterval

public SubnetworkLogConfig setAggregationInterval(String aggregationInterval)

Can only be specified if VPC flow logging for this subnetwork is enabled. Toggles the aggregation interval for collecting flow logs. Increasing the interval time will reduce the amount of generated flow logs for long lasting connections. Default is an interval of 5 seconds per connection.

Parameters:

aggregationInterval - aggregationInterval or null for none

getEnable

public Boolean getEnable()

Whether to enable flow logging for this subnetwork. If this field is not explicitly set, it will not appear in get listings. If not set the default behavior is determined by the org policy, if there is no org policy specified, then it will default to disabled.

Returns:

value or null for none

setEnable

public SubnetworkLogConfig setEnable(Boolean enable)

Whether to enable flow logging for this subnetwork. If this field is not explicitly set, it will not appear in get listings. If not set the default behavior is determined by the org policy, if there is no org policy specified, then it will default to disabled.

Parameters:

enable - enable or null for none

getFilterExpr

public String getFilterExpr()

Can only be specified if VPC flow logs for this subnetwork is enabled. The filter expression is used to define which VPC flow logs should be exported to Cloud Logging.

Returns:

value or null for none

setFilterExpr

public SubnetworkLogConfig setFilterExpr(String filterExpr)

Can only be specified if VPC flow logs for this subnetwork is enabled. The filter expression is used to define which VPC flow logs should be exported to Cloud Logging.

Parameters:

filterExpr - filterExpr or null for none

getFlowSampling

public Float getFlowSampling()

Can only be specified if VPC flow logging for this subnetwork is enabled. The value of the field must be in [0, 1]. Set the sampling rate of VPC flow logs within the subnetwork where 1.0 means all collected logs are reported and 0.0 means no logs are reported. Default is 0.5 unless otherwise specified by the org policy, which means half of all collected logs are reported.

Returns:

value or null for none

setFlowSampling

public SubnetworkLogConfig setFlowSampling(Float flowSampling)

Can only be specified if VPC flow logging for this subnetwork is enabled. The value of the field must be in [0, 1]. Set the sampling rate of VPC flow logs within the subnetwork where 1.0 means all collected logs are reported and 0.0 means no logs are reported. Default is 0.5 unless otherwise specified by the org policy, which means half of all collected logs are reported.

Parameters:

flowSampling - flowSampling or null for none

getMetadata

public String getMetadata()

Can only be specified if VPC flow logs for this subnetwork is enabled. Configures whether all, none or a subset of metadata fields should be added to the reported VPC flow logs. Default is EXCLUDE_ALL_METADATA.

Returns:

value or null for none

setMetadata

public SubnetworkLogConfig setMetadata(String metadata)

Can only be specified if VPC flow logs for this subnetwork is enabled. Configures whether all, none or a subset of metadata fields should be added to the reported VPC flow logs. Default is EXCLUDE_ALL_METADATA.

Parameters:

metadata - metadata or null for none

getMetadataFields

public List<String> getMetadataFields()

Can only be specified if VPC flow logs for this subnetwork is enabled and "metadata" was set to CUSTOM_METADATA.

Returns:

value or null for none

setMetadataFields

public SubnetworkLogConfig setMetadataFields(List<String> metadataFields)

Can only be specified if VPC flow logs for this subnetwork is enabled and "metadata" was set to CUSTOM_METADATA.

Parameters:

metadataFields - metadataFields or null for none

set

public SubnetworkLogConfig set(String fieldName,
                               Object value)

Overrides:

set in class GenericJson

clone

public SubnetworkLogConfig clone()

Overrides:

clone in class GenericJson