Reference documentation and code samples for the Compute V1 Client class TargetGrpcProxy.
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.
Generated from protobuf messagegoogle.cloud.compute.v1.TargetGrpcProxy
Namespace
Google \ Cloud \ Compute \ V1
Methods
__construct
Constructor.
Parameters
Name
Description
data
array
Optional. Data for populating the Message object.
↳ creation_timestamp
string
[Output Only] Creation timestamp in RFC3339 text format.
↳ description
string
An optional description of this resource. Provide this property when you create the resource.
↳ fingerprint
string
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.
↳ id
int|string
[Output Only] The unique identifier for the resource type. The server generates this identifier.
↳ kind
string
[Output Only] Type of the resource. Always compute#targetGrpcProxy for target grpc proxies.
↳ name
string
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.
↳ self_link
string
[Output Only] Server-defined URL for the resource.
↳ self_link_with_id
string
[Output Only] Server-defined URL with id for the resource.
↳ url_map
string
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.
↳ validate_for_proxyless
bool
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
getCreationTimestamp
[Output Only] Creation timestamp in RFC3339 text format.
Returns
Type
Description
string
hasCreationTimestamp
clearCreationTimestamp
setCreationTimestamp
[Output Only] Creation timestamp in RFC3339 text format.
Parameter
Name
Description
var
string
Returns
Type
Description
$this
getDescription
An optional description of this resource. Provide this property when you create the resource.
Returns
Type
Description
string
hasDescription
clearDescription
setDescription
An optional description of this resource. Provide this property when you create the resource.
Parameter
Name
Description
var
string
Returns
Type
Description
$this
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.
Returns
Type
Description
string
hasFingerprint
clearFingerprint
setFingerprint
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.
Parameter
Name
Description
var
string
Returns
Type
Description
$this
getId
[Output Only] The unique identifier for the resource type. The server generates this identifier.
Returns
Type
Description
int|string
hasId
clearId
setId
[Output Only] The unique identifier for the resource type. The server generates this identifier.
Parameter
Name
Description
var
int|string
Returns
Type
Description
$this
getKind
[Output Only] Type of the resource. Always compute#targetGrpcProxy for target grpc proxies.
Returns
Type
Description
string
hasKind
clearKind
setKind
[Output Only] Type of the resource. Always compute#targetGrpcProxy for target grpc proxies.
Parameter
Name
Description
var
string
Returns
Type
Description
$this
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
Type
Description
string
hasName
clearName
setName
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.
Parameter
Name
Description
var
string
Returns
Type
Description
$this
getSelfLink
[Output Only] Server-defined URL for the resource.
Returns
Type
Description
string
hasSelfLink
clearSelfLink
setSelfLink
[Output Only] Server-defined URL for the resource.
Parameter
Name
Description
var
string
Returns
Type
Description
$this
getSelfLinkWithId
[Output Only] Server-defined URL with id for the resource.
Returns
Type
Description
string
hasSelfLinkWithId
clearSelfLinkWithId
setSelfLinkWithId
[Output Only] Server-defined URL with id for the resource.
Parameter
Name
Description
var
string
Returns
Type
Description
$this
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.
Returns
Type
Description
string
hasUrlMap
clearUrlMap
setUrlMap
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.
Parameter
Name
Description
var
string
Returns
Type
Description
$this
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
Returns
Type
Description
bool
hasValidateForProxyless
clearValidateForProxyless
setValidateForProxyless
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
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-09-04 UTC."],[],[],null,["# Compute V1 Client - Class TargetGrpcProxy (1.35.0)\n\nVersion latestkeyboard_arrow_down\n\n- [1.35.0 (latest)](/php/docs/reference/cloud-compute/latest/V1.TargetGrpcProxy)\n- [1.34.0](/php/docs/reference/cloud-compute/1.34.0/V1.TargetGrpcProxy)\n- [1.33.0](/php/docs/reference/cloud-compute/1.33.0/V1.TargetGrpcProxy)\n- [1.32.0](/php/docs/reference/cloud-compute/1.32.0/V1.TargetGrpcProxy)\n- [1.31.0](/php/docs/reference/cloud-compute/1.31.0/V1.TargetGrpcProxy)\n- [1.30.0](/php/docs/reference/cloud-compute/1.30.0/V1.TargetGrpcProxy)\n- [1.29.0](/php/docs/reference/cloud-compute/1.29.0/V1.TargetGrpcProxy)\n- [1.28.0](/php/docs/reference/cloud-compute/1.28.0/V1.TargetGrpcProxy)\n- [1.27.0](/php/docs/reference/cloud-compute/1.27.0/V1.TargetGrpcProxy)\n- [1.26.0](/php/docs/reference/cloud-compute/1.26.0/V1.TargetGrpcProxy)\n- [1.25.0](/php/docs/reference/cloud-compute/1.25.0/V1.TargetGrpcProxy)\n- [1.24.0](/php/docs/reference/cloud-compute/1.24.0/V1.TargetGrpcProxy)\n- [1.23.0](/php/docs/reference/cloud-compute/1.23.0/V1.TargetGrpcProxy)\n- [1.22.1](/php/docs/reference/cloud-compute/1.22.1/V1.TargetGrpcProxy)\n- [1.21.0](/php/docs/reference/cloud-compute/1.21.0/V1.TargetGrpcProxy)\n- [1.20.0](/php/docs/reference/cloud-compute/1.20.0/V1.TargetGrpcProxy)\n- [1.19.0](/php/docs/reference/cloud-compute/1.19.0/V1.TargetGrpcProxy)\n- [1.18.1](/php/docs/reference/cloud-compute/1.18.1/V1.TargetGrpcProxy)\n- [1.17.0](/php/docs/reference/cloud-compute/1.17.0/V1.TargetGrpcProxy)\n- [1.16.2](/php/docs/reference/cloud-compute/1.16.2/V1.TargetGrpcProxy)\n- [1.14.0](/php/docs/reference/cloud-compute/1.14.0/V1.TargetGrpcProxy)\n- [1.13.0](/php/docs/reference/cloud-compute/1.13.0/V1.TargetGrpcProxy)\n- [1.12.1](/php/docs/reference/cloud-compute/1.12.1/V1.TargetGrpcProxy)\n- [1.11.1](/php/docs/reference/cloud-compute/1.11.1/V1.TargetGrpcProxy)\n- [1.10.1](/php/docs/reference/cloud-compute/1.10.1/V1.TargetGrpcProxy)\n- [1.9.1](/php/docs/reference/cloud-compute/1.9.1/V1.TargetGrpcProxy)\n- [1.8.3](/php/docs/reference/cloud-compute/1.8.3/V1.TargetGrpcProxy)\n- [1.7.1](/php/docs/reference/cloud-compute/1.7.1/V1.TargetGrpcProxy)\n- [1.6.1](/php/docs/reference/cloud-compute/1.6.1/V1.TargetGrpcProxy)\n- [1.5.0](/php/docs/reference/cloud-compute/1.5.0/V1.TargetGrpcProxy) \nReference documentation and code samples for the Compute V1 Client class TargetGrpcProxy.\n\nRepresents 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.\n\nGenerated from protobuf message `google.cloud.compute.v1.TargetGrpcProxy`\n\nNamespace\n---------\n\nGoogle \\\\ Cloud \\\\ Compute \\\\ V1\n\nMethods\n-------\n\n### __construct\n\nConstructor.\n\n### getCreationTimestamp\n\n\\[Output Only\\] Creation timestamp in RFC3339 text format.\n\n### hasCreationTimestamp\n\n### clearCreationTimestamp\n\n### setCreationTimestamp\n\n\\[Output Only\\] Creation timestamp in RFC3339 text format.\n\n### getDescription\n\nAn optional description of this resource. Provide this property when you create the resource.\n\n### hasDescription\n\n### clearDescription\n\n### setDescription\n\nAn optional description of this resource. Provide this property when you create the resource.\n\n### getFingerprint\n\nFingerprint 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.\n\n### hasFingerprint\n\n### clearFingerprint\n\n### setFingerprint\n\nFingerprint 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.\n\n### getId\n\n\\[Output Only\\] The unique identifier for the resource type. The server generates this identifier.\n\n### hasId\n\n### clearId\n\n### setId\n\n\\[Output Only\\] The unique identifier for the resource type. The server generates this identifier.\n\n### getKind\n\n\\[Output Only\\] Type of the resource. Always compute#targetGrpcProxy for target grpc proxies.\n\n### hasKind\n\n### clearKind\n\n### setKind\n\n\\[Output Only\\] Type of the resource. Always compute#targetGrpcProxy for target grpc proxies.\n\n### getName\n\nName 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.\n\n### hasName\n\n### clearName\n\n### setName\n\nName 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.\n\n### getSelfLink\n\n\\[Output Only\\] Server-defined URL for the resource.\n\n### hasSelfLink\n\n### clearSelfLink\n\n### setSelfLink\n\n\\[Output Only\\] Server-defined URL for the resource.\n\n### getSelfLinkWithId\n\n\\[Output Only\\] Server-defined URL with id for the resource.\n\n### hasSelfLinkWithId\n\n### clearSelfLinkWithId\n\n### setSelfLinkWithId\n\n\\[Output Only\\] Server-defined URL with id for the resource.\n\n### getUrlMap\n\nURL to the UrlMap resource that defines the mapping from URL to the BackendService. The protocol field in the BackendService must be set to GRPC.\n\n### hasUrlMap\n\n### clearUrlMap\n\n### setUrlMap\n\nURL to the UrlMap resource that defines the mapping from URL to the BackendService. The protocol field in the BackendService must be set to GRPC.\n\n### getValidateForProxyless\n\nIf 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\n\n### hasValidateForProxyless\n\n### clearValidateForProxyless\n\n### setValidateForProxyless\n\nIf 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"]]
