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.
- 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. (== resource_for
$api_version.targetHttpsProxies == ) (== resource_for$api_version.regionTargetHttpsProxies ==)
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.
-
#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.
-
#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.
41235 41236 41237 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 41235 def initialize(**args) update!(**args) end |
Instance Attribute Details
#authentication ⇒ String
[Deprecated] Use serverTlsPolicy instead.
Corresponds to the JSON property authentication
41072 41073 41074 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 41072 def authentication @authentication end |
#authorization ⇒ String
[Deprecated] Use authorizationPolicy instead.
Corresponds to the JSON property authorization
41077 41078 41079 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 41077 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
41089 41090 41091 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 41089 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.
Corresponds to the JSON property certificateMap
41096 41097 41098 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 41096 def certificate_map @certificate_map end |
#creation_timestamp ⇒ String
[Output Only] Creation timestamp in RFC3339 text format.
Corresponds to the JSON property creationTimestamp
41101 41102 41103 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 41101 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
41107 41108 41109 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 41107 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.
41118 41119 41120 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 41118 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
41133 41134 41135 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 41133 def http_filters @http_filters end |
#id ⇒ Fixnum
[Output Only] The unique identifier for the resource. This identifier is
defined by the server.
Corresponds to the JSON property id
41139 41140 41141 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 41139 def id @id end |
#kind ⇒ String
[Output Only] Type of resource. Always compute#targetHttpsProxy for target
HTTPS proxies.
Corresponds to the JSON property kind
41145 41146 41147 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 41145 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
41155 41156 41157 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 41155 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
41167 41168 41169 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 41167 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
41180 41181 41182 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 41180 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
41186 41187 41188 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 41186 def region @region end |
#self_link ⇒ String
[Output Only] Server-defined URL for the resource.
Corresponds to the JSON property selfLink
41191 41192 41193 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 41191 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
41196 41197 41198 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 41196 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.
If left blank, communications are not encrypted.
Note: This field currently has no impact.
Corresponds to the JSON property serverTlsPolicy
41207 41208 41209 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 41207 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
41216 41217 41218 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 41216 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
41223 41224 41225 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 41223 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
41233 41234 41235 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 41233 def url_map @url_map end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
41240 41241 41242 41243 41244 41245 41246 41247 41248 41249 41250 41251 41252 41253 41254 41255 41256 41257 41258 41259 41260 41261 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 41240 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) @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) @url_map = args[:url_map] if args.key?(:url_map) end |