Class TargetTcpProxy.Builder (1.56.0)

public static final class TargetTcpProxy.Builder extends GeneratedMessageV3.Builder<TargetTcpProxy.Builder> implements TargetTcpProxyOrBuilder

Represents a Target TCP Proxy resource. A target TCP proxy is a component of a Proxy Network Load Balancer. The forwarding rule references the target TCP proxy, and the target proxy then references a backend service. For more information, read Proxy Network Load Balancer overview.

Protobuf type google.cloud.compute.v1.TargetTcpProxy

Static Methods

getDescriptor()

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

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

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

build()

public TargetTcpProxy build()
Returns
Type Description
TargetTcpProxy

buildPartial()

public TargetTcpProxy buildPartial()
Returns
Type Description
TargetTcpProxy

clear()

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

clearCreationTimestamp()

public TargetTcpProxy.Builder clearCreationTimestamp()

[Output Only] Creation timestamp in RFC3339 text format.

optional string creation_timestamp = 30525366;

Returns
Type Description
TargetTcpProxy.Builder

This builder for chaining.

clearDescription()

public TargetTcpProxy.Builder clearDescription()

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

optional string description = 422937596;

Returns
Type Description
TargetTcpProxy.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

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

clearId()

public TargetTcpProxy.Builder clearId()

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

optional uint64 id = 3355;

Returns
Type Description
TargetTcpProxy.Builder

This builder for chaining.

clearKind()

public TargetTcpProxy.Builder clearKind()

[Output Only] Type of the resource. Always compute#targetTcpProxy for target TCP proxies.

optional string kind = 3292052;

Returns
Type Description
TargetTcpProxy.Builder

This builder for chaining.

clearName()

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

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

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

clearProxyBind()

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

This builder for chaining.

clearProxyHeader()

public TargetTcpProxy.Builder clearProxyHeader()

Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE. Check the ProxyHeader enum for the list of possible values.

optional string proxy_header = 160374142;

Returns
Type Description
TargetTcpProxy.Builder

This builder for chaining.

clearRegion()

public TargetTcpProxy.Builder clearRegion()

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

optional string region = 138946292;

Returns
Type Description
TargetTcpProxy.Builder

This builder for chaining.

public TargetTcpProxy.Builder clearSelfLink()

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

optional string self_link = 456214797;

Returns
Type Description
TargetTcpProxy.Builder

This builder for chaining.

clearService()

public TargetTcpProxy.Builder clearService()

URL to the BackendService resource.

optional string service = 373540533;

Returns
Type Description
TargetTcpProxy.Builder

This builder for chaining.

clone()

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

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 TargetTcpProxy getDefaultInstanceForType()
Returns
Type Description
TargetTcpProxy

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

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

optional string kind = 3292052;

Returns
Type Description
String

The kind.

getKindBytes()

public ByteString getKindBytes()

[Output Only] Type of the resource. Always compute#targetTcpProxy for target TCP 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.

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

optional string proxy_header = 160374142;

Returns
Type Description
String

The proxyHeader.

getProxyHeaderBytes()

public ByteString getProxyHeaderBytes()

Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE. Check the ProxyHeader enum for the list of possible values.

optional string proxy_header = 160374142;

Returns
Type Description
ByteString

The bytes for proxyHeader.

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.

optional string region = 138946292;

Returns
Type Description
String

The region.

getRegionBytes()

public ByteString getRegionBytes()

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

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.

getService()

public String getService()

URL to the BackendService resource.

optional string service = 373540533;

Returns
Type Description
String

The service.

getServiceBytes()

public ByteString getServiceBytes()

URL to the BackendService resource.

optional string service = 373540533;

Returns
Type Description
ByteString

The bytes for service.

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.

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 the resource. Always compute#targetTcpProxy for target TCP 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.

hasProxyHeader()

public boolean hasProxyHeader()

Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE. Check the ProxyHeader enum for the list of possible values.

optional string proxy_header = 160374142;

Returns
Type Description
boolean

Whether the proxyHeader field is set.

hasRegion()

public boolean hasRegion()

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

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.

hasService()

public boolean hasService()

URL to the BackendService resource.

optional string service = 373540533;

Returns
Type Description
boolean

Whether the service field is set.

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(TargetTcpProxy other)

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

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

mergeFrom(Message other)

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

mergeUnknownFields(UnknownFieldSet unknownFields)

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

setCreationTimestamp(String value)

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

This builder for chaining.

setCreationTimestampBytes(ByteString value)

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

This builder for chaining.

setDescription(String value)

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

This builder for chaining.

setDescriptionBytes(ByteString value)

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

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

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

setId(long value)

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

This builder for chaining.

setKind(String value)

public TargetTcpProxy.Builder setKind(String value)

[Output Only] Type of the resource. Always compute#targetTcpProxy for target TCP proxies.

optional string kind = 3292052;

Parameter
Name Description
value String

The kind to set.

Returns
Type Description
TargetTcpProxy.Builder

This builder for chaining.

setKindBytes(ByteString value)

public TargetTcpProxy.Builder setKindBytes(ByteString value)

[Output Only] Type of the resource. Always compute#targetTcpProxy for target TCP proxies.

optional string kind = 3292052;

Parameter
Name Description
value ByteString

The bytes for kind to set.

Returns
Type Description
TargetTcpProxy.Builder

This builder for chaining.

setName(String value)

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

This builder for chaining.

setNameBytes(ByteString value)

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

This builder for chaining.

setProxyBind(boolean value)

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

This builder for chaining.

setProxyHeader(String value)

public TargetTcpProxy.Builder setProxyHeader(String value)

Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE. Check the ProxyHeader enum for the list of possible values.

optional string proxy_header = 160374142;

Parameter
Name Description
value String

The proxyHeader to set.

Returns
Type Description
TargetTcpProxy.Builder

This builder for chaining.

setProxyHeaderBytes(ByteString value)

public TargetTcpProxy.Builder setProxyHeaderBytes(ByteString value)

Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE. Check the ProxyHeader enum for the list of possible values.

optional string proxy_header = 160374142;

Parameter
Name Description
value ByteString

The bytes for proxyHeader to set.

Returns
Type Description
TargetTcpProxy.Builder

This builder for chaining.

setRegion(String value)

public TargetTcpProxy.Builder setRegion(String value)

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

optional string region = 138946292;

Parameter
Name Description
value String

The region to set.

Returns
Type Description
TargetTcpProxy.Builder

This builder for chaining.

setRegionBytes(ByteString value)

public TargetTcpProxy.Builder setRegionBytes(ByteString value)

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

optional string region = 138946292;

Parameter
Name Description
value ByteString

The bytes for region to set.

Returns
Type Description
TargetTcpProxy.Builder

This builder for chaining.

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

public TargetTcpProxy.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
TargetTcpProxy.Builder
Overrides
public TargetTcpProxy.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
TargetTcpProxy.Builder

This builder for chaining.

setSelfLinkBytes(ByteString value)

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

This builder for chaining.

setService(String value)

public TargetTcpProxy.Builder setService(String value)

URL to the BackendService resource.

optional string service = 373540533;

Parameter
Name Description
value String

The service to set.

Returns
Type Description
TargetTcpProxy.Builder

This builder for chaining.

setServiceBytes(ByteString value)

public TargetTcpProxy.Builder setServiceBytes(ByteString value)

URL to the BackendService resource.

optional string service = 373540533;

Parameter
Name Description
value ByteString

The bytes for service to set.

Returns
Type Description
TargetTcpProxy.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

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