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 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. Traffic is encrypted during transport and never leaves Google datacenters. Because this traffic is carried over a communication mechanism internal to Google, you cannot explicitly set the protocol (for example, HTTP or HTTPS). The request to the handler, however, will appear to have used the HTTP protocol. 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, 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 = host + relative_url Tasks can be dispatched to secure app handlers, unsecure app handlers, and URIs restricted with login: admin. Because tasks are not run as any user, they cannot be dispatched to URIs restricted with login: required Task dispatches also do not follow redirects. 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 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



188
189
190
 
# File 'generated/google/apis/cloudtasks_v2beta2/classes.rb', line 188

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

Instance Attribute Details

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

App Engine Routing. Defines routing characteristics specific to App Engine - service, version, and instance. 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:



116
117
118
 
# File 'generated/google/apis/cloudtasks_v2beta2/classes.rb', line 116

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 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. Corresponds to the JSON property headers

Returns:

  • (Hash<String,String>) 


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

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). 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. Corresponds to the JSON property httpMethod

Returns:

  • (String) 


167
168
169
 
# File 'generated/google/apis/cloudtasks_v2beta2/classes.rb', line 167

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) 


177
178
179
 
# File 'generated/google/apis/cloudtasks_v2beta2/classes.rb', line 177

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 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. Corresponds to the JSON property relativeUrl

Returns:

  • (String) 


186
187
188
 
# File 'generated/google/apis/cloudtasks_v2beta2/classes.rb', line 186

def relative_url
  @relative_url
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



193
194
195
196
197
198
199
 
# File 'generated/google/apis/cloudtasks_v2beta2/classes.rb', line 193

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