Class: Google::Cloud::Tasks::V2beta2::AppEngineHttpRequest

Inherits:
Object
  • Object
show all
Defined in:
lib/google/cloud/tasks/v2beta2/doc/google/cloud/tasks/v2beta2/target.rb

Overview

App Engine HTTP request.

The message defines the HTTP request that is sent to an App Engine app when the task is dispatched.

This proto can only be used for tasks in a queue which has app_engine_http_target set.

Using AppEngineHttpRequest requires +appengine.applications.get+ Google IAM permission for the project and the following scope:

+https://www.googleapis.com/auth/cloud-platform+

The task will be delivered to the App Engine app which belongs to the same project as the queue. For more information, see How Requests are Routed and how routing is affected by dispatch files.

The AppEngineRouting used to construct the URL that the task is delivered to can be set at the queue-level or task-level:

The +url+ that the task will be sent to is:

The task attempt has succeeded if the app's request handler returns an HTTP response code in the range [+200+ - +299+]. +503+ is considered an App Engine system error instead of an application error. Requests returning error +503+ will be retried regardless of retry configuration and not counted against retry counts. Any other response code or a failure to receive a response before the deadline is a failed attempt.

Instance Attribute Summary collapse

Instance Attribute Details

#app_engine_routing ⇒ Google::Cloud::Tasks::V2beta2::AppEngineRouting

Returns Task-level setting for App Engine routing.

If set, app_engine_routing_override is used for all tasks in the queue, no matter what the setting is for the task-level app_engine_routing.

Returns:



196
 
# File 'lib/google/cloud/tasks/v2beta2/doc/google/cloud/tasks/v2beta2/target.rb', line 196

class AppEngineHttpRequest; end

#headers ⇒ Hash{String => String}

Returns HTTP request headers.

This map contains the header field names and values. Headers can be set when the task is created. Repeated headers are not supported but a header value can contain commas.

Cloud Tasks sets some headers to default values:

If the task has a payload, Cloud Tasks sets the following headers:

  • +Content-Type+: By default, the +Content-Type+ header is set to +"application/octet-stream"+. The default can be overridden by explicitly setting +Content-Type+ to a particular media type when the task is created. For example, +Content-Type+ can be set to +"application/json"+.
  • +Content-Length+: This is computed by Cloud Tasks. This value is output only. It cannot be changed.

The headers below cannot be set or overridden:

  • +Host+
  • +X-Google-*+
  • +X-AppEngine-*+

In addition, Cloud Tasks sets some headers when the task is dispatched, such as headers containing information about the task; see request headers. These headers are set only when the task is dispatched, so they are not visible when the task is returned in a Cloud Tasks response.

Although there is no specific limit for the maximum number of headers or the size, there is a limit on the maximum size of the Task. For more information, see the CreateTask documentation.

Returns:

  • (Hash{String => String}) —

    HTTP request headers.

    This map contains the header field names and values. Headers can be set when the task is created. Repeated headers are not supported but a header value can contain commas.

    Cloud Tasks sets some headers to default values:

    If the task has a payload, Cloud Tasks sets the following headers:

    • +Content-Type+: By default, the +Content-Type+ header is set to +"application/octet-stream"+. The default can be overridden by explicitly setting +Content-Type+ to a particular media type when the task is created. For example, +Content-Type+ can be set to +"application/json"+.
    • +Content-Length+: This is computed by Cloud Tasks. This value is output only. It cannot be changed.

    The headers below cannot be set or overridden:

    • +Host+
    • +X-Google-*+
    • +X-AppEngine-*+

    In addition, Cloud Tasks sets some headers when the task is dispatched, such as headers containing information about the task; see request headers. These headers are set only when the task is dispatched, so they are not visible when the task is returned in a Cloud Tasks response.

    Although there is no specific limit for the maximum number of headers or the size, there is a limit on the maximum size of the Task. For more information, see the CreateTask documentation.



196
 
# File 'lib/google/cloud/tasks/v2beta2/doc/google/cloud/tasks/v2beta2/target.rb', line 196

class AppEngineHttpRequest; end

#http_method ⇒ Google::Cloud::Tasks::V2beta2::HttpMethod

Returns The HTTP method to use for the request. The default is POST.

The app's request handler for the task's target URL must be able to handle HTTP requests with this http_method, otherwise the task attempt will fail with error code 405 (Method Not Allowed). See Writing a push task request handler and the documentation for the request handlers in the language your app is written in e.g. Python Request Handler.

Returns:



196
 
# File 'lib/google/cloud/tasks/v2beta2/doc/google/cloud/tasks/v2beta2/target.rb', line 196

class AppEngineHttpRequest; end

#payload ⇒ String

Returns Payload.

The payload will be sent as the HTTP message body. A message body, and thus a payload, is allowed only if the HTTP method is POST or PUT. It is an error to set a data payload on a task with an incompatible HttpMethod.

Returns:

  • (String) —

    Payload.

    The payload will be sent as the HTTP message body. A message body, and thus a payload, is allowed only if the HTTP method is POST or PUT. It is an error to set a data payload on a task with an incompatible HttpMethod.



196
 
# File 'lib/google/cloud/tasks/v2beta2/doc/google/cloud/tasks/v2beta2/target.rb', line 196

class AppEngineHttpRequest; end

#relative_url ⇒ String

Returns The relative URL.

The relative URL must begin with "/" and must be a valid HTTP relative URL. It can contain a path and query string arguments. If the relative URL is empty, then the root path "/" will be used. No spaces are allowed, and the maximum length allowed is 2083 characters.

Returns:

  • (String) —

    The relative URL.

    The relative URL must begin with "/" and must be a valid HTTP relative URL. It can contain a path and query string arguments. If the relative URL is empty, then the root path "/" will be used. No spaces are allowed, and the maximum length allowed is 2083 characters.



196
 
# File 'lib/google/cloud/tasks/v2beta2/doc/google/cloud/tasks/v2beta2/target.rb', line 196

class AppEngineHttpRequest; end