Class: Google::Apis::ComputeBeta::TargetHttpsProxy
- Inherits:
-
Object
- Object
- Google::Apis::ComputeBeta::TargetHttpsProxy
- Includes:
- Google::Apis::Core::Hashable, Google::Apis::Core::JsonObjectSupport
- Defined in:
- lib/google/apis/compute_beta/classes.rb,
lib/google/apis/compute_beta/representations.rb,
lib/google/apis/compute_beta/representations.rb
Overview
Represents a Target HTTPS Proxy resource. Google Compute Engine has two Target HTTPS Proxy resources: * Global * Regional A target HTTPS proxy is a component of GCP HTTPS load balancers. * targetHttpProxies are used by global external Application Load Balancers, classic Application Load Balancers, cross-region internal Application Load Balancers, and Traffic Director. * regionTargetHttpProxies are used by regional internal Application Load Balancers and regional external Application Load Balancers. Forwarding rules reference a target HTTPS proxy, and the target proxy then references a URL map. For more information, read Using Target Proxies and Forwarding rule concepts.
Instance Attribute Summary collapse
-
#authentication ⇒ String
[Deprecated] Use serverTlsPolicy instead.
-
#authorization ⇒ String
[Deprecated] Use authorizationPolicy instead.
-
#authorization_policy ⇒ String
Optional.
-
#certificate_map ⇒ String
URL of a certificate map that identifies a certificate map associated with the given target proxy.
-
#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.
-
#http_filters ⇒ Array<String>
URLs to networkservices.HttpFilter resources enabled for xDS clients using this configuration.
-
#http_keep_alive_timeout_sec ⇒ Fixnum
Specifies how long to keep a connection open, after completing a response, while there is no matching traffic (in seconds).
-
#id ⇒ Fixnum
[Output Only] The unique identifier for the resource.
-
#kind ⇒ String
[Output Only] Type of resource.
-
#name ⇒ String
Name of the resource.
-
#proxy_bind ⇒ Boolean
(also: #proxy_bind?)
This field only applies when the forwarding rule that references this target proxy has a loadBalancingScheme set to INTERNAL_SELF_MANAGED.
-
#quic_override ⇒ String
Specifies the QUIC override policy for this TargetHttpsProxy resource.
-
#region ⇒ String
[Output Only] URL of the region where the regional TargetHttpsProxy resides.
-
#self_link ⇒ String
[Output Only] Server-defined URL for the resource.
-
#server_tls_policy ⇒ String
Optional.
-
#ssl_certificates ⇒ Array<String>
URLs to SslCertificate resources that are used to authenticate connections between users and the load balancer.
-
#ssl_policy ⇒ String
URL of SslPolicy resource that will be associated with the TargetHttpsProxy resource.
-
#url_map ⇒ String
A fully-qualified or valid partial URL to the UrlMap resource that defines the mapping from URL to the BackendService.
Instance Method Summary collapse
-
#initialize(**args) ⇒ TargetHttpsProxy
constructor
A new instance of TargetHttpsProxy.
-
#update!(**args) ⇒ Object
Update properties of this object.
Constructor Details
#initialize(**args) ⇒ TargetHttpsProxy
Returns a new instance of TargetHttpsProxy.
46503 46504 46505 |
# File 'lib/google/apis/compute_beta/classes.rb', line 46503 def initialize(**args) update!(**args) end |
Instance Attribute Details
#authentication ⇒ String
[Deprecated] Use serverTlsPolicy instead.
Corresponds to the JSON property authentication
46335 46336 46337 |
# File 'lib/google/apis/compute_beta/classes.rb', line 46335 def authentication @authentication end |
#authorization ⇒ String
[Deprecated] Use authorizationPolicy instead.
Corresponds to the JSON property authorization
46340 46341 46342 |
# File 'lib/google/apis/compute_beta/classes.rb', line 46340 def @authorization end |
#authorization_policy ⇒ String
Optional. A URL referring to a networksecurity.AuthorizationPolicy resource
that describes how the proxy should authorize inbound traffic. If left blank,
access will not be restricted by an authorization policy. Refer to the
AuthorizationPolicy resource for additional details. authorizationPolicy only
applies to a global TargetHttpsProxy attached to globalForwardingRules with
the loadBalancingScheme set to INTERNAL_SELF_MANAGED. Note: This field
currently has no impact.
Corresponds to the JSON property authorizationPolicy
46351 46352 46353 |
# File 'lib/google/apis/compute_beta/classes.rb', line 46351 def @authorization_policy end |
#certificate_map ⇒ String
URL of a certificate map that identifies a certificate map associated with the
given target proxy. This field can only be set for global target proxies. If
set, sslCertificates will be ignored. Accepted format is //certificatemanager.
googleapis.com/projects/project/locations/location/certificateMaps/
resourceName.
Corresponds to the JSON property certificateMap
46360 46361 46362 |
# File 'lib/google/apis/compute_beta/classes.rb', line 46360 def certificate_map @certificate_map end |
#creation_timestamp ⇒ String
[Output Only] Creation timestamp in RFC3339 text format.
Corresponds to the JSON property creationTimestamp
46365 46366 46367 |
# File 'lib/google/apis/compute_beta/classes.rb', line 46365 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
46371 46372 46373 |
# File 'lib/google/apis/compute_beta/classes.rb', line 46371 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 TargetHttpsProxy. An up-to-date fingerprint must be provided in
order to patch the TargetHttpsProxy; otherwise, the request will fail with
error 412 conditionNotMet. To see the latest fingerprint, make a get() request
to retrieve the TargetHttpsProxy.
Corresponds to the JSON property fingerprint
NOTE: Values are automatically base64 encoded/decoded in the client library.
46382 46383 46384 |
# File 'lib/google/apis/compute_beta/classes.rb', line 46382 def fingerprint @fingerprint end |
#http_filters ⇒ Array<String>
URLs to networkservices.HttpFilter resources enabled for xDS clients using
this configuration. For example, https://networkservices.googleapis.com/beta/
projects/project/locations/ locationhttpFilters/httpFilter Only filters that
handle outbound connection and stream events may be specified. These filters
work in conjunction with a default set of HTTP filters that may already be
configured by Traffic Director. Traffic Director will determine the final
location of these filters within xDS configuration based on the name of the
HTTP filter. If Traffic Director positions multiple filters at the same
location, those filters will be in the same order as specified in this list.
httpFilters only applies for loadbalancers with loadBalancingScheme set to
INTERNAL_SELF_MANAGED. See ForwardingRule for more details.
Corresponds to the JSON property httpFilters
46397 46398 46399 |
# File 'lib/google/apis/compute_beta/classes.rb', line 46397 def http_filters @http_filters end |
#http_keep_alive_timeout_sec ⇒ Fixnum
Specifies how long to keep a connection open, after completing a response,
while there is no matching traffic (in seconds). If an HTTP keep-alive is not
specified, a default value (610 seconds) will be used. For global external
Application Load Balancers, the minimum allowed value is 5 seconds and the
maximum allowed value is 1200 seconds. For classic Application Load Balancers,
this option is not supported.
Corresponds to the JSON property httpKeepAliveTimeoutSec
46407 46408 46409 |
# File 'lib/google/apis/compute_beta/classes.rb', line 46407 def http_keep_alive_timeout_sec @http_keep_alive_timeout_sec end |
#id ⇒ Fixnum
[Output Only] The unique identifier for the resource. This identifier is
defined by the server.
Corresponds to the JSON property id
46413 46414 46415 |
# File 'lib/google/apis/compute_beta/classes.rb', line 46413 def id @id end |
#kind ⇒ String
[Output Only] Type of resource. Always compute#targetHttpsProxy for target
HTTPS proxies.
Corresponds to the JSON property kind
46419 46420 46421 |
# File 'lib/google/apis/compute_beta/classes.rb', line 46419 def kind @kind 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
46429 46430 46431 |
# File 'lib/google/apis/compute_beta/classes.rb', line 46429 def name @name end |
#proxy_bind ⇒ Boolean Also known as: proxy_bind?
This field only applies when the forwarding rule that references this target
proxy has a loadBalancingScheme set to INTERNAL_SELF_MANAGED. When this field
is set to true, Envoy proxies set up inbound traffic interception and bind to
the IP address and port specified in the forwarding rule. This is generally
useful when using Traffic Director to configure Envoy as a gateway or middle
proxy (in other words, not a sidecar proxy). The Envoy proxy listens for
inbound requests and handles requests when it receives them. The default is
false.
Corresponds to the JSON property proxyBind
46441 46442 46443 |
# File 'lib/google/apis/compute_beta/classes.rb', line 46441 def proxy_bind @proxy_bind end |
#quic_override ⇒ String
Specifies the QUIC override policy for this TargetHttpsProxy resource. This
setting determines whether the load balancer attempts to negotiate QUIC with
clients. You can specify NONE, ENABLE, or DISABLE. - When quic-override is set
to NONE, Google manages whether QUIC is used. - When quic-override is set to
ENABLE, the load balancer uses QUIC when possible. - When quic-override is set
to DISABLE, the load balancer doesn't use QUIC. - If the quic-override flag is
not specified, NONE is implied.
Corresponds to the JSON property quicOverride
46453 46454 46455 |
# File 'lib/google/apis/compute_beta/classes.rb', line 46453 def quic_override @quic_override end |
#region ⇒ String
[Output Only] URL of the region where the regional TargetHttpsProxy resides.
This field is not applicable to global TargetHttpsProxies.
Corresponds to the JSON property region
46459 46460 46461 |
# File 'lib/google/apis/compute_beta/classes.rb', line 46459 def region @region end |
#self_link ⇒ String
[Output Only] Server-defined URL for the resource.
Corresponds to the JSON property selfLink
46464 46465 46466 |
# File 'lib/google/apis/compute_beta/classes.rb', line 46464 def self_link @self_link end |
#server_tls_policy ⇒ String
Optional. A URL referring to a networksecurity.ServerTlsPolicy resource that
describes how the proxy should authenticate inbound traffic. serverTlsPolicy
only applies to a global TargetHttpsProxy attached to globalForwardingRules
with the loadBalancingScheme set to INTERNAL_SELF_MANAGED or EXTERNAL or
EXTERNAL_MANAGED. For details which ServerTlsPolicy resources are accepted
with INTERNAL_SELF_MANAGED and which with EXTERNAL, EXTERNAL_MANAGED
loadBalancingScheme consult ServerTlsPolicy documentation. If left blank,
communications are not encrypted.
Corresponds to the JSON property serverTlsPolicy
46476 46477 46478 |
# File 'lib/google/apis/compute_beta/classes.rb', line 46476 def server_tls_policy @server_tls_policy end |
#ssl_certificates ⇒ Array<String>
URLs to SslCertificate resources that are used to authenticate connections
between users and the load balancer. At least one SSL certificate must be
specified. Currently, you may specify up to 15 SSL certificates.
sslCertificates do not apply when the load balancing scheme is set to
INTERNAL_SELF_MANAGED.
Corresponds to the JSON property sslCertificates
46485 46486 46487 |
# File 'lib/google/apis/compute_beta/classes.rb', line 46485 def ssl_certificates @ssl_certificates end |
#ssl_policy ⇒ String
URL of SslPolicy resource that will be associated with the TargetHttpsProxy
resource. If not set, the TargetHttpsProxy resource has no SSL policy
configured.
Corresponds to the JSON property sslPolicy
46492 46493 46494 |
# File 'lib/google/apis/compute_beta/classes.rb', line 46492 def ssl_policy @ssl_policy end |
#url_map ⇒ String
A fully-qualified or valid partial URL to the UrlMap resource that defines the
mapping from URL to the BackendService. For example, the following are all
valid URLs for specifying a URL map: - https://www.googleapis.compute/v1/
projects/project/global/urlMaps/ url-map - projects/project/global/urlMaps/url-
map - global/urlMaps/url-map
Corresponds to the JSON property urlMap
46501 46502 46503 |
# File 'lib/google/apis/compute_beta/classes.rb', line 46501 def url_map @url_map end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
46508 46509 46510 46511 46512 46513 46514 46515 46516 46517 46518 46519 46520 46521 46522 46523 46524 46525 46526 46527 46528 46529 |
# File 'lib/google/apis/compute_beta/classes.rb', line 46508 def update!(**args) @authentication = args[:authentication] if args.key?(:authentication) @authorization = args[:authorization] if args.key?(:authorization) @authorization_policy = args[:authorization_policy] if args.key?(:authorization_policy) @certificate_map = args[:certificate_map] if args.key?(:certificate_map) @creation_timestamp = args[:creation_timestamp] if args.key?(:creation_timestamp) @description = args[:description] if args.key?(:description) @fingerprint = args[:fingerprint] if args.key?(:fingerprint) @http_filters = args[:http_filters] if args.key?(:http_filters) @http_keep_alive_timeout_sec = args[:http_keep_alive_timeout_sec] if args.key?(:http_keep_alive_timeout_sec) @id = args[:id] if args.key?(:id) @kind = args[:kind] if args.key?(:kind) @name = args[:name] if args.key?(:name) @proxy_bind = args[:proxy_bind] if args.key?(:proxy_bind) @quic_override = args[:quic_override] if args.key?(:quic_override) @region = args[:region] if args.key?(:region) @self_link = args[:self_link] if args.key?(:self_link) @server_tls_policy = args[:server_tls_policy] if args.key?(:server_tls_policy) @ssl_certificates = args[:ssl_certificates] if args.key?(:ssl_certificates) @ssl_policy = args[:ssl_policy] if args.key?(:ssl_policy) @url_map = args[:url_map] if args.key?(:url_map) end |