Class: Google::Apis::ComputeAlpha::TargetHttpsProxy
- Inherits:
-
Object
- Object
- Google::Apis::ComputeAlpha::TargetHttpsProxy
- 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 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.
-
#self_link_with_id ⇒ String
[Output Only] Server-defined URL for this resource with the resource id.
-
#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.
-
#tls_early_data ⇒ String
Specifies whether TLS 1.3 0-RTT Data ("Early Data") should be accepted for this service.
-
#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.
51433 51434 51435 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 51433 def initialize(**args) update!(**args) end |
Instance Attribute Details
#authentication ⇒ String
[Deprecated] Use serverTlsPolicy instead.
Corresponds to the JSON property authentication
51241 51242 51243 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 51241 def authentication @authentication end |
#authorization ⇒ String
[Deprecated] Use authorizationPolicy instead.
Corresponds to the JSON property authorization
51246 51247 51248 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 51246 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
51257 51258 51259 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 51257 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
51266 51267 51268 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 51266 def certificate_map @certificate_map end |
#creation_timestamp ⇒ String
[Output Only] Creation timestamp in RFC3339 text format.
Corresponds to the JSON property creationTimestamp
51271 51272 51273 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 51271 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
51277 51278 51279 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 51277 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.
51288 51289 51290 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 51288 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
51303 51304 51305 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 51303 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
51313 51314 51315 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 51313 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
51319 51320 51321 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 51319 def id @id end |
#kind ⇒ String
[Output Only] Type of resource. Always compute#targetHttpsProxy for target
HTTPS proxies.
Corresponds to the JSON property kind
51325 51326 51327 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 51325 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
51335 51336 51337 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 51335 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
51347 51348 51349 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 51347 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
51359 51360 51361 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 51359 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
51365 51366 51367 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 51365 def region @region end |
#self_link ⇒ String
[Output Only] Server-defined URL for the resource.
Corresponds to the JSON property selfLink
51370 51371 51372 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 51370 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
51375 51376 51377 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 51375 def self_link_with_id @self_link_with_id 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
51387 51388 51389 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 51387 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
51396 51397 51398 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 51396 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
51403 51404 51405 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 51403 def ssl_policy @ssl_policy end |
#tls_early_data ⇒ String
Specifies whether TLS 1.3 0-RTT Data ("Early Data") should be accepted for
this service. Early Data allows a TLS resumption handshake to include the
initial application payload (a HTTP request) alongside the handshake, reducing
the effective round trips to "zero". This applies to TLS 1.3 connections over
TCP (HTTP/2) as well as over UDP (QUIC/h3). This can improve application
performance, especially on networks where interruptions may be common, such as
on mobile. Requests with Early Data will have the "Early-Data" HTTP header set
on the request, with a value of "1", to allow the backend to determine whether
Early Data was included. Note: TLS Early Data may allow requests to be
replayed, as the data is sent to the backend before the handshake has fully
completed. Applications that allow idempotent HTTP methods to make non-
idempotent changes, such as a GET request updating a database, should not
accept Early Data on those requests, and reject requests with the "Early-Data:
1" HTTP header by returning a HTTP 425 (Too Early) status code, in order to
remain RFC compliant. The default value is DISABLED.
Corresponds to the JSON property tlsEarlyData
51422 51423 51424 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 51422 def tls_early_data @tls_early_data 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
51431 51432 51433 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 51431 def url_map @url_map end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
51438 51439 51440 51441 51442 51443 51444 51445 51446 51447 51448 51449 51450 51451 51452 51453 51454 51455 51456 51457 51458 51459 51460 51461 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 51438 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) @self_link_with_id = args[:self_link_with_id] if args.key?(:self_link_with_id) @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) @tls_early_data = args[:tls_early_data] if args.key?(:tls_early_data) @url_map = args[:url_map] if args.key?(:url_map) end |