public final class VpcFlowLogsConfig extends GeneratedMessageV3 implements VpcFlowLogsConfigOrBuilder
A configuration to generate VPC Flow Logs.
Protobuf type google.cloud.networkmanagement.v1beta1.VpcFlowLogsConfig
Inherited Members
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)
com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)
Static Fields
AGGREGATION_INTERVAL_FIELD_NUMBER
public static final int AGGREGATION_INTERVAL_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
CREATE_TIME_FIELD_NUMBER
public static final int CREATE_TIME_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
DESCRIPTION_FIELD_NUMBER
public static final int DESCRIPTION_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
FILTER_EXPR_FIELD_NUMBER
public static final int FILTER_EXPR_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
FLOW_SAMPLING_FIELD_NUMBER
public static final int FLOW_SAMPLING_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
INTERCONNECT_ATTACHMENT_FIELD_NUMBER
public static final int INTERCONNECT_ATTACHMENT_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
LABELS_FIELD_NUMBER
public static final int LABELS_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
public static final int METADATA_FIELDS_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
public static final int METADATA_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
NAME_FIELD_NUMBER
public static final int NAME_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
STATE_FIELD_NUMBER
public static final int STATE_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
UPDATE_TIME_FIELD_NUMBER
public static final int UPDATE_TIME_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
VPN_TUNNEL_FIELD_NUMBER
public static final int VPN_TUNNEL_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
Static Methods
getDefaultInstance()
public static VpcFlowLogsConfig getDefaultInstance()
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
newBuilder()
public static VpcFlowLogsConfig.Builder newBuilder()
newBuilder(VpcFlowLogsConfig prototype)
public static VpcFlowLogsConfig.Builder newBuilder(VpcFlowLogsConfig prototype)
public static VpcFlowLogsConfig parseDelimitedFrom(InputStream input)
public static VpcFlowLogsConfig parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(byte[] data)
public static VpcFlowLogsConfig parseFrom(byte[] data)
| Parameter |
| Name |
Description |
data |
byte[]
|
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static VpcFlowLogsConfig parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteString data)
public static VpcFlowLogsConfig parseFrom(ByteString data)
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static VpcFlowLogsConfig parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static VpcFlowLogsConfig parseFrom(CodedInputStream input)
public static VpcFlowLogsConfig parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static VpcFlowLogsConfig parseFrom(InputStream input)
public static VpcFlowLogsConfig parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteBuffer data)
public static VpcFlowLogsConfig parseFrom(ByteBuffer data)
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static VpcFlowLogsConfig parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
parser()
public static Parser<VpcFlowLogsConfig> parser()
Methods
containsLabels(String key)
public 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
|
equals(Object obj)
public boolean equals(Object obj)
| Parameter |
| Name |
Description |
obj |
Object
|
Overrides
getAggregationInterval()
public 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];
getAggregationIntervalValue()
public 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 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 TimestampOrBuilder getCreateTimeOrBuilder()
Output only. The time the config was created.
.google.protobuf.Timestamp create_time = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
getDefaultInstanceForType()
public VpcFlowLogsConfig getDefaultInstanceForType()
getDescription()
public 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 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 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 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 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 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 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 Map<String,String> getLabels()
getLabelsCount()
public 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 Map<String,String> getLabelsMap()
Optional. Resource labels to represent user-provided metadata.
map<string, string> labels = 11 [(.google.api.field_behavior) = OPTIONAL];
getLabelsOrDefault(String key, String defaultValue)
public String getLabelsOrDefault(String key, String defaultValue)
Optional. Resource labels to represent user-provided metadata.
map<string, string> labels = 11 [(.google.api.field_behavior) = OPTIONAL];
| Returns |
| Type |
Description |
String |
|
getLabelsOrThrow(String key)
public 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 |
|
public 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];
public 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.
|
public 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.
|
public 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.
|
public ProtocolStringList 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];
public 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()
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 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.
|
getParserForType()
public Parser<VpcFlowLogsConfig> getParserForType()
Overrides
getSerializedSize()
public int getSerializedSize()
| Returns |
| Type |
Description |
int |
|
Overrides
getState()
public 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];
getStateValue()
public 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 VpcFlowLogsConfig.TargetResourceCase getTargetResourceCase()
getUpdateTime()
public 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 TimestampOrBuilder getUpdateTimeOrBuilder()
Output only. The time the config was updated.
.google.protobuf.Timestamp update_time = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
getVpnTunnel()
public 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 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 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 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 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 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 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 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.
|
public 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 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 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 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.
|
hashCode()
| Returns |
| Type |
Description |
int |
|
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
internalGetMapFieldReflection(int number)
protected MapFieldReflectionAccessor internalGetMapFieldReflection(int number)
| Parameter |
| Name |
Description |
number |
int
|
| Returns |
| Type |
Description |
com.google.protobuf.MapFieldReflectionAccessor |
|
Overrides
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)
isInitialized()
public final boolean isInitialized()
Overrides
newBuilderForType()
public VpcFlowLogsConfig.Builder newBuilderForType()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected VpcFlowLogsConfig.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
| Returns |
| Type |
Description |
Object |
|
Overrides
toBuilder()
public VpcFlowLogsConfig.Builder toBuilder()
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Overrides
