REST Resource: targetGrpcProxies

Resource: 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.

JSON representation
{"kind":string,"id":string,"creationTimestamp":string,"name":string,"description":string,"selfLink":string,"selfLinkWithId":string,"urlMap":string,"validateForProxyless":boolean,"fingerprint":string}
Fields
kind

string

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

id

string (uint64 format)

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

creationTimestamp

string

[Output Only] Creation timestamp inRFC3339 text format.

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 withRFC1035. 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.

description

string

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

selfLink

string

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

selfLinkWithId

string

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

urlMap

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.

validateForProxyless

boolean

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

fingerprint

string (bytes format)

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

A base64-encoded string.

Methods

delete

 Deletes the specified TargetGrpcProxy in the given scope

get

 Returns the specified TargetGrpcProxy resource in the given scope.

insert

 Creates a TargetGrpcProxy in the specified project in the given scope using the parameters that are included in the request.

list

 Lists the TargetGrpcProxies for a project in the given scope.

patch

 Patches the specified TargetGrpcProxy resource with the data included in the request.

Except as otherwise noted, the content of this page is licensed under theCreative Commons Attribution 4.0 License, and code samples are licensed under theApache 2.0 License. For details, see theGoogle Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.

Last updated 2025-07-28 UTC.