Class: Google::Apis::ComputeAlpha::TargetHttpsProxy

Inherits:
Object
  • Object
show all
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

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ TargetHttpsProxy

Returns a new instance of TargetHttpsProxy.



39368
39369
39370
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 39368

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#authentication ⇒ String

[Deprecated] Use serverTlsPolicy instead. Corresponds to the JSON property authentication

Returns:

  • (String) 


39207
39208
39209
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 39207

def authentication
  @authentication
end

#authorization ⇒ String

[Deprecated] Use authorizationPolicy instead. Corresponds to the JSON property authorization

Returns:

  • (String) 


39212
39213
39214
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 39212

def authorization
  @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

Returns:

  • (String) 


39224
39225
39226
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 39224

def authorization_policy
  @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

Returns:

  • (String) 


39231
39232
39233
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 39231

def certificate_map
  @certificate_map
end

#creation_timestamp ⇒ String

[Output Only] Creation timestamp in RFC3339 text format. Corresponds to the JSON property creationTimestamp

Returns:

  • (String) 


39236
39237
39238
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 39236

def creation_timestamp
  @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

Returns:

  • (String) 


39242
39243
39244
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 39242

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.

Returns:

  • (String) 


39253
39254
39255
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 39253

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

Returns:

  • (Array<String>) 


39268
39269
39270
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 39268

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

Returns:

  • (Fixnum) 


39274
39275
39276
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 39274

def id
  @id
end

#kind ⇒ String

[Output Only] Type of resource. Always compute#targetHttpsProxy for target HTTPS proxies. Corresponds to the JSON property kind

Returns:

  • (String) 


39280
39281
39282
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 39280

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

Returns:

  • (String) 


39290
39291
39292
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 39290

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

Returns:

  • (Boolean) 


39302
39303
39304
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 39302

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

Returns:

  • (String) 


39315
39316
39317
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 39315

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

Returns:

  • (String) 


39321
39322
39323
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 39321

def region
  @region
end

#self_link ⇒ String

[Output Only] Server-defined URL for the resource. Corresponds to the JSON property selfLink

Returns:

  • (String) 


39326
39327
39328
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 39326

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

Returns:

  • (String) 


39331
39332
39333
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 39331

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

Returns:

  • (String) 


39342
39343
39344
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 39342

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. Corresponds to the JSON property sslCertificates

Returns:

  • (Array<String>) 


39349
39350
39351
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 39349

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

Returns:

  • (String) 


39356
39357
39358
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 39356

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:

Returns:

  • (String) 


39366
39367
39368
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 39366

def url_map
  @url_map
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



39373
39374
39375
39376
39377
39378
39379
39380
39381
39382
39383
39384
39385
39386
39387
39388
39389
39390
39391
39392
39393
39394
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 39373

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