Class: Google::Apis::ComputeAlpha::ForwardingRule

Inherits:
Object
  • Object
show all
Includes:
Google::Apis::Core::Hashable, Google::Apis::Core::JsonObjectSupport
Defined in:
generated/google/apis/compute_alpha/classes.rb,
generated/google/apis/compute_alpha/representations.rb,
generated/google/apis/compute_alpha/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, ports] tuple. (== resource_for beta.forwardingRules ==) (== resource_for v1.forwardingRules ==) (== resource_for beta. globalForwardingRules ==) (== resource_for v1.globalForwardingRules ==) (== resource_for beta.regionForwardingRules ==) (== resource_for v1. regionForwardingRules ==)

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



5928
5929
5930
# File 'generated/google/apis/compute_alpha/classes.rb', line 5928

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

Instance Attribute Details

#all_portsBoolean Also known as: all_ports?

This field is used along with the backend_service field for internal load balancing or with the target field for internal TargetInstance. This field cannot be used with port or portRange fields. When the load balancing scheme is INTERNAL and protocol is TCP/UDP, specify this field to allow packets addressed to any ports will be forwarded to the backends configured with this forwarding rule. Corresponds to the JSON property allPorts

Returns:

  • (Boolean)


5742
5743
5744
# File 'generated/google/apis/compute_alpha/classes.rb', line 5742

def all_ports
  @all_ports
end

#backend_serviceString

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)


5750
5751
5752
# File 'generated/google/apis/compute_alpha/classes.rb', line 5750

def backend_service
  @backend_service
end

#creation_timestampString

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

Returns:

  • (String)


5755
5756
5757
# File 'generated/google/apis/compute_alpha/classes.rb', line 5755

def creation_timestamp
  @creation_timestamp
end

#descriptionString

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

Returns:

  • (String)


5761
5762
5763
# File 'generated/google/apis/compute_alpha/classes.rb', line 5761

def description
  @description
end

#fingerprintString

Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a ForwardingRule. Include the fingerprint in patch request to ensure that you do not overwrite changes that were applied from another concurrent request. To see the latest fingerprint, make a get() request to retrieve a ForwardingRule. Corresponds to the JSON property fingerprint NOTE: Values are automatically base64 encoded/decoded in the client library.

Returns:

  • (String)


5773
5774
5775
# File 'generated/google/apis/compute_alpha/classes.rb', line 5773

def fingerprint
  @fingerprint
end

#idFixnum

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

Returns:

  • (Fixnum)


5779
5780
5781
# File 'generated/google/apis/compute_alpha/classes.rb', line 5779

def id
  @id
end

#ip_addressString

The IP address that this forwarding rule is serving on behalf of. Addresses are restricted based on the forwarding rule's load balancing scheme ( EXTERNAL or INTERNAL) and scope (global or regional). When the load balancing scheme is EXTERNAL, for global forwarding rules, the address must be a global IP, and for regional forwarding rules, the address must live in the same region as the forwarding rule. If this field is empty, an ephemeral IPv4 address from the same scope (global or regional) will be assigned. A regional forwarding rule supports IPv4 only. A global forwarding rule supports either IPv4 or IPv6. When the load balancing scheme is INTERNAL, this can only be an RFC 1918 IP address belonging to the network/subnet configured for the forwarding rule. By default, if this field is empty, an ephemeral internal IP address will be automatically allocated from the IP range of the subnet or network configured for this forwarding rule. An address can be specified either by a literal IP address or a URL reference to an existing Address resource. The following examples are all valid:

Returns:

  • (String)


5725
5726
5727
# File 'generated/google/apis/compute_alpha/classes.rb', line 5725

def ip_address
  @ip_address
end

#ip_protocolString

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)


5732
5733
5734
# File 'generated/google/apis/compute_alpha/classes.rb', line 5732

def ip_protocol
  @ip_protocol
end

#ip_versionString

The IP Version that will be used by this forwarding rule. Valid options are IPV4 or IPV6. This can only be specified for a global forwarding rule. Corresponds to the JSON property ipVersion

Returns:

  • (String)


5785
5786
5787
# File 'generated/google/apis/compute_alpha/classes.rb', line 5785

def ip_version
  @ip_version
end

#kindString

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

Returns:

  • (String)


5791
5792
5793
# File 'generated/google/apis/compute_alpha/classes.rb', line 5791

def kind
  @kind
end

#label_fingerprintString

A fingerprint for the labels being applied to this resource, which is essentially a hash of the labels set used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels. To see the latest fingerprint, make a get() request to retrieve a ForwardingRule. Corresponds to the JSON property labelFingerprint NOTE: Values are automatically base64 encoded/decoded in the client library.

Returns:

  • (String)


5803
5804
5805
# File 'generated/google/apis/compute_alpha/classes.rb', line 5803

def label_fingerprint
  @label_fingerprint
end

#labelsHash<String,String>

Labels to apply to this resource. These can be later modified by the setLabels method. Each label key/value pair must comply with RFC1035. Label values may be empty. Corresponds to the JSON property labels

Returns:

  • (Hash<String,String>)


5810
5811
5812
# File 'generated/google/apis/compute_alpha/classes.rb', line 5810

def labels
  @labels
end

#load_balancing_schemeString

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)


5819
5820
5821
# File 'generated/google/apis/compute_alpha/classes.rb', line 5819

def load_balancing_scheme
  @load_balancing_scheme
end

#nameString

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


5829
5830
5831
# File 'generated/google/apis/compute_alpha/classes.rb', line 5829

def name
  @name
end

#networkString

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)


5837
5838
5839
# File 'generated/google/apis/compute_alpha/classes.rb', line 5837

def network
  @network
end

#network_tierString

This signifies the networking tier used for configuring this load balancer and can only take the following values: PREMIUM , STANDARD. For regional ForwardingRule, the valid values are PREMIUM and STANDARD. For GlobalForwardingRule, the valid value is PREMIUM. If this field is not specified, it is assumed to be PREMIUM. If IPAddress is specified, this value must be equal to the networkTier of the Address. Corresponds to the JSON property networkTier

Returns:

  • (String)


5847
5848
5849
# File 'generated/google/apis/compute_alpha/classes.rb', line 5847

def network_tier
  @network_tier
end

#port_rangeString

This field is used along with the target field for TargetHttpProxy, TargetHttpsProxy, TargetSslProxy, TargetTcpProxy, TargetVpnGateway, TargetPool, TargetInstance. 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. Some types of forwarding target have constraints on the acceptable ports:

  • TargetHttpProxy: 80, 8080
  • TargetHttpsProxy: 443
  • TargetTcpProxy: 25, 43, 110, 143, 195, 443, 465, 587, 700, 993, 995, 1688, 1883, 5222
  • TargetSslProxy: 25, 43, 110, 143, 195, 443, 465, 587, 700, 993, 995, 1688, 1883, 5222
  • TargetVpnGateway: 500, 4500 Corresponds to the JSON property portRange

Returns:

  • (String)


5865
5866
5867
# File 'generated/google/apis/compute_alpha/classes.rb', line 5865

def port_range
  @port_range
end

#portsArray<String>

This field is used along with the backend_service field for internal 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. You may specify a maximum of up to 5 ports. Corresponds to the JSON property ports

Returns:

  • (Array<String>)


5875
5876
5877
# File 'generated/google/apis/compute_alpha/classes.rb', line 5875

def ports
  @ports
end

#regionString

[Output Only] URL of the region where the regional forwarding rule resides. This field is not applicable to global forwarding rules. 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)


5883
5884
5885
# File 'generated/google/apis/compute_alpha/classes.rb', line 5883

def region
  @region
end

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

Returns:

  • (String)


5888
5889
5890
# File 'generated/google/apis/compute_alpha/classes.rb', line 5888

def self_link
  @self_link
end

#service_labelString

An optional prefix to the service name for this Forwarding Rule. If specified, will be the first label of the fully qualified service name. The label must be 1-63 characters long, and comply with RFC1035. Specifically, the label 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. This field is only used for internal load balancing. Corresponds to the JSON property serviceLabel

Returns:

  • (String)


5900
5901
5902
# File 'generated/google/apis/compute_alpha/classes.rb', line 5900

def service_label
  @service_label
end

#service_nameString

[Output Only] The internal fully qualified service name for this Forwarding Rule. This field is only used for internal load balancing. Corresponds to the JSON property serviceName

Returns:

  • (String)


5907
5908
5909
# File 'generated/google/apis/compute_alpha/classes.rb', line 5907

def service_name
  @service_name
end

#subnetworkString

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)


5917
5918
5919
# File 'generated/google/apis/compute_alpha/classes.rb', line 5917

def subnetwork
  @subnetwork
end

#targetString

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. Corresponds to the JSON property target

Returns:

  • (String)


5926
5927
5928
# File 'generated/google/apis/compute_alpha/classes.rb', line 5926

def target
  @target
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



5933
5934
5935
5936
5937
5938
5939
5940
5941
5942
5943
5944
5945
5946
5947
5948
5949
5950
5951
5952
5953
5954
5955
5956
5957
5958
# File 'generated/google/apis/compute_alpha/classes.rb', line 5933

def update!(**args)
  @ip_address = args[:ip_address] if args.key?(:ip_address)
  @ip_protocol = args[:ip_protocol] if args.key?(:ip_protocol)
  @all_ports = args[:all_ports] if args.key?(:all_ports)
  @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)
  @fingerprint = args[:fingerprint] if args.key?(:fingerprint)
  @id = args[:id] if args.key?(:id)
  @ip_version = args[:ip_version] if args.key?(:ip_version)
  @kind = args[:kind] if args.key?(:kind)
  @label_fingerprint = args[:label_fingerprint] if args.key?(:label_fingerprint)
  @labels = args[:labels] if args.key?(:labels)
  @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)
  @network_tier = args[:network_tier] if args.key?(:network_tier)
  @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)
  @service_label = args[:service_label] if args.key?(:service_label)
  @service_name = args[:service_name] if args.key?(:service_name)
  @subnetwork = args[:subnetwork] if args.key?(:subnetwork)
  @target = args[:target] if args.key?(:target)
end