Reference documentation and code samples for the Cloud Tasks V2beta3 API class Google::Cloud::Tasks::V2beta3::HttpTarget.
HTTP target.
When specified as a [Queue][target_type], all the tasks with [HttpRequest] will be overridden according to the target.
Inherits
- Object
Extended By
- Google::Protobuf::MessageExts::ClassMethods
Includes
- Google::Protobuf::MessageExts
Methods
#header_overrides
def header_overrides() -> ::Array<::Google::Cloud::Tasks::V2beta3::HttpTarget::HeaderOverride>
-
(::Array<::Google::Cloud::Tasks::V2beta3::HttpTarget::HeaderOverride>) — HTTP target headers.
This map contains the header field names and values. Headers will be set when running the CreateTask and/or [BufferTask][google.cloud.tasks.v2beta3.CloudTasks.BufferTask].
These headers represent a subset of the headers that will be configured for the task's HTTP request. Some HTTP request headers will be ignored or replaced.
A partial list of headers that will be ignored or replaced is:
- Several predefined headers, prefixed with "X-CloudTasks-", can be used to define properties of the task.
- Host: This will be computed by Cloud Tasks and derived from [HttpRequest.url][google.cloud.tasks.v2beta3.Target.HttpRequest.url].
- Content-Length: This will be computed by Cloud Tasks.
Content-Type
won't be set by Cloud Tasks. You can explicitly setContent-Type
to a media type when the task is created. For example,Content-Type
can be set to"application/octet-stream"
or"application/json"
. The default value is set to"application/json"
.- User-Agent: This will be set to
"Google-Cloud-Tasks"
.
Headers which can have multiple values (according to RFC2616) can be specified using comma-separated values.
The size of the headers must be less than 80KB. Queue-level headers to override headers of all the tasks in the queue.
#header_overrides=
def header_overrides=(value) -> ::Array<::Google::Cloud::Tasks::V2beta3::HttpTarget::HeaderOverride>
-
value (::Array<::Google::Cloud::Tasks::V2beta3::HttpTarget::HeaderOverride>) — HTTP target headers.
This map contains the header field names and values. Headers will be set when running the CreateTask and/or [BufferTask][google.cloud.tasks.v2beta3.CloudTasks.BufferTask].
These headers represent a subset of the headers that will be configured for the task's HTTP request. Some HTTP request headers will be ignored or replaced.
A partial list of headers that will be ignored or replaced is:
- Several predefined headers, prefixed with "X-CloudTasks-", can be used to define properties of the task.
- Host: This will be computed by Cloud Tasks and derived from [HttpRequest.url][google.cloud.tasks.v2beta3.Target.HttpRequest.url].
- Content-Length: This will be computed by Cloud Tasks.
Content-Type
won't be set by Cloud Tasks. You can explicitly setContent-Type
to a media type when the task is created. For example,Content-Type
can be set to"application/octet-stream"
or"application/json"
. The default value is set to"application/json"
.- User-Agent: This will be set to
"Google-Cloud-Tasks"
.
Headers which can have multiple values (according to RFC2616) can be specified using comma-separated values.
The size of the headers must be less than 80KB. Queue-level headers to override headers of all the tasks in the queue.
-
(::Array<::Google::Cloud::Tasks::V2beta3::HttpTarget::HeaderOverride>) — HTTP target headers.
This map contains the header field names and values. Headers will be set when running the CreateTask and/or [BufferTask][google.cloud.tasks.v2beta3.CloudTasks.BufferTask].
These headers represent a subset of the headers that will be configured for the task's HTTP request. Some HTTP request headers will be ignored or replaced.
A partial list of headers that will be ignored or replaced is:
- Several predefined headers, prefixed with "X-CloudTasks-", can be used to define properties of the task.
- Host: This will be computed by Cloud Tasks and derived from [HttpRequest.url][google.cloud.tasks.v2beta3.Target.HttpRequest.url].
- Content-Length: This will be computed by Cloud Tasks.
Content-Type
won't be set by Cloud Tasks. You can explicitly setContent-Type
to a media type when the task is created. For example,Content-Type
can be set to"application/octet-stream"
or"application/json"
. The default value is set to"application/json"
.- User-Agent: This will be set to
"Google-Cloud-Tasks"
.
Headers which can have multiple values (according to RFC2616) can be specified using comma-separated values.
The size of the headers must be less than 80KB. Queue-level headers to override headers of all the tasks in the queue.
#http_method
def http_method() -> ::Google::Cloud::Tasks::V2beta3::HttpMethod
-
(::Google::Cloud::Tasks::V2beta3::HttpMethod) — The HTTP method to use for the request.
When specified, it overrides HttpRequest for the task. Note that if the value is set to [HttpMethod][GET] the [HttpRequest][body] of the task will be ignored at execution time.
#http_method=
def http_method=(value) -> ::Google::Cloud::Tasks::V2beta3::HttpMethod
-
value (::Google::Cloud::Tasks::V2beta3::HttpMethod) — The HTTP method to use for the request.
When specified, it overrides HttpRequest for the task. Note that if the value is set to [HttpMethod][GET] the [HttpRequest][body] of the task will be ignored at execution time.
-
(::Google::Cloud::Tasks::V2beta3::HttpMethod) — The HTTP method to use for the request.
When specified, it overrides HttpRequest for the task. Note that if the value is set to [HttpMethod][GET] the [HttpRequest][body] of the task will be ignored at execution time.
#oauth_token
def oauth_token() -> ::Google::Cloud::Tasks::V2beta3::OAuthToken
-
(::Google::Cloud::Tasks::V2beta3::OAuthToken) — If specified, an
OAuth token
will be generated and attached as the
Authorization
header in the HTTP request.This type of authorization should generally only be used when calling Google APIs hosted on *.googleapis.com.
#oauth_token=
def oauth_token=(value) -> ::Google::Cloud::Tasks::V2beta3::OAuthToken
-
value (::Google::Cloud::Tasks::V2beta3::OAuthToken) — If specified, an
OAuth token
will be generated and attached as the
Authorization
header in the HTTP request.This type of authorization should generally only be used when calling Google APIs hosted on *.googleapis.com.
-
(::Google::Cloud::Tasks::V2beta3::OAuthToken) — If specified, an
OAuth token
will be generated and attached as the
Authorization
header in the HTTP request.This type of authorization should generally only be used when calling Google APIs hosted on *.googleapis.com.
#oidc_token
def oidc_token() -> ::Google::Cloud::Tasks::V2beta3::OidcToken
-
(::Google::Cloud::Tasks::V2beta3::OidcToken) — If specified, an
OIDC
token will be generated and attached as an
Authorization
header in the HTTP request.This type of authorization can be used for many scenarios, including calling Cloud Run, or endpoints where you intend to validate the token yourself.
#oidc_token=
def oidc_token=(value) -> ::Google::Cloud::Tasks::V2beta3::OidcToken
-
value (::Google::Cloud::Tasks::V2beta3::OidcToken) — If specified, an
OIDC
token will be generated and attached as an
Authorization
header in the HTTP request.This type of authorization can be used for many scenarios, including calling Cloud Run, or endpoints where you intend to validate the token yourself.
-
(::Google::Cloud::Tasks::V2beta3::OidcToken) — If specified, an
OIDC
token will be generated and attached as an
Authorization
header in the HTTP request.This type of authorization can be used for many scenarios, including calling Cloud Run, or endpoints where you intend to validate the token yourself.
#uri_override
def uri_override() -> ::Google::Cloud::Tasks::V2beta3::UriOverride
-
(::Google::Cloud::Tasks::V2beta3::UriOverride) — URI override.
When specified, overrides the execution URI for all the tasks in the queue.
#uri_override=
def uri_override=(value) -> ::Google::Cloud::Tasks::V2beta3::UriOverride
-
value (::Google::Cloud::Tasks::V2beta3::UriOverride) — URI override.
When specified, overrides the execution URI for all the tasks in the queue.
-
(::Google::Cloud::Tasks::V2beta3::UriOverride) — URI override.
When specified, overrides the execution URI for all the tasks in the queue.