target.apidocs.com.google.api.services.compute.model.TargetHttpsProxy.html Maven / Gradle / Ivy
TargetHttpsProxy (Compute Engine API v1-rev20250107-2.0.0)
com.google.api.services.compute.model
Class TargetHttpsProxy
- java.lang.Object
-
- java.util.AbstractMap<String,Object>
-
- com.google.api.client.util.GenericData
-
- com.google.api.client.json.GenericJson
-
- com.google.api.services.compute.model.TargetHttpsProxy
-
public final class TargetHttpsProxy
extends com.google.api.client.json.GenericJson
Represents a Target HTTPS Proxy resource. Google Compute Engine has two Target HTTPS Proxy
resources: * [Global](/compute/docs/reference/rest/v1/targetHttpsProxies) *
[Regional](/compute/docs/reference/rest/v1/regionTargetHttpsProxies) A target HTTPS proxy is a
component of Google Cloud 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.
This is the Java data model class that specifies how to parse/serialize into the JSON that is
transmitted over HTTP when working with the Compute Engine API. For a detailed explanation see:
https://developers.google.com/api-client-library/java/google-http-java-client/json
- Author:
- Google, Inc.
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from class com.google.api.client.util.GenericData
com.google.api.client.util.GenericData.Flags
-
Nested classes/interfaces inherited from class java.util.AbstractMap
AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>
-
Constructor Summary
Constructors
Constructor and Description
TargetHttpsProxy()
-
Method Summary
All Methods Instance Methods Concrete Methods
Modifier and Type
Method and Description
TargetHttpsProxy
clone()
byte[]
decodeFingerprint()
Fingerprint of this resource.
TargetHttpsProxy
encodeFingerprint(byte[] fingerprint)
Fingerprint of this resource.
String
getAuthorizationPolicy()
Optional.
String
getCertificateMap()
URL of a certificate map that identifies a certificate map associated with the given target
proxy.
String
getCreationTimestamp()
[Output Only] Creation timestamp in RFC3339 text format.
String
getDescription()
An optional description of this resource.
String
getFingerprint()
Fingerprint of this resource.
Integer
getHttpKeepAliveTimeoutSec()
Specifies how long to keep a connection open, after completing a response, while there is no
matching traffic (in seconds).
BigInteger
getId()
[Output Only] The unique identifier for the resource.
String
getKind()
[Output Only] Type of resource.
String
getName()
Name of the resource.
Boolean
getProxyBind()
This field only applies when the forwarding rule that references this target proxy has a
loadBalancingScheme set to INTERNAL_SELF_MANAGED.
String
getQuicOverride()
Specifies the QUIC override policy for this TargetHttpsProxy resource.
String
getRegion()
[Output Only] URL of the region where the regional TargetHttpsProxy resides.
String
getSelfLink()
[Output Only] Server-defined URL for the resource.
String
getServerTlsPolicy()
Optional.
List<String>
getSslCertificates()
URLs to SslCertificate resources that are used to authenticate connections between users and
the load balancer.
String
getSslPolicy()
URL of SslPolicy resource that will be associated with the TargetHttpsProxy resource.
String
getTlsEarlyData()
Specifies whether TLS 1.3 0-RTT Data ("Early Data") should be accepted for this service.
String
getUrlMap()
A fully-qualified or valid partial URL to the UrlMap resource that defines the mapping from URL
to the BackendService.
TargetHttpsProxy
set(String fieldName,
Object value)
TargetHttpsProxy
setAuthorizationPolicy(String authorizationPolicy)
Optional.
TargetHttpsProxy
setCertificateMap(String certificateMap)
URL of a certificate map that identifies a certificate map associated with the given target
proxy.
TargetHttpsProxy
setCreationTimestamp(String creationTimestamp)
[Output Only] Creation timestamp in RFC3339 text format.
TargetHttpsProxy
setDescription(String description)
An optional description of this resource.
TargetHttpsProxy
setFingerprint(String fingerprint)
Fingerprint of this resource.
TargetHttpsProxy
setHttpKeepAliveTimeoutSec(Integer httpKeepAliveTimeoutSec)
Specifies how long to keep a connection open, after completing a response, while there is no
matching traffic (in seconds).
TargetHttpsProxy
setId(BigInteger id)
[Output Only] The unique identifier for the resource.
TargetHttpsProxy
setKind(String kind)
[Output Only] Type of resource.
TargetHttpsProxy
setName(String name)
Name of the resource.
TargetHttpsProxy
setProxyBind(Boolean proxyBind)
This field only applies when the forwarding rule that references this target proxy has a
loadBalancingScheme set to INTERNAL_SELF_MANAGED.
TargetHttpsProxy
setQuicOverride(String quicOverride)
Specifies the QUIC override policy for this TargetHttpsProxy resource.
TargetHttpsProxy
setRegion(String region)
[Output Only] URL of the region where the regional TargetHttpsProxy resides.
TargetHttpsProxy
setSelfLink(String selfLink)
[Output Only] Server-defined URL for the resource.
TargetHttpsProxy
setServerTlsPolicy(String serverTlsPolicy)
Optional.
TargetHttpsProxy
setSslCertificates(List<String> sslCertificates)
URLs to SslCertificate resources that are used to authenticate connections between users and
the load balancer.
TargetHttpsProxy
setSslPolicy(String sslPolicy)
URL of SslPolicy resource that will be associated with the TargetHttpsProxy resource.
TargetHttpsProxy
setTlsEarlyData(String tlsEarlyData)
Specifies whether TLS 1.3 0-RTT Data ("Early Data") should be accepted for this service.
TargetHttpsProxy
setUrlMap(String urlMap)
A fully-qualified or valid partial URL to the UrlMap resource that defines the mapping from URL
to the BackendService.
-
Methods inherited from class com.google.api.client.json.GenericJson
getFactory, setFactory, toPrettyString, toString
-
Methods inherited from class com.google.api.client.util.GenericData
entrySet, equals, get, getClassInfo, getUnknownKeys, hashCode, put, putAll, remove, setUnknownKeys
-
Methods inherited from class java.util.AbstractMap
clear, containsKey, containsValue, isEmpty, keySet, size, values
-
Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface java.util.Map
compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll
-
-
Method Detail
-
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.
- Returns:
- value or
null for none
-
setAuthorizationPolicy
public TargetHttpsProxy setAuthorizationPolicy(String authorizationPolicy)
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.
- Parameters:
authorizationPolicy - authorizationPolicy or null for none
-
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}.
- Returns:
- value or
null for none
-
setCertificateMap
public TargetHttpsProxy setCertificateMap(String certificateMap)
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}.
- Parameters:
certificateMap - certificateMap or null for none
-
getCreationTimestamp
public String getCreationTimestamp()
[Output Only] Creation timestamp in RFC3339 text format.
- Returns:
- value or
null for none
-
setCreationTimestamp
public TargetHttpsProxy setCreationTimestamp(String creationTimestamp)
[Output Only] Creation timestamp in RFC3339 text format.
- Parameters:
creationTimestamp - creationTimestamp or null for none
-
getDescription
public String getDescription()
An optional description of this resource. Provide this property when you create the resource.
- Returns:
- value or
null for none
-
setDescription
public TargetHttpsProxy setDescription(String description)
An optional description of this resource. Provide this property when you create the resource.
- Parameters:
description - description or null for none
-
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.
- Returns:
- value or
null for none
- See Also:
decodeFingerprint()
-
decodeFingerprint
public byte[] decodeFingerprint()
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.
- Returns:
- Base64 decoded value or
null for none
- Since:
- 1.14
- See Also:
getFingerprint()
-
setFingerprint
public TargetHttpsProxy setFingerprint(String fingerprint)
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.
- Parameters:
fingerprint - fingerprint or null for none
- See Also:
#encodeFingerprint()
-
encodeFingerprint
public TargetHttpsProxy encodeFingerprint(byte[] fingerprint)
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.
- Since:
- 1.14
- See Also:
The value is encoded Base64 or {@code null} for none.
-
getHttpKeepAliveTimeoutSec
public Integer 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.
- Returns:
- value or
null for none
-
setHttpKeepAliveTimeoutSec
public TargetHttpsProxy setHttpKeepAliveTimeoutSec(Integer httpKeepAliveTimeoutSec)
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.
- Parameters:
httpKeepAliveTimeoutSec - httpKeepAliveTimeoutSec or null for none
-
getId
public BigInteger getId()
[Output Only] The unique identifier for the resource. This identifier is defined by the server.
- Returns:
- value or
null for none
-
setId
public TargetHttpsProxy setId(BigInteger id)
[Output Only] The unique identifier for the resource. This identifier is defined by the server.
- Parameters:
id - id or null for none
-
getKind
public String getKind()
[Output Only] Type of resource. Always compute#targetHttpsProxy for target HTTPS proxies.
- Returns:
- value or
null for none
-
setKind
public TargetHttpsProxy setKind(String kind)
[Output Only] Type of resource. Always compute#targetHttpsProxy for target HTTPS proxies.
- Parameters:
kind - kind or null for none
-
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]([-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.
- Returns:
- value or
null for none
-
setName
public TargetHttpsProxy setName(String name)
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.
- Parameters:
name - name or null for none
-
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.
- Returns:
- value or
null for none
-
setProxyBind
public TargetHttpsProxy setProxyBind(Boolean proxyBind)
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.
- Parameters:
proxyBind - proxyBind or null for none
-
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.
- Returns:
- value or
null for none
-
setQuicOverride
public TargetHttpsProxy setQuicOverride(String quicOverride)
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.
- Parameters:
quicOverride - quicOverride or null for none
-
getRegion
public String getRegion()
[Output Only] URL of the region where the regional TargetHttpsProxy resides. This field is not
applicable to global TargetHttpsProxies.
- Returns:
- value or
null for none
-
setRegion
public TargetHttpsProxy setRegion(String region)
[Output Only] URL of the region where the regional TargetHttpsProxy resides. This field is not
applicable to global TargetHttpsProxies.
- Parameters:
region - region or null for none
-
getSelfLink
public String getSelfLink()
[Output Only] Server-defined URL for the resource.
- Returns:
- value or
null for none
-
setSelfLink
public TargetHttpsProxy setSelfLink(String selfLink)
[Output Only] Server-defined URL for the resource.
- Parameters:
selfLink - selfLink or null for none
-
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.
- Returns:
- value or
null for none
-
setServerTlsPolicy
public TargetHttpsProxy setServerTlsPolicy(String serverTlsPolicy)
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.
- Parameters:
serverTlsPolicy - serverTlsPolicy or null for none
-
getSslCertificates
public List<String> getSslCertificates()
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 namespace. Using Certificate Manager Certificates in this
field is 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 or up to 100 Certificate Manager 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}.
- Returns:
- value or
null for none
-
setSslCertificates
public TargetHttpsProxy setSslCertificates(List<String> sslCertificates)
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 namespace. Using Certificate Manager Certificates in this
field is 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 or up to 100 Certificate Manager 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}.
- Parameters:
sslCertificates - sslCertificates or null for none
-
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.
- Returns:
- value or
null for none
-
setSslPolicy
public TargetHttpsProxy setSslPolicy(String sslPolicy)
URL of SslPolicy resource that will be associated with the TargetHttpsProxy resource. If not
set, the TargetHttpsProxy resource has no SSL policy configured.
- Parameters:
sslPolicy - sslPolicy or null for none
-
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.
- Returns:
- value or
null for none
-
setTlsEarlyData
public TargetHttpsProxy setTlsEarlyData(String tlsEarlyData)
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.
- Parameters:
tlsEarlyData - tlsEarlyData or null for none
-
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
- Returns:
- value or
null for none
-
setUrlMap
public TargetHttpsProxy setUrlMap(String urlMap)
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
- Parameters:
urlMap - urlMap or null for none
-
set
public TargetHttpsProxy set(String fieldName,
Object value)
- Overrides:
set in class com.google.api.client.json.GenericJson
-
clone
public TargetHttpsProxy clone()
- Overrides:
clone in class com.google.api.client.json.GenericJson
Copyright © 2011–2025 Google. All rights reserved.
© 2015 - 2025 Weber Informatics LLC | Privacy Policy