• Home
• com.google.apis
• google-api-services-compute
• v1-rev20250107-2.0.0
• source code
• TargetHttpProxy.html

×

Project download

Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance.
Project price only 1 $

You can buy this project and download/modify it how often you want.

target.apidocs.com.google.api.services.compute.model.TargetHttpProxy.html Maven / Gradle / Ivy

Skip navigation links




Overview
Package
Class
Use
Tree
Deprecated
Index
Help




Prev Class
Next Class


Frames
No Frames


All Classes






Summary: 
Nested | 
Field | 
Constr | 
Method


Detail: 
Field | 
Constr | 
Method








com.google.api.services.compute.model
Class TargetHttpProxy



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













All Implemented Interfaces:
Cloneable, Map<String,Object>




public final class TargetHttpProxy
extends com.google.api.client.json.GenericJson
Represents a Target HTTP Proxy resource. Google Compute Engine has two Target HTTP Proxy
 resources: * [Global](/compute/docs/reference/rest/v1/targetHttpProxies) *
 [Regional](/compute/docs/reference/rest/v1/regionTargetHttpProxies) A target HTTP proxy is a
 component of Google Cloud HTTP 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 HTTP 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>





Nested classes/interfaces inherited from interface java.util.Map
Map.Entry<K,V>








Constructor Summary

Constructors 

Constructor and Description


TargetHttpProxy() 









Method Summary

All Methods Instance Methods Concrete Methods 

Modifier and Type
Method and Description


TargetHttpProxy
clone() 


byte[]
decodeFingerprint()
Fingerprint of this resource.



TargetHttpProxy
encodeFingerprint(byte[] fingerprint)
Fingerprint of this resource.



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
getRegion()
[Output Only] URL of the region where the regional Target HTTP Proxy resides.



String
getSelfLink()
[Output Only] Server-defined URL for the resource.



String
getUrlMap()
URL to the UrlMap resource that defines the mapping from URL to the BackendService.



TargetHttpProxy
set(String fieldName,
   Object value) 


TargetHttpProxy
setCreationTimestamp(String creationTimestamp)
[Output Only] Creation timestamp in RFC3339 text format.



TargetHttpProxy
setDescription(String description)
An optional description of this resource.



TargetHttpProxy
setFingerprint(String fingerprint)
Fingerprint of this resource.



TargetHttpProxy
setHttpKeepAliveTimeoutSec(Integer httpKeepAliveTimeoutSec)
Specifies how long to keep a connection open, after completing a response, while there is no
 matching traffic (in seconds).



TargetHttpProxy
setId(BigInteger id)
[Output Only] The unique identifier for the resource.



TargetHttpProxy
setKind(String kind)
[Output Only] Type of resource.



TargetHttpProxy
setName(String name)
Name of the resource.



TargetHttpProxy
setProxyBind(Boolean proxyBind)
This field only applies when the forwarding rule that references this target proxy has a
 loadBalancingScheme set to INTERNAL_SELF_MANAGED.



TargetHttpProxy
setRegion(String region)
[Output Only] URL of the region where the regional Target HTTP Proxy resides.



TargetHttpProxy
setSelfLink(String selfLink)
[Output Only] Server-defined URL for the resource.



TargetHttpProxy
setUrlMap(String urlMap)
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














Constructor Detail





TargetHttpProxy
public TargetHttpProxy()









Method Detail





getCreationTimestamp
public String getCreationTimestamp()
[Output Only] Creation timestamp in RFC3339 text format.

Returns:
value or null for none








setCreationTimestamp
public TargetHttpProxy 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 TargetHttpProxy 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 TargetHttpProxy. An up-to-
 date fingerprint must be provided in order to patch/update the TargetHttpProxy; otherwise, the
 request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get()
 request to retrieve the TargetHttpProxy.

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 TargetHttpProxy. An up-to-
 date fingerprint must be provided in order to patch/update the TargetHttpProxy; otherwise, the
 request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get()
 request to retrieve the TargetHttpProxy.

Returns:
Base64 decoded value or null for none
Since:
1.14
See Also:
getFingerprint()








setFingerprint
public TargetHttpProxy 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 TargetHttpProxy. An up-to-
 date fingerprint must be provided in order to patch/update the TargetHttpProxy; otherwise, the
 request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get()
 request to retrieve the TargetHttpProxy.

Parameters:
fingerprint - fingerprint or null for none
See Also:
#encodeFingerprint()








encodeFingerprint
public TargetHttpProxy 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 TargetHttpProxy. An up-to-
 date fingerprint must be provided in order to patch/update the TargetHttpProxy; otherwise, the
 request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get()
 request to retrieve the TargetHttpProxy.

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 TargetHttpProxy 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 TargetHttpProxy 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#targetHttpProxy for target HTTP proxies.

Returns:
value or null for none








setKind
public TargetHttpProxy setKind(String kind)
[Output Only] Type of resource. Always compute#targetHttpProxy for target HTTP 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 TargetHttpProxy 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 TargetHttpProxy 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








getRegion
public String getRegion()
[Output Only] URL of the region where the regional Target HTTP Proxy resides. This field is not
 applicable to global Target HTTP Proxies.

Returns:
value or null for none








setRegion
public TargetHttpProxy setRegion(String region)
[Output Only] URL of the region where the regional Target HTTP Proxy resides. This field is not
 applicable to global Target HTTP Proxies.

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 TargetHttpProxy setSelfLink(String selfLink)
[Output Only] Server-defined URL for the resource.

Parameters:
selfLink - selfLink or null for none








getUrlMap
public String getUrlMap()
URL to the UrlMap resource that defines the mapping from URL to the BackendService.

Returns:
value or null for none








setUrlMap
public TargetHttpProxy setUrlMap(String urlMap)
URL to the UrlMap resource that defines the mapping from URL to the BackendService.

Parameters:
urlMap - urlMap or null for none








set
public TargetHttpProxy set(String fieldName,
                           Object value)

Overrides:
set in class com.google.api.client.json.GenericJson








clone
public TargetHttpProxy clone()

Overrides:
clone in class com.google.api.client.json.GenericJson














Skip navigation links




Overview
Package
Class
Use
Tree
Deprecated
Index
Help




Prev Class
Next Class


Frames
No Frames


All Classes






Summary: 
Nested | 
Field | 
Constr | 
Method


Detail: 
Field | 
Constr | 
Method






Copyright © 2011–2025 Google. All rights reserved.