![JAR search and dependency download from the Maven repository](/logo.png)
target.apidocs.com.google.api.services.compute.model.TargetHttpsProxy.html Maven / Gradle / Ivy
TargetHttpsProxy (Compute Engine API beta-rev20220726-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 GenericJson
Represents a Target HTTPS Proxy resource. Google Compute Engine has two Target HTTPS Proxy
resources: * [Global](/compute/docs/reference/rest/beta/targetHttpsProxies) *
[Regional](/compute/docs/reference/rest/beta/regionTargetHttpsProxies) A target HTTPS proxy is a
component of GCP HTTPS load balancers. * targetHttpsProxies are used by external HTTPS load
balancers. * regionTargetHttpsProxies are used by internal HTTPS load balancers. Forwarding rules
reference a target HTTPS proxy, and the target proxy then references a URL map. For more
information, read Using Target Proxies and Forwarding rule concepts.
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
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
getAuthentication()
[Deprecated] Use serverTlsPolicy instead.
String
getAuthorization()
[Deprecated] Use authorizationPolicy instead.
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.
List<String>
getHttpFilters()
URLs to networkservices.HttpFilter resources enabled for xDS clients using this configuration.
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
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
setAuthentication(String authentication)
[Deprecated] Use serverTlsPolicy instead.
TargetHttpsProxy
setAuthorization(String authorization)
[Deprecated] Use authorizationPolicy instead.
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
setHttpFilters(List<String> httpFilters)
URLs to networkservices.HttpFilter resources enabled for xDS clients using this configuration.
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
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
-
getAuthentication
public String getAuthentication()
[Deprecated] Use serverTlsPolicy instead.
- Returns:
- value or
null
for none
-
setAuthentication
public TargetHttpsProxy setAuthentication(String authentication)
[Deprecated] Use serverTlsPolicy instead.
- Parameters:
authentication
- authentication or null
for none
-
getAuthorization
public String getAuthorization()
[Deprecated] Use authorizationPolicy instead.
- Returns:
- value or
null
for none
-
setAuthorization
public TargetHttpsProxy setAuthorization(String authorization)
[Deprecated] Use authorizationPolicy instead.
- Parameters:
authorization
- authorization or null
for none
-
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 target proxies. If set, sslCertificates will be
ignored.
- 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 target proxies. If set, sslCertificates will be
ignored.
- 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.
-
getHttpFilters
public List<String> getHttpFilters()
URLs to networkservices.HttpFilter resources enabled for xDS clients using this configuration.
For example, https://networkservices.googleapis.com/beta/projects/project/locations/
locationhttpFilters/httpFilter Only filters that handle outbound connection and stream events
may be specified. These filters work in conjunction with a default set of HTTP filters that may
already be configured by Traffic Director. Traffic Director will determine the final location
of these filters within xDS configuration based on the name of the HTTP filter. If Traffic
Director positions multiple filters at the same location, those filters will be in the same
order as specified in this list. httpFilters only applies for loadbalancers with
loadBalancingScheme set to INTERNAL_SELF_MANAGED. See ForwardingRule for more details.
- Returns:
- value or
null
for none
-
setHttpFilters
public TargetHttpsProxy setHttpFilters(List<String> httpFilters)
URLs to networkservices.HttpFilter resources enabled for xDS clients using this configuration.
For example, https://networkservices.googleapis.com/beta/projects/project/locations/
locationhttpFilters/httpFilter Only filters that handle outbound connection and stream events
may be specified. These filters work in conjunction with a default set of HTTP filters that may
already be configured by Traffic Director. Traffic Director will determine the final location
of these filters within xDS configuration based on the name of the HTTP filter. If Traffic
Director positions multiple filters at the same location, those filters will be in the same
order as specified in this list. httpFilters only applies for loadbalancers with
loadBalancingScheme set to INTERNAL_SELF_MANAGED. See ForwardingRule for more details.
- Parameters:
httpFilters
- httpFilters 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. If left blank, communications are not encrypted. Note: This field
currently has no impact.
- 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. If left blank, communications are not encrypted. Note: This field
currently has no impact.
- 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. Currently, you may specify
up to 15 SSL certificates. sslCertificates do not apply when the load balancing scheme is set
to INTERNAL_SELF_MANAGED.
- 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. Currently, you may specify
up to 15 SSL certificates. sslCertificates do not apply when the load balancing scheme is set
to INTERNAL_SELF_MANAGED.
- 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
-
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 GenericJson
-
clone
public TargetHttpsProxy clone()
- Overrides:
clone
in class GenericJson
Copyright © 2011–2022 Google. All rights reserved.
© 2015 - 2025 Weber Informatics LLC | Privacy Policy