Class: Google::Apis::ComputeAlpha::ForwardingRule
- Inherits:
-
Object
- Object
- Google::Apis::ComputeAlpha::ForwardingRule
- 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 Forwarding Rule resource. Forwarding rule resources in GCP can be either regional or global in scope:
- Global *
Regional
A forwarding rule and its corresponding IP address represent the frontend
configuration of a Google Cloud Platform load balancer. Forwarding rules can
also reference target instances and Cloud VPN Classic gateways (
targetVpnGateway).
For more information, read Forwarding rule concepts and Using protocol
forwarding.
(== resource_for
$api_version
.forwardingRules ==) (== resource_for$ api_version
.globalForwardingRules ==) (== resource_for$api_version
. regionForwardingRules ==)
Instance Attribute Summary collapse
-
#all_ports ⇒ Boolean
(also: #all_ports?)
This field is used along with the backend_service field for internal load balancing or with the target field for internal TargetInstance.
-
#allow_global_access ⇒ Boolean
(also: #allow_global_access?)
This field is used along with the backend_service field for internal load balancing or with the target field for internal TargetInstance.
-
#backend_service ⇒ String
Identifies the backend service to which the forwarding rule sends traffic.
-
#creation_timestamp ⇒ String
[Output Only] Creation timestamp in RFC3339 text format.
-
#description ⇒ String
An optional description of this resource.
-
#fingerprint ⇒ String
Fingerprint of this resource.
-
#id ⇒ Fixnum
[Output Only] The unique identifier for the resource.
-
#ip_address ⇒ String
IP address that this forwarding rule serves.
-
#ip_protocol ⇒ String
The IP protocol to which this rule applies.
-
#ip_version ⇒ String
The IP Version that will be used by this forwarding rule.
-
#is_mirroring_collector ⇒ Boolean
(also: #is_mirroring_collector?)
Indicates whether or not this load balancer can be used as a collector for packet mirroring.
-
#kind ⇒ String
[Output Only] Type of the resource.
-
#label_fingerprint ⇒ String
A fingerprint for the labels being applied to this resource, which is essentially a hash of the labels set used for optimistic locking.
-
#labels ⇒ Hash<String,String>
Labels for this resource.
-
#load_balancing_scheme ⇒ String
Specifies the forwarding rule type.
-
#metadata_filters ⇒ Array<Google::Apis::ComputeAlpha::MetadataFilter>
Opaque filter criteria used by Loadbalancer to restrict routing configuration to a limited set of xDS compliant clients.
-
#name ⇒ String
Name of the resource; provided by the client when the resource is created.
-
#network ⇒ String
This field is not used for external load balancing.
-
#network_tier ⇒ String
This signifies the networking tier used for configuring this load balancer and can only take the following values: PREMIUM, STANDARD.
-
#port_range ⇒ String
This field can be used only if: * Load balancing scheme is one of EXTERNAL, INTERNAL_SELF_MANAGED or INTERNAL_MANAGED, and * IPProtocol is one of TCP, UDP, or SCTP.
-
#ports ⇒ Array<String>
The ports field is only supported when the forwarding rule references a backend_service directly.
-
#psc_connection_id ⇒ Fixnum
[Output Only] The PSC connection id of the PSC Forwarding Rule.
-
#region ⇒ String
[Output Only] URL of the region where the regional forwarding rule resides.
-
#self_link ⇒ String
[Output Only] Server-defined URL for the resource.
-
#self_link_with_id ⇒ String
[Output Only] Server-defined URL for this resource with the resource id.
-
#service_directory_registrations ⇒ Array<Google::Apis::ComputeAlpha::ForwardingRuleServiceDirectoryRegistration>
Service Directory resources to register this forwarding rule with.
-
#service_label ⇒ String
An optional prefix to the service name for this Forwarding Rule.
-
#service_name ⇒ String
[Output Only] The internal fully qualified service name for this Forwarding Rule.
-
#subnetwork ⇒ String
This field is only used for internal load balancing.
-
#target ⇒ String
Corresponds to the JSON property
target
.
Instance Method Summary collapse
-
#initialize(**args) ⇒ ForwardingRule
constructor
A new instance of ForwardingRule.
-
#update!(**args) ⇒ Object
Update properties of this object.
Constructor Details
#initialize(**args) ⇒ ForwardingRule
Returns a new instance of ForwardingRule.
9327 9328 9329 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 9327 def initialize(**args) update!(**args) end |
Instance Attribute Details
#all_ports ⇒ Boolean 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
9068 9069 9070 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 9068 def all_ports @all_ports end |
#allow_global_access ⇒ Boolean Also known as: allow_global_access?
This field is used along with the backend_service field for internal load
balancing or with the target field for internal TargetInstance. If the field
is set to TRUE, clients can access ILB from all regions. Otherwise only allows
access from clients in the same region as the internal load balancer.
Corresponds to the JSON property allowGlobalAccess
9077 9078 9079 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 9077 def allow_global_access @allow_global_access end |
#backend_service ⇒ String
Identifies the backend service to which the forwarding rule sends traffic.
Required for Internal TCP/UDP Load Balancing and Network Load Balancing; must
be omitted for all other load balancer types.
Corresponds to the JSON property backendService
9085 9086 9087 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 9085 def backend_service @backend_service end |
#creation_timestamp ⇒ String
[Output Only] Creation timestamp in RFC3339 text format.
Corresponds to the JSON property creationTimestamp
9090 9091 9092 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 9090 def @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
9096 9097 9098 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 9096 def description @description end |
#fingerprint ⇒ String
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.
9108 9109 9110 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 9108 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
9114 9115 9116 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 9114 def id @id end |
#ip_address ⇒ String
IP address that this forwarding rule serves. When a client sends traffic to this IP address, the forwarding rule directs the traffic to the target that you specify in the forwarding rule. If you don't specify a reserved IP address, an ephemeral IP address is assigned. Methods for specifying an IP address:
- IPv4 dotted decimal, as in
100.1.2.3
* Full URL, as in https://www. googleapis.com/compute/v1/projects/project_id/regions/region/addresses/address- name * Partial URL or by name, as in: - projects/project_id/regions/region/addresses/address-name
- regions/region/addresses/address-name
- global/addresses/address-name
- address-name
The loadBalancingScheme and the forwarding rule's target determine the type of
IP address that you can use. For detailed information, refer to IP address
specifications.
Must be set to
0.0.0.0
when the target is targetGrpcProxy that has validateForProxyless field set to true. For Private Service Connect forwarding rules that forward traffic to Google APIs, IP address must be provided. Corresponds to the JSON propertyIPAddress
9041 9042 9043 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 9041 def ip_address @ip_address end |
#ip_protocol ⇒ String
The IP protocol to which this rule applies. For protocol forwarding, valid options are TCP, UDP, ESP, AH, SCTP and ICMP. The valid IP protocols are different for different load balancing products:
- Internal TCP/UDP Load Balancing: The load balancing scheme is INTERNAL, and one of TCP, UDP or ALL is valid.
- Traffic Director: The load balancing scheme is INTERNAL_SELF_MANAGED, and only TCP is valid.
- Internal HTTP(S) Load Balancing: The load balancing scheme is INTERNAL_MANAGED, and only TCP is valid.
- HTTP(S), SSL Proxy, and TCP Proxy Load Balancing: The load balancing scheme is EXTERNAL and only TCP is valid.
- Network Load Balancing: The load balancing scheme is EXTERNAL, and one of
TCP or UDP is valid.
Corresponds to the JSON property
IPProtocol
9058 9059 9060 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 9058 def ip_protocol @ip_protocol end |
#ip_version ⇒ String
The IP Version that will be used by this forwarding rule. Valid options are
IPV4 or IPV6. This can only be specified for an external global forwarding
rule.
Corresponds to the JSON property ipVersion
9121 9122 9123 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 9121 def ip_version @ip_version end |
#is_mirroring_collector ⇒ Boolean Also known as: is_mirroring_collector?
Indicates whether or not this load balancer can be used as a collector for
packet mirroring. To prevent mirroring loops, instances behind this load
balancer will not have their traffic mirrored even if a PacketMirroring rule
applies to them. This can only be set to true for load balancers that have
their loadBalancingScheme set to INTERNAL.
Corresponds to the JSON property isMirroringCollector
9130 9131 9132 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 9130 def is_mirroring_collector @is_mirroring_collector end |
#kind ⇒ String
[Output Only] Type of the resource. Always compute#forwardingRule for
Forwarding Rule resources.
Corresponds to the JSON property kind
9137 9138 9139 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 9137 def kind @kind end |
#label_fingerprint ⇒ String
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, otherwise the request
will fail with error 412 conditionNotMet.
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.
9150 9151 9152 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 9150 def label_fingerprint @label_fingerprint end |
#labels ⇒ Hash<String,String>
Labels for this resource. These can only be added or 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
9157 9158 9159 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 9157 def labels @labels end |
#load_balancing_scheme ⇒ String
Specifies the forwarding rule type.
- EXTERNAL is used for:
- Classic Cloud VPN gateways
- Protocol forwarding to VMs from an external IP address
- HTTP(S), SSL Proxy, TCP Proxy, and Network Load Balancing
- INTERNAL is used for:
- Protocol forwarding to VMs from an internal IP address
- Internal TCP/UDP Load Balancing
- INTERNAL_MANAGED is used for:
- Internal HTTP(S) Load Balancing
- INTERNAL_SELF_MANAGED is used for:
- Traffic Director
For more information about forwarding rules, refer to Forwarding rule concepts.
Corresponds to the JSON property
loadBalancingScheme
9175 9176 9177 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 9175 def load_balancing_scheme @load_balancing_scheme end |
#metadata_filters ⇒ Array<Google::Apis::ComputeAlpha::MetadataFilter>
Opaque filter criteria used by Loadbalancer to restrict routing configuration
to a limited set of xDS compliant clients. In their xDS requests to
Loadbalancer, xDS clients present node metadata. When there is a match, the
relevant configuration is made available to those proxies. Otherwise, all the
resources (e.g. TargetHttpProxy, UrlMap) referenced by the ForwardingRule will
not be visible to those proxies.
For each metadataFilter in this list, if its filterMatchCriteria is set to
MATCH_ANY, at least one of the filterLabels must match the corresponding label
provided in the metadata. If its filterMatchCriteria is set to MATCH_ALL, then
all of its filterLabels must match with corresponding labels provided in the
metadata. If multiple metadataFilters are specified, all of them need to be
satisfied in order to be considered a match.
metadataFilters specified here will be applifed before those specified in the
UrlMap that this ForwardingRule references.
metadataFilters only applies to Loadbalancers that have their
loadBalancingScheme set to INTERNAL_SELF_MANAGED.
Corresponds to the JSON property metadataFilters
9195 9196 9197 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 9195 def @metadata_filters 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])?
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
9205 9206 9207 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 9205 def name @name end |
#network ⇒ String
This field is not used for external load balancing.
For Internal TCP/UDP 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.
For Private Service Connect forwarding rules that forward traffic to Google
APIs, a network must be provided.
Corresponds to the JSON property network
9215 9216 9217 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 9215 def network @network end |
#network_tier ⇒ String
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
9225 9226 9227 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 9225 def network_tier @network_tier end |
#port_range ⇒ String
This field can be used only if: * Load balancing scheme is one of EXTERNAL, INTERNAL_SELF_MANAGED or INTERNAL_MANAGED, and * IPProtocol is one of TCP, UDP, or SCTP. Packets addressed to ports in the specified range will be forwarded to target or backend_service. You can only use one of ports, port_range, or allPorts. The three are mutually exclusive. 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
- TargetGrpcProxy: no constraints
- 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
9245 9246 9247 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 9245 def port_range @port_range end |
#ports ⇒ Array<String>
The ports field is only supported when the forwarding rule references a
backend_service directly. Supported load balancing products are Internal TCP/
UDP Load Balancing and Network Load Balancing. Only packets addressed to the
specified list of ports are forwarded to backends.
You can only use one of ports and port_range, or allPorts. The three are
mutually exclusive.
You can specify a list of up to five ports, which can be non-contiguous.
For Internal TCP/UDP Load Balancing, if you specify allPorts, you should not
specify ports.
For more information, see Port specifications.
Corresponds to the JSON property ports
9260 9261 9262 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 9260 def ports @ports end |
#psc_connection_id ⇒ Fixnum
[Output Only] The PSC connection id of the PSC Forwarding Rule.
Corresponds to the JSON property pscConnectionId
9265 9266 9267 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 9265 def psc_connection_id @psc_connection_id end |
#region ⇒ String
[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
9273 9274 9275 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 9273 def region @region end |
#self_link ⇒ String
[Output Only] Server-defined URL for the resource.
Corresponds to the JSON property selfLink
9278 9279 9280 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 9278 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
9283 9284 9285 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 9283 def self_link_with_id @self_link_with_id end |
#service_directory_registrations ⇒ Array<Google::Apis::ComputeAlpha::ForwardingRuleServiceDirectoryRegistration>
Service Directory resources to register this forwarding rule with. Currently,
only supports a single Service Directory resource.
It is only supported for Internal TCP/UDP Load Balancing and Internal HTTP(S)
Load Balancing.
Corresponds to the JSON property serviceDirectoryRegistrations
9291 9292 9293 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 9291 def service_directory_registrations @service_directory_registrations end |
#service_label ⇒ String
An optional prefix to the service name for this Forwarding Rule. If specified,
the prefix is 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
9303 9304 9305 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 9303 def service_label @service_label end |
#service_name ⇒ String
[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
9310 9311 9312 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 9310 def service_name @service_name end |
#subnetwork ⇒ String
This field is only used for internal 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
9320 9321 9322 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 9320 def subnetwork @subnetwork end |
#target ⇒ String
Corresponds to the JSON property target
9325 9326 9327 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 9325 def target @target end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
9332 9333 9334 9335 9336 9337 9338 9339 9340 9341 9342 9343 9344 9345 9346 9347 9348 9349 9350 9351 9352 9353 9354 9355 9356 9357 9358 9359 9360 9361 9362 9363 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 9332 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) @allow_global_access = args[:allow_global_access] if args.key?(:allow_global_access) @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) @is_mirroring_collector = args[:is_mirroring_collector] if args.key?(:is_mirroring_collector) @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) @metadata_filters = args[:metadata_filters] if args.key?(:metadata_filters) @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) @psc_connection_id = args[:psc_connection_id] if args.key?(:psc_connection_id) @region = args[:region] if args.key?(:region) @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) @service_directory_registrations = args[:service_directory_registrations] if args.key?(:service_directory_registrations) @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 |