Class TargetHttpsProxy.Builder (1.64.0)

public static final class TargetHttpsProxy.Builder extends GeneratedMessageV3.Builder<TargetHttpsProxy.Builder> implements TargetHttpsProxyOrBuilder

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.

Protobuf type google.cloud.compute.v1.TargetHttpsProxy

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

Methods

addAllSslCertificates(Iterable<String> values)

public TargetHttpsProxy.Builder addAllSslCertificates(Iterable<String> values)

URLs to SslCertificate resources that are used to authenticate connections between users and the load balancer. At least one SSL certificate must be specified. SslCertificates do not apply when the load balancing scheme is set to INTERNAL_SELF_MANAGED. The URLs should refer to a SSL Certificate resource or Certificate Manager Certificate resource. Mixing Classic Certificates and Certificate Manager Certificates is not allowed. Certificate Manager Certificates must include the certificatemanager API. Certificate Manager Certificates are not supported by Global external Application Load Balancer or Classic Application Load Balancer, use certificate_map instead. Currently, you may specify up to 15 Classic SSL Certificates. Certificate Manager Certificates accepted formats are: - //certificatemanager.googleapis.com/projects/{project}/locations/{ location}/certificates/{resourceName}. - https://certificatemanager.googleapis.com/v1alpha1/projects/{project }/locations/{location}/certificates/{resourceName}.

repeated string ssl_certificates = 366006543;

Parameter
Name Description
values Iterable<String>

The sslCertificates to add.

Returns
Type Description
TargetHttpsProxy.Builder

This builder for chaining.

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public TargetHttpsProxy.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
TargetHttpsProxy.Builder
Overrides

addSslCertificates(String value)

public TargetHttpsProxy.Builder addSslCertificates(String value)

URLs to SslCertificate resources that are used to authenticate connections between users and the load balancer. At least one SSL certificate must be specified. SslCertificates do not apply when the load balancing scheme is set to INTERNAL_SELF_MANAGED. The URLs should refer to a SSL Certificate resource or Certificate Manager Certificate resource. Mixing Classic Certificates and Certificate Manager Certificates is not allowed. Certificate Manager Certificates must include the certificatemanager API. Certificate Manager Certificates are not supported by Global external Application Load Balancer or Classic Application Load Balancer, use certificate_map instead. Currently, you may specify up to 15 Classic SSL Certificates. Certificate Manager Certificates accepted formats are: - //certificatemanager.googleapis.com/projects/{project}/locations/{ location}/certificates/{resourceName}. - https://certificatemanager.googleapis.com/v1alpha1/projects/{project }/locations/{location}/certificates/{resourceName}.

repeated string ssl_certificates = 366006543;

Parameter
Name Description
value String

The sslCertificates to add.

Returns
Type Description
TargetHttpsProxy.Builder

This builder for chaining.

addSslCertificatesBytes(ByteString value)

public TargetHttpsProxy.Builder addSslCertificatesBytes(ByteString value)

URLs to SslCertificate resources that are used to authenticate connections between users and the load balancer. At least one SSL certificate must be specified. SslCertificates do not apply when the load balancing scheme is set to INTERNAL_SELF_MANAGED. The URLs should refer to a SSL Certificate resource or Certificate Manager Certificate resource. Mixing Classic Certificates and Certificate Manager Certificates is not allowed. Certificate Manager Certificates must include the certificatemanager API. Certificate Manager Certificates are not supported by Global external Application Load Balancer or Classic Application Load Balancer, use certificate_map instead. Currently, you may specify up to 15 Classic SSL Certificates. Certificate Manager Certificates accepted formats are: - //certificatemanager.googleapis.com/projects/{project}/locations/{ location}/certificates/{resourceName}. - https://certificatemanager.googleapis.com/v1alpha1/projects/{project }/locations/{location}/certificates/{resourceName}.

repeated string ssl_certificates = 366006543;

Parameter
Name Description
value ByteString

The bytes of the sslCertificates to add.

Returns
Type Description
TargetHttpsProxy.Builder

This builder for chaining.

build()

public TargetHttpsProxy build()
Returns
Type Description
TargetHttpsProxy

buildPartial()

public TargetHttpsProxy buildPartial()
Returns
Type Description
TargetHttpsProxy

clear()

public TargetHttpsProxy.Builder clear()
Returns
Type Description
TargetHttpsProxy.Builder
Overrides

clearAuthorizationPolicy()

public TargetHttpsProxy.Builder clearAuthorizationPolicy()

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.

optional string authorization_policy = 33945528;

Returns
Type Description
TargetHttpsProxy.Builder

This builder for chaining.

clearCertificateMap()

public TargetHttpsProxy.Builder clearCertificateMap()

URL of a certificate map that identifies a certificate map associated with the given target proxy. This field can only be set for Global external Application Load Balancer or Classic Application Load Balancer. For other products use Certificate Manager Certificates instead. If set, sslCertificates will be ignored. Accepted format is //certificatemanager.googleapis.com/projects/{project }/locations/{location}/certificateMaps/{resourceName}.

optional string certificate_map = 156463796;

Returns
Type Description
TargetHttpsProxy.Builder

This builder for chaining.

clearCreationTimestamp()

public TargetHttpsProxy.Builder clearCreationTimestamp()

[Output Only] Creation timestamp in RFC3339 text format.

optional string creation_timestamp = 30525366;

Returns
Type Description
TargetHttpsProxy.Builder

This builder for chaining.

clearDescription()

public TargetHttpsProxy.Builder clearDescription()

An optional description of this resource. Provide this property when you create the resource.

optional string description = 422937596;

Returns
Type Description
TargetHttpsProxy.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public TargetHttpsProxy.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
TargetHttpsProxy.Builder
Overrides

clearFingerprint()

public TargetHttpsProxy.Builder clearFingerprint()

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.

optional string fingerprint = 234678500;

Returns
Type Description
TargetHttpsProxy.Builder

This builder for chaining.

clearHttpKeepAliveTimeoutSec()

public TargetHttpsProxy.Builder clearHttpKeepAliveTimeoutSec()

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.

optional int32 http_keep_alive_timeout_sec = 447326046;

Returns
Type Description
TargetHttpsProxy.Builder

This builder for chaining.

clearId()

public TargetHttpsProxy.Builder clearId()

[Output Only] The unique identifier for the resource. This identifier is defined by the server.

optional uint64 id = 3355;

Returns
Type Description
TargetHttpsProxy.Builder

This builder for chaining.

clearKind()

public TargetHttpsProxy.Builder clearKind()

[Output Only] Type of resource. Always compute#targetHttpsProxy for target HTTPS proxies.

optional string kind = 3292052;

Returns
Type Description
TargetHttpsProxy.Builder

This builder for chaining.

clearName()

public TargetHttpsProxy.Builder clearName()

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? 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.

optional string name = 3373707;

Returns
Type Description
TargetHttpsProxy.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public TargetHttpsProxy.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
TargetHttpsProxy.Builder
Overrides

clearProxyBind()

public TargetHttpsProxy.Builder clearProxyBind()

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.

optional bool proxy_bind = 286025582;

Returns
Type Description
TargetHttpsProxy.Builder

This builder for chaining.

clearQuicOverride()

public TargetHttpsProxy.Builder clearQuicOverride()

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. Check the QuicOverride enum for the list of possible values.

optional string quic_override = 456577197;

Returns
Type Description
TargetHttpsProxy.Builder

This builder for chaining.

clearRegion()

public TargetHttpsProxy.Builder clearRegion()

[Output Only] URL of the region where the regional TargetHttpsProxy resides. This field is not applicable to global TargetHttpsProxies.

optional string region = 138946292;

Returns
Type Description
TargetHttpsProxy.Builder

This builder for chaining.

public TargetHttpsProxy.Builder clearSelfLink()

[Output Only] Server-defined URL for the resource.

optional string self_link = 456214797;

Returns
Type Description
TargetHttpsProxy.Builder

This builder for chaining.

clearServerTlsPolicy()

public TargetHttpsProxy.Builder clearServerTlsPolicy()

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.

optional string server_tls_policy = 295825266;

Returns
Type Description
TargetHttpsProxy.Builder

This builder for chaining.

clearSslCertificates()

public TargetHttpsProxy.Builder clearSslCertificates()

URLs to SslCertificate resources that are used to authenticate connections between users and the load balancer. At least one SSL certificate must be specified. SslCertificates do not apply when the load balancing scheme is set to INTERNAL_SELF_MANAGED. The URLs should refer to a SSL Certificate resource or Certificate Manager Certificate resource. Mixing Classic Certificates and Certificate Manager Certificates is not allowed. Certificate Manager Certificates must include the certificatemanager API. Certificate Manager Certificates are not supported by Global external Application Load Balancer or Classic Application Load Balancer, use certificate_map instead. Currently, you may specify up to 15 Classic SSL Certificates. Certificate Manager Certificates accepted formats are: - //certificatemanager.googleapis.com/projects/{project}/locations/{ location}/certificates/{resourceName}. - https://certificatemanager.googleapis.com/v1alpha1/projects/{project }/locations/{location}/certificates/{resourceName}.

repeated string ssl_certificates = 366006543;

Returns
Type Description
TargetHttpsProxy.Builder

This builder for chaining.

clearSslPolicy()

public TargetHttpsProxy.Builder clearSslPolicy()

URL of SslPolicy resource that will be associated with the TargetHttpsProxy resource. If not set, the TargetHttpsProxy resource has no SSL policy configured.

optional string ssl_policy = 295190213;

Returns
Type Description
TargetHttpsProxy.Builder

This builder for chaining.

clearTlsEarlyData()

public TargetHttpsProxy.Builder clearTlsEarlyData()

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. Check the TlsEarlyData enum for the list of possible values.

optional string tls_early_data = 61108426;

Returns
Type Description
TargetHttpsProxy.Builder

This builder for chaining.

clearUrlMap()

public TargetHttpsProxy.Builder clearUrlMap()

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

optional string url_map = 367020684;

Returns
Type Description
TargetHttpsProxy.Builder

This builder for chaining.

clone()

public TargetHttpsProxy.Builder clone()
Returns
Type Description
TargetHttpsProxy.Builder
Overrides

getAuthorizationPolicy()

public String getAuthorizationPolicy()

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.

optional string authorization_policy = 33945528;

Returns
Type Description
String

The authorizationPolicy.

getAuthorizationPolicyBytes()

public ByteString getAuthorizationPolicyBytes()

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.

optional string authorization_policy = 33945528;

Returns
Type Description
ByteString

The bytes for authorizationPolicy.

getCertificateMap()

public String getCertificateMap()

URL of a certificate map that identifies a certificate map associated with the given target proxy. This field can only be set for Global external Application Load Balancer or Classic Application Load Balancer. For other products use Certificate Manager Certificates instead. If set, sslCertificates will be ignored. Accepted format is //certificatemanager.googleapis.com/projects/{project }/locations/{location}/certificateMaps/{resourceName}.

optional string certificate_map = 156463796;

Returns
Type Description
String

The certificateMap.

getCertificateMapBytes()

public ByteString getCertificateMapBytes()

URL of a certificate map that identifies a certificate map associated with the given target proxy. This field can only be set for Global external Application Load Balancer or Classic Application Load Balancer. For other products use Certificate Manager Certificates instead. If set, sslCertificates will be ignored. Accepted format is //certificatemanager.googleapis.com/projects/{project }/locations/{location}/certificateMaps/{resourceName}.

optional string certificate_map = 156463796;

Returns
Type Description
ByteString

The bytes for certificateMap.

getCreationTimestamp()

public String getCreationTimestamp()

[Output Only] Creation timestamp in RFC3339 text format.

optional string creation_timestamp = 30525366;

Returns
Type Description
String

The creationTimestamp.

getCreationTimestampBytes()

public ByteString getCreationTimestampBytes()

[Output Only] Creation timestamp in RFC3339 text format.

optional string creation_timestamp = 30525366;

Returns
Type Description
ByteString

The bytes for creationTimestamp.

getDefaultInstanceForType()

public TargetHttpsProxy getDefaultInstanceForType()
Returns
Type Description
TargetHttpsProxy

getDescription()

public String getDescription()

An optional description of this resource. Provide this property when you create the resource.

optional string description = 422937596;

Returns
Type Description
String

The description.

getDescriptionBytes()

public ByteString getDescriptionBytes()

An optional description of this resource. Provide this property when you create the resource.

optional string description = 422937596;

Returns
Type Description
ByteString

The bytes for description.

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

getFingerprint()

public String getFingerprint()

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.

optional string fingerprint = 234678500;

Returns
Type Description
String

The fingerprint.

getFingerprintBytes()

public ByteString getFingerprintBytes()

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.

optional string fingerprint = 234678500;

Returns
Type Description
ByteString

The bytes for fingerprint.

getHttpKeepAliveTimeoutSec()

public int getHttpKeepAliveTimeoutSec()

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.

optional int32 http_keep_alive_timeout_sec = 447326046;

Returns
Type Description
int

The httpKeepAliveTimeoutSec.

getId()

public long getId()

[Output Only] The unique identifier for the resource. This identifier is defined by the server.

optional uint64 id = 3355;

Returns
Type Description
long

The id.

getKind()

public String getKind()

[Output Only] Type of resource. Always compute#targetHttpsProxy for target HTTPS proxies.

optional string kind = 3292052;

Returns
Type Description
String

The kind.

getKindBytes()

public ByteString getKindBytes()

[Output Only] Type of resource. Always compute#targetHttpsProxy for target HTTPS proxies.

optional string kind = 3292052;

Returns
Type Description
ByteString

The bytes for kind.

getName()

public String getName()

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? 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.

optional string name = 3373707;

Returns
Type Description
String

The name.

getNameBytes()

public ByteString getNameBytes()

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? 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.

optional string name = 3373707;

Returns
Type Description
ByteString

The bytes for name.

getProxyBind()

public boolean getProxyBind()

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.

optional bool proxy_bind = 286025582;

Returns
Type Description
boolean

The proxyBind.

getQuicOverride()

public String getQuicOverride()

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. Check the QuicOverride enum for the list of possible values.

optional string quic_override = 456577197;

Returns
Type Description
String

The quicOverride.

getQuicOverrideBytes()

public ByteString getQuicOverrideBytes()

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. Check the QuicOverride enum for the list of possible values.

optional string quic_override = 456577197;

Returns
Type Description
ByteString

The bytes for quicOverride.

getRegion()

public String getRegion()

[Output Only] URL of the region where the regional TargetHttpsProxy resides. This field is not applicable to global TargetHttpsProxies.

optional string region = 138946292;

Returns
Type Description
String

The region.

getRegionBytes()

public ByteString getRegionBytes()

[Output Only] URL of the region where the regional TargetHttpsProxy resides. This field is not applicable to global TargetHttpsProxies.

optional string region = 138946292;

Returns
Type Description
ByteString

The bytes for region.

public String getSelfLink()

[Output Only] Server-defined URL for the resource.

optional string self_link = 456214797;

Returns
Type Description
String

The selfLink.

getSelfLinkBytes()

public ByteString getSelfLinkBytes()

[Output Only] Server-defined URL for the resource.

optional string self_link = 456214797;

Returns
Type Description
ByteString

The bytes for selfLink.

getServerTlsPolicy()

public String getServerTlsPolicy()

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.

optional string server_tls_policy = 295825266;

Returns
Type Description
String

The serverTlsPolicy.

getServerTlsPolicyBytes()

public ByteString getServerTlsPolicyBytes()

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.

optional string server_tls_policy = 295825266;

Returns
Type Description
ByteString

The bytes for serverTlsPolicy.

getSslCertificates(int index)

public String getSslCertificates(int index)

URLs to SslCertificate resources that are used to authenticate connections between users and the load balancer. At least one SSL certificate must be specified. SslCertificates do not apply when the load balancing scheme is set to INTERNAL_SELF_MANAGED. The URLs should refer to a SSL Certificate resource or Certificate Manager Certificate resource. Mixing Classic Certificates and Certificate Manager Certificates is not allowed. Certificate Manager Certificates must include the certificatemanager API. Certificate Manager Certificates are not supported by Global external Application Load Balancer or Classic Application Load Balancer, use certificate_map instead. Currently, you may specify up to 15 Classic SSL Certificates. Certificate Manager Certificates accepted formats are: - //certificatemanager.googleapis.com/projects/{project}/locations/{ location}/certificates/{resourceName}. - https://certificatemanager.googleapis.com/v1alpha1/projects/{project }/locations/{location}/certificates/{resourceName}.

repeated string ssl_certificates = 366006543;

Parameter
Name Description
index int

The index of the element to return.

Returns
Type Description
String

The sslCertificates at the given index.

getSslCertificatesBytes(int index)

public ByteString getSslCertificatesBytes(int index)

URLs to SslCertificate resources that are used to authenticate connections between users and the load balancer. At least one SSL certificate must be specified. SslCertificates do not apply when the load balancing scheme is set to INTERNAL_SELF_MANAGED. The URLs should refer to a SSL Certificate resource or Certificate Manager Certificate resource. Mixing Classic Certificates and Certificate Manager Certificates is not allowed. Certificate Manager Certificates must include the certificatemanager API. Certificate Manager Certificates are not supported by Global external Application Load Balancer or Classic Application Load Balancer, use certificate_map instead. Currently, you may specify up to 15 Classic SSL Certificates. Certificate Manager Certificates accepted formats are: - //certificatemanager.googleapis.com/projects/{project}/locations/{ location}/certificates/{resourceName}. - https://certificatemanager.googleapis.com/v1alpha1/projects/{project }/locations/{location}/certificates/{resourceName}.

repeated string ssl_certificates = 366006543;

Parameter
Name Description
index int

The index of the value to return.

Returns
Type Description
ByteString

The bytes of the sslCertificates at the given index.

getSslCertificatesCount()

public int getSslCertificatesCount()

URLs to SslCertificate resources that are used to authenticate connections between users and the load balancer. At least one SSL certificate must be specified. SslCertificates do not apply when the load balancing scheme is set to INTERNAL_SELF_MANAGED. The URLs should refer to a SSL Certificate resource or Certificate Manager Certificate resource. Mixing Classic Certificates and Certificate Manager Certificates is not allowed. Certificate Manager Certificates must include the certificatemanager API. Certificate Manager Certificates are not supported by Global external Application Load Balancer or Classic Application Load Balancer, use certificate_map instead. Currently, you may specify up to 15 Classic SSL Certificates. Certificate Manager Certificates accepted formats are: - //certificatemanager.googleapis.com/projects/{project}/locations/{ location}/certificates/{resourceName}. - https://certificatemanager.googleapis.com/v1alpha1/projects/{project }/locations/{location}/certificates/{resourceName}.

repeated string ssl_certificates = 366006543;

Returns
Type Description
int

The count of sslCertificates.

getSslCertificatesList()

public ProtocolStringList getSslCertificatesList()

URLs to SslCertificate resources that are used to authenticate connections between users and the load balancer. At least one SSL certificate must be specified. SslCertificates do not apply when the load balancing scheme is set to INTERNAL_SELF_MANAGED. The URLs should refer to a SSL Certificate resource or Certificate Manager Certificate resource. Mixing Classic Certificates and Certificate Manager Certificates is not allowed. Certificate Manager Certificates must include the certificatemanager API. Certificate Manager Certificates are not supported by Global external Application Load Balancer or Classic Application Load Balancer, use certificate_map instead. Currently, you may specify up to 15 Classic SSL Certificates. Certificate Manager Certificates accepted formats are: - //certificatemanager.googleapis.com/projects/{project}/locations/{ location}/certificates/{resourceName}. - https://certificatemanager.googleapis.com/v1alpha1/projects/{project }/locations/{location}/certificates/{resourceName}.

repeated string ssl_certificates = 366006543;

Returns
Type Description
ProtocolStringList

A list containing the sslCertificates.

getSslPolicy()

public String getSslPolicy()

URL of SslPolicy resource that will be associated with the TargetHttpsProxy resource. If not set, the TargetHttpsProxy resource has no SSL policy configured.

optional string ssl_policy = 295190213;

Returns
Type Description
String

The sslPolicy.

getSslPolicyBytes()

public ByteString getSslPolicyBytes()

URL of SslPolicy resource that will be associated with the TargetHttpsProxy resource. If not set, the TargetHttpsProxy resource has no SSL policy configured.

optional string ssl_policy = 295190213;

Returns
Type Description
ByteString

The bytes for sslPolicy.

getTlsEarlyData()

public String getTlsEarlyData()

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. Check the TlsEarlyData enum for the list of possible values.

optional string tls_early_data = 61108426;

Returns
Type Description
String

The tlsEarlyData.

getTlsEarlyDataBytes()

public ByteString getTlsEarlyDataBytes()

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. Check the TlsEarlyData enum for the list of possible values.

optional string tls_early_data = 61108426;

Returns
Type Description
ByteString

The bytes for tlsEarlyData.

getUrlMap()

public String getUrlMap()

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

optional string url_map = 367020684;

Returns
Type Description
String

The urlMap.

getUrlMapBytes()

public ByteString getUrlMapBytes()

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

optional string url_map = 367020684;

Returns
Type Description
ByteString

The bytes for urlMap.

hasAuthorizationPolicy()

public boolean hasAuthorizationPolicy()

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.

optional string authorization_policy = 33945528;

Returns
Type Description
boolean

Whether the authorizationPolicy field is set.

hasCertificateMap()

public boolean hasCertificateMap()

URL of a certificate map that identifies a certificate map associated with the given target proxy. This field can only be set for Global external Application Load Balancer or Classic Application Load Balancer. For other products use Certificate Manager Certificates instead. If set, sslCertificates will be ignored. Accepted format is //certificatemanager.googleapis.com/projects/{project }/locations/{location}/certificateMaps/{resourceName}.

optional string certificate_map = 156463796;

Returns
Type Description
boolean

Whether the certificateMap field is set.

hasCreationTimestamp()

public boolean hasCreationTimestamp()

[Output Only] Creation timestamp in RFC3339 text format.

optional string creation_timestamp = 30525366;

Returns
Type Description
boolean

Whether the creationTimestamp field is set.

hasDescription()

public boolean hasDescription()

An optional description of this resource. Provide this property when you create the resource.

optional string description = 422937596;

Returns
Type Description
boolean

Whether the description field is set.

hasFingerprint()

public boolean hasFingerprint()

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.

optional string fingerprint = 234678500;

Returns
Type Description
boolean

Whether the fingerprint field is set.

hasHttpKeepAliveTimeoutSec()

public boolean hasHttpKeepAliveTimeoutSec()

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.

optional int32 http_keep_alive_timeout_sec = 447326046;

Returns
Type Description
boolean

Whether the httpKeepAliveTimeoutSec field is set.

hasId()

public boolean hasId()

[Output Only] The unique identifier for the resource. This identifier is defined by the server.

optional uint64 id = 3355;

Returns
Type Description
boolean

Whether the id field is set.

hasKind()

public boolean hasKind()

[Output Only] Type of resource. Always compute#targetHttpsProxy for target HTTPS proxies.

optional string kind = 3292052;

Returns
Type Description
boolean

Whether the kind field is set.

hasName()

public boolean hasName()

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? 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.

optional string name = 3373707;

Returns
Type Description
boolean

Whether the name field is set.

hasProxyBind()

public boolean hasProxyBind()

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.

optional bool proxy_bind = 286025582;

Returns
Type Description
boolean

Whether the proxyBind field is set.

hasQuicOverride()

public boolean hasQuicOverride()

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. Check the QuicOverride enum for the list of possible values.

optional string quic_override = 456577197;

Returns
Type Description
boolean

Whether the quicOverride field is set.

hasRegion()

public boolean hasRegion()

[Output Only] URL of the region where the regional TargetHttpsProxy resides. This field is not applicable to global TargetHttpsProxies.

optional string region = 138946292;

Returns
Type Description
boolean

Whether the region field is set.

public boolean hasSelfLink()

[Output Only] Server-defined URL for the resource.

optional string self_link = 456214797;

Returns
Type Description
boolean

Whether the selfLink field is set.

hasServerTlsPolicy()

public boolean hasServerTlsPolicy()

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.

optional string server_tls_policy = 295825266;

Returns
Type Description
boolean

Whether the serverTlsPolicy field is set.

hasSslPolicy()

public boolean hasSslPolicy()

URL of SslPolicy resource that will be associated with the TargetHttpsProxy resource. If not set, the TargetHttpsProxy resource has no SSL policy configured.

optional string ssl_policy = 295190213;

Returns
Type Description
boolean

Whether the sslPolicy field is set.

hasTlsEarlyData()

public boolean hasTlsEarlyData()

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. Check the TlsEarlyData enum for the list of possible values.

optional string tls_early_data = 61108426;

Returns
Type Description
boolean

Whether the tlsEarlyData field is set.

hasUrlMap()

public boolean hasUrlMap()

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

optional string url_map = 367020684;

Returns
Type Description
boolean

Whether the urlMap field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(TargetHttpsProxy other)

public TargetHttpsProxy.Builder mergeFrom(TargetHttpsProxy other)
Parameter
Name Description
other TargetHttpsProxy
Returns
Type Description
TargetHttpsProxy.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public TargetHttpsProxy.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
TargetHttpsProxy.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public TargetHttpsProxy.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
TargetHttpsProxy.Builder
Overrides

mergeUnknownFields(UnknownFieldSet unknownFields)

public final TargetHttpsProxy.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
TargetHttpsProxy.Builder
Overrides

setAuthorizationPolicy(String value)

public TargetHttpsProxy.Builder setAuthorizationPolicy(String value)

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.

optional string authorization_policy = 33945528;

Parameter
Name Description
value String

The authorizationPolicy to set.

Returns
Type Description
TargetHttpsProxy.Builder

This builder for chaining.

setAuthorizationPolicyBytes(ByteString value)

public TargetHttpsProxy.Builder setAuthorizationPolicyBytes(ByteString value)

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.

optional string authorization_policy = 33945528;

Parameter
Name Description
value ByteString

The bytes for authorizationPolicy to set.

Returns
Type Description
TargetHttpsProxy.Builder

This builder for chaining.

setCertificateMap(String value)

public TargetHttpsProxy.Builder setCertificateMap(String value)

URL of a certificate map that identifies a certificate map associated with the given target proxy. This field can only be set for Global external Application Load Balancer or Classic Application Load Balancer. For other products use Certificate Manager Certificates instead. If set, sslCertificates will be ignored. Accepted format is //certificatemanager.googleapis.com/projects/{project }/locations/{location}/certificateMaps/{resourceName}.

optional string certificate_map = 156463796;

Parameter
Name Description
value String

The certificateMap to set.

Returns
Type Description
TargetHttpsProxy.Builder

This builder for chaining.

setCertificateMapBytes(ByteString value)

public TargetHttpsProxy.Builder setCertificateMapBytes(ByteString value)

URL of a certificate map that identifies a certificate map associated with the given target proxy. This field can only be set for Global external Application Load Balancer or Classic Application Load Balancer. For other products use Certificate Manager Certificates instead. If set, sslCertificates will be ignored. Accepted format is //certificatemanager.googleapis.com/projects/{project }/locations/{location}/certificateMaps/{resourceName}.

optional string certificate_map = 156463796;

Parameter
Name Description
value ByteString

The bytes for certificateMap to set.

Returns
Type Description
TargetHttpsProxy.Builder

This builder for chaining.

setCreationTimestamp(String value)

public TargetHttpsProxy.Builder setCreationTimestamp(String value)

[Output Only] Creation timestamp in RFC3339 text format.

optional string creation_timestamp = 30525366;

Parameter
Name Description
value String

The creationTimestamp to set.

Returns
Type Description
TargetHttpsProxy.Builder

This builder for chaining.

setCreationTimestampBytes(ByteString value)

public TargetHttpsProxy.Builder setCreationTimestampBytes(ByteString value)

[Output Only] Creation timestamp in RFC3339 text format.

optional string creation_timestamp = 30525366;

Parameter
Name Description
value ByteString

The bytes for creationTimestamp to set.

Returns
Type Description
TargetHttpsProxy.Builder

This builder for chaining.

setDescription(String value)

public TargetHttpsProxy.Builder setDescription(String value)

An optional description of this resource. Provide this property when you create the resource.

optional string description = 422937596;

Parameter
Name Description
value String

The description to set.

Returns
Type Description
TargetHttpsProxy.Builder

This builder for chaining.

setDescriptionBytes(ByteString value)

public TargetHttpsProxy.Builder setDescriptionBytes(ByteString value)

An optional description of this resource. Provide this property when you create the resource.

optional string description = 422937596;

Parameter
Name Description
value ByteString

The bytes for description to set.

Returns
Type Description
TargetHttpsProxy.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public TargetHttpsProxy.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
TargetHttpsProxy.Builder
Overrides

setFingerprint(String value)

public TargetHttpsProxy.Builder setFingerprint(String value)

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.

optional string fingerprint = 234678500;

Parameter
Name Description
value String

The fingerprint to set.

Returns
Type Description
TargetHttpsProxy.Builder

This builder for chaining.

setFingerprintBytes(ByteString value)

public TargetHttpsProxy.Builder setFingerprintBytes(ByteString value)

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.

optional string fingerprint = 234678500;

Parameter
Name Description
value ByteString

The bytes for fingerprint to set.

Returns
Type Description
TargetHttpsProxy.Builder

This builder for chaining.

setHttpKeepAliveTimeoutSec(int value)

public TargetHttpsProxy.Builder setHttpKeepAliveTimeoutSec(int value)

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.

optional int32 http_keep_alive_timeout_sec = 447326046;

Parameter
Name Description
value int

The httpKeepAliveTimeoutSec to set.

Returns
Type Description
TargetHttpsProxy.Builder

This builder for chaining.

setId(long value)

public TargetHttpsProxy.Builder setId(long value)

[Output Only] The unique identifier for the resource. This identifier is defined by the server.

optional uint64 id = 3355;

Parameter
Name Description
value long

The id to set.

Returns
Type Description
TargetHttpsProxy.Builder

This builder for chaining.

setKind(String value)

public TargetHttpsProxy.Builder setKind(String value)

[Output Only] Type of resource. Always compute#targetHttpsProxy for target HTTPS proxies.

optional string kind = 3292052;

Parameter
Name Description
value String

The kind to set.

Returns
Type Description
TargetHttpsProxy.Builder

This builder for chaining.

setKindBytes(ByteString value)

public TargetHttpsProxy.Builder setKindBytes(ByteString value)

[Output Only] Type of resource. Always compute#targetHttpsProxy for target HTTPS proxies.

optional string kind = 3292052;

Parameter
Name Description
value ByteString

The bytes for kind to set.

Returns
Type Description
TargetHttpsProxy.Builder

This builder for chaining.

setName(String value)

public TargetHttpsProxy.Builder setName(String value)

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? 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.

optional string name = 3373707;

Parameter
Name Description
value String

The name to set.

Returns
Type Description
TargetHttpsProxy.Builder

This builder for chaining.

setNameBytes(ByteString value)

public TargetHttpsProxy.Builder setNameBytes(ByteString value)

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? 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.

optional string name = 3373707;

Parameter
Name Description
value ByteString

The bytes for name to set.

Returns
Type Description
TargetHttpsProxy.Builder

This builder for chaining.

setProxyBind(boolean value)

public TargetHttpsProxy.Builder setProxyBind(boolean value)

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.

optional bool proxy_bind = 286025582;

Parameter
Name Description
value boolean

The proxyBind to set.

Returns
Type Description
TargetHttpsProxy.Builder

This builder for chaining.

setQuicOverride(String value)

public TargetHttpsProxy.Builder setQuicOverride(String value)

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. Check the QuicOverride enum for the list of possible values.

optional string quic_override = 456577197;

Parameter
Name Description
value String

The quicOverride to set.

Returns
Type Description
TargetHttpsProxy.Builder

This builder for chaining.

setQuicOverrideBytes(ByteString value)

public TargetHttpsProxy.Builder setQuicOverrideBytes(ByteString value)

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. Check the QuicOverride enum for the list of possible values.

optional string quic_override = 456577197;

Parameter
Name Description
value ByteString

The bytes for quicOverride to set.

Returns
Type Description
TargetHttpsProxy.Builder

This builder for chaining.

setRegion(String value)

public TargetHttpsProxy.Builder setRegion(String value)

[Output Only] URL of the region where the regional TargetHttpsProxy resides. This field is not applicable to global TargetHttpsProxies.

optional string region = 138946292;

Parameter
Name Description
value String

The region to set.

Returns
Type Description
TargetHttpsProxy.Builder

This builder for chaining.

setRegionBytes(ByteString value)

public TargetHttpsProxy.Builder setRegionBytes(ByteString value)

[Output Only] URL of the region where the regional TargetHttpsProxy resides. This field is not applicable to global TargetHttpsProxies.

optional string region = 138946292;

Parameter
Name Description
value ByteString

The bytes for region to set.

Returns
Type Description
TargetHttpsProxy.Builder

This builder for chaining.

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public TargetHttpsProxy.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
TargetHttpsProxy.Builder
Overrides
public TargetHttpsProxy.Builder setSelfLink(String value)

[Output Only] Server-defined URL for the resource.

optional string self_link = 456214797;

Parameter
Name Description
value String

The selfLink to set.

Returns
Type Description
TargetHttpsProxy.Builder

This builder for chaining.

setSelfLinkBytes(ByteString value)

public TargetHttpsProxy.Builder setSelfLinkBytes(ByteString value)

[Output Only] Server-defined URL for the resource.

optional string self_link = 456214797;

Parameter
Name Description
value ByteString

The bytes for selfLink to set.

Returns
Type Description
TargetHttpsProxy.Builder

This builder for chaining.

setServerTlsPolicy(String value)

public TargetHttpsProxy.Builder setServerTlsPolicy(String value)

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.

optional string server_tls_policy = 295825266;

Parameter
Name Description
value String

The serverTlsPolicy to set.

Returns
Type Description
TargetHttpsProxy.Builder

This builder for chaining.

setServerTlsPolicyBytes(ByteString value)

public TargetHttpsProxy.Builder setServerTlsPolicyBytes(ByteString value)

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.

optional string server_tls_policy = 295825266;

Parameter
Name Description
value ByteString

The bytes for serverTlsPolicy to set.

Returns
Type Description
TargetHttpsProxy.Builder

This builder for chaining.

setSslCertificates(int index, String value)

public TargetHttpsProxy.Builder setSslCertificates(int index, String value)

URLs to SslCertificate resources that are used to authenticate connections between users and the load balancer. At least one SSL certificate must be specified. SslCertificates do not apply when the load balancing scheme is set to INTERNAL_SELF_MANAGED. The URLs should refer to a SSL Certificate resource or Certificate Manager Certificate resource. Mixing Classic Certificates and Certificate Manager Certificates is not allowed. Certificate Manager Certificates must include the certificatemanager API. Certificate Manager Certificates are not supported by Global external Application Load Balancer or Classic Application Load Balancer, use certificate_map instead. Currently, you may specify up to 15 Classic SSL Certificates. Certificate Manager Certificates accepted formats are: - //certificatemanager.googleapis.com/projects/{project}/locations/{ location}/certificates/{resourceName}. - https://certificatemanager.googleapis.com/v1alpha1/projects/{project }/locations/{location}/certificates/{resourceName}.

repeated string ssl_certificates = 366006543;

Parameters
Name Description
index int

The index to set the value at.

value String

The sslCertificates to set.

Returns
Type Description
TargetHttpsProxy.Builder

This builder for chaining.

setSslPolicy(String value)

public TargetHttpsProxy.Builder setSslPolicy(String value)

URL of SslPolicy resource that will be associated with the TargetHttpsProxy resource. If not set, the TargetHttpsProxy resource has no SSL policy configured.

optional string ssl_policy = 295190213;

Parameter
Name Description
value String

The sslPolicy to set.

Returns
Type Description
TargetHttpsProxy.Builder

This builder for chaining.

setSslPolicyBytes(ByteString value)

public TargetHttpsProxy.Builder setSslPolicyBytes(ByteString value)

URL of SslPolicy resource that will be associated with the TargetHttpsProxy resource. If not set, the TargetHttpsProxy resource has no SSL policy configured.

optional string ssl_policy = 295190213;

Parameter
Name Description
value ByteString

The bytes for sslPolicy to set.

Returns
Type Description
TargetHttpsProxy.Builder

This builder for chaining.

setTlsEarlyData(String value)

public TargetHttpsProxy.Builder setTlsEarlyData(String value)

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. Check the TlsEarlyData enum for the list of possible values.

optional string tls_early_data = 61108426;

Parameter
Name Description
value String

The tlsEarlyData to set.

Returns
Type Description
TargetHttpsProxy.Builder

This builder for chaining.

setTlsEarlyDataBytes(ByteString value)

public TargetHttpsProxy.Builder setTlsEarlyDataBytes(ByteString value)

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. Check the TlsEarlyData enum for the list of possible values.

optional string tls_early_data = 61108426;

Parameter
Name Description
value ByteString

The bytes for tlsEarlyData to set.

Returns
Type Description
TargetHttpsProxy.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final TargetHttpsProxy.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
TargetHttpsProxy.Builder
Overrides

setUrlMap(String value)

public TargetHttpsProxy.Builder setUrlMap(String value)

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

optional string url_map = 367020684;

Parameter
Name Description
value String

The urlMap to set.

Returns
Type Description
TargetHttpsProxy.Builder

This builder for chaining.

setUrlMapBytes(ByteString value)

public TargetHttpsProxy.Builder setUrlMapBytes(ByteString value)

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

optional string url_map = 367020684;

Parameter
Name Description
value ByteString

The bytes for urlMap to set.

Returns
Type Description
TargetHttpsProxy.Builder

This builder for chaining.