Class: Google::Apis::NetworkmanagementV1::VpcFlowLogsConfig

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/networkmanagement_v1/classes.rb,
lib/google/apis/networkmanagement_v1/representations.rb,
lib/google/apis/networkmanagement_v1/representations.rb

Overview

A configuration to generate VPC Flow Logs.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ VpcFlowLogsConfig

Returns a new instance of VpcFlowLogsConfig.



3046
3047
3048
 
# File 'lib/google/apis/networkmanagement_v1/classes.rb', line 3046

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#aggregation_interval ⇒ String

Optional. The aggregation interval for the logs. Default value is INTERVAL_5_SEC. Corresponds to the JSON property aggregationInterval

Returns:

  • (String) 


2968
2969
2970
 
# File 'lib/google/apis/networkmanagement_v1/classes.rb', line 2968

def aggregation_interval
  @aggregation_interval
end

#create_time ⇒ String

Output only. The time the config was created. Corresponds to the JSON property createTime

Returns:

  • (String) 


2973
2974
2975
 
# File 'lib/google/apis/networkmanagement_v1/classes.rb', line 2973

def create_time
  @create_time
end

#description ⇒ String

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

Returns:

  • (String) 


2979
2980
2981
 
# File 'lib/google/apis/networkmanagement_v1/classes.rb', line 2979

def description
  @description
end

#filter_expr ⇒ String

Optional. Export filter used to define which VPC Flow Logs should be logged. Corresponds to the JSON property filterExpr

Returns:

  • (String) 


2984
2985
2986
 
# File 'lib/google/apis/networkmanagement_v1/classes.rb', line 2984

def filter_expr
  @filter_expr
end

#flow_sampling ⇒ 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. Corresponds to the JSON property flowSampling

Returns:

  • (Float) 


2992
2993
2994
 
# File 'lib/google/apis/networkmanagement_v1/classes.rb', line 2992

def flow_sampling
  @flow_sampling
end

#interconnect_attachment ⇒ String

Traffic will be logged from the Interconnect Attachment. Format: projects/ project_id/regions/region/interconnectAttachments/name Corresponds to the JSON property interconnectAttachment

Returns:

  • (String) 


2998
2999
3000
 
# File 'lib/google/apis/networkmanagement_v1/classes.rb', line 2998

def interconnect_attachment
  @interconnect_attachment
end

#labels ⇒ Hash<String,String>

Optional. Resource labels to represent user-provided metadata. Corresponds to the JSON property labels

Returns:

  • (Hash<String,String>) 


3003
3004
3005
 
# File 'lib/google/apis/networkmanagement_v1/classes.rb', line 3003

def labels
  @labels
end

#metadata ⇒ String

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. Corresponds to the JSON property metadata

Returns:

  • (String) 


3009
3010
3011
 
# File 'lib/google/apis/networkmanagement_v1/classes.rb', line 3009

def metadata
  @metadata
end

#metadata_fields ⇒ 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. Corresponds to the JSON property metadataFields

Returns:

  • (Array<String>) 


3015
3016
3017
 
# File 'lib/google/apis/networkmanagement_v1/classes.rb', line 3015

def metadata_fields
  @metadata_fields
end

#name ⇒ String

Identifier. Unique name of the configuration using the form: projects/ project_id/locations/global/vpcFlowLogsConfigs/vpc_flow_logs_config_id` Corresponds to the JSON propertyname`

Returns:

  • (String) 


3021
3022
3023
 
# File 'lib/google/apis/networkmanagement_v1/classes.rb', line 3021

def name
  @name
end

#state ⇒ String

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

Returns:

  • (String) 


3027
3028
3029
 
# File 'lib/google/apis/networkmanagement_v1/classes.rb', line 3027

def state
  @state
end

#target_resource_state ⇒ String

Output only. A diagnostic bit - describes the state of the configured target resource for diagnostic purposes. Corresponds to the JSON property targetResourceState

Returns:

  • (String) 


3033
3034
3035
 
# File 'lib/google/apis/networkmanagement_v1/classes.rb', line 3033

def target_resource_state
  @target_resource_state
end

#update_time ⇒ String

Output only. The time the config was updated. Corresponds to the JSON property updateTime

Returns:

  • (String) 


3038
3039
3040
 
# File 'lib/google/apis/networkmanagement_v1/classes.rb', line 3038

def update_time
  @update_time
end

#vpn_tunnel ⇒ String

Traffic will be logged from the VPN Tunnel. Format: projects/project_id/ regions/region/vpnTunnels/name Corresponds to the JSON property vpnTunnel

Returns:

  • (String) 


3044
3045
3046
 
# File 'lib/google/apis/networkmanagement_v1/classes.rb', line 3044

def vpn_tunnel
  @vpn_tunnel
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



3051
3052
3053
3054
3055
3056
3057
3058
3059
3060
3061
3062
3063
3064
3065
3066
 
# File 'lib/google/apis/networkmanagement_v1/classes.rb', line 3051

def update!(**args)
  @aggregation_interval = args[:aggregation_interval] if args.key?(:aggregation_interval)
  @create_time = args[:create_time] if args.key?(:create_time)
  @description = args[:description] if args.key?(:description)
  @filter_expr = args[:filter_expr] if args.key?(:filter_expr)
  @flow_sampling = args[:flow_sampling] if args.key?(:flow_sampling)
  @interconnect_attachment = args[:interconnect_attachment] if args.key?(:interconnect_attachment)
  @labels = args[:labels] if args.key?(:labels)
  @metadata = args[:metadata] if args.key?(:metadata)
  @metadata_fields = args[:metadata_fields] if args.key?(:metadata_fields)
  @name = args[:name] if args.key?(:name)
  @state = args[:state] if args.key?(:state)
  @target_resource_state = args[:target_resource_state] if args.key?(:target_resource_state)
  @update_time = args[:update_time] if args.key?(:update_time)
  @vpn_tunnel = args[:vpn_tunnel] if args.key?(:vpn_tunnel)
end