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. * targetHttpsProxies are used by external HTTPS load balancers.
- regionTargetHttpsProxies are used by internal HTTPS 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.
43843 43844 43845 |
# File 'lib/google/apis/compute_beta/classes.rb', line 43843 def initialize(**args) update!(**args) end |
Instance Attribute Details
#authentication ⇒ String
[Deprecated] Use serverTlsPolicy instead.
Corresponds to the JSON property authentication
43675 43676 43677 |
# File 'lib/google/apis/compute_beta/classes.rb', line 43675 def authentication @authentication end |
#authorization ⇒ String
[Deprecated] Use authorizationPolicy instead.
Corresponds to the JSON property authorization
43680 43681 43682 |
# File 'lib/google/apis/compute_beta/classes.rb', line 43680 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
43691 43692 43693 |
# File 'lib/google/apis/compute_beta/classes.rb', line 43691 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
43700 43701 43702 |
# File 'lib/google/apis/compute_beta/classes.rb', line 43700 def certificate_map @certificate_map end |
#creation_timestamp ⇒ String
[Output Only] Creation timestamp in RFC3339 text format.
Corresponds to the JSON property creationTimestamp
43705 43706 43707 |
# File 'lib/google/apis/compute_beta/classes.rb', line 43705 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
43711 43712 43713 |
# File 'lib/google/apis/compute_beta/classes.rb', line 43711 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.
43722 43723 43724 |
# File 'lib/google/apis/compute_beta/classes.rb', line 43722 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
43737 43738 43739 |
# File 'lib/google/apis/compute_beta/classes.rb', line 43737 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
HTTP(S) load balancer, the minimum allowed value is 5 seconds and the maximum
allowed value is 1200 seconds. For Global external HTTP(S) load balancer (
classic), this option is not available publicly.
Corresponds to the JSON property httpKeepAliveTimeoutSec
43747 43748 43749 |
# File 'lib/google/apis/compute_beta/classes.rb', line 43747 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
43753 43754 43755 |
# File 'lib/google/apis/compute_beta/classes.rb', line 43753 def id @id end |
#kind ⇒ String
[Output Only] Type of resource. Always compute#targetHttpsProxy for target
HTTPS proxies.
Corresponds to the JSON property kind
43759 43760 43761 |
# File 'lib/google/apis/compute_beta/classes.rb', line 43759 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
43769 43770 43771 |
# File 'lib/google/apis/compute_beta/classes.rb', line 43769 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
43781 43782 43783 |
# File 'lib/google/apis/compute_beta/classes.rb', line 43781 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
43793 43794 43795 |
# File 'lib/google/apis/compute_beta/classes.rb', line 43793 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
43799 43800 43801 |
# File 'lib/google/apis/compute_beta/classes.rb', line 43799 def region @region end |
#self_link ⇒ String
[Output Only] Server-defined URL for the resource.
Corresponds to the JSON property selfLink
43804 43805 43806 |
# File 'lib/google/apis/compute_beta/classes.rb', line 43804 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
43816 43817 43818 |
# File 'lib/google/apis/compute_beta/classes.rb', line 43816 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
43825 43826 43827 |
# File 'lib/google/apis/compute_beta/classes.rb', line 43825 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
43832 43833 43834 |
# File 'lib/google/apis/compute_beta/classes.rb', line 43832 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
43841 43842 43843 |
# File 'lib/google/apis/compute_beta/classes.rb', line 43841 def url_map @url_map end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
43848 43849 43850 43851 43852 43853 43854 43855 43856 43857 43858 43859 43860 43861 43862 43863 43864 43865 43866 43867 43868 43869 |
# File 'lib/google/apis/compute_beta/classes.rb', line 43848 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 |