Class TargetHttpProxy.Builder (1.29.0)

public static final class TargetHttpProxy.Builder extends GeneratedMessageV3.Builder<TargetHttpProxy.Builder> implements TargetHttpProxyOrBuilder

Represents a Target HTTP Proxy resource. Google Compute Engine has two Target HTTP Proxy resources: * Global * Regional A target HTTP proxy is a component of GCP HTTP load balancers. * targetHttpProxies are used by external HTTP load balancers and Traffic Director. * regionTargetHttpProxies are used by internal HTTP 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.

Protobuf type google.cloud.compute.v1.TargetHttpProxy

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public TargetHttpProxy.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
TargetHttpProxy.Builder
Overrides

build()

public TargetHttpProxy build()
Returns
TypeDescription
TargetHttpProxy

buildPartial()

public TargetHttpProxy buildPartial()
Returns
TypeDescription
TargetHttpProxy

clear()

public TargetHttpProxy.Builder clear()
Returns
TypeDescription
TargetHttpProxy.Builder
Overrides

clearCreationTimestamp()

public TargetHttpProxy.Builder clearCreationTimestamp()

[Output Only] Creation timestamp in RFC3339 text format.

optional string creation_timestamp = 30525366;

Returns
TypeDescription
TargetHttpProxy.Builder

This builder for chaining.

clearDescription()

public TargetHttpProxy.Builder clearDescription()

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

optional string description = 422937596;

Returns
TypeDescription
TargetHttpProxy.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public TargetHttpProxy.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
NameDescription
fieldFieldDescriptor
Returns
TypeDescription
TargetHttpProxy.Builder
Overrides

clearFingerprint()

public TargetHttpProxy.Builder clearFingerprint()

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.

optional string fingerprint = 234678500;

Returns
TypeDescription
TargetHttpProxy.Builder

This builder for chaining.

clearId()

public TargetHttpProxy.Builder clearId()

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

optional uint64 id = 3355;

Returns
TypeDescription
TargetHttpProxy.Builder

This builder for chaining.

clearKind()

public TargetHttpProxy.Builder clearKind()

[Output Only] Type of resource. Always compute#targetHttpProxy for target HTTP proxies.

optional string kind = 3292052;

Returns
TypeDescription
TargetHttpProxy.Builder

This builder for chaining.

clearName()

public TargetHttpProxy.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
TypeDescription
TargetHttpProxy.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public TargetHttpProxy.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
NameDescription
oneofOneofDescriptor
Returns
TypeDescription
TargetHttpProxy.Builder
Overrides

clearProxyBind()

public TargetHttpProxy.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
TypeDescription
TargetHttpProxy.Builder

This builder for chaining.

clearRegion()

public TargetHttpProxy.Builder clearRegion()

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

optional string region = 138946292;

Returns
TypeDescription
TargetHttpProxy.Builder

This builder for chaining.

public TargetHttpProxy.Builder clearSelfLink()

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

optional string self_link = 456214797;

Returns
TypeDescription
TargetHttpProxy.Builder

This builder for chaining.

clearUrlMap()

public TargetHttpProxy.Builder clearUrlMap()

URL to the UrlMap resource that defines the mapping from URL to the BackendService.

optional string url_map = 367020684;

Returns
TypeDescription
TargetHttpProxy.Builder

This builder for chaining.

clone()

public TargetHttpProxy.Builder clone()
Returns
TypeDescription
TargetHttpProxy.Builder
Overrides

getCreationTimestamp()

public String getCreationTimestamp()

[Output Only] Creation timestamp in RFC3339 text format.

optional string creation_timestamp = 30525366;

Returns
TypeDescription
String

The creationTimestamp.

getCreationTimestampBytes()

public ByteString getCreationTimestampBytes()

[Output Only] Creation timestamp in RFC3339 text format.

optional string creation_timestamp = 30525366;

Returns
TypeDescription
ByteString

The bytes for creationTimestamp.

getDefaultInstanceForType()

public TargetHttpProxy getDefaultInstanceForType()
Returns
TypeDescription
TargetHttpProxy

getDescription()

public String getDescription()

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

optional string description = 422937596;

Returns
TypeDescription
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
TypeDescription
ByteString

The bytes for description.

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
TypeDescription
Descriptor
Overrides

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.

optional string fingerprint = 234678500;

Returns
TypeDescription
String

The fingerprint.

getFingerprintBytes()

public ByteString getFingerprintBytes()

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.

optional string fingerprint = 234678500;

Returns
TypeDescription
ByteString

The bytes for fingerprint.

getId()

public long getId()

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

optional uint64 id = 3355;

Returns
TypeDescription
long

The id.

getKind()

public String getKind()

[Output Only] Type of resource. Always compute#targetHttpProxy for target HTTP proxies.

optional string kind = 3292052;

Returns
TypeDescription
String

The kind.

getKindBytes()

public ByteString getKindBytes()

[Output Only] Type of resource. Always compute#targetHttpProxy for target HTTP proxies.

optional string kind = 3292052;

Returns
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
boolean

The proxyBind.

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.

optional string region = 138946292;

Returns
TypeDescription
String

The region.

getRegionBytes()

public ByteString getRegionBytes()

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

optional string region = 138946292;

Returns
TypeDescription
ByteString

The bytes for region.

public String getSelfLink()

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

optional string self_link = 456214797;

Returns
TypeDescription
String

The selfLink.

getSelfLinkBytes()

public ByteString getSelfLinkBytes()

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

optional string self_link = 456214797;

Returns
TypeDescription
ByteString

The bytes for selfLink.

getUrlMap()

public String getUrlMap()

URL to the UrlMap resource that defines the mapping from URL to the BackendService.

optional string url_map = 367020684;

Returns
TypeDescription
String

The urlMap.

getUrlMapBytes()

public ByteString getUrlMapBytes()

URL to the UrlMap resource that defines the mapping from URL to the BackendService.

optional string url_map = 367020684;

Returns
TypeDescription
ByteString

The bytes for urlMap.

hasCreationTimestamp()

public boolean hasCreationTimestamp()

[Output Only] Creation timestamp in RFC3339 text format.

optional string creation_timestamp = 30525366;

Returns
TypeDescription
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
TypeDescription
boolean

Whether the description field is set.

hasFingerprint()

public boolean hasFingerprint()

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.

optional string fingerprint = 234678500;

Returns
TypeDescription
boolean

Whether the fingerprint 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
TypeDescription
boolean

Whether the id field is set.

hasKind()

public boolean hasKind()

[Output Only] Type of resource. Always compute#targetHttpProxy for target HTTP proxies.

optional string kind = 3292052;

Returns
TypeDescription
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
TypeDescription
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
TypeDescription
boolean

Whether the proxyBind field is set.

hasRegion()

public boolean hasRegion()

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

optional string region = 138946292;

Returns
TypeDescription
boolean

Whether the region field is set.

public boolean hasSelfLink()

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

optional string self_link = 456214797;

Returns
TypeDescription
boolean

Whether the selfLink field is set.

hasUrlMap()

public boolean hasUrlMap()

URL to the UrlMap resource that defines the mapping from URL to the BackendService.

optional string url_map = 367020684;

Returns
TypeDescription
boolean

Whether the urlMap field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

mergeFrom(TargetHttpProxy other)

public TargetHttpProxy.Builder mergeFrom(TargetHttpProxy other)
Parameter
NameDescription
otherTargetHttpProxy
Returns
TypeDescription
TargetHttpProxy.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public TargetHttpProxy.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
TargetHttpProxy.Builder
Overrides
Exceptions
TypeDescription
IOException

mergeFrom(Message other)

public TargetHttpProxy.Builder mergeFrom(Message other)
Parameter
NameDescription
otherMessage
Returns
TypeDescription
TargetHttpProxy.Builder
Overrides

mergeUnknownFields(UnknownFieldSet unknownFields)

public final TargetHttpProxy.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
TargetHttpProxy.Builder
Overrides

setCreationTimestamp(String value)

public TargetHttpProxy.Builder setCreationTimestamp(String value)

[Output Only] Creation timestamp in RFC3339 text format.

optional string creation_timestamp = 30525366;

Parameter
NameDescription
valueString

The creationTimestamp to set.

Returns
TypeDescription
TargetHttpProxy.Builder

This builder for chaining.

setCreationTimestampBytes(ByteString value)

public TargetHttpProxy.Builder setCreationTimestampBytes(ByteString value)

[Output Only] Creation timestamp in RFC3339 text format.

optional string creation_timestamp = 30525366;

Parameter
NameDescription
valueByteString

The bytes for creationTimestamp to set.

Returns
TypeDescription
TargetHttpProxy.Builder

This builder for chaining.

setDescription(String value)

public TargetHttpProxy.Builder setDescription(String value)

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

optional string description = 422937596;

Parameter
NameDescription
valueString

The description to set.

Returns
TypeDescription
TargetHttpProxy.Builder

This builder for chaining.

setDescriptionBytes(ByteString value)

public TargetHttpProxy.Builder setDescriptionBytes(ByteString value)

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

optional string description = 422937596;

Parameter
NameDescription
valueByteString

The bytes for description to set.

Returns
TypeDescription
TargetHttpProxy.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public TargetHttpProxy.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
TargetHttpProxy.Builder
Overrides

setFingerprint(String value)

public TargetHttpProxy.Builder setFingerprint(String value)

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.

optional string fingerprint = 234678500;

Parameter
NameDescription
valueString

The fingerprint to set.

Returns
TypeDescription
TargetHttpProxy.Builder

This builder for chaining.

setFingerprintBytes(ByteString value)

public TargetHttpProxy.Builder setFingerprintBytes(ByteString value)

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.

optional string fingerprint = 234678500;

Parameter
NameDescription
valueByteString

The bytes for fingerprint to set.

Returns
TypeDescription
TargetHttpProxy.Builder

This builder for chaining.

setId(long value)

public TargetHttpProxy.Builder setId(long value)

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

optional uint64 id = 3355;

Parameter
NameDescription
valuelong

The id to set.

Returns
TypeDescription
TargetHttpProxy.Builder

This builder for chaining.

setKind(String value)

public TargetHttpProxy.Builder setKind(String value)

[Output Only] Type of resource. Always compute#targetHttpProxy for target HTTP proxies.

optional string kind = 3292052;

Parameter
NameDescription
valueString

The kind to set.

Returns
TypeDescription
TargetHttpProxy.Builder

This builder for chaining.

setKindBytes(ByteString value)

public TargetHttpProxy.Builder setKindBytes(ByteString value)

[Output Only] Type of resource. Always compute#targetHttpProxy for target HTTP proxies.

optional string kind = 3292052;

Parameter
NameDescription
valueByteString

The bytes for kind to set.

Returns
TypeDescription
TargetHttpProxy.Builder

This builder for chaining.

setName(String value)

public TargetHttpProxy.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
NameDescription
valueString

The name to set.

Returns
TypeDescription
TargetHttpProxy.Builder

This builder for chaining.

setNameBytes(ByteString value)

public TargetHttpProxy.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
NameDescription
valueByteString

The bytes for name to set.

Returns
TypeDescription
TargetHttpProxy.Builder

This builder for chaining.

setProxyBind(boolean value)

public TargetHttpProxy.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
NameDescription
valueboolean

The proxyBind to set.

Returns
TypeDescription
TargetHttpProxy.Builder

This builder for chaining.

setRegion(String value)

public TargetHttpProxy.Builder setRegion(String value)

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

optional string region = 138946292;

Parameter
NameDescription
valueString

The region to set.

Returns
TypeDescription
TargetHttpProxy.Builder

This builder for chaining.

setRegionBytes(ByteString value)

public TargetHttpProxy.Builder setRegionBytes(ByteString value)

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

optional string region = 138946292;

Parameter
NameDescription
valueByteString

The bytes for region to set.

Returns
TypeDescription
TargetHttpProxy.Builder

This builder for chaining.

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

public TargetHttpProxy.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
NameDescription
fieldFieldDescriptor
indexint
valueObject
Returns
TypeDescription
TargetHttpProxy.Builder
Overrides
public TargetHttpProxy.Builder setSelfLink(String value)

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

optional string self_link = 456214797;

Parameter
NameDescription
valueString

The selfLink to set.

Returns
TypeDescription
TargetHttpProxy.Builder

This builder for chaining.

setSelfLinkBytes(ByteString value)

public TargetHttpProxy.Builder setSelfLinkBytes(ByteString value)

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

optional string self_link = 456214797;

Parameter
NameDescription
valueByteString

The bytes for selfLink to set.

Returns
TypeDescription
TargetHttpProxy.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final TargetHttpProxy.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
TargetHttpProxy.Builder
Overrides

setUrlMap(String value)

public TargetHttpProxy.Builder setUrlMap(String value)

URL to the UrlMap resource that defines the mapping from URL to the BackendService.

optional string url_map = 367020684;

Parameter
NameDescription
valueString

The urlMap to set.

Returns
TypeDescription
TargetHttpProxy.Builder

This builder for chaining.

setUrlMapBytes(ByteString value)

public TargetHttpProxy.Builder setUrlMapBytes(ByteString value)

URL to the UrlMap resource that defines the mapping from URL to the BackendService.

optional string url_map = 367020684;

Parameter
NameDescription
valueByteString

The bytes for urlMap to set.

Returns
TypeDescription
TargetHttpProxy.Builder

This builder for chaining.