Reference documentation and code samples for the Network Management V1 API class Google::Cloud::NetworkManagement::V1::VpcFlowLogsConfig.
A configuration to generate VPC Flow Logs.
Inherits
- Object
Extended By
- Google::Protobuf::MessageExts::ClassMethods
Includes
- Google::Protobuf::MessageExts
Methods
#aggregation_interval
def aggregation_interval() -> ::Google::Cloud::NetworkManagement::V1::VpcFlowLogsConfig::AggregationInterval
Returns
- (::Google::Cloud::NetworkManagement::V1::VpcFlowLogsConfig::AggregationInterval) — Optional. The aggregation interval for the logs. Default value is INTERVAL_5_SEC.
#aggregation_interval=
def aggregation_interval=(value) -> ::Google::Cloud::NetworkManagement::V1::VpcFlowLogsConfig::AggregationInterval
Parameter
- value (::Google::Cloud::NetworkManagement::V1::VpcFlowLogsConfig::AggregationInterval) — Optional. The aggregation interval for the logs. Default value is INTERVAL_5_SEC.
Returns
- (::Google::Cloud::NetworkManagement::V1::VpcFlowLogsConfig::AggregationInterval) — Optional. The aggregation interval for the logs. Default value is INTERVAL_5_SEC.
#create_time
def create_time() -> ::Google::Protobuf::Timestamp
Returns
- (::Google::Protobuf::Timestamp) — Output only. The time the config was created.
#description
def description() -> ::String
Returns
- (::String) — Optional. The user-supplied description of the VPC Flow Logs configuration. Maximum of 512 characters.
#description=
def description=(value) -> ::String
Parameter
- value (::String) — Optional. The user-supplied description of the VPC Flow Logs configuration. Maximum of 512 characters.
Returns
- (::String) — Optional. The user-supplied description of the VPC Flow Logs configuration. Maximum of 512 characters.
#filter_expr
def filter_expr() -> ::String
Returns
- (::String) — Optional. Export filter used to define which VPC Flow Logs should be logged.
#filter_expr=
def filter_expr=(value) -> ::String
Parameter
- value (::String) — Optional. Export filter used to define which VPC Flow Logs should be logged.
Returns
- (::String) — Optional. Export filter used to define which VPC Flow Logs should be logged.
#flow_sampling
def flow_sampling() -> ::Float
Returns
- (::Float) — 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.
#flow_sampling=
def flow_sampling=(value) -> ::Float
Parameter
- value (::Float) — 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.
Returns
- (::Float) — 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.
#interconnect_attachment
def interconnect_attachment() -> ::String
Returns
- (::String) — Traffic will be logged from the Interconnect Attachment. Format: projects/{project_id}/regions/{region}/interconnectAttachments/{name}
#interconnect_attachment=
def interconnect_attachment=(value) -> ::String
Parameter
- value (::String) — Traffic will be logged from the Interconnect Attachment. Format: projects/{project_id}/regions/{region}/interconnectAttachments/{name}
Returns
- (::String) — Traffic will be logged from the Interconnect Attachment. Format: projects/{project_id}/regions/{region}/interconnectAttachments/{name}
#labels
def labels() -> ::Google::Protobuf::Map{::String => ::String}
Returns
- (::Google::Protobuf::Map{::String => ::String}) — Optional. Resource labels to represent user-provided metadata.
#labels=
def labels=(value) -> ::Google::Protobuf::Map{::String => ::String}
Parameter
- value (::Google::Protobuf::Map{::String => ::String}) — Optional. Resource labels to represent user-provided metadata.
Returns
- (::Google::Protobuf::Map{::String => ::String}) — Optional. Resource labels to represent user-provided metadata.
#metadata
def metadata() -> ::Google::Cloud::NetworkManagement::V1::VpcFlowLogsConfig::Metadata
Returns
- (::Google::Cloud::NetworkManagement::V1::VpcFlowLogsConfig::Metadata) — 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.
#metadata=
def metadata=(value) -> ::Google::Cloud::NetworkManagement::V1::VpcFlowLogsConfig::Metadata
Parameter
- value (::Google::Cloud::NetworkManagement::V1::VpcFlowLogsConfig::Metadata) — 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.
Returns
- (::Google::Cloud::NetworkManagement::V1::VpcFlowLogsConfig::Metadata) — 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.
#metadata_fields
def metadata_fields() -> ::Array<::String>
Returns
- (::Array<::String>) — Optional. Custom metadata fields to include in the reported VPC flow logs. Can only be specified if "metadata" was set to CUSTOM_METADATA.
#metadata_fields=
def metadata_fields=(value) -> ::Array<::String>
Parameter
- value (::Array<::String>) — Optional. Custom metadata fields to include in the reported VPC flow logs. Can only be specified if "metadata" was set to CUSTOM_METADATA.
Returns
- (::Array<::String>) — Optional. Custom metadata fields to include in the reported VPC flow logs. Can only be specified if "metadata" was set to CUSTOM_METADATA.
#name
def name() -> ::String
Returns
-
(::String) — Identifier. Unique name of the configuration using the form:
projects/{project_id}/locations/global/vpcFlowLogsConfigs/{vpc_flow_logs_config_id}
#name=
def name=(value) -> ::String
Parameter
-
value (::String) — Identifier. Unique name of the configuration using the form:
projects/{project_id}/locations/global/vpcFlowLogsConfigs/{vpc_flow_logs_config_id}
Returns
-
(::String) — Identifier. Unique name of the configuration using the form:
projects/{project_id}/locations/global/vpcFlowLogsConfigs/{vpc_flow_logs_config_id}
#state
def state() -> ::Google::Cloud::NetworkManagement::V1::VpcFlowLogsConfig::State
Returns
- (::Google::Cloud::NetworkManagement::V1::VpcFlowLogsConfig::State) — Optional. The state of the VPC Flow Log configuration. Default value is ENABLED. When creating a new configuration, it must be enabled.
#state=
def state=(value) -> ::Google::Cloud::NetworkManagement::V1::VpcFlowLogsConfig::State
Parameter
- value (::Google::Cloud::NetworkManagement::V1::VpcFlowLogsConfig::State) — Optional. The state of the VPC Flow Log configuration. Default value is ENABLED. When creating a new configuration, it must be enabled.
Returns
- (::Google::Cloud::NetworkManagement::V1::VpcFlowLogsConfig::State) — Optional. The state of the VPC Flow Log configuration. Default value is ENABLED. When creating a new configuration, it must be enabled.
#target_resource_state
def target_resource_state() -> ::Google::Cloud::NetworkManagement::V1::VpcFlowLogsConfig::TargetResourceState
Returns
- (::Google::Cloud::NetworkManagement::V1::VpcFlowLogsConfig::TargetResourceState) — Output only. A diagnostic bit - describes the state of the configured target resource for diagnostic purposes.
#update_time
def update_time() -> ::Google::Protobuf::Timestamp
Returns
- (::Google::Protobuf::Timestamp) — Output only. The time the config was updated.
#vpn_tunnel
def vpn_tunnel() -> ::String
Returns
- (::String) — Traffic will be logged from the VPN Tunnel. Format: projects/{project_id}/regions/{region}/vpnTunnels/{name}
#vpn_tunnel=
def vpn_tunnel=(value) -> ::String
Parameter
- value (::String) — Traffic will be logged from the VPN Tunnel. Format: projects/{project_id}/regions/{region}/vpnTunnels/{name}
Returns
- (::String) — Traffic will be logged from the VPN Tunnel. Format: projects/{project_id}/regions/{region}/vpnTunnels/{name}