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

Go to download







TargetTcpProxy (Compute Engine API beta-rev20220726-2.0.0)











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 TargetTcpProxy



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













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




public final class TargetTcpProxy
extends GenericJson
Represents a Target TCP Proxy resource. A target TCP proxy is a component of a TCP Proxy load
 balancer. Global forwarding rules reference target TCP proxy, and the target proxy then
 references an external backend service. For more information, read TCP Proxy Load Balancing
 overview.

  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>





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








Constructor Summary

Constructors 

Constructor and Description


TargetTcpProxy() 









Method Summary

All Methods Instance Methods Concrete Methods 

Modifier and Type
Method and Description


TargetTcpProxy
clone() 


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



String
getDescription()
An optional description of this resource.



BigInteger
getId()
[Output Only] The unique identifier for the resource.



String
getKind()
[Output Only] Type of the 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
getProxyHeader()
Specifies the type of proxy header to append before sending data to the backend, either NONE or
 PROXY_V1.



String
getRegion()
[Output Only] URL of the region where the regional TCP proxy resides.



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



String
getService()
URL to the BackendService resource.



TargetTcpProxy
set(String fieldName,
   Object value) 


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



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



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



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



TargetTcpProxy
setName(String name)
Name of the resource.



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



TargetTcpProxy
setProxyHeader(String proxyHeader)
Specifies the type of proxy header to append before sending data to the backend, either NONE or
 PROXY_V1.



TargetTcpProxy
setRegion(String region)
[Output Only] URL of the region where the regional TCP proxy resides.



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



TargetTcpProxy
setService(String service)
URL to the BackendService resource.







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





TargetTcpProxy
public TargetTcpProxy()









Method Detail





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

Returns:
value or null for none








setCreationTimestamp
public TargetTcpProxy 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 TargetTcpProxy setDescription(String description)
An optional description of this resource. Provide this property when you create the resource.

Parameters:
description - description 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 TargetTcpProxy 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 the resource. Always compute#targetTcpProxy for target TCP proxies.

Returns:
value or null for none








setKind
public TargetTcpProxy setKind(String kind)
[Output Only] Type of the resource. Always compute#targetTcpProxy for target TCP 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 TargetTcpProxy 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 TargetTcpProxy 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








getProxyHeader
public String getProxyHeader()
Specifies the type of proxy header to append before sending data to the backend, either NONE or
 PROXY_V1. The default is NONE.

Returns:
value or null for none








setProxyHeader
public TargetTcpProxy setProxyHeader(String proxyHeader)
Specifies the type of proxy header to append before sending data to the backend, either NONE or
 PROXY_V1. The default is NONE.

Parameters:
proxyHeader - proxyHeader or null for none








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

Returns:
value or null for none








setRegion
public TargetTcpProxy setRegion(String region)
[Output Only] URL of the region where the regional TCP proxy resides. This field is not
 applicable to global TCP proxy.

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

Parameters:
selfLink - selfLink or null for none








getService
public String getService()
URL to the BackendService resource.

Returns:
value or null for none








setService
public TargetTcpProxy setService(String service)
URL to the BackendService resource.

Parameters:
service - service or null for none








set
public TargetTcpProxy set(String fieldName,
                          Object value)

Overrides:
set in class GenericJson








clone
public TargetTcpProxy clone()

Overrides:
clone in class 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–2022 Google. All rights reserved.

Modifier and Type	Method and Description
`TargetTcpProxy`	`clone()`
`String`	`getCreationTimestamp()` [Output Only] Creation timestamp in RFC3339 text format.
`String`	`getDescription()` An optional description of this resource.
`BigInteger`	`getId()` [Output Only] The unique identifier for the resource.
`String`	`getKind()` [Output Only] Type of the 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`	`getProxyHeader()` Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1.
`String`	`getRegion()` [Output Only] URL of the region where the regional TCP proxy resides.
`String`	`getSelfLink()` [Output Only] Server-defined URL for the resource.
`String`	`getService()` URL to the BackendService resource.
`TargetTcpProxy`	`set(String fieldName, Object value)`
`TargetTcpProxy`	`setCreationTimestamp(String creationTimestamp)` [Output Only] Creation timestamp in RFC3339 text format.
`TargetTcpProxy`	`setDescription(String description)` An optional description of this resource.
`TargetTcpProxy`	`setId(BigInteger id)` [Output Only] The unique identifier for the resource.
`TargetTcpProxy`	`setKind(String kind)` [Output Only] Type of the resource.
`TargetTcpProxy`	`setName(String name)` Name of the resource.
`TargetTcpProxy`	`setProxyBind(Boolean proxyBind)` This field only applies when the forwarding rule that references this target proxy has a loadBalancingScheme set to INTERNAL_SELF_MANAGED.
`TargetTcpProxy`	`setProxyHeader(String proxyHeader)` Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1.
`TargetTcpProxy`	`setRegion(String region)` [Output Only] URL of the region where the regional TCP proxy resides.
`TargetTcpProxy`	`setSelfLink(String selfLink)` [Output Only] Server-defined URL for the resource.
`TargetTcpProxy`	`setService(String service)` URL to the BackendService resource.