Cloud Tasks V2beta3 API - Class Google::Cloud::Tasks::V2beta3::HttpTarget (v0.17.1)

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

defheader_overrides()->::Array<::Google::Cloud::Tasks::V2beta3::HttpTarget::HeaderOverride>
Returns
  • (::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 set Content-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=

defheader_overrides=(value)->::Array<::Google::Cloud::Tasks::V2beta3::HttpTarget::HeaderOverride>
Parameter
  • 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 set Content-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.

Returns
  • (::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 set Content-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

defhttp_method()->::Google::Cloud::Tasks::V2beta3::HttpMethod
Returns

#http_method=

defhttp_method=(value)->::Google::Cloud::Tasks::V2beta3::HttpMethod
Parameter
  • 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.

Returns

#oauth_token

defoauth_token()->::Google::Cloud::Tasks::V2beta3::OAuthToken
Returns
  • (::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.

    Note: The following fields are mutually exclusive: oauth_token, oidc_token. If a field in that set is populated, all other fields in the set will automatically be cleared.

#oauth_token=

defoauth_token=(value)->::Google::Cloud::Tasks::V2beta3::OAuthToken
Parameter
  • 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.

    Note: The following fields are mutually exclusive: oauth_token, oidc_token. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns
  • (::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.

    Note: The following fields are mutually exclusive: oauth_token, oidc_token. If a field in that set is populated, all other fields in the set will automatically be cleared.

#oidc_token

defoidc_token()->::Google::Cloud::Tasks::V2beta3::OidcToken
Returns
  • (::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.

    Note: The following fields are mutually exclusive: oidc_token, oauth_token. If a field in that set is populated, all other fields in the set will automatically be cleared.

#oidc_token=

defoidc_token=(value)->::Google::Cloud::Tasks::V2beta3::OidcToken
Parameter
  • 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.

    Note: The following fields are mutually exclusive: oidc_token, oauth_token. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns
  • (::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.

    Note: The following fields are mutually exclusive: oidc_token, oauth_token. If a field in that set is populated, all other fields in the set will automatically be cleared.

#uri_override

defuri_override()->::Google::Cloud::Tasks::V2beta3::UriOverride
Returns

#uri_override=

defuri_override=(value)->::Google::Cloud::Tasks::V2beta3::UriOverride
Parameter
Returns

Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.

Last updated 2025年10月30日 UTC.