target_http_proxies

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

Overview

Name	target_http_proxies
Type	Resource
Id	google.compute.target_http_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.
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 TargetHttpProxy. An up-to-date fingerprint must be provided in order to patch/update the TargetHttpProxy; otherwise, the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve the TargetHttpProxy.
httpKeepAliveTimeoutSec	integer (int32)	Specifies how long to keep a connection open, after completing a response, while there is no matching traffic (in seconds). If an HTTP keep-alive is not specified, a default value (610 seconds) will be used. For global external Application Load Balancers, the minimum allowed value is 5 seconds and the maximum allowed value is 1200 seconds. For classic Application Load Balancers, this option is not supported.
kind	string	Output only. [Output Only] Type of resource. Always compute#targetHttpProxy for target HTTP proxies. (default: compute#targetHttpProxy)
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.
region	string	Output only. [Output Only] URL of the region where the regional Target HTTP Proxy resides. This field is not applicable to global Target HTTP Proxies.
selfLink	string	[Output Only] Server-defined URL for the resource.
urlMap	string	URL to the UrlMap resource that defines the mapping from URL to the BackendService.

list

Name	Datatype	Description
id	string	[Output Only] Unique identifier for the resource; defined by the server.
items	array	A list of TargetHttpProxy resources.
kind	string	Output only. Type of resource. Always compute#targetHttpProxyList for lists of target HTTP proxies. (default: compute#targetHttpProxyList)
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.
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 TargetHttpProxy. An up-to-date fingerprint must be provided in order to patch/update the TargetHttpProxy; otherwise, the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve the TargetHttpProxy.
httpKeepAliveTimeoutSec	integer (int32)	Specifies how long to keep a connection open, after completing a response, while there is no matching traffic (in seconds). If an HTTP keep-alive is not specified, a default value (610 seconds) will be used. For global external Application Load Balancers, the minimum allowed value is 5 seconds and the maximum allowed value is 1200 seconds. For classic Application Load Balancers, this option is not supported.
kind	string	Output only. [Output Only] Type of resource. Always compute#targetHttpProxy for target HTTP proxies. (default: compute#targetHttpProxy)
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.
region	string	Output only. [Output Only] URL of the region where the regional Target HTTP Proxy resides. This field is not applicable to global Target HTTP Proxies.
selfLink	string	[Output Only] Server-defined URL for the resource.
urlMap	string	URL to the UrlMap resource that defines the mapping from URL to the BackendService.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	project, targetHttpProxy		Returns the specified TargetHttpProxy resource.
list	select	project	returnPartialSuccess, orderBy, maxResults, pageToken, filter	Retrieves the list of TargetHttpProxy resources available to the specified project.
aggregated_list	select	project	includeAllScopes, orderBy, filter, serviceProjectNumber, maxResults, pageToken, returnPartialSuccess	Retrieves the list of all TargetHttpProxy 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	requestId	Creates a TargetHttpProxy resource in the specified project using the data included in the request.
patch	update	project, targetHttpProxy	requestId	Patches the specified TargetHttpProxy resource with the data included in the request. This method supports PATCH semantics and usesJSON merge patch format and processing rules.
delete	delete	project, targetHttpProxy	requestId	Deletes the specified TargetHttpProxy resource.
set_url_map	exec	project, targetHttpProxy	requestId	Changes the URL map for TargetHttpProxy.

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
targetHttpProxy	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 TargetHttpProxy resource.

SELECT
id,
name,
creationTimestamp,
description,
fingerprint,
httpKeepAliveTimeoutSec,
kind,
proxyBind,
region,
selfLink,
urlMap
FROM google.compute.target_http_proxies
WHERE project = '{{ project }}' -- required
AND targetHttpProxy = '{{ targetHttpProxy }}' -- required
;

list

Retrieves the list of TargetHttpProxy resources available
to the specified project.

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

aggregated_list

Retrieves the list of all TargetHttpProxy 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,
fingerprint,
httpKeepAliveTimeoutSec,
kind,
proxyBind,
region,
selfLink,
urlMap
FROM google.compute.target_http_proxies
WHERE project = '{{ project }}' -- required
AND includeAllScopes = '{{ includeAllScopes }}'
AND orderBy = '{{ orderBy }}'
AND filter = '{{ filter }}'
AND serviceProjectNumber = '{{ serviceProjectNumber }}'
AND maxResults = '{{ maxResults }}'
AND pageToken = '{{ pageToken }}'
AND returnPartialSuccess = '{{ returnPartialSuccess }}'
;

INSERT examples

insert

Creates a TargetHttpProxy resource in the specified
project using the data included in the request.

INSERT INTO google.compute.target_http_proxies (
data__proxyBind,
data__name,
data__fingerprint,
data__httpKeepAliveTimeoutSec,
data__description,
data__urlMap,
data__selfLink,
data__id,
project,
requestId
)
SELECT 
{{ proxyBind }},
'{{ name }}',
'{{ fingerprint }}',
{{ httpKeepAliveTimeoutSec }},
'{{ description }}',
'{{ urlMap }}',
'{{ selfLink }}',
'{{ id }}',
'{{ 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_http_proxies
props:
  - name: project
    value: "{{ project }}"
    description: Required parameter for the target_http_proxies resource.
  - 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: 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 TargetHttpProxy. An up-to-date fingerprint must
      be provided in order to patch/update the TargetHttpProxy; otherwise, the
      request will fail with error 412 conditionNotMet. To see the
      latest fingerprint, make a get() request to retrieve the
      TargetHttpProxy.
  - name: httpKeepAliveTimeoutSec
    value: {{ httpKeepAliveTimeoutSec }}
    description: |
      Specifies how long to keep a connection open, after completing a response,
      while there is no matching traffic (in seconds). If an HTTP keep-alive is
      not specified, a default value (610 seconds) will be used.
      For global external Application Load Balancers, the minimum allowed value
      is 5 seconds and the maximum allowed value is 1200 seconds.
      For classic Application Load Balancers, this option is not supported.
  - name: description
    value: "{{ description }}"
    description: |
      An optional description of this resource. Provide this property when you
      create the resource.
  - name: urlMap
    value: "{{ urlMap }}"
    description: |
      URL to the UrlMap resource that defines the mapping from URL to
      the BackendService.
  - 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: requestId
    value: "{{ requestId }}"

UPDATE examples

patch

Patches the specified TargetHttpProxy 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_http_proxies
SET 
data__proxyBind = {{ proxyBind }},
data__name = '{{ name }}',
data__fingerprint = '{{ fingerprint }}',
data__httpKeepAliveTimeoutSec = {{ httpKeepAliveTimeoutSec }},
data__description = '{{ description }}',
data__urlMap = '{{ urlMap }}',
data__selfLink = '{{ selfLink }}',
data__id = '{{ id }}'
WHERE 
project = '{{ project }}' --required
AND targetHttpProxy = '{{ targetHttpProxy }}' --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 TargetHttpProxy resource.

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

Lifecycle Methods

set_url_map

Changes the URL map for TargetHttpProxy.

EXEC google.compute.target_http_proxies.set_url_map 
@project='{{ project }}' --required, 
@targetHttpProxy='{{ targetHttpProxy }}' --required, 
@requestId='{{ requestId }}' 
@@json=
'{
"urlMap": "{{ urlMap }}"
}'
;