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 Google Cloud 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.
Instance Attribute Summary collapse
-
#all_ports ⇒ Boolean
(also: #all_ports?)
This field is used along with the backend_service field for Internal TCP/UDP Load Balancing or Network Load Balancing, or with the target field for internal and external 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.
-
#allow_psc_global_access ⇒ Boolean
(also: #allow_psc_global_access?)
This is used in PSC consumer ForwardingRule to control whether the PSC endpoint can be accessed from another region.
-
#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 load balancer 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 - 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.
-
#psc_connection_status ⇒ String
Corresponds to the JSON property
pscConnectionStatus
. -
#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.
-
#source_ip_ranges ⇒ Array<String>
If not empty, this Forwarding Rule will only forward the traffic when the source IP address matches one of the IP addresses or CIDR ranges set here.
-
#subnetwork ⇒ String
This field identifies the subnetwork that the load balanced IP should belong to for this Forwarding Rule, used in internal load balancing and network load balancing with IPv6.
-
#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.
9584 9585 9586 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 9584 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 TCP/UDP
Load Balancing or Network Load Balancing, or with the target field for
internal and external TargetInstance. You can only use one of ports and
port_range, or allPorts. The three are mutually exclusive. For TCP, UDP and
SCTP traffic, packets addressed to any ports will be forwarded to the target
or backendService.
Corresponds to the JSON property allPorts
9330 9331 9332 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 9330 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
9339 9340 9341 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 9339 def allow_global_access @allow_global_access end |
#allow_psc_global_access ⇒ Boolean Also known as: allow_psc_global_access?
This is used in PSC consumer ForwardingRule to control whether the PSC
endpoint can be accessed from another region.
Corresponds to the JSON property allowPscGlobalAccess
9346 9347 9348 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 9346 def allow_psc_global_access @allow_psc_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
9354 9355 9356 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 9354 def backend_service @backend_service end |
#creation_timestamp ⇒ String
[Output Only] Creation timestamp in RFC3339 text format.
Corresponds to the JSON property creationTimestamp
9359 9360 9361 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 9359 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
9365 9366 9367 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 9365 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.
9376 9377 9378 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 9376 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
9382 9383 9384 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 9382 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, see 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 property IPAddress
9311 9312 9313 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 9311 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, ICMP and L3_DEFAULT. The valid IP
protocols are different for different load balancing products as described in
Load balancing features.
Corresponds to the JSON property IPProtocol
9320 9321 9322 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 9320 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
9389 9390 9391 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 9389 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
9398 9399 9400 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 9398 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
9405 9406 9407 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 9405 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.
9417 9418 9419 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 9417 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
9424 9425 9426 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 9424 def labels @labels end |
#load_balancing_scheme ⇒ String
Specifies the forwarding rule type. For more information about forwarding
rules, refer to Forwarding rule concepts.
Corresponds to the JSON property loadBalancingScheme
9430 9431 9432 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 9430 def load_balancing_scheme @load_balancing_scheme end |
#metadata_filters ⇒ Array<Google::Apis::ComputeAlpha::MetadataFilter>
Opaque filter criteria used by load balancer to restrict routing configuration
to a limited set of xDS compliant clients. In their xDS requests to load
balancer, 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 are
not 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
9449 9450 9451 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 9449 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. For Private Service Connect
forwarding rules that forward traffic to Google APIs, the forwarding rule name
must be a 1-20 characters string with lowercase letters and numbers and must
start with a letter.
Corresponds to the JSON property name
9462 9463 9464 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 9462 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
9471 9472 9473 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 9471 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
9481 9482 9483 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 9481 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 - 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 ports. Some types of forwarding
target have constraints on the acceptable ports. For more information, see
Port specifications. @pattern: \d+(?:-\d+)?
Corresponds to the JSON property portRange
9494 9495 9496 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 9494 def port_range @port_range end |
#ports ⇒ Array<String>
The ports field is only supported when the forwarding rule references a
backend_service directly. 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. Forwarding rules with
the same [IPAddress, IPProtocol] pair must have disjoint ports. @pattern: \d+(
?:-\d+)?
Corresponds to the JSON property ports
9506 9507 9508 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 9506 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
9511 9512 9513 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 9511 def psc_connection_id @psc_connection_id end |
#psc_connection_status ⇒ String
Corresponds to the JSON property pscConnectionStatus
9516 9517 9518 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 9516 def psc_connection_status @psc_connection_status 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
9524 9525 9526 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 9524 def region @region end |
#self_link ⇒ String
[Output Only] Server-defined URL for the resource.
Corresponds to the JSON property selfLink
9529 9530 9531 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 9529 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
9534 9535 9536 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 9534 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.
Corresponds to the JSON property serviceDirectoryRegistrations
9540 9541 9542 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 9540 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
9552 9553 9554 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 9552 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
9558 9559 9560 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 9558 def service_name @service_name end |
#source_ip_ranges ⇒ Array<String>
If not empty, this Forwarding Rule will only forward the traffic when the
source IP address matches one of the IP addresses or CIDR ranges set here.
Note that a Forwarding Rule can only have up to 64 source IP ranges, and this
field can only be used with a regional Forwarding Rule whose scheme is
EXTERNAL. Each source_ip_range entry should be either an IP address (for
example, 1.2.3.4) or a CIDR range (for example, 1.2.3.0/24).
Corresponds to the JSON property sourceIpRanges
9568 9569 9570 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 9568 def source_ip_ranges @source_ip_ranges end |
#subnetwork ⇒ String
This field identifies the subnetwork that the load balanced IP should belong
to for this Forwarding Rule, used in internal load balancing and network load
balancing with IPv6. If the network specified is in auto subnet mode, this
field is optional. However, a subnetwork must be specified if the network is
in custom subnet mode or when creating external forwarding rule with IPv6.
Corresponds to the JSON property subnetwork
9577 9578 9579 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 9577 def subnetwork @subnetwork end |
#target ⇒ String
Corresponds to the JSON property target
9582 9583 9584 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 9582 def target @target end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
9589 9590 9591 9592 9593 9594 9595 9596 9597 9598 9599 9600 9601 9602 9603 9604 9605 9606 9607 9608 9609 9610 9611 9612 9613 9614 9615 9616 9617 9618 9619 9620 9621 9622 9623 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 9589 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) @allow_psc_global_access = args[:allow_psc_global_access] if args.key?(:allow_psc_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) @psc_connection_status = args[:psc_connection_status] if args.key?(:psc_connection_status) @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) @source_ip_ranges = args[:source_ip_ranges] if args.key?(:source_ip_ranges) @subnetwork = args[:subnetwork] if args.key?(:subnetwork) @target = args[:target] if args.key?(:target) end |