Class: Google::Apis::ComputeBeta::FirewallPolicy

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

Overview

Represents a Firewall Policy resource.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ FirewallPolicy

Returns a new instance of FirewallPolicy.



13947
13948
13949
 
# File 'lib/google/apis/compute_beta/classes.rb', line 13947

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

Instance Attribute Details

#associations ⇒ Array<Google::Apis::ComputeBeta::FirewallPolicyAssociation>

A list of associations that belong to this firewall policy. Corresponds to the JSON property associations

Returns:



13807
13808
13809
 
# File 'lib/google/apis/compute_beta/classes.rb', line 13807

def associations
  @associations
end

#creation_timestamp ⇒ String

Output only. [Output Only] Creation timestamp inRFC3339 text format. Corresponds to the JSON property creationTimestamp

Returns:

  • (String) 


13813
13814
13815
 
# File 'lib/google/apis/compute_beta/classes.rb', line 13813

def creation_timestamp
  @creation_timestamp
end

#description ⇒ String

An optional description of this resource. Provide this property when you create the resource. Corresponds to the JSON property description

Returns:

  • (String) 


13819
13820
13821
 
# File 'lib/google/apis/compute_beta/classes.rb', line 13819

def description
  @description
end

#display_name ⇒ String

Deprecated, please use short name instead. User-provided name of the Organization firewall policy. The name should be unique in the organization in which the firewall policy is created. This field is not applicable to network firewall policies. This name must be set on creation and cannot be changed. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. Corresponds to the JSON property displayName

Returns:

  • (String) 


13834
13835
13836
 
# File 'lib/google/apis/compute_beta/classes.rb', line 13834

def display_name
  @display_name
end

#fingerprint ⇒ String

Specifies a fingerprint for this resource, which is essentially a hash of the metadata's contents and used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update metadata. You must always provide an up-to-date fingerprint hash in order to update or change metadata, otherwise the request will fail with error412 conditionNotMet. To see the latest fingerprint, make get() request to the firewall policy. Corresponds to the JSON property fingerprint NOTE: Values are automatically base64 encoded/decoded in the client library.

Returns:

  • (String) 


13847
13848
13849
 
# File 'lib/google/apis/compute_beta/classes.rb', line 13847

def fingerprint
  @fingerprint
end

#id ⇒ Fixnum

[Output Only] The unique identifier for the resource. This identifier is defined by the server. Corresponds to the JSON property id

Returns:

  • (Fixnum) 


13853
13854
13855
 
# File 'lib/google/apis/compute_beta/classes.rb', line 13853

def id
  @id
end

#kind ⇒ String

Output only. [Output only] Type of the resource. Alwayscompute# firewallPolicyfor firewall policies Corresponds to the JSON property kind

Returns:

  • (String) 


13859
13860
13861
 
# File 'lib/google/apis/compute_beta/classes.rb', line 13859

def kind
  @kind
end

#name ⇒ String

Name of the resource. For Organization Firewall Policies it's a [Output Only] numeric ID allocated by Google Cloud which uniquely identifies the Organization Firewall Policy. Corresponds to the JSON property name

Returns:

  • (String) 


13866
13867
13868
 
# File 'lib/google/apis/compute_beta/classes.rb', line 13866

def name
  @name
end

#packet_mirroring_rules ⇒ Array<Google::Apis::ComputeBeta::FirewallPolicyRule>

A list of packet mirroring rules that belong to this policy. Corresponds to the JSON property packetMirroringRules

Returns:



13871
13872
13873
 
# File 'lib/google/apis/compute_beta/classes.rb', line 13871

def packet_mirroring_rules
  @packet_mirroring_rules
end

#parent ⇒ String

Output only. [Output Only] The parent of the firewall policy. This field is not applicable to network firewall policies. Corresponds to the JSON property parent

Returns:

  • (String) 


13877
13878
13879
 
# File 'lib/google/apis/compute_beta/classes.rb', line 13877

def parent
  @parent
end

#policy_source ⇒ String

Indicates the source of this Firewall Policy. This field is optional on creation and defaults to USER_DEFINED. The USER_DEFINED value indicates a regular firewall policy. The SYSTEM value indicates a system-level policy managed by an internal service like GKE. This SYSTEM value is reserved for internal services and cannot be set by users during policy creation. Policies with a SYSTEM source cannot be modified or deleted by users. Corresponds to the JSON property policySource

Returns:

  • (String) 


13889
13890
13891
 
# File 'lib/google/apis/compute_beta/classes.rb', line 13889

def policy_source
  @policy_source
end

#policy_type ⇒ String

The type of the firewall policy. This field can be one of VPC_POLICY, RDMA_ROCE_POLICY or ULL_POLICY. Note: if not specified then VPC_POLICY will be used. Corresponds to the JSON property policyType

Returns:

  • (String) 


13896
13897
13898
 
# File 'lib/google/apis/compute_beta/classes.rb', line 13896

def policy_type
  @policy_type
end

#region ⇒ String

Output only. [Output Only] URL of the region where the regional firewall policy resides. This field is not applicable to global firewall policies. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body. Corresponds to the JSON property region

Returns:

  • (String) 


13905
13906
13907
 
# File 'lib/google/apis/compute_beta/classes.rb', line 13905

def region
  @region
end

#rule_tuple_count ⇒ Fixnum

Output only. [Output Only] Total count of all firewall policy rule tuples. A firewall policy can not exceed a set number of tuples. Corresponds to the JSON property ruleTupleCount

Returns:

  • (Fixnum) 


13912
13913
13914
 
# File 'lib/google/apis/compute_beta/classes.rb', line 13912

def rule_tuple_count
  @rule_tuple_count
end

#rules ⇒ Array<Google::Apis::ComputeBeta::FirewallPolicyRule>

A list of rules that belong to this policy. There must always be a default rule (rule with priority 2147483647 and match "*"). If no rules are provided when creating a firewall policy, a default rule with action "allow" will be added. Corresponds to the JSON property rules

Returns:



13920
13921
13922
 
# File 'lib/google/apis/compute_beta/classes.rb', line 13920

def rules
  @rules
end

#self_link ⇒ String

[Output Only] Server-defined URL for the resource. Corresponds to the JSON property selfLink

Returns:

  • (String) 


13925
13926
13927
 
# File 'lib/google/apis/compute_beta/classes.rb', line 13925

def self_link
  @self_link
end

#self_link_with_id ⇒ String

Output only. [Output Only] Server-defined URL for this resource with the resource id. Corresponds to the JSON property selfLinkWithId

Returns:

  • (String) 


13931
13932
13933
 
# File 'lib/google/apis/compute_beta/classes.rb', line 13931

def self_link_with_id
  @self_link_with_id
end

#short_name ⇒ String

User-provided name of the Organization firewall policy. The name should be unique in the organization in which the firewall policy is created. This field is not applicable to network firewall policies. This name must be set on creation and cannot be changed. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. Corresponds to the JSON property shortName

Returns:

  • (String) 


13945
13946
13947
 
# File 'lib/google/apis/compute_beta/classes.rb', line 13945

def short_name
  @short_name
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



13952
13953
13954
13955
13956
13957
13958
13959
13960
13961
13962
13963
13964
13965
13966
13967
13968
13969
13970
13971
 
# File 'lib/google/apis/compute_beta/classes.rb', line 13952

def update!(**args)
  @associations = args[:associations] if args.key?(:associations)
  @creation_timestamp = args[:creation_timestamp] if args.key?(:creation_timestamp)
  @description = args[:description] if args.key?(:description)
  @display_name = args[:display_name] if args.key?(:display_name)
  @fingerprint = args[:fingerprint] if args.key?(:fingerprint)
  @id = args[:id] if args.key?(:id)
  @kind = args[:kind] if args.key?(:kind)
  @name = args[:name] if args.key?(:name)
  @packet_mirroring_rules = args[:packet_mirroring_rules] if args.key?(:packet_mirroring_rules)
  @parent = args[:parent] if args.key?(:parent)
  @policy_source = args[:policy_source] if args.key?(:policy_source)
  @policy_type = args[:policy_type] if args.key?(:policy_type)
  @region = args[:region] if args.key?(:region)
  @rule_tuple_count = args[:rule_tuple_count] if args.key?(:rule_tuple_count)
  @rules = args[:rules] if args.key?(:rules)
  @self_link = args[:self_link] if args.key?(:self_link)
  @self_link_with_id = args[:self_link_with_id] if args.key?(:self_link_with_id)
  @short_name = args[:short_name] if args.key?(:short_name)
end