Class: Google::Apis::CloudtasksV2::AppEngineHttpRequest
- Inherits:
-
Object
- Object
- Google::Apis::CloudtasksV2::AppEngineHttpRequest
- Defined in:
- generated/google/apis/cloudtasks_v2/classes.rb,
generated/google/apis/cloudtasks_v2/representations.rb,
generated/google/apis/cloudtasks_v2/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.
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 app_engine_routing_override is set on the
queue, this value 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_uri Tasks can be dispatched to secure app handlers, unsecure app handlers, and URIs restricted withlogin: admin
. Because tasks are not run as any user, they cannot be dispatched to URIs restricted withlogin: 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
]. The task attempt has failed if the app's handler returns a non-2xx response code or Cloud Tasks does not receive response before the deadline. Failed tasks will be retried according to the retry configuration.503
(Service Unavailable) is considered an App Engine system error instead of an application error and will cause Cloud Tasks' traffic congestion control to temporarily throttle the queue's dispatches. Unlike other types of task targets, a429
(Too Many Requests) response from an app handler does not cause traffic congestion control to throttle the queue.
Instance Attribute Summary collapse
-
#app_engine_routing ⇒ Google::Apis::CloudtasksV2::AppEngineRouting
App Engine Routing.
-
#body ⇒ String
HTTP request body.
-
#headers ⇒ Hash<String,String>
HTTP request headers.
-
#http_method ⇒ String
The HTTP method to use for the request.
-
#relative_uri ⇒ String
The relative URI.
Instance Method Summary collapse
-
#initialize(**args) ⇒ AppEngineHttpRequest
constructor
A new instance of AppEngineHttpRequest.
-
#update!(**args) ⇒ Object
Update properties of this object.
Methods included from Google::Apis::Core::JsonObjectSupport
Methods included from Google::Apis::Core::Hashable
Constructor Details
#initialize(**args) ⇒ AppEngineHttpRequest
Returns a new instance of AppEngineHttpRequest.
177 178 179 |
# File 'generated/google/apis/cloudtasks_v2/classes.rb', line 177 def initialize(**args) update!(**args) end |
Instance Attribute Details
#app_engine_routing ⇒ Google::Apis::CloudtasksV2::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.
Using AppEngineRouting requires
appengine.applications.get
Google IAM permission for the project
and the following scope:
https://www.googleapis.com/auth/cloud-platform
Corresponds to the JSON property appEngineRouting
104 105 106 |
# File 'generated/google/apis/cloudtasks_v2/classes.rb', line 104 def app_engine_routing @app_engine_routing end |
#body ⇒ String
HTTP request body.
A request body is allowed only if the HTTP method is POST or PUT. It is
an error to set a body on a task with an incompatible HttpMethod.
Corresponds to the JSON property body
NOTE: Values are automatically base64 encoded/decoded in the client library.
112 113 114 |
# File 'generated/google/apis/cloudtasks_v2/classes.rb', line 112 def body @body 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 modifiedUser-Agent
. If the task has a body, Cloud Tasks sets the following headers:Content-Type
: By default, theContent-Type
header is set to"application/octet-stream"
. The default can be overridden by explicitly settingContent-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 propertyheaders
150 151 152 |
# File 'generated/google/apis/cloudtasks_v2/classes.rb', line 150 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
166 167 168 |
# File 'generated/google/apis/cloudtasks_v2/classes.rb', line 166 def http_method @http_method end |
#relative_uri ⇒ String
The relative URI.
The relative URI must begin with "/" and must be a valid HTTP relative URI.
It can contain a path and query string arguments.
If the relative URI 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 relativeUri
175 176 177 |
# File 'generated/google/apis/cloudtasks_v2/classes.rb', line 175 def relative_uri @relative_uri end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
182 183 184 185 186 187 188 |
# File 'generated/google/apis/cloudtasks_v2/classes.rb', line 182 def update!(**args) @app_engine_routing = args[:app_engine_routing] if args.key?(:app_engine_routing) @body = args[:body] if args.key?(:body) @headers = args[:headers] if args.key?(:headers) @http_method = args[:http_method] if args.key?(:http_method) @relative_uri = args[:relative_uri] if args.key?(:relative_uri) end |