Class: Google::Apis::ComputeAlpha::Firewall

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 Rule resource. Firewall rules allow or deny ingress traffic to, and egress traffic from your instances. For more information, read Firewall rules.

Defined Under Namespace

Classes: Allowed, Denied

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ Firewall

Returns a new instance of Firewall.



9004
9005
9006
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 9004

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

Instance Attribute Details

#allowed ⇒ Array<Google::Apis::ComputeAlpha::Firewall::Allowed>

The list of ALLOW rules specified by this firewall. Each rule specifies a protocol and port-range tuple that describes a permitted connection. Corresponds to the JSON property allowed

Returns:



8840
8841
8842
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 8840

def allowed
  @allowed
end

#creation_timestamp ⇒ String

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

Returns:

  • (String) 


8845
8846
8847
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 8845

def creation_timestamp
  @creation_timestamp
end

#denied ⇒ Array<Google::Apis::ComputeAlpha::Firewall::Denied>

The list of DENY rules specified by this firewall. Each rule specifies a protocol and port-range tuple that describes a denied connection. Corresponds to the JSON property denied

Returns:



8851
8852
8853
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 8851

def denied
  @denied
end

#description ⇒ String

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

Returns:

  • (String) 


8857
8858
8859
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 8857

def description
  @description
end

#destination_ranges ⇒ Array<String>

If destination ranges are specified, the firewall rule applies only to traffic that has destination IP address in these ranges. These ranges must be expressed in CIDR format. Both IPv4 and IPv6 are supported. Corresponds to the JSON property destinationRanges

Returns:

  • (Array<String>) 


8864
8865
8866
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 8864

def destination_ranges
  @destination_ranges
end

#direction ⇒ String

Direction of traffic to which this firewall applies, either INGRESS or EGRESS. The default is INGRESS. For EGRESS traffic, you cannot specify the sourceTags fields. Corresponds to the JSON property direction

Returns:

  • (String) 


8871
8872
8873
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 8871

def direction
  @direction
end

#disabled ⇒ Boolean Also known as: disabled?

Denotes whether the firewall rule is disabled. When set to true, the firewall rule is not enforced and the network behaves as if it did not exist. If this is unspecified, the firewall rule will be enabled. Corresponds to the JSON property disabled

Returns:

  • (Boolean) 


8878
8879
8880
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 8878

def disabled
  @disabled
end

#enable_logging ⇒ Boolean Also known as: enable_logging?

Deprecated in favor of enable in LogConfig. This field denotes whether to enable logging for a particular firewall rule. If logging is enabled, logs will be exported t Cloud Logging. Corresponds to the JSON property enableLogging

Returns:

  • (Boolean) 


8886
8887
8888
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 8886

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


8893
8894
8895
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 8893

def id
  @id
end

#kind ⇒ String

[Output Only] Type of the resource. Always compute#firewall for firewall rules. Corresponds to the JSON property kind

Returns:

  • (String) 


8898
8899
8900
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 8898

def kind
  @kind
end

#log_config ⇒ Google::Apis::ComputeAlpha::FirewallLogConfig

The available logging options for a firewall rule. Corresponds to the JSON property logConfig

Returns:



8903
8904
8905
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 8903

def log_config
  @log_config
end

#name ⇒ String

Name of the resource; provided by the client when the resource is created. 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])?. The first character must be a lowercase letter, and all following characters (except for the last character) must be a dash, lowercase letter, or digit. The last character must be a lowercase letter or digit. Corresponds to the JSON property name

Returns:

  • (String) 


8913
8914
8915
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 8913

def name
  @name
end

#network ⇒ String

URL of the network resource for this firewall rule. If not specified when creating a firewall rule, the default network is used: global/networks/default If you choose to specify this field, you can specify the network as a full or partial URL. For example, the following are all valid URLs: - https://www. googleapis.com/compute/v1/projects/myproject/global/networks/my-network - projects/myproject/global/networks/my-network - global/networks/default Corresponds to the JSON property network

Returns:

  • (String) 


8923
8924
8925
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 8923

def network
  @network
end

#priority ⇒ Fixnum

Priority for this rule. This is an integer between 0 and 65535, both inclusive. The default value is 1000. Relative priorities determine which rule takes effect if multiple rules apply. Lower values indicate higher priority. For example, a rule with priority 0 has higher precedence than a rule with priority 1. DENY rules take precedence over ALLOW rules if they have equal priority. Note that VPC networks have implied rules with a priority of 65535. To avoid conflicts with the implied rules, use a priority number less than 65535. Corresponds to the JSON property priority

Returns:

  • (Fixnum) 


8935
8936
8937
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 8935

def priority
  @priority
end

#self_link ⇒ String

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

Returns:

  • (String) 


8940
8941
8942
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 8940

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) 


8945
8946
8947
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 8945

def self_link_with_id
  @self_link_with_id
end

#source_ranges ⇒ Array<String>

If source ranges are specified, the firewall rule applies only to traffic that has a source IP address in these ranges. These ranges must be expressed in CIDR format. One or both of sourceRanges and sourceTags may be set. If both fields are set, the rule applies to traffic that has a source IP address within sourceRanges OR a source IP from a resource with a matching tag listed in the sourceTags field. The connection does not need to match both fields for the rule to apply. Both IPv4 and IPv6 are supported. Corresponds to the JSON property sourceRanges

Returns:

  • (Array<String>) 


8956
8957
8958
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 8956

def source_ranges
  @source_ranges
end

#source_service_accounts ⇒ Array<String>

If source service accounts are specified, the firewall rules apply only to traffic originating from an instance with a service account in this list. Source service accounts cannot be used to control traffic to an instance's external IP address because service accounts are associated with an instance, not an IP address. sourceRanges can be set at the same time as sourceServiceAccounts. If both are set, the firewall applies to traffic that has a source IP address within the sourceRanges OR a source IP that belongs to an instance with service account listed in sourceServiceAccount. The connection does not need to match both fields for the firewall to apply. sourceServiceAccounts cannot be used at the same time as sourceTags or targetTags. Corresponds to the JSON property sourceServiceAccounts

Returns:

  • (Array<String>) 


8971
8972
8973
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 8971

def source_service_accounts
  @source_service_accounts
end

#source_tags ⇒ Array<String>

If source tags are specified, the firewall rule applies only to traffic with source IPs that match the primary network interfaces of VM instances that have the tag and are in the same VPC network. Source tags cannot be used to control traffic to an instance's external IP address, it only applies to traffic between instances in the same virtual network. Because tags are associated with instances, not IP addresses. One or both of sourceRanges and sourceTags may be set. If both fields are set, the firewall applies to traffic that has a source IP address within sourceRanges OR a source IP from a resource with a matching tag listed in the sourceTags field. The connection does not need to match both fields for the firewall to apply. Corresponds to the JSON property sourceTags

Returns:

  • (Array<String>) 


8985
8986
8987
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 8985

def source_tags
  @source_tags
end

#target_service_accounts ⇒ Array<String>

A list of service accounts indicating sets of instances located in the network that may make network connections as specified in allowed[]. targetServiceAccounts cannot be used at the same time as targetTags or sourceTags. If neither targetServiceAccounts nor targetTags are specified, the firewall rule applies to all instances on the specified network. Corresponds to the JSON property targetServiceAccounts

Returns:

  • (Array<String>) 


8994
8995
8996
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 8994

def target_service_accounts
  @target_service_accounts
end

#target_tags ⇒ Array<String>

A list of tags that controls which instances the firewall rule applies to. If targetTags are specified, then the firewall rule applies only to instances in the VPC network that have one of those tags. If no targetTags are specified, the firewall rule applies to all instances on the specified network. Corresponds to the JSON property targetTags

Returns:

  • (Array<String>) 


9002
9003
9004
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 9002

def target_tags
  @target_tags
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



9009
9010
9011
9012
9013
9014
9015
9016
9017
9018
9019
9020
9021
9022
9023
9024
9025
9026
9027
9028
9029
9030
9031
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 9009

def update!(**args)
  @allowed = args[:allowed] if args.key?(:allowed)
  @creation_timestamp = args[:creation_timestamp] if args.key?(:creation_timestamp)
  @denied = args[:denied] if args.key?(:denied)
  @description = args[:description] if args.key?(:description)
  @destination_ranges = args[:destination_ranges] if args.key?(:destination_ranges)
  @direction = args[:direction] if args.key?(:direction)
  @disabled = args[:disabled] if args.key?(:disabled)
  @enable_logging = args[:enable_logging] if args.key?(:enable_logging)
  @id = args[:id] if args.key?(:id)
  @kind = args[:kind] if args.key?(:kind)
  @log_config = args[:log_config] if args.key?(:log_config)
  @name = args[:name] if args.key?(:name)
  @network = args[:network] if args.key?(:network)
  @priority = args[:priority] if args.key?(:priority)
  @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)
  @source_ranges = args[:source_ranges] if args.key?(:source_ranges)
  @source_service_accounts = args[:source_service_accounts] if args.key?(:source_service_accounts)
  @source_tags = args[:source_tags] if args.key?(:source_tags)
  @target_service_accounts = args[:target_service_accounts] if args.key?(:target_service_accounts)
  @target_tags = args[:target_tags] if args.key?(:target_tags)
end