target_grpc_proxies

Creates, updates, deletes, gets or lists a target_grpc_proxies resource.

Overview

Name	target_grpc_proxies
Type	Resource
Id	google.compute.target_grpc_proxies

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	string (uint64)	Output only. [Output Only] The unique identifier for the resource type. The server generates this identifier.
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. (pattern: [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?)
creationTimestamp	string	Output only. [Output Only] Creation timestamp inRFC3339 text format.
description	string	An optional description of this resource. Provide this property when you create the resource.
fingerprint	string (byte)	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.
kind	string	Output only. [Output Only] Type of the resource. Alwayscompute#targetGrpcProxy for target grpc proxies. (default: compute#targetGrpcProxy)
selfLink	string	Output only. [Output Only] Server-defined URL for the resource.
selfLinkWithId	string	Output only. [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

list

Name	Datatype	Description
id	string	[Output Only] Unique identifier for the resource; defined by the server.
items	array	A list of TargetGrpcProxy resources.
kind	string	Output only. [Output Only] Type of the resource. Alwayscompute#targetGrpcProxy for target grpc proxies. (default: compute#targetGrpcProxyList)
nextPageToken	string	[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger thanmaxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.
selfLink	string	[Output Only] Server-defined URL for this resource.
warning	object	[Output Only] Informational warning message.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	project, targetGrpcProxy		Returns the specified TargetGrpcProxy resource in the given scope.
list	select	project	filter, maxResults, pageToken, orderBy, returnPartialSuccess	Lists the TargetGrpcProxies for a project in the given scope.
insert	insert	project	requestId	Creates a TargetGrpcProxy in the specified project in the given scope using the parameters that are included in the request.
patch	update	project, targetGrpcProxy	requestId	Patches the specified TargetGrpcProxy resource with the data included in the request. This method supports PATCH semantics and usesJSON merge patch format and processing rules.
delete	delete	project, targetGrpcProxy	requestId	Deletes the specified TargetGrpcProxy in the given scope

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
project	string
targetGrpcProxy	string
filter	string
maxResults	integer (uint32)
orderBy	string
pageToken	string
requestId	string
returnPartialSuccess	boolean

SELECT examples

get

Returns the specified TargetGrpcProxy resource in the given scope.

SELECT
id,
name,
creationTimestamp,
description,
fingerprint,
kind,
selfLink,
selfLinkWithId,
urlMap,
validateForProxyless
FROM google.compute.target_grpc_proxies
WHERE project = '{{ project }}' -- required
AND targetGrpcProxy = '{{ targetGrpcProxy }}' -- required
;

list

Lists the TargetGrpcProxies for a project in the given scope.

SELECT
id,
items,
kind,
nextPageToken,
selfLink,
warning
FROM google.compute.target_grpc_proxies
WHERE project = '{{ project }}' -- required
AND filter = '{{ filter }}'
AND maxResults = '{{ maxResults }}'
AND pageToken = '{{ pageToken }}'
AND orderBy = '{{ orderBy }}'
AND returnPartialSuccess = '{{ returnPartialSuccess }}'
;

INSERT examples

insert

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

INSERT INTO google.compute.target_grpc_proxies (
data__name,
data__fingerprint,
data__urlMap,
data__description,
data__validateForProxyless,
project,
requestId
)
SELECT 
'{{ name }}',
'{{ fingerprint }}',
'{{ urlMap }}',
'{{ description }}',
{{ validateForProxyless }},
'{{ project }}',
'{{ requestId }}'
RETURNING
id,
name,
clientOperationId,
creationTimestamp,
description,
endTime,
error,
getVersionOperationMetadata,
httpErrorMessage,
httpErrorStatusCode,
insertTime,
instancesBulkInsertOperationMetadata,
kind,
operationGroupId,
operationType,
progress,
region,
selfLink,
setCommonInstanceMetadataOperationMetadata,
startTime,
status,
statusMessage,
targetId,
targetLink,
user,
warnings,
zone
;

Manifest

# Description fields are for documentation purposes
- name: target_grpc_proxies
props:
  - name: project
    value: "{{ project }}"
    description: Required parameter for the target_grpc_proxies resource.
  - name: name
    value: "{{ name }}"
    description: |
      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.
  - name: fingerprint
    value: "{{ fingerprint }}"
    description: |
      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.
  - name: urlMap
    value: "{{ urlMap }}"
    description: |
      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.
  - name: description
    value: "{{ description }}"
    description: |
      An optional description of this resource. Provide this property when you
      create the resource.
  - name: validateForProxyless
    value: {{ validateForProxyless }}
    description: |
      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
  - name: requestId
    value: "{{ requestId }}"

UPDATE examples

patch

Patches the specified TargetGrpcProxy resource with the data included in
the request. This method supports PATCH
semantics and usesJSON merge
patch format and processing rules.

UPDATE google.compute.target_grpc_proxies
SET 
data__name = '{{ name }}',
data__fingerprint = '{{ fingerprint }}',
data__urlMap = '{{ urlMap }}',
data__description = '{{ description }}',
data__validateForProxyless = {{ validateForProxyless }}
WHERE 
project = '{{ project }}' --required
AND targetGrpcProxy = '{{ targetGrpcProxy }}' --required
AND requestId = '{{ requestId}}'
RETURNING
id,
name,
clientOperationId,
creationTimestamp,
description,
endTime,
error,
getVersionOperationMetadata,
httpErrorMessage,
httpErrorStatusCode,
insertTime,
instancesBulkInsertOperationMetadata,
kind,
operationGroupId,
operationType,
progress,
region,
selfLink,
setCommonInstanceMetadataOperationMetadata,
startTime,
status,
statusMessage,
targetId,
targetLink,
user,
warnings,
zone;

DELETE examples

delete

Deletes the specified TargetGrpcProxy in the given scope

DELETE FROM google.compute.target_grpc_proxies
WHERE project = '{{ project }}' --required
AND targetGrpcProxy = '{{ targetGrpcProxy }}' --required
AND requestId = '{{ requestId }}'
;