Class: Google::Apis::ComputeV1::FirewallPolicy

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



7467
7468
7469
 
# File 'lib/google/apis/compute_v1/classes.rb', line 7467

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

Instance Attribute Details

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

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

Returns:



7370
7371
7372
 
# File 'lib/google/apis/compute_v1/classes.rb', line 7370

def associations
  @associations
end

#creation_timestamp ⇒ String

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

Returns:

  • (String) 


7375
7376
7377
 
# File 'lib/google/apis/compute_v1/classes.rb', line 7375

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) 


7381
7382
7383
 
# File 'lib/google/apis/compute_v1/classes.rb', line 7381

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) 


7394
7395
7396
 
# File 'lib/google/apis/compute_v1/classes.rb', line 7394

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) 


7406
7407
7408
 
# File 'lib/google/apis/compute_v1/classes.rb', line 7406

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) 


7412
7413
7414
 
# File 'lib/google/apis/compute_v1/classes.rb', line 7412

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) 


7418
7419
7420
 
# File 'lib/google/apis/compute_v1/classes.rb', line 7418

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) 


7424
7425
7426
 
# File 'lib/google/apis/compute_v1/classes.rb', line 7424

def name
  @name
end

#parent ⇒ String

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

Returns:

  • (String) 


7429
7430
7431
 
# File 'lib/google/apis/compute_v1/classes.rb', line 7429

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


7435
7436
7437
 
# File 'lib/google/apis/compute_v1/classes.rb', line 7435

def rule_tuple_count
  @rule_tuple_count
end

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



7443
7444
7445
 
# File 'lib/google/apis/compute_v1/classes.rb', line 7443

def rules
  @rules
end

#self_link ⇒ String

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

Returns:

  • (String) 


7448
7449
7450
 
# File 'lib/google/apis/compute_v1/classes.rb', line 7448

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) 


7453
7454
7455
 
# File 'lib/google/apis/compute_v1/classes.rb', line 7453

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) 


7465
7466
7467
 
# File 'lib/google/apis/compute_v1/classes.rb', line 7465

def short_name
  @short_name
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



7472
7473
7474
7475
7476
7477
7478
7479
7480
7481
7482
7483
7484
7485
7486
7487
 
# File 'lib/google/apis/compute_v1/classes.rb', line 7472

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