Class TargetGrpcProxy.Builder (1.56.0)

public static final class TargetGrpcProxy.Builder extends GeneratedMessageV3.Builder<TargetGrpcProxy.Builder> implements TargetGrpcProxyOrBuilder

Represents a Target gRPC Proxy resource. A target gRPC proxy is a component of load balancers intended for load balancing gRPC traffic. Only global forwarding rules with load balancing scheme INTERNAL_SELF_MANAGED can reference a target gRPC proxy. The target gRPC Proxy references a URL map that specifies how traffic is routed to gRPC backend services.

Protobuf type google.cloud.compute.v1.TargetGrpcProxy

Static Methods

getDescriptor()

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

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

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

build()

public TargetGrpcProxy build()
Returns
Type Description
TargetGrpcProxy

buildPartial()

public TargetGrpcProxy buildPartial()
Returns
Type Description
TargetGrpcProxy

clear()

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

clearCreationTimestamp()

public TargetGrpcProxy.Builder clearCreationTimestamp()

[Output Only] Creation timestamp in RFC3339 text format.

optional string creation_timestamp = 30525366;

Returns
Type Description
TargetGrpcProxy.Builder

This builder for chaining.

clearDescription()

public TargetGrpcProxy.Builder clearDescription()

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

optional string description = 422937596;

Returns
Type Description
TargetGrpcProxy.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

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

clearFingerprint()

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

optional string fingerprint = 234678500;

Returns
Type Description
TargetGrpcProxy.Builder

This builder for chaining.

clearId()

public TargetGrpcProxy.Builder clearId()

[Output Only] The unique identifier for the resource type. The server generates this identifier.

optional uint64 id = 3355;

Returns
Type Description
TargetGrpcProxy.Builder

This builder for chaining.

clearKind()

public TargetGrpcProxy.Builder clearKind()

[Output Only] Type of the resource. Always compute#targetGrpcProxy for target grpc proxies.

optional string kind = 3292052;

Returns
Type Description
TargetGrpcProxy.Builder

This builder for chaining.

clearName()

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

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

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

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

optional string self_link = 456214797;

Returns
Type Description
TargetGrpcProxy.Builder

This builder for chaining.

clearSelfLinkWithId()

public TargetGrpcProxy.Builder clearSelfLinkWithId()

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

optional string self_link_with_id = 44520962;

Returns
Type Description
TargetGrpcProxy.Builder

This builder for chaining.

clearUrlMap()

public TargetGrpcProxy.Builder clearUrlMap()

URL to the UrlMap resource that defines the mapping from URL to the BackendService. The protocol field in the BackendService must be set to GRPC.

optional string url_map = 367020684;

Returns
Type Description
TargetGrpcProxy.Builder

This builder for chaining.

clearValidateForProxyless()

public TargetGrpcProxy.Builder clearValidateForProxyless()

If true, indicates that the BackendServices referenced by the urlMap may be accessed by gRPC applications without using a sidecar proxy. This will enable configuration checks on urlMap and its referenced BackendServices to not allow unsupported features. A gRPC application must use "xds:///" scheme in the target URI of the service it is connecting to. If false, indicates that the BackendServices referenced by the urlMap will be accessed by gRPC applications via a sidecar proxy. In this case, a gRPC application must not use "xds:///" scheme in the target URI of the service it is connecting to

optional bool validate_for_proxyless = 101822888;

Returns
Type Description
TargetGrpcProxy.Builder

This builder for chaining.

clone()

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

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

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

optional string fingerprint = 234678500;

Returns
Type Description
ByteString

The bytes for fingerprint.

getId()

public long getId()

[Output Only] The unique identifier for the resource type. The server generates this identifier.

optional uint64 id = 3355;

Returns
Type Description
long

The id.

getKind()

public String getKind()

[Output Only] Type of the resource. Always compute#targetGrpcProxy for target grpc proxies.

optional string kind = 3292052;

Returns
Type Description
String

The kind.

getKindBytes()

public ByteString getKindBytes()

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

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.

getSelfLinkWithId()

public String getSelfLinkWithId()

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

optional string self_link_with_id = 44520962;

Returns
Type Description
String

The selfLinkWithId.

getSelfLinkWithIdBytes()

public ByteString getSelfLinkWithIdBytes()

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

optional string self_link_with_id = 44520962;

Returns
Type Description
ByteString

The bytes for selfLinkWithId.

getUrlMap()

public String getUrlMap()

URL to the UrlMap resource that defines the mapping from URL to the BackendService. The protocol field in the BackendService must be set to GRPC.

optional string url_map = 367020684;

Returns
Type Description
String

The urlMap.

getUrlMapBytes()

public ByteString getUrlMapBytes()

URL to the UrlMap resource that defines the mapping from URL to the BackendService. The protocol field in the BackendService must be set to GRPC.

optional string url_map = 367020684;

Returns
Type Description
ByteString

The bytes for urlMap.

getValidateForProxyless()

public boolean getValidateForProxyless()

If true, indicates that the BackendServices referenced by the urlMap may be accessed by gRPC applications without using a sidecar proxy. This will enable configuration checks on urlMap and its referenced BackendServices to not allow unsupported features. A gRPC application must use "xds:///" scheme in the target URI of the service it is connecting to. If false, indicates that the BackendServices referenced by the urlMap will be accessed by gRPC applications via a sidecar proxy. In this case, a gRPC application must not use "xds:///" scheme in the target URI of the service it is connecting to

optional bool validate_for_proxyless = 101822888;

Returns
Type Description
boolean

The validateForProxyless.

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.

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

optional string fingerprint = 234678500;

Returns
Type Description
boolean

Whether the fingerprint field is set.

hasId()

public boolean hasId()

[Output Only] The unique identifier for the resource type. The server generates this identifier.

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#targetGrpcProxy for target grpc 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.

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.

hasSelfLinkWithId()

public boolean hasSelfLinkWithId()

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

optional string self_link_with_id = 44520962;

Returns
Type Description
boolean

Whether the selfLinkWithId field is set.

hasUrlMap()

public boolean hasUrlMap()

URL to the UrlMap resource that defines the mapping from URL to the BackendService. The protocol field in the BackendService must be set to GRPC.

optional string url_map = 367020684;

Returns
Type Description
boolean

Whether the urlMap field is set.

hasValidateForProxyless()

public boolean hasValidateForProxyless()

If true, indicates that the BackendServices referenced by the urlMap may be accessed by gRPC applications without using a sidecar proxy. This will enable configuration checks on urlMap and its referenced BackendServices to not allow unsupported features. A gRPC application must use "xds:///" scheme in the target URI of the service it is connecting to. If false, indicates that the BackendServices referenced by the urlMap will be accessed by gRPC applications via a sidecar proxy. In this case, a gRPC application must not use "xds:///" scheme in the target URI of the service it is connecting to

optional bool validate_for_proxyless = 101822888;

Returns
Type Description
boolean

Whether the validateForProxyless field is set.

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(TargetGrpcProxy other)

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

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

mergeFrom(Message other)

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

mergeUnknownFields(UnknownFieldSet unknownFields)

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

setCreationTimestamp(String value)

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

This builder for chaining.

setCreationTimestampBytes(ByteString value)

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

This builder for chaining.

setDescription(String value)

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

This builder for chaining.

setDescriptionBytes(ByteString value)

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

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

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

setFingerprint(String value)

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

optional string fingerprint = 234678500;

Parameter
Name Description
value String

The fingerprint to set.

Returns
Type Description
TargetGrpcProxy.Builder

This builder for chaining.

setFingerprintBytes(ByteString value)

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

optional string fingerprint = 234678500;

Parameter
Name Description
value ByteString

The bytes for fingerprint to set.

Returns
Type Description
TargetGrpcProxy.Builder

This builder for chaining.

setId(long value)

public TargetGrpcProxy.Builder setId(long value)

[Output Only] The unique identifier for the resource type. The server generates this identifier.

optional uint64 id = 3355;

Parameter
Name Description
value long

The id to set.

Returns
Type Description
TargetGrpcProxy.Builder

This builder for chaining.

setKind(String value)

public TargetGrpcProxy.Builder setKind(String value)

[Output Only] Type of the resource. Always compute#targetGrpcProxy for target grpc proxies.

optional string kind = 3292052;

Parameter
Name Description
value String

The kind to set.

Returns
Type Description
TargetGrpcProxy.Builder

This builder for chaining.

setKindBytes(ByteString value)

public TargetGrpcProxy.Builder setKindBytes(ByteString value)

[Output Only] Type of the resource. Always compute#targetGrpcProxy for target grpc proxies.

optional string kind = 3292052;

Parameter
Name Description
value ByteString

The bytes for kind to set.

Returns
Type Description
TargetGrpcProxy.Builder

This builder for chaining.

setName(String value)

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

This builder for chaining.

setNameBytes(ByteString value)

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

This builder for chaining.

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

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

This builder for chaining.

setSelfLinkBytes(ByteString value)

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

This builder for chaining.

setSelfLinkWithId(String value)

public TargetGrpcProxy.Builder setSelfLinkWithId(String value)

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

optional string self_link_with_id = 44520962;

Parameter
Name Description
value String

The selfLinkWithId to set.

Returns
Type Description
TargetGrpcProxy.Builder

This builder for chaining.

setSelfLinkWithIdBytes(ByteString value)

public TargetGrpcProxy.Builder setSelfLinkWithIdBytes(ByteString value)

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

optional string self_link_with_id = 44520962;

Parameter
Name Description
value ByteString

The bytes for selfLinkWithId to set.

Returns
Type Description
TargetGrpcProxy.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

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

setUrlMap(String value)

public TargetGrpcProxy.Builder setUrlMap(String value)

URL to the UrlMap resource that defines the mapping from URL to the BackendService. The protocol field in the BackendService must be set to GRPC.

optional string url_map = 367020684;

Parameter
Name Description
value String

The urlMap to set.

Returns
Type Description
TargetGrpcProxy.Builder

This builder for chaining.

setUrlMapBytes(ByteString value)

public TargetGrpcProxy.Builder setUrlMapBytes(ByteString value)

URL to the UrlMap resource that defines the mapping from URL to the BackendService. The protocol field in the BackendService must be set to GRPC.

optional string url_map = 367020684;

Parameter
Name Description
value ByteString

The bytes for urlMap to set.

Returns
Type Description
TargetGrpcProxy.Builder

This builder for chaining.

setValidateForProxyless(boolean value)

public TargetGrpcProxy.Builder setValidateForProxyless(boolean value)

If true, indicates that the BackendServices referenced by the urlMap may be accessed by gRPC applications without using a sidecar proxy. This will enable configuration checks on urlMap and its referenced BackendServices to not allow unsupported features. A gRPC application must use "xds:///" scheme in the target URI of the service it is connecting to. If false, indicates that the BackendServices referenced by the urlMap will be accessed by gRPC applications via a sidecar proxy. In this case, a gRPC application must not use "xds:///" scheme in the target URI of the service it is connecting to

optional bool validate_for_proxyless = 101822888;

Parameter
Name Description
value boolean

The validateForProxyless to set.

Returns
Type Description
TargetGrpcProxy.Builder

This builder for chaining.