Cloud Tasks V2 API - Class Google::Cloud::Tasks::V2::HttpRequest (v0.7.0)

Reference documentation and code samples for the Cloud Tasks V2 API class Google::Cloud::Tasks::V2::HttpRequest.

HTTP request.

The task will be pushed to the worker as an HTTP request. If the worker or the redirected worker acknowledges the task by returning a successful HTTP response code ([200 - 299]), the task will be removed from the queue. If any other HTTP response code is returned or no response is received, the task will be retried according to the following:

  • User-specified throttling: retry configuration, rate limits, and the [queue's state][google.cloud.tasks.v2.Queue.state].

  • System throttling: To prevent the worker from overloading, Cloud Tasks may temporarily reduce the queue's effective rate. User-specified settings will not be changed.

System throttling happens because:

  • Cloud Tasks backs off on all errors. Normally the backoff specified in rate limits will be used. But if the worker returns 429 (Too Many Requests), 503 (Service Unavailable), or the rate of errors is high, Cloud Tasks will use a higher backoff rate. The retry specified in the Retry-After HTTP response header is considered.

  • To prevent traffic spikes and to smooth sudden increases in traffic, dispatches ramp up slowly when the queue is newly created or idle and if large numbers of tasks suddenly become available to dispatch (due to spikes in create task rates, the queue being unpaused, or many tasks that are scheduled at the same time).

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#body

def body() -> ::String
Returns
  • (::String) — HTTP request body.

    A request body is allowed only if the HTTP method is POST, PUT, or PATCH. It is an error to set body on a task with an incompatible HttpMethod.

#body=

def body=(value) -> ::String
Parameter
  • value (::String) — HTTP request body.

    A request body is allowed only if the HTTP method is POST, PUT, or PATCH. It is an error to set body on a task with an incompatible HttpMethod.

Returns
  • (::String) — HTTP request body.

    A request body is allowed only if the HTTP method is POST, PUT, or PATCH. It is an error to set body on a task with an incompatible HttpMethod.

#headers

def headers() -> ::Google::Protobuf::Map{::String => ::String}
Returns
  • (::Google::Protobuf::Map{::String => ::String}) — HTTP request headers.

    This map contains the header field names and values. Headers can be set when the [task is created][google.cloud.tasks.v2beta3.CloudTasks.CreateTask].

    These headers represent a subset of the headers that will accompany 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:

    • Host: This will be computed by Cloud Tasks and derived from HttpRequest.url.
    • Content-Length: This will be computed by Cloud Tasks.
    • User-Agent: This will be set to "Google-Cloud-Tasks".
    • X-Google-*: Google use only.
    • X-AppEngine-*: Google use only.

    Content-Type won't be set by Cloud Tasks. You can explicitly set Content-Type to a media type when the [task is created][google.cloud.tasks.v2beta3.CloudTasks.CreateTask]. For example, Content-Type can be set to "application/octet-stream" or "application/json".

    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.

#headers=

def headers=(value) -> ::Google::Protobuf::Map{::String => ::String}
Parameter
  • value (::Google::Protobuf::Map{::String => ::String}) — HTTP request headers.

    This map contains the header field names and values. Headers can be set when the [task is created][google.cloud.tasks.v2beta3.CloudTasks.CreateTask].

    These headers represent a subset of the headers that will accompany 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:

    • Host: This will be computed by Cloud Tasks and derived from HttpRequest.url.
    • Content-Length: This will be computed by Cloud Tasks.
    • User-Agent: This will be set to "Google-Cloud-Tasks".
    • X-Google-*: Google use only.
    • X-AppEngine-*: Google use only.

    Content-Type won't be set by Cloud Tasks. You can explicitly set Content-Type to a media type when the [task is created][google.cloud.tasks.v2beta3.CloudTasks.CreateTask]. For example, Content-Type can be set to "application/octet-stream" or "application/json".

    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.

Returns
  • (::Google::Protobuf::Map{::String => ::String}) — HTTP request headers.

    This map contains the header field names and values. Headers can be set when the [task is created][google.cloud.tasks.v2beta3.CloudTasks.CreateTask].

    These headers represent a subset of the headers that will accompany 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:

    • Host: This will be computed by Cloud Tasks and derived from HttpRequest.url.
    • Content-Length: This will be computed by Cloud Tasks.
    • User-Agent: This will be set to "Google-Cloud-Tasks".
    • X-Google-*: Google use only.
    • X-AppEngine-*: Google use only.

    Content-Type won't be set by Cloud Tasks. You can explicitly set Content-Type to a media type when the [task is created][google.cloud.tasks.v2beta3.CloudTasks.CreateTask]. For example, Content-Type can be set to "application/octet-stream" or "application/json".

    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.

#http_method

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

#http_method=

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

#oauth_token

def oauth_token() -> ::Google::Cloud::Tasks::V2::OAuthToken
Returns
  • (::Google::Cloud::Tasks::V2::OAuthToken) — If specified, an OAuth token will be generated and attached as an 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::V2::OAuthToken
Parameter
  • value (::Google::Cloud::Tasks::V2::OAuthToken) — If specified, an OAuth token will be generated and attached as an Authorization header in the HTTP request.

    This type of authorization should generally only be used when calling Google APIs hosted on *.googleapis.com.

Returns
  • (::Google::Cloud::Tasks::V2::OAuthToken) — If specified, an OAuth token will be generated and attached as an 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::V2::OidcToken
Returns
  • (::Google::Cloud::Tasks::V2::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::V2::OidcToken
Parameter
  • value (::Google::Cloud::Tasks::V2::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.

Returns
  • (::Google::Cloud::Tasks::V2::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.

#url

def url() -> ::String
Returns
  • (::String) — Required. The full url path that the request will be sent to.

    This string must begin with either "http://" or "https://". Some examples are: http://acme.com and https://acme.com/sales:8080. Cloud Tasks will encode some characters for safety and compatibility. The maximum allowed URL length is 2083 characters after encoding.

    The Location header response from a redirect response [300 - 399] may be followed. The redirect is not counted as a separate attempt.

#url=

def url=(value) -> ::String
Parameter
  • value (::String) — Required. The full url path that the request will be sent to.

    This string must begin with either "http://" or "https://". Some examples are: http://acme.com and https://acme.com/sales:8080. Cloud Tasks will encode some characters for safety and compatibility. The maximum allowed URL length is 2083 characters after encoding.

    The Location header response from a redirect response [300 - 399] may be followed. The redirect is not counted as a separate attempt.

Returns
  • (::String) — Required. The full url path that the request will be sent to.

    This string must begin with either "http://" or "https://". Some examples are: http://acme.com and https://acme.com/sales:8080. Cloud Tasks will encode some characters for safety and compatibility. The maximum allowed URL length is 2083 characters after encoding.

    The Location header response from a redirect response [300 - 399] may be followed. The redirect is not counted as a separate attempt.