Class: Google::Apis::ComputeV1::ForwardingRule

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

Overview

A ForwardingRule resource. A ForwardingRule resource specifies which pool of target virtual machines to forward a packet to if it matches the given [ IPAddress, IPProtocol, portRange] tuple.

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Google::Apis::Core::JsonObjectSupport

#to_json

Methods included from Google::Apis::Core::Hashable

process_value, #to_h

Constructor Details

#initialize(**args) ⇒ ForwardingRule

Returns a new instance of ForwardingRule



2706
2707
2708
 
# File 'generated/google/apis/compute_v1/classes.rb', line 2706

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

Instance Attribute Details

#backend_service ⇒ String

This field is not used for external load balancing. For internal load balancing, this field identifies the BackendService resource to receive the matched traffic. Corresponds to the JSON property backendService

Returns:

  • (String) 


2604
2605
2606
 
# File 'generated/google/apis/compute_v1/classes.rb', line 2604

def backend_service
  @backend_service
end

#creation_timestamp ⇒ String

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

Returns:

  • (String) 


2609
2610
2611
 
# File 'generated/google/apis/compute_v1/classes.rb', line 2609

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) 


2615
2616
2617
 
# File 'generated/google/apis/compute_v1/classes.rb', line 2615

def description
  @description
end

#id ⇒ String

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

Returns:

  • (String) 


2621
2622
2623
 
# File 'generated/google/apis/compute_v1/classes.rb', line 2621

def id
  @id
end

#ip_address ⇒ String

The IP address that this forwarding rule is serving on behalf of. For global forwarding rules, the address must be a global IP. For regional forwarding rules, the address must live in the same region as the forwarding rule. By default, this field is empty and an ephemeral IP from the same scope ( global or regional) will be assigned. When the load balancing scheme is INTERNAL, this can only be an RFC 1918 IP address belonging to the network/subnetwork configured for the forwarding rule. A reserved address cannot be used. If the field is empty, the IP address will be automatically allocated from the internal IP range of the subnetwork or network configured for this forwarding rule. Only IPv4 is supported. Corresponds to the JSON property IPAddress

Returns:

  • (String) 


2590
2591
2592
 
# File 'generated/google/apis/compute_v1/classes.rb', line 2590

def ip_address
  @ip_address
end

#ip_protocol ⇒ String

The IP protocol to which this rule applies. Valid options are TCP, UDP, ESP, AH, SCTP or ICMP. When the load balancing scheme is INTERNAL, only TCP and UDP are valid. Corresponds to the JSON property IPProtocol

Returns:

  • (String) 


2597
2598
2599
 
# File 'generated/google/apis/compute_v1/classes.rb', line 2597

def ip_protocol
  @ip_protocol
end

#kind ⇒ String

[Output Only] Type of the resource. Always compute#forwardingRule for Forwarding Rule resources. Corresponds to the JSON property kind

Returns:

  • (String) 


2627
2628
2629
 
# File 'generated/google/apis/compute_v1/classes.rb', line 2627

def kind
  @kind
end

#load_balancing_scheme ⇒ String

This signifies what the ForwardingRule will be used for and can only take the following values: INTERNAL, EXTERNAL The value of INTERNAL means that this will be used for Internal Network Load Balancing (TCP, UDP). The value of EXTERNAL means that this will be used for External Load Balancing (HTTP(S) LB, External TCP/UDP LB, SSL Proxy) Corresponds to the JSON property loadBalancingScheme

Returns:

  • (String) 


2636
2637
2638
 
# File 'generated/google/apis/compute_v1/classes.rb', line 2636

def load_balancing_scheme
  @load_balancing_scheme
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? 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 name

Returns:

  • (String) 


2646
2647
2648
 
# File 'generated/google/apis/compute_v1/classes.rb', line 2646

def name
  @name
end

#network ⇒ String

This field is not used for external load balancing. For internal load balancing, this field identifies the network that the load balanced IP should belong to for this Forwarding Rule. If this field is not specified, the default network will be used. Corresponds to the JSON property network

Returns:

  • (String) 


2654
2655
2656
 
# File 'generated/google/apis/compute_v1/classes.rb', line 2654

def network
  @network
end

#port_range ⇒ String

Applicable only when IPProtocol is TCP, UDP, or SCTP, only packets addressed to ports in the specified range will be forwarded to target. Forwarding rules with the same [IPAddress, IPProtocol] pair must have disjoint port ranges. This field is not used for internal load balancing. Corresponds to the JSON property portRange

Returns:

  • (String) 


2662
2663
2664
 
# File 'generated/google/apis/compute_v1/classes.rb', line 2662

def port_range
  @port_range
end

#ports ⇒ Array<String>

This field is not used for external load balancing. When the load balancing scheme is INTERNAL, a single port or a comma separated list of ports can be configured. Only packets addressed to these ports will be forwarded to the backends configured with this forwarding rule. If the port list is not provided then all ports are allowed to pass through. You may specify a maximum of up to 5 ports. Corresponds to the JSON property ports

Returns:

  • (Array<String>) 


2672
2673
2674
 
# File 'generated/google/apis/compute_v1/classes.rb', line 2672

def ports
  @ports
end

#region ⇒ String

[Output Only] URL of the region where the regional forwarding rule resides. This field is not applicable to global forwarding rules. Corresponds to the JSON property region

Returns:

  • (String) 


2678
2679
2680
 
# File 'generated/google/apis/compute_v1/classes.rb', line 2678

def region
  @region
end

#self_link ⇒ String

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

Returns:

  • (String) 


2683
2684
2685
 
# File 'generated/google/apis/compute_v1/classes.rb', line 2683

def self_link
  @self_link
end

#subnetwork ⇒ String

This field is not used for external load balancing. For internal load balancing, this field identifies the subnetwork that the load balanced IP should belong to for this Forwarding Rule. If the network specified is in auto subnet mode, this field is optional. However, if the network is in custom subnet mode, a subnetwork must be specified. Corresponds to the JSON property subnetwork

Returns:

  • (String) 


2693
2694
2695
 
# File 'generated/google/apis/compute_v1/classes.rb', line 2693

def subnetwork
  @subnetwork
end

#target ⇒ String

The URL of the target resource to receive the matched traffic. For regional forwarding rules, this target must live in the same region as the forwarding rule. For global forwarding rules, this target must be a global load balancing resource. The forwarded traffic must be of a type appropriate to the target object. For example, TargetHttpProxy requires HTTP traffic, and TargetHttpsProxy requires HTTPS traffic. This field is not used for internal load balancing. Corresponds to the JSON property target

Returns:

  • (String) 


2704
2705
2706
 
# File 'generated/google/apis/compute_v1/classes.rb', line 2704

def target
  @target
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



2711
2712
2713
2714
2715
2716
2717
2718
2719
2720
2721
2722
2723
2724
2725
2726
2727
2728
 
# File 'generated/google/apis/compute_v1/classes.rb', line 2711

def update!(**args)
  @ip_address = args[:ip_address] if args.key?(:ip_address)
  @ip_protocol = args[:ip_protocol] if args.key?(:ip_protocol)
  @backend_service = args[:backend_service] if args.key?(:backend_service)
  @creation_timestamp = args[:creation_timestamp] if args.key?(:creation_timestamp)
  @description = args[:description] if args.key?(:description)
  @id = args[:id] if args.key?(:id)
  @kind = args[:kind] if args.key?(:kind)
  @load_balancing_scheme = args[:load_balancing_scheme] if args.key?(:load_balancing_scheme)
  @name = args[:name] if args.key?(:name)
  @network = args[:network] if args.key?(:network)
  @port_range = args[:port_range] if args.key?(:port_range)
  @ports = args[:ports] if args.key?(:ports)
  @region = args[:region] if args.key?(:region)
  @self_link = args[:self_link] if args.key?(:self_link)
  @subnetwork = args[:subnetwork] if args.key?(:subnetwork)
  @target = args[:target] if args.key?(:target)
end