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.



4576
4577
4578
 
# File 'lib/google/apis/networkmanagement_v1/classes.rb', line 4576

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) 


4475
4476
4477
 
# File 'lib/google/apis/networkmanagement_v1/classes.rb', line 4475

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) 


4480
4481
4482
 
# File 'lib/google/apis/networkmanagement_v1/classes.rb', line 4480

def create_time
  @create_time
end

#cross_project_metadata ⇒ String

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

Returns:

  • (String) 


4487
4488
4489
 
# File 'lib/google/apis/networkmanagement_v1/classes.rb', line 4487

def cross_project_metadata
  @cross_project_metadata
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) 


4493
4494
4495
 
# File 'lib/google/apis/networkmanagement_v1/classes.rb', line 4493

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) 


4498
4499
4500
 
# File 'lib/google/apis/networkmanagement_v1/classes.rb', line 4498

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) 


4506
4507
4508
 
# File 'lib/google/apis/networkmanagement_v1/classes.rb', line 4506

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) 


4512
4513
4514
 
# File 'lib/google/apis/networkmanagement_v1/classes.rb', line 4512

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>) 


4517
4518
4519
 
# File 'lib/google/apis/networkmanagement_v1/classes.rb', line 4517

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) 


4523
4524
4525
 
# File 'lib/google/apis/networkmanagement_v1/classes.rb', line 4523

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>) 


4529
4530
4531
 
# File 'lib/google/apis/networkmanagement_v1/classes.rb', line 4529

def metadata_fields
  @metadata_fields
end

#name ⇒ String

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

Returns:

  • (String) 


4538
4539
4540
 
# File 'lib/google/apis/networkmanagement_v1/classes.rb', line 4538

def name
  @name
end

#network ⇒ String

Traffic will be logged from VMs, VPN tunnels and Interconnect Attachments within the network. Format: projects/project_id/global/networks/name Corresponds to the JSON property network

Returns:

  • (String) 


4544
4545
4546
 
# File 'lib/google/apis/networkmanagement_v1/classes.rb', line 4544

def network
  @network
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. Setting state= DISABLED will pause the log generation for this config. Corresponds to the JSON property state

Returns:

  • (String) 


4551
4552
4553
 
# File 'lib/google/apis/networkmanagement_v1/classes.rb', line 4551

def state
  @state
end

#subnet ⇒ String

Traffic will be logged from VMs within the subnetwork. Format: projects/ project_id/regions/region/subnetworks/name Corresponds to the JSON property subnet

Returns:

  • (String) 


4557
4558
4559
 
# File 'lib/google/apis/networkmanagement_v1/classes.rb', line 4557

def subnet
  @subnet
end

#target_resource_state ⇒ String

Output only. Describes the state of the configured target resource for diagnostic purposes. Corresponds to the JSON property targetResourceState

Returns:

  • (String) 


4563
4564
4565
 
# File 'lib/google/apis/networkmanagement_v1/classes.rb', line 4563

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) 


4568
4569
4570
 
# File 'lib/google/apis/networkmanagement_v1/classes.rb', line 4568

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) 


4574
4575
4576
 
# File 'lib/google/apis/networkmanagement_v1/classes.rb', line 4574

def vpn_tunnel
  @vpn_tunnel
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



4581
4582
4583
4584
4585
4586
4587
4588
4589
4590
4591
4592
4593
4594
4595
4596
4597
4598
4599
 
# File 'lib/google/apis/networkmanagement_v1/classes.rb', line 4581

def update!(**args)
  @aggregation_interval = args[:aggregation_interval] if args.key?(:aggregation_interval)
  @create_time = args[:create_time] if args.key?(:create_time)
  @cross_project_metadata = args[:cross_project_metadata] if args.key?(:cross_project_metadata)
  @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)
  @network = args[:network] if args.key?(:network)
  @state = args[:state] if args.key?(:state)
  @subnet = args[:subnet] if args.key?(:subnet)
  @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