target_tcp_proxies

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

Overview

Name	target_tcp_proxies
Type	Resource
Id	google.compute.target_tcp_proxies

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	string (uint64)	[Output Only] The unique identifier for the resource. This identifier is defined by the server.
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.
kind	string	Output only. [Output Only] Type of the resource. Alwayscompute#targetTcpProxy for target TCP proxies. (default: compute#targetTcpProxy)
loadBalancingScheme	string	Specifies the type of load balancing scheme used by this target proxy. (EXTERNAL, EXTERNAL_MANAGED, INTERNAL_MANAGED, LOAD_BALANCING_SCHEME_UNSPECIFIED)
proxyBind	boolean	This field only applies when the forwarding rule that references this target proxy has a loadBalancingScheme set toINTERNAL_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.
proxyHeader	string	Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE. (NONE, PROXY_V1)
region	string	Output only. [Output Only] URL of the region where the regional TCP proxy resides. This field is not applicable to global TCP proxy.
selfLink	string	[Output Only] Server-defined URL for the resource.
service	string	URL to the BackendService resource.

list

Name	Datatype	Description
id	string	[Output Only] Unique identifier for the resource; defined by the server.
items	array	A list of TargetTcpProxy resources.
kind	string	Output only. Type of resource. (default: compute#targetTcpProxyList)
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. [Output Only] Server-defined URL for this resource.
warning	object	[Output Only] Informational warning message.

aggregated_list

Name	Datatype	Description
id	string (uint64)	[Output Only] The unique identifier for the resource. This identifier is defined by the server.
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.
kind	string	Output only. [Output Only] Type of the resource. Alwayscompute#targetTcpProxy for target TCP proxies. (default: compute#targetTcpProxy)
loadBalancingScheme	string	Specifies the type of load balancing scheme used by this target proxy. (EXTERNAL, EXTERNAL_MANAGED, INTERNAL_MANAGED, LOAD_BALANCING_SCHEME_UNSPECIFIED)
proxyBind	boolean	This field only applies when the forwarding rule that references this target proxy has a loadBalancingScheme set toINTERNAL_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.
proxyHeader	string	Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE. (NONE, PROXY_V1)
region	string	Output only. [Output Only] URL of the region where the regional TCP proxy resides. This field is not applicable to global TCP proxy.
selfLink	string	[Output Only] Server-defined URL for the resource.
service	string	URL to the BackendService resource.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	project, region, targetTcpProxy		Returns the specified TargetTcpProxy resource.
list	select	project, region	maxResults, pageToken, filter, orderBy, returnPartialSuccess	Retrieves a list of TargetTcpProxy resources available to the specified project in a given region.
aggregated_list	select	project	includeAllScopes, orderBy, maxResults, pageToken, filter, serviceProjectNumber, returnPartialSuccess	Retrieves the list of all TargetTcpProxy resources, regional and global, available to the specified project. To prevent failure, Google recommends that you set the returnPartialSuccess parameter to true.
insert	insert	project, region	requestId	Creates a TargetTcpProxy resource in the specified project and region using the data included in the request.
delete	delete	project, region, targetTcpProxy	requestId	Deletes the specified TargetTcpProxy resource.
set_proxy_header	exec	project, targetTcpProxy	requestId	Changes the ProxyHeaderType for TargetTcpProxy.
set_backend_service	exec	project, targetTcpProxy	requestId	Changes the BackendService for TargetTcpProxy.

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
region	string
targetTcpProxy	string
filter	string
includeAllScopes	boolean
maxResults	integer (uint32)
orderBy	string
pageToken	string
requestId	string
returnPartialSuccess	boolean
serviceProjectNumber	string (int64)

SELECT examples

get

Returns the specified TargetTcpProxy resource.

SELECT
id,
name,
creationTimestamp,
description,
kind,
loadBalancingScheme,
proxyBind,
proxyHeader,
region,
selfLink,
service
FROM google.compute.target_tcp_proxies
WHERE project = '{{ project }}' -- required
AND region = '{{ region }}' -- required
AND targetTcpProxy = '{{ targetTcpProxy }}' -- required
;

list

Retrieves a list of TargetTcpProxy resources
available to the specified project in a given region.

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

aggregated_list

Retrieves the list of all TargetTcpProxy resources, regional and global,
available to the specified project.

To prevent failure, Google recommends that you set the
returnPartialSuccess parameter to true.

SELECT
id,
name,
creationTimestamp,
description,
kind,
loadBalancingScheme,
proxyBind,
proxyHeader,
region,
selfLink,
service
FROM google.compute.target_tcp_proxies
WHERE project = '{{ project }}' -- required
AND includeAllScopes = '{{ includeAllScopes }}'
AND orderBy = '{{ orderBy }}'
AND maxResults = '{{ maxResults }}'
AND pageToken = '{{ pageToken }}'
AND filter = '{{ filter }}'
AND serviceProjectNumber = '{{ serviceProjectNumber }}'
AND returnPartialSuccess = '{{ returnPartialSuccess }}'
;

INSERT examples

insert

Creates a TargetTcpProxy resource in the specified project and region using
the data included in the request.

INSERT INTO google.compute.target_tcp_proxies (
data__description,
data__loadBalancingScheme,
data__selfLink,
data__id,
data__proxyBind,
data__service,
data__name,
data__proxyHeader,
project,
region,
requestId
)
SELECT 
'{{ description }}',
'{{ loadBalancingScheme }}',
'{{ selfLink }}',
'{{ id }}',
{{ proxyBind }},
'{{ service }}',
'{{ name }}',
'{{ proxyHeader }}',
'{{ project }}',
'{{ region }}',
'{{ 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_tcp_proxies
props:
  - name: project
    value: "{{ project }}"
    description: Required parameter for the target_tcp_proxies resource.
  - name: region
    value: "{{ region }}"
    description: Required parameter for the target_tcp_proxies resource.
  - name: description
    value: "{{ description }}"
    description: |
      An optional description of this resource. Provide this property when you
      create the resource.
  - name: loadBalancingScheme
    value: "{{ loadBalancingScheme }}"
    description: |
      Specifies the type of load balancing scheme used by this target proxy.
    valid_values: ['EXTERNAL', 'EXTERNAL_MANAGED', 'INTERNAL_MANAGED', 'LOAD_BALANCING_SCHEME_UNSPECIFIED']
  - name: selfLink
    value: "{{ selfLink }}"
    description: |
      [Output Only] Server-defined URL for the resource.
  - name: id
    value: "{{ id }}"
    description: |
      [Output Only] The unique identifier for the resource. This identifier is
      defined by the server.
  - name: proxyBind
    value: {{ proxyBind }}
    description: |
      This field only applies when the forwarding rule that references this
      target proxy has a loadBalancingScheme set toINTERNAL_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.
  - name: service
    value: "{{ service }}"
    description: |
      URL to the BackendService 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: proxyHeader
    value: "{{ proxyHeader }}"
    description: |
      Specifies the type of proxy header to append before sending data to the
      backend, either NONE or PROXY_V1. The default
      is NONE.
    valid_values: ['NONE', 'PROXY_V1']
  - name: requestId
    value: "{{ requestId }}"

DELETE examples

delete

Deletes the specified TargetTcpProxy resource.

DELETE FROM google.compute.target_tcp_proxies
WHERE project = '{{ project }}' --required
AND region = '{{ region }}' --required
AND targetTcpProxy = '{{ targetTcpProxy }}' --required
AND requestId = '{{ requestId }}'
;

Lifecycle Methods

set_proxy_header

Changes the ProxyHeaderType for TargetTcpProxy.

EXEC google.compute.target_tcp_proxies.set_proxy_header 
@project='{{ project }}' --required, 
@targetTcpProxy='{{ targetTcpProxy }}' --required, 
@requestId='{{ requestId }}' 
@@json=
'{
"proxyHeader": "{{ proxyHeader }}"
}'
;

set_backend_service

Changes the BackendService for TargetTcpProxy.

EXEC google.compute.target_tcp_proxies.set_backend_service 
@project='{{ project }}' --required, 
@targetTcpProxy='{{ targetTcpProxy }}' --required, 
@requestId='{{ requestId }}' 
@@json=
'{
"service": "{{ service }}"
}'
;