Package com.google.cloud.networkmanagement.v1beta1

Interface VpcFlowLogsConfigOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
VpcFlowLogsConfig, VpcFlowLogsConfig.Builder
@Generated public interface VpcFlowLogsConfigOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Details

    • getName

      String getName()
       Identifier. Unique name of the configuration. The name can have one of the
 following forms:

 - For project-level configurations:
 `projects/{project_id}/locations/global/vpcFlowLogsConfigs/{vpc_flow_logs_config_id}`

 - For organization-level configurations:
 `organizations/{organization_id}/locations/global/vpcFlowLogsConfigs/{vpc_flow_logs_config_id}`
      string name = 1 [(.google.api.field_behavior) = IDENTIFIER];
      Returns:
      The name.

    • getNameBytes

      com.google.protobuf.ByteString getNameBytes()
       Identifier. Unique name of the configuration. The name can have one of the
 following forms:

 - For project-level configurations:
 `projects/{project_id}/locations/global/vpcFlowLogsConfigs/{vpc_flow_logs_config_id}`

 - For organization-level configurations:
 `organizations/{organization_id}/locations/global/vpcFlowLogsConfigs/{vpc_flow_logs_config_id}`
      string name = 1 [(.google.api.field_behavior) = IDENTIFIER];
      Returns:
      The bytes for name.

    • hasDescription

      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:
      Whether the description field is set.

    • getDescription

      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:
      The description.

    • getDescriptionBytes

      com.google.protobuf.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:
      The bytes for description.

    • hasState

      boolean hasState()
       Optional. The state of the VPC Flow Log configuration. Default value is
 ENABLED. When creating a new configuration, it must be enabled. Setting
 state=DISABLED will pause the log generation for this config.
      optional .google.cloud.networkmanagement.v1beta1.VpcFlowLogsConfig.State state = 3 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      Whether the state field is set.

    • getStateValue

      int getStateValue()
       Optional. The state of the VPC Flow Log configuration. Default value is
 ENABLED. When creating a new configuration, it must be enabled. Setting
 state=DISABLED will pause the log generation for this config.
      optional .google.cloud.networkmanagement.v1beta1.VpcFlowLogsConfig.State state = 3 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The enum numeric value on the wire for state.

    • getState

      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. Setting
 state=DISABLED will pause the log generation for this config.
      optional .google.cloud.networkmanagement.v1beta1.VpcFlowLogsConfig.State state = 3 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The state.

    • hasAggregationInterval

      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:
      Whether the aggregationInterval field is set.

    • getAggregationIntervalValue

      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:
      The enum numeric value on the wire for aggregationInterval.

    • getAggregationInterval

      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:
      The aggregationInterval.

    • hasFlowSampling

      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:
      Whether the flowSampling field is set.

    • getFlowSampling

      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:
      The flowSampling.

    • hasMetadata

      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:
      Whether the metadata field is set.

    • getMetadataValue

      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:
      The enum numeric value on the wire for metadata.

    • getMetadata

      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:
      The metadata.

    • getMetadataFieldsList

      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:
      A list containing the metadataFields.

    • getMetadataFieldsCount

      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:
      The count of metadataFields.

    • getMetadataFields

      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];
      Parameters:
      index - The index of the element to return.
      Returns:
      The metadataFields at the given index.

    • getMetadataFieldsBytes

      com.google.protobuf.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];
      Parameters:
      index - The index of the value to return.
      Returns:
      The bytes of the metadataFields at the given index.

    • hasFilterExpr

      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:
      Whether the filterExpr field is set.

    • getFilterExpr

      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:
      The filterExpr.

    • getFilterExprBytes

      com.google.protobuf.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:
      The bytes for filterExpr.

    • hasCrossProjectMetadata

      boolean hasCrossProjectMetadata()
       Optional. Determines whether to include cross project annotations in the
 logs. This field is available only for organization configurations. If not
 specified in org configs will be set to CROSS_PROJECT_METADATA_ENABLED.
      optional .google.cloud.networkmanagement.v1beta1.VpcFlowLogsConfig.CrossProjectMetadata cross_project_metadata = 13 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      Whether the crossProjectMetadata field is set.

    • getCrossProjectMetadataValue

      int getCrossProjectMetadataValue()
       Optional. Determines whether to include cross project annotations in the
 logs. This field is available only for organization configurations. If not
 specified in org configs will be set to CROSS_PROJECT_METADATA_ENABLED.
      optional .google.cloud.networkmanagement.v1beta1.VpcFlowLogsConfig.CrossProjectMetadata cross_project_metadata = 13 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The enum numeric value on the wire for crossProjectMetadata.

    • getCrossProjectMetadata

      VpcFlowLogsConfig.CrossProjectMetadata getCrossProjectMetadata()
       Optional. Determines whether to include cross project annotations in the
 logs. This field is available only for organization configurations. If not
 specified in org configs will be set to CROSS_PROJECT_METADATA_ENABLED.
      optional .google.cloud.networkmanagement.v1beta1.VpcFlowLogsConfig.CrossProjectMetadata cross_project_metadata = 13 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The crossProjectMetadata.

    • hasTargetResourceState

      boolean hasTargetResourceState()
       Output only. Describes the state of the configured target resource for
 diagnostic purposes.
      optional .google.cloud.networkmanagement.v1beta1.VpcFlowLogsConfig.TargetResourceState target_resource_state = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      Whether the targetResourceState field is set.

    • getTargetResourceStateValue

      int getTargetResourceStateValue()
       Output only. Describes the state of the configured target resource for
 diagnostic purposes.
      optional .google.cloud.networkmanagement.v1beta1.VpcFlowLogsConfig.TargetResourceState target_resource_state = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The enum numeric value on the wire for targetResourceState.

    • getTargetResourceState

      VpcFlowLogsConfig.TargetResourceState getTargetResourceState()
       Output only. Describes the state of the configured target resource for
 diagnostic purposes.
      optional .google.cloud.networkmanagement.v1beta1.VpcFlowLogsConfig.TargetResourceState target_resource_state = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The targetResourceState.

    • hasNetwork

      boolean hasNetwork()
       Traffic will be logged from VMs, VPN tunnels and Interconnect Attachments
 within the network.
 Format: projects/{project_id}/global/networks/{name}
      string network = 100;
      Returns:
      Whether the network field is set.

    • getNetwork

      String getNetwork()
       Traffic will be logged from VMs, VPN tunnels and Interconnect Attachments
 within the network.
 Format: projects/{project_id}/global/networks/{name}
      string network = 100;
      Returns:
      The network.

    • getNetworkBytes

      com.google.protobuf.ByteString getNetworkBytes()
       Traffic will be logged from VMs, VPN tunnels and Interconnect Attachments
 within the network.
 Format: projects/{project_id}/global/networks/{name}
      string network = 100;
      Returns:
      The bytes for network.

    • hasSubnet

      boolean hasSubnet()
       Traffic will be logged from VMs within the subnetwork.
 Format: projects/{project_id}/regions/{region}/subnetworks/{name}
      string subnet = 101;
      Returns:
      Whether the subnet field is set.

    • getSubnet

      String getSubnet()
       Traffic will be logged from VMs within the subnetwork.
 Format: projects/{project_id}/regions/{region}/subnetworks/{name}
      string subnet = 101;
      Returns:
      The subnet.

    • getSubnetBytes

      com.google.protobuf.ByteString getSubnetBytes()
       Traffic will be logged from VMs within the subnetwork.
 Format: projects/{project_id}/regions/{region}/subnetworks/{name}
      string subnet = 101;
      Returns:
      The bytes for subnet.

    • hasInterconnectAttachment

      boolean hasInterconnectAttachment()
       Traffic will be logged from the Interconnect Attachment.
 Format:
 projects/{project_id}/regions/{region}/interconnectAttachments/{name}
      string interconnect_attachment = 102;
      Returns:
      Whether the interconnectAttachment field is set.

    • getInterconnectAttachment

      String getInterconnectAttachment()
       Traffic will be logged from the Interconnect Attachment.
 Format:
 projects/{project_id}/regions/{region}/interconnectAttachments/{name}
      string interconnect_attachment = 102;
      Returns:
      The interconnectAttachment.

    • getInterconnectAttachmentBytes

      com.google.protobuf.ByteString getInterconnectAttachmentBytes()
       Traffic will be logged from the Interconnect Attachment.
 Format:
 projects/{project_id}/regions/{region}/interconnectAttachments/{name}
      string interconnect_attachment = 102;
      Returns:
      The bytes for interconnectAttachment.

    • hasVpnTunnel

      boolean hasVpnTunnel()
       Traffic will be logged from the VPN Tunnel.
 Format: projects/{project_id}/regions/{region}/vpnTunnels/{name}
      string vpn_tunnel = 103;
      Returns:
      Whether the vpnTunnel field is set.

    • getVpnTunnel

      String getVpnTunnel()
       Traffic will be logged from the VPN Tunnel.
 Format: projects/{project_id}/regions/{region}/vpnTunnels/{name}
      string vpn_tunnel = 103;
      Returns:
      The vpnTunnel.

    • getVpnTunnelBytes

      com.google.protobuf.ByteString getVpnTunnelBytes()
       Traffic will be logged from the VPN Tunnel.
 Format: projects/{project_id}/regions/{region}/vpnTunnels/{name}
      string vpn_tunnel = 103;
      Returns:
      The bytes for vpnTunnel.

    • getLabelsCount

      int getLabelsCount()
       Optional. Resource labels to represent user-provided metadata.
      map<string, string> labels = 11 [(.google.api.field_behavior) = OPTIONAL];

    • containsLabels

      boolean containsLabels(String key)
       Optional. Resource labels to represent user-provided metadata.
      map<string, string> labels = 11 [(.google.api.field_behavior) = OPTIONAL];

    • getLabels

      @Deprecated Map<String,String> getLabels()
      Deprecated.
      Use getLabelsMap() instead.

    • getLabelsMap

      Map<String,String> getLabelsMap()
       Optional. Resource labels to represent user-provided metadata.
      map<string, string> labels = 11 [(.google.api.field_behavior) = OPTIONAL];

    • getLabelsOrDefault

      String getLabelsOrDefault(String key, String defaultValue)
       Optional. Resource labels to represent user-provided metadata.
      map<string, string> labels = 11 [(.google.api.field_behavior) = OPTIONAL];

    • getLabelsOrThrow

      String getLabelsOrThrow(String key)
       Optional. Resource labels to represent user-provided metadata.
      map<string, string> labels = 11 [(.google.api.field_behavior) = OPTIONAL];

    • hasCreateTime

      boolean hasCreateTime()
       Output only. The time the config was created.
      .google.protobuf.Timestamp create_time = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      Whether the createTime field is set.

    • getCreateTime

      com.google.protobuf.Timestamp getCreateTime()
       Output only. The time the config was created.
      .google.protobuf.Timestamp create_time = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The createTime.

    • getCreateTimeOrBuilder

      com.google.protobuf.TimestampOrBuilder getCreateTimeOrBuilder()
       Output only. The time the config was created.
      .google.protobuf.Timestamp create_time = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

    • hasUpdateTime

      boolean hasUpdateTime()
       Output only. The time the config was updated.
      .google.protobuf.Timestamp update_time = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      Whether the updateTime field is set.

    • getUpdateTime

      com.google.protobuf.Timestamp getUpdateTime()
       Output only. The time the config was updated.
      .google.protobuf.Timestamp update_time = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The updateTime.

    • getUpdateTimeOrBuilder

      com.google.protobuf.TimestampOrBuilder getUpdateTimeOrBuilder()
       Output only. The time the config was updated.
      .google.protobuf.Timestamp update_time = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

    • getTargetResourceCase

      VpcFlowLogsConfig.TargetResourceCase getTargetResourceCase()