Class: Google::Apis::CloudtasksV2beta2::AppEngineHttpRequest

Inherits:
Object
  • Object
show all
Includes:
Google::Apis::Core::Hashable, Google::Apis::Core::JsonObjectSupport
Defined in:
generated/google/apis/cloudtasks_v2beta2/classes.rb,
generated/google/apis/cloudtasks_v2beta2/representations.rb,
generated/google/apis/cloudtasks_v2beta2/representations.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 Queue.app_engine_http_target set. Using this type of target 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:

  • If set, AppEngineHttpTarget.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. The url that the task will be sent to is:
  • url = AppEngineRouting.host + AppEngineHttpRequest.relative_url The task will be sent to a task handler by an HTTP request using the specified AppEngineHttpRequest.http_method (for example POST, HTTP GET, etc). The task attempt has succeeded if the task handler returns an HTTP response code in the range [200 - 299]. Error 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 Method Summary collapse

Methods included from Google::Apis::Core::JsonObjectSupport

#to_json

Methods included from Google::Apis::Core::Hashable

process_value, #to_h

Constructor Details

#initialize(**args) ⇒ AppEngineHttpRequest

Returns a new instance of AppEngineHttpRequest



164
165
166
 
# File 'generated/google/apis/cloudtasks_v2beta2/classes.rb', line 164

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#app_engine_routing ⇒ Google::Apis::CloudtasksV2beta2::AppEngineRouting

App Engine Routing. For more information about services, versions, and instances see An Overview of App Engine, Microservices Architecture on Google App Engine, App Engine Standard request routing, and App Engine Flex request routing. Corresponds to the JSON property appEngineRouting

Returns:



95
96
97
 
# File 'generated/google/apis/cloudtasks_v2beta2/classes.rb', line 95

def app_engine_routing
  @app_engine_routing
end

#headers ⇒ 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:

  • User-Agent: By default, this header is "AppEngine-Google; (+http://code.google.com/appengine)". This header can be modified, but Cloud Tasks will append "AppEngine-Google; (+http://code.google.com/appengine)" to the modified User-Agent. If the task has an AppEngineHttpRequest.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 explictly 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, some App Engine headers, which contain task-specific information, are also be sent to the task handler; see request headers. Corresponds to the JSON property headers

Returns:

  • (Hash<String,String>) 


127
128
129
 
# File 'generated/google/apis/cloudtasks_v2beta2/classes.rb', line 127

def headers
  @headers
end

#http_method ⇒ String

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" because "the method specified in the Request-Line is not allowed for the resource identified by the Request-URI". 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 RequestHandler. Corresponds to the JSON property httpMethod

Returns:

  • (String) 


143
144
145
 
# File 'generated/google/apis/cloudtasks_v2beta2/classes.rb', line 143

def http_method
  @http_method
end

#payload ⇒ 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. Corresponds to the JSON property payload NOTE: Values are automatically base64 encoded/decoded in the client library.

Returns:

  • (String) 


153
154
155
 
# File 'generated/google/apis/cloudtasks_v2beta2/classes.rb', line 153

def payload
  @payload
end

#relative_url ⇒ String

The relative URL. The relative URL must begin with "/" and must be a valid HTTP relative URL. It can contain a path, query string arguments, and # fragments. 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. Corresponds to the JSON property relativeUrl

Returns:

  • (String) 


162
163
164
 
# File 'generated/google/apis/cloudtasks_v2beta2/classes.rb', line 162

def relative_url
  @relative_url
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



169
170
171
172
173
174
175
 
# File 'generated/google/apis/cloudtasks_v2beta2/classes.rb', line 169

def update!(**args)
  @app_engine_routing = args[:app_engine_routing] if args.key?(:app_engine_routing)
  @headers = args[:headers] if args.key?(:headers)
  @http_method = args[:http_method] if args.key?(:http_method)
  @payload = args[:payload] if args.key?(:payload)
  @relative_url = args[:relative_url] if args.key?(:relative_url)
end