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

Successful response

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 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. (pattern: a-z?)
creationTimestamp	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.
kind	string	[Output Only] Type of the resource. Always compute#targetTcpProxy for target TCP proxies. (default: compute#targetTcpProxy)
proxyBind	boolean	This field only applies when the forwarding rule that references this target proxy has a loadBalancingScheme set to INTERNAL_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.
region	string	[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

Successful response

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	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 than maxResults, 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, region, targetTcpProxy		Returns the specified TargetTcpProxy resource.
list	select	project, region	filter, maxResults, orderBy, pageToken, returnPartialSuccess	Retrieves a list of TargetTcpProxy resources available to the specified project in a given region.
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_backend_service	exec	project, targetTcpProxy	requestId	Changes the BackendService for TargetTcpProxy.
set_proxy_header	exec	project, targetTcpProxy	requestId	Changes the ProxyHeaderType 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
maxResults	integer (uint32)
orderBy	string
pageToken	string
requestId	string
returnPartialSuccess	boolean

SELECT examples

get

Returns the specified TargetTcpProxy resource.

SELECT
id,
name,
creationTimestamp,
description,
kind,
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 filter = '{{ filter }}'
AND maxResults = '{{ maxResults }}'
AND orderBy = '{{ orderBy }}'
AND pageToken = '{{ pageToken }}'
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__kind,
data__id,
data__creationTimestamp,
data__name,
data__description,
data__selfLink,
data__service,
data__proxyHeader,
data__proxyBind,
data__region,
project,
region,
requestId
)
SELECT 
'{{ kind }}',
'{{ id }}',
'{{ creationTimestamp }}',
'{{ name }}',
'{{ description }}',
'{{ selfLink }}',
'{{ service }}',
'{{ proxyHeader }}',
{{ proxyBind }},
'{{ region }}',
'{{ project }}',
'{{ region }}',
'{{ requestId }}'
RETURNING
id,
name,
clientOperationId,
creationTimestamp,
description,
endTime,
error,
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: string
      description: Required parameter for the target_tcp_proxies resource.
    - name: region
      value: string
      description: Required parameter for the target_tcp_proxies resource.
    - name: kind
      value: string
      description: >
        [Output Only] Type of the resource. Always compute#targetTcpProxy for target TCP proxies.
        
      default: compute#targetTcpProxy
    - name: id
      value: string
      description: >
        [Output Only] The unique identifier for the resource. This identifier is defined by the server.
        
    - name: creationTimestamp
      value: string
      description: >
        [Output Only] Creation timestamp in RFC3339 text format.
        
    - name: name
      value: string
      description: >
        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.
        
    - name: description
      value: string
      description: >
        An optional description of this resource. Provide this property when you create the resource.
        
    - name: selfLink
      value: string
      description: >
        [Output Only] Server-defined URL for the resource.
        
    - name: service
      value: string
      description: >
        URL to the BackendService resource.
        
    - name: proxyHeader
      value: string
      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: proxyBind
      value: boolean
      description: >
        This field only applies when the forwarding rule that references this target proxy has a loadBalancingScheme set to INTERNAL_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: region
      value: string
      description: >
        [Output Only] URL of the region where the regional TCP proxy resides. This field is not applicable to global TCP proxy.
        
    - name: requestId
      value: string

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_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 }}"
}';

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 }}"
}';