Class: Google::Apis::NetworkmanagementV1beta1::VpcFlowLogsConfig

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/networkmanagement_v1beta1/classes.rb,
lib/google/apis/networkmanagement_v1beta1/representations.rb,
lib/google/apis/networkmanagement_v1beta1/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.



3949
3950
3951
 
# File 'lib/google/apis/networkmanagement_v1beta1/classes.rb', line 3949

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) 


3848
3849
3850
 
# File 'lib/google/apis/networkmanagement_v1beta1/classes.rb', line 3848

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) 


3853
3854
3855
 
# File 'lib/google/apis/networkmanagement_v1beta1/classes.rb', line 3853

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) 


3860
3861
3862
 
# File 'lib/google/apis/networkmanagement_v1beta1/classes.rb', line 3860

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) 


3866
3867
3868
 
# File 'lib/google/apis/networkmanagement_v1beta1/classes.rb', line 3866

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) 


3871
3872
3873
 
# File 'lib/google/apis/networkmanagement_v1beta1/classes.rb', line 3871

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) 


3879
3880
3881
 
# File 'lib/google/apis/networkmanagement_v1beta1/classes.rb', line 3879

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) 


3885
3886
3887
 
# File 'lib/google/apis/networkmanagement_v1beta1/classes.rb', line 3885

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


3890
3891
3892
 
# File 'lib/google/apis/networkmanagement_v1beta1/classes.rb', line 3890

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) 


3896
3897
3898
 
# File 'lib/google/apis/networkmanagement_v1beta1/classes.rb', line 3896

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


3902
3903
3904
 
# File 'lib/google/apis/networkmanagement_v1beta1/classes.rb', line 3902

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) 


3911
3912
3913
 
# File 'lib/google/apis/networkmanagement_v1beta1/classes.rb', line 3911

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) 


3917
3918
3919
 
# File 'lib/google/apis/networkmanagement_v1beta1/classes.rb', line 3917

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) 


3924
3925
3926
 
# File 'lib/google/apis/networkmanagement_v1beta1/classes.rb', line 3924

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) 


3930
3931
3932
 
# File 'lib/google/apis/networkmanagement_v1beta1/classes.rb', line 3930

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) 


3936
3937
3938
 
# File 'lib/google/apis/networkmanagement_v1beta1/classes.rb', line 3936

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) 


3941
3942
3943
 
# File 'lib/google/apis/networkmanagement_v1beta1/classes.rb', line 3941

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) 


3947
3948
3949
 
# File 'lib/google/apis/networkmanagement_v1beta1/classes.rb', line 3947

def vpn_tunnel
  @vpn_tunnel
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



3954
3955
3956
3957
3958
3959
3960
3961
3962
3963
3964
3965
3966
3967
3968
3969
3970
3971
3972
 
# File 'lib/google/apis/networkmanagement_v1beta1/classes.rb', line 3954

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