Class: Google::Apis::ComputeAlpha::ForwardingRule
- Inherits:
-
Object
- Object
- Google::Apis::ComputeAlpha::ForwardingRule
- Defined in:
- generated/google/apis/compute_alpha/classes.rb,
generated/google/apis/compute_alpha/representations.rb,
generated/google/apis/compute_alpha/representations.rb
Overview
Represents a Forwarding Rule resource. A forwardingRules resource represents a regional forwarding rule. Regional external forwarding rules can reference any of the following resources:
- A target instance
- A Cloud VPN Classic gateway (targetVpnGateway),
- A target pool for a Network Load Balancer
- A global target HTTP(S) proxy for an HTTP(S) load balancer using Standard Tier
- A target SSL proxy for a SSL Proxy load balancer using Standard Tier
- A target TCP proxy for a TCP Proxy load balancer using Standard Tier. Regional internal forwarding rules can reference the backend service of an internal TCP/UDP load balancer. For regional internal forwarding rules, the following applies:
- If the loadBalancingScheme for the load balancer is INTERNAL, then the forwarding rule references a regional internal backend service.
- If the loadBalancingScheme for the load balancer is INTERNAL_MANAGED, then the forwarding rule must reference a regional target HTTP(S) proxy. For more information, read Using Forwarding rules. A globalForwardingRules resource represents a global forwarding rule. Global forwarding rules are only used by load balancers that use Premium Tier. (== 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
-
#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
This field is only used for INTERNAL load balancing.
-
#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
The IP address that this forwarding rule is serving on behalf of.
-
#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 to apply to this resource.
-
#load_balancing_scheme ⇒ String
This signifies what the ForwardingRule will be used for and can only take the following values: INTERNAL, INTERNAL_SELF_MANAGED, EXTERNAL.
-
#metadata_filters ⇒ Array<Google::Apis::ComputeAlpha::MetadataFilter>
Opaque filter criteria used by Loadbalancer to restrict routing configuration to a limited set 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 is used along with the target field for TargetHttpProxy, TargetHttpsProxy, TargetSslProxy, TargetTcpProxy, TargetVpnGateway, TargetPool, TargetInstance.
-
#ports ⇒ Array<String>
This field is used along with the backend_service field for internal load balancing.
-
#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_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
The URL of the target resource to receive the matched traffic.
Instance Method Summary collapse
-
#initialize(**args) ⇒ ForwardingRule
constructor
A new instance of ForwardingRule.
-
#update!(**args) ⇒ Object
Update properties of this object.
Methods included from Google::Apis::Core::JsonObjectSupport
Methods included from Google::Apis::Core::Hashable
Constructor Details
#initialize(**args) ⇒ ForwardingRule
Returns a new instance of ForwardingRule
7598 7599 7600 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 7598 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
7367 7368 7369 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 7367 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
7376 7377 7378 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 7376 def allow_global_access @allow_global_access end |
#backend_service ⇒ String
This field is only used for INTERNAL load balancing.
For internal load balancing, this field identifies the BackendService resource
to receive the matched traffic.
Corresponds to the JSON property backendService
7384 7385 7386 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 7384 def backend_service @backend_service end |
#creation_timestamp ⇒ String
[Output Only] Creation timestamp in RFC3339 text format.
Corresponds to the JSON property creationTimestamp
7389 7390 7391 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 7389 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
7395 7396 7397 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 7395 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.
7407 7408 7409 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 7407 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
7413 7414 7415 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 7413 def id @id end |
#ip_address ⇒ String
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_SELF_MANAGED, this must be a URL reference to an existing Address resource ( internal regional static IP address), with a purpose of GCE_END_POINT and address_type of INTERNAL. 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:
- 100.1.2.3
- https://www.googleapis.com/compute/v1/projects/project/regions/region/ addresses/address
- projects/project/regions/region/addresses/address
- regions/region/addresses/address
- global/addresses/address
- address
Corresponds to the JSON property
IPAddress
7349 7350 7351 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 7349 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. When
the load balancing scheme is INTERNAL_SELF_MANAGED, only TCPis valid.
Corresponds to the JSON property IPProtocol
7357 7358 7359 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 7357 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
7420 7421 7422 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 7420 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
7429 7430 7431 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 7429 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
7436 7437 7438 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 7436 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.
7449 7450 7451 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 7449 def label_fingerprint @label_fingerprint end |
#labels ⇒ Hash<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
7456 7457 7458 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 7456 def labels @labels end |
#load_balancing_scheme ⇒ String
This signifies what the ForwardingRule will be used for and can only take the
following values: INTERNAL, INTERNAL_SELF_MANAGED, EXTERNAL. The value of
INTERNAL means that this will be used for Internal Network Load Balancing (TCP,
UDP). The value of INTERNAL_SELF_MANAGED means that this will be used for
Internal Global HTTP(S) LB. 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
7466 7467 7468 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 7466 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 xDS compliant clients. In their xDS requests to Loadbalancer,
xDS clients present node metadata. If a match takes place, the relevant
routing configuration is made available 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 in the provided
metadata.
metadataFilters specified here can be overridden by 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
7483 7484 7485 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 7483 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
7493 7494 7495 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 7493 def name @name end |
#network ⇒ String
This field is not used for external load balancing.
For INTERNAL and INTERNAL_SELF_MANAGED 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
7501 7502 7503 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 7501 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
7511 7512 7513 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 7511 def network_tier @network_tier end |
#port_range ⇒ String
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
7529 7530 7531 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 7529 def port_range @port_range end |
#ports ⇒ Array<String>
This field is used along with the backend_service field for internal load
balancing.
When the load balancing scheme is INTERNAL, a list of ports can be configured,
for example, ['80'], ['8000','9000'] etc. 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
7539 7540 7541 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 7539 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. 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
7547 7548 7549 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 7547 def region @region end |
#self_link ⇒ String
[Output Only] Server-defined URL for the resource.
Corresponds to the JSON property selfLink
7552 7553 7554 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 7552 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
7557 7558 7559 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 7557 def self_link_with_id @self_link_with_id end |
#service_label ⇒ String
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
7569 7570 7571 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 7569 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
7576 7577 7578 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 7576 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
7586 7587 7588 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 7586 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 INTERNAL_SELF_MANAGED load balancing, only HTTP and HTTPS targets
are valid.
Corresponds to the JSON property target
7596 7597 7598 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 7596 def target @target end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
7603 7604 7605 7606 7607 7608 7609 7610 7611 7612 7613 7614 7615 7616 7617 7618 7619 7620 7621 7622 7623 7624 7625 7626 7627 7628 7629 7630 7631 7632 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 7603 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) @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_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 |