Class: Google::Apis::ComputeAlpha::FirewallPolicy

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



8547
8548
8549
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 8547

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

Instance Attribute Details

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

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

Returns:



8442
8443
8444
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 8442

def associations
  @associations
end

#creation_timestamp ⇒ String

[Output Only] Creation timestamp in RFC3339 text format. Corresponds to the JSON property creationTimestamp

Returns:

  • (String) 


8447
8448
8449
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 8447

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) 


8453
8454
8455
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 8453

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


8466
8467
8468
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 8466

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


8478
8479
8480
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 8478

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) 


8484
8485
8486
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 8484

def id
  @id
end

#kind ⇒ String

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

Returns:

  • (String) 


8490
8491
8492
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 8490

def kind
  @kind
end

#name ⇒ String

[Output Only] Name of the resource. It is a numeric ID allocated by GCP which uniquely identifies the Firewall Policy. Corresponds to the JSON property name

Returns:

  • (String) 


8496
8497
8498
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 8496

def name
  @name
end

#parent ⇒ String

[Output Only] The parent of the firewall policy. Corresponds to the JSON property parent

Returns:

  • (String) 


8501
8502
8503
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 8501

def parent
  @parent
end

#region ⇒ String

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


8509
8510
8511
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 8509

def region
  @region
end

#rule_tuple_count ⇒ Fixnum

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


8515
8516
8517
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 8515

def rule_tuple_count
  @rule_tuple_count
end

#rules ⇒ Array<Google::Apis::ComputeAlpha::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:



8523
8524
8525
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 8523

def rules
  @rules
end

#self_link ⇒ String

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

Returns:

  • (String) 


8528
8529
8530
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 8528

def self_link
  @self_link
end

#self_link_with_id ⇒ String

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

Returns:

  • (String) 


8533
8534
8535
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 8533

def self_link_with_id
  @self_link_with_id
end

#short_name ⇒ String

User-provided name of the Organization firewall plicy. The name should be unique in the organization in which the firewall policy is created. 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) 


8545
8546
8547
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 8545

def short_name
  @short_name
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



8552
8553
8554
8555
8556
8557
8558
8559
8560
8561
8562
8563
8564
8565
8566
8567
8568
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 8552

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)
  @parent = args[:parent] if args.key?(:parent)
  @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