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

Reference documentation and code samples for the Cloud Tasks V2beta3 API class Google::Cloud::Tasks::V2beta3::HttpTarget.

HTTP target.

When specified as a Queue, 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>
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.

    Do not put business sensitive or personally identifying data in the HTTP Header Override Configuration or other similar fields in accordance with Section 12 (Resource Fields) of the Service Specific Terms.

#header_overrides=

def header_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.

    Do not put business sensitive or personally identifying data in the HTTP Header Override Configuration or other similar fields in accordance with Section 12 (Resource Fields) of the Service Specific Terms.

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.

    Do not put business sensitive or personally identifying data in the HTTP Header Override Configuration or other similar fields in accordance with Section 12 (Resource Fields) of the Service Specific Terms.

#http_method

def http_method() -> ::Google::Cloud::Tasks::V2beta3::HttpMethod
Returns

#http_method=

def http_method=(value) -> ::Google::Cloud::Tasks::V2beta3::HttpMethod
Parameter
Returns

#oauth_token

def oauth_token() -> ::Google::Cloud::Tasks::V2beta3::OAuthToken
Returns
  • (::Google::Cloud::Tasks::V2beta3::OAuthToken) — If specified, an OAuth token is generated and attached as the Authorization header in the HTTP request.

    This type of authorization should generally be used only when calling Google APIs hosted on *.googleapis.com. Note that both the service account email and the scope MUST be specified when using the queue-level authorization override.

    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=

def oauth_token=(value) -> ::Google::Cloud::Tasks::V2beta3::OAuthToken
Parameter
  • value (::Google::Cloud::Tasks::V2beta3::OAuthToken) — If specified, an OAuth token is generated and attached as the Authorization header in the HTTP request.

    This type of authorization should generally be used only when calling Google APIs hosted on *.googleapis.com. Note that both the service account email and the scope MUST be specified when using the queue-level authorization override.

    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 is generated and attached as the Authorization header in the HTTP request.

    This type of authorization should generally be used only when calling Google APIs hosted on *.googleapis.com. Note that both the service account email and the scope MUST be specified when using the queue-level authorization override.

    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

def oidc_token() -> ::Google::Cloud::Tasks::V2beta3::OidcToken
Returns
  • (::Google::Cloud::Tasks::V2beta3::OidcToken) — If specified, an OIDC token is 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 that both the service account email and the audience MUST be specified when using the queue-level authorization override.

    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=

def oidc_token=(value) -> ::Google::Cloud::Tasks::V2beta3::OidcToken
Parameter
  • value (::Google::Cloud::Tasks::V2beta3::OidcToken) — If specified, an OIDC token is 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 that both the service account email and the audience MUST be specified when using the queue-level authorization override.

    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 is 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 that both the service account email and the audience MUST be specified when using the queue-level authorization override.

    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

def uri_override() -> ::Google::Cloud::Tasks::V2beta3::UriOverride
Returns

#uri_override=

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