Interface VpcFlowLogsConfigOrBuilder (1.53.0)

Version 1.53.0

• 1.54.0 (latest)
• 1.53.0
• 1.52.0
• 1.50.0
• 1.49.0
• 1.48.0
• 1.47.0
• 1.46.0
• 1.45.0
• 1.44.0
• 1.43.0
• 1.42.0
• 1.41.0
• 1.40.0
• 1.38.0
• 1.37.0
• 1.36.0
• 1.35.0
• 1.34.0
• 1.33.0
• 1.32.0
• 1.31.0
• 1.30.0
• 1.29.0
• 1.28.0
• 1.25.0
• 1.24.0
• 1.23.0
• 1.22.0
• 1.21.0
• 1.20.0
• 1.19.0
• 1.18.0
• 1.17.0
• 1.16.0
• 1.15.0
• 1.14.0
• 1.13.0
• 1.12.0
• 1.10.0
• 1.9.0
• 1.8.0
• 1.7.0
• 1.6.0
• 1.5.0
• 1.1.10

public interface VpcFlowLogsConfigOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

containsLabels(String key)

public abstract boolean containsLabels(String key)

Optional. Resource labels to represent user-provided metadata.

map<string, string> labels = 11 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
key	String

Returns
Type	Description
boolean

getAggregationInterval()

public abstract VpcFlowLogsConfig.AggregationInterval getAggregationInterval()

Optional. The aggregation interval for the logs. Default value is INTERVAL_5_SEC.

optional .google.cloud.networkmanagement.v1beta1.VpcFlowLogsConfig.AggregationInterval aggregation_interval = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
VpcFlowLogsConfig.AggregationInterval	The aggregationInterval.

getAggregationIntervalValue()

public abstract int getAggregationIntervalValue()

Optional. The aggregation interval for the logs. Default value is INTERVAL_5_SEC.

optional .google.cloud.networkmanagement.v1beta1.VpcFlowLogsConfig.AggregationInterval aggregation_interval = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
int	The enum numeric value on the wire for aggregationInterval.

getCreateTime()

public abstract Timestamp getCreateTime()

Output only. The time the config was created.

.google.protobuf.Timestamp create_time = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
Timestamp	The createTime.

getCreateTimeOrBuilder()

public abstract TimestampOrBuilder getCreateTimeOrBuilder()

Output only. The time the config was created.

.google.protobuf.Timestamp create_time = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
TimestampOrBuilder

getDescription()

public abstract String getDescription()

Optional. The user-supplied description of the VPC Flow Logs configuration. Maximum of 512 characters.

optional string description = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
String	The description.

getDescriptionBytes()

public abstract ByteString getDescriptionBytes()

Optional. The user-supplied description of the VPC Flow Logs configuration. Maximum of 512 characters.

optional string description = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
ByteString	The bytes for description.

getFilterExpr()

public abstract String getFilterExpr()

Optional. Export filter used to define which VPC Flow Logs should be logged.

optional string filter_expr = 8 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
String	The filterExpr.

getFilterExprBytes()

public abstract ByteString getFilterExprBytes()

Optional. Export filter used to define which VPC Flow Logs should be logged.

optional string filter_expr = 8 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
ByteString	The bytes for filterExpr.

getFlowSampling()

public abstract float getFlowSampling()

Optional. The value of the field must be in (0, 1]. The sampling rate of VPC Flow Logs where 1.0 means all collected logs are reported. Setting the sampling rate to 0.0 is not allowed. If you want to disable VPC Flow Logs, use the state field instead. Default value is 1.0.

optional float flow_sampling = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
float	The flowSampling.

getInterconnectAttachment()

public abstract String getInterconnectAttachment()

Traffic will be logged from the Interconnect Attachment. Format: projects/{project_id}/regions/{region}/interconnectAttachments/{name}

string interconnect_attachment = 102;

Returns
Type	Description
String	The interconnectAttachment.

getInterconnectAttachmentBytes()

public abstract ByteString getInterconnectAttachmentBytes()

Traffic will be logged from the Interconnect Attachment. Format: projects/{project_id}/regions/{region}/interconnectAttachments/{name}

string interconnect_attachment = 102;

Returns
Type	Description
ByteString	The bytes for interconnectAttachment.

getLabels() (deprecated)

public abstract Map<String,String> getLabels()

Use #getLabelsMap() instead.

Returns
Type	Description
Map<String,String>

getLabelsCount()

public abstract int getLabelsCount()

Optional. Resource labels to represent user-provided metadata.

map<string, string> labels = 11 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
int

getLabelsMap()

public abstract Map<String,String> getLabelsMap()

Optional. Resource labels to represent user-provided metadata.

map<string, string> labels = 11 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
Map<String,String>

getLabelsOrDefault(String key, String defaultValue)

public abstract String getLabelsOrDefault(String key, String defaultValue)

Optional. Resource labels to represent user-provided metadata.

map<string, string> labels = 11 [(.google.api.field_behavior) = OPTIONAL];

Parameters
Name	Description
key	String
defaultValue	String

Returns
Type	Description
String

getLabelsOrThrow(String key)

public abstract String getLabelsOrThrow(String key)

Optional. Resource labels to represent user-provided metadata.

map<string, string> labels = 11 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
key	String

Returns
Type	Description
String

getMetadata()

public abstract VpcFlowLogsConfig.Metadata getMetadata()

Optional. Configures whether all, none or a subset of metadata fields should be added to the reported VPC flow logs. Default value is INCLUDE_ALL_METADATA.

optional .google.cloud.networkmanagement.v1beta1.VpcFlowLogsConfig.Metadata metadata = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
VpcFlowLogsConfig.Metadata	The metadata.

getMetadataFields(int index)

public abstract String getMetadataFields(int index)

Optional. Custom metadata fields to include in the reported VPC flow logs. Can only be specified if "metadata" was set to CUSTOM_METADATA.

repeated string metadata_fields = 7 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
index	int The index of the element to return.

Returns
Type	Description
String	The metadataFields at the given index.

getMetadataFieldsBytes(int index)

public abstract ByteString getMetadataFieldsBytes(int index)

Optional. Custom metadata fields to include in the reported VPC flow logs. Can only be specified if "metadata" was set to CUSTOM_METADATA.

repeated string metadata_fields = 7 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
index	int The index of the value to return.

Returns
Type	Description
ByteString	The bytes of the metadataFields at the given index.

getMetadataFieldsCount()

public abstract int getMetadataFieldsCount()

Optional. Custom metadata fields to include in the reported VPC flow logs. Can only be specified if "metadata" was set to CUSTOM_METADATA.

repeated string metadata_fields = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
int	The count of metadataFields.

getMetadataFieldsList()

public abstract List<String> getMetadataFieldsList()

Optional. Custom metadata fields to include in the reported VPC flow logs. Can only be specified if "metadata" was set to CUSTOM_METADATA.

repeated string metadata_fields = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
List<String>	A list containing the metadataFields.

getMetadataValue()

public abstract int getMetadataValue()

Optional. Configures whether all, none or a subset of metadata fields should be added to the reported VPC flow logs. Default value is INCLUDE_ALL_METADATA.

optional .google.cloud.networkmanagement.v1beta1.VpcFlowLogsConfig.Metadata metadata = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
int	The enum numeric value on the wire for metadata.

getName()

public abstract String getName()

Identifier. Unique name of the configuration using the form: projects/{project_id}/locations/global/vpcFlowLogsConfigs/{vpc_flow_logs_config_id}

string name = 1 [(.google.api.field_behavior) = IDENTIFIER];

Returns
Type	Description
String	The name.

getNameBytes()

public abstract ByteString getNameBytes()

Identifier. Unique name of the configuration using the form: projects/{project_id}/locations/global/vpcFlowLogsConfigs/{vpc_flow_logs_config_id}

string name = 1 [(.google.api.field_behavior) = IDENTIFIER];

Returns
Type	Description
ByteString	The bytes for name.

getState()

public abstract VpcFlowLogsConfig.State getState()

Optional. The state of the VPC Flow Log configuration. Default value is ENABLED. When creating a new configuration, it must be enabled.

optional .google.cloud.networkmanagement.v1beta1.VpcFlowLogsConfig.State state = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
VpcFlowLogsConfig.State	The state.

getStateValue()

public abstract int getStateValue()

Optional. The state of the VPC Flow Log configuration. Default value is ENABLED. When creating a new configuration, it must be enabled.

optional .google.cloud.networkmanagement.v1beta1.VpcFlowLogsConfig.State state = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
int	The enum numeric value on the wire for state.

getTargetResourceCase()

public abstract VpcFlowLogsConfig.TargetResourceCase getTargetResourceCase()

Returns
Type	Description
VpcFlowLogsConfig.TargetResourceCase

getUpdateTime()

public abstract Timestamp getUpdateTime()

Output only. The time the config was updated.

.google.protobuf.Timestamp update_time = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
Timestamp	The updateTime.

getUpdateTimeOrBuilder()

public abstract TimestampOrBuilder getUpdateTimeOrBuilder()

Output only. The time the config was updated.

.google.protobuf.Timestamp update_time = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
TimestampOrBuilder

getVpnTunnel()

public abstract String getVpnTunnel()

Traffic will be logged from the VPN Tunnel. Format: projects/{project_id}/regions/{region}/vpnTunnels/{name}

string vpn_tunnel = 103;

Returns
Type	Description
String	The vpnTunnel.

getVpnTunnelBytes()

public abstract ByteString getVpnTunnelBytes()

Traffic will be logged from the VPN Tunnel. Format: projects/{project_id}/regions/{region}/vpnTunnels/{name}

string vpn_tunnel = 103;

Returns
Type	Description
ByteString	The bytes for vpnTunnel.

hasAggregationInterval()

public abstract boolean hasAggregationInterval()

Optional. The aggregation interval for the logs. Default value is INTERVAL_5_SEC.

optional .google.cloud.networkmanagement.v1beta1.VpcFlowLogsConfig.AggregationInterval aggregation_interval = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
boolean	Whether the aggregationInterval field is set.

hasCreateTime()

public abstract boolean hasCreateTime()

Output only. The time the config was created.

.google.protobuf.Timestamp create_time = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
boolean	Whether the createTime field is set.

hasDescription()

public abstract boolean hasDescription()

Optional. The user-supplied description of the VPC Flow Logs configuration. Maximum of 512 characters.

optional string description = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
boolean	Whether the description field is set.

hasFilterExpr()

public abstract boolean hasFilterExpr()

Optional. Export filter used to define which VPC Flow Logs should be logged.

optional string filter_expr = 8 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
boolean	Whether the filterExpr field is set.

hasFlowSampling()

public abstract boolean hasFlowSampling()

Optional. The value of the field must be in (0, 1]. The sampling rate of VPC Flow Logs where 1.0 means all collected logs are reported. Setting the sampling rate to 0.0 is not allowed. If you want to disable VPC Flow Logs, use the state field instead. Default value is 1.0.

optional float flow_sampling = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
boolean	Whether the flowSampling field is set.

hasInterconnectAttachment()

public abstract boolean hasInterconnectAttachment()

Traffic will be logged from the Interconnect Attachment. Format: projects/{project_id}/regions/{region}/interconnectAttachments/{name}

string interconnect_attachment = 102;

Returns
Type	Description
boolean	Whether the interconnectAttachment field is set.

hasMetadata()

public abstract boolean hasMetadata()

Optional. Configures whether all, none or a subset of metadata fields should be added to the reported VPC flow logs. Default value is INCLUDE_ALL_METADATA.

optional .google.cloud.networkmanagement.v1beta1.VpcFlowLogsConfig.Metadata metadata = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
boolean	Whether the metadata field is set.

hasState()

public abstract boolean hasState()

Optional. The state of the VPC Flow Log configuration. Default value is ENABLED. When creating a new configuration, it must be enabled.

optional .google.cloud.networkmanagement.v1beta1.VpcFlowLogsConfig.State state = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
boolean	Whether the state field is set.

hasUpdateTime()

public abstract boolean hasUpdateTime()

Output only. The time the config was updated.

.google.protobuf.Timestamp update_time = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
boolean	Whether the updateTime field is set.

hasVpnTunnel()

public abstract boolean hasVpnTunnel()

Traffic will be logged from the VPN Tunnel. Format: projects/{project_id}/regions/{region}/vpnTunnels/{name}

string vpn_tunnel = 103;

Returns
Type	Description
boolean	Whether the vpnTunnel field is set.