Class TargetHttpProxy.Builder (1.88.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 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.

Protobuf type google.cloud.compute.v1.TargetHttpProxy

Static Methods

getDescriptor()

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

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

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

build()

public TargetHttpProxy build()
Returns
Type Description
TargetHttpProxy

buildPartial()

public TargetHttpProxy buildPartial()
Returns
Type Description
TargetHttpProxy

clear()

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

clearCreationTimestamp()

public TargetHttpProxy.Builder clearCreationTimestamp()

[Output Only] Creation timestamp in RFC3339 text format.

optional string creation_timestamp = 30525366;

Returns
Type Description
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
Type Description
TargetHttpProxy.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public TargetHttpProxy.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
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
Type Description
TargetHttpProxy.Builder

This builder for chaining.

clearHttpKeepAliveTimeoutSec()

public TargetHttpProxy.Builder clearHttpKeepAliveTimeoutSec()

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.

optional int32 http_keep_alive_timeout_sec = 447326046;

Returns
Type Description
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
Type Description
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
Type Description
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
Type Description
TargetHttpProxy.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public TargetHttpProxy.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
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
Type Description
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
Type Description
TargetHttpProxy.Builder

This builder for chaining.

public TargetHttpProxy.Builder clearSelfLink()

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

optional string self_link = 456214797;

Returns
Type Description
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
Type Description
TargetHttpProxy.Builder

This builder for chaining.

clone()

public TargetHttpProxy.Builder clone()
Returns
Type Description
TargetHttpProxy.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 TargetHttpProxy getDefaultInstanceForType()
Returns
Type Description
TargetHttpProxy

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

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
Type Description
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
Type Description
ByteString

The bytes for fingerprint.

getHttpKeepAliveTimeoutSec()

public int 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.

optional int32 http_keep_alive_timeout_sec = 447326046;

Returns
Type Description
int

The httpKeepAliveTimeoutSec.

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 resource. Always compute#targetHttpProxy for target HTTP proxies.

optional string kind = 3292052;

Returns
Type Description
String

The kind.

getKindBytes()

public ByteString getKindBytes()

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