Package com.google.cloud.tasks.v2

Class AppEngineHttpRequest

  • All Implemented Interfaces:
    AppEngineHttpRequestOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
    public final class AppEngineHttpRequest
extends com.google.protobuf.GeneratedMessageV3
implements AppEngineHttpRequestOrBuilder
     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][google.cloud.tasks.v2.AppEngineHttpRequest]
 requires
 [`appengine.applications.get`](https://cloud.google.com/appengine/docs/admin-api/access-control)
 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](https://cloud.google.com/appengine/docs/standard/python/how-requests-are-routed)
 and how routing is affected by
 [dispatch
 files](https://cloud.google.com/appengine/docs/python/config/dispatchref).
 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][google.cloud.tasks.v2.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][google.cloud.tasks.v2.Queue.app_engine_routing_override], this value
   is used for all tasks in the queue, no matter what the setting is for the
   [task-level
   app_engine_routing][google.cloud.tasks.v2.AppEngineHttpRequest.app_engine_routing].


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

 * `url =` [host][google.cloud.tasks.v2.AppEngineRouting.host] `+`
   [relative_uri][google.cloud.tasks.v2.AppEngineHttpRequest.relative_uri]

 Tasks can be dispatched to secure app handlers, unsecure app handlers, and
 URIs restricted with
 [`login:
 admin`](https://cloud.google.com/appengine/docs/standard/python/config/appref).
 Because tasks are not run as any user, they cannot be dispatched to URIs
 restricted with
 [`login:
 required`](https://cloud.google.com/appengine/docs/standard/python/config/appref)
 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][google.cloud.tasks.v2.Task.dispatch_deadline]. Failed tasks will
 be retried according to the [retry
 configuration][google.cloud.tasks.v2.Queue.retry_config]. `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, a `429` (Too Many Requests) response from an app handler does not
 cause traffic congestion control to throttle the queue.
    Protobuf type google.cloud.tasks.v2.AppEngineHttpRequest
    See Also:
    Serialized Form

    • Method Detail

      • newInstance

        protected Object newInstance​(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
        Overrides:
        newInstance in class com.google.protobuf.GeneratedMessageV3

      • getDescriptor

        public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

      • internalGetMapField

        protected com.google.protobuf.MapField internalGetMapField​(int number)
        Overrides:
        internalGetMapField in class com.google.protobuf.GeneratedMessageV3

      • internalGetFieldAccessorTable

        protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
        Specified by:
        internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

      • getHttpMethodValue

        public int getHttpMethodValue()
         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 fails with
 error code 405 (Method Not Allowed). See [Writing a push task request
 handler](https://cloud.google.com/appengine/docs/java/taskqueue/push/creating-handlers#writing_a_push_task_request_handler)
 and the App Engine documentation for your runtime on [How Requests are
 Handled](https://cloud.google.com/appengine/docs/standard/python3/how-requests-are-handled).
        .google.cloud.tasks.v2.HttpMethod http_method = 1;
        Specified by:
        getHttpMethodValue in interface AppEngineHttpRequestOrBuilder
        Returns:
        The enum numeric value on the wire for httpMethod.

      • getHttpMethod

        public HttpMethod getHttpMethod()
         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 fails with
 error code 405 (Method Not Allowed). See [Writing a push task request
 handler](https://cloud.google.com/appengine/docs/java/taskqueue/push/creating-handlers#writing_a_push_task_request_handler)
 and the App Engine documentation for your runtime on [How Requests are
 Handled](https://cloud.google.com/appengine/docs/standard/python3/how-requests-are-handled).
        .google.cloud.tasks.v2.HttpMethod http_method = 1;
        Specified by:
        getHttpMethod in interface AppEngineHttpRequestOrBuilder
        Returns:
        The httpMethod.

      • hasAppEngineRouting

        public boolean hasAppEngineRouting()
         Task-level setting for App Engine routing.

 * If [app_engine_routing_override is set on the
   queue][google.cloud.tasks.v2.Queue.app_engine_routing_override], this
   value is used for all tasks in the queue, no matter what the setting is
   for the [task-level
   app_engine_routing][google.cloud.tasks.v2.AppEngineHttpRequest.app_engine_routing].
        .google.cloud.tasks.v2.AppEngineRouting app_engine_routing = 2;
        Specified by:
        hasAppEngineRouting in interface AppEngineHttpRequestOrBuilder
        Returns:
        Whether the appEngineRouting field is set.

      • getAppEngineRouting

        public AppEngineRouting getAppEngineRouting()
         Task-level setting for App Engine routing.

 * If [app_engine_routing_override is set on the
   queue][google.cloud.tasks.v2.Queue.app_engine_routing_override], this
   value is used for all tasks in the queue, no matter what the setting is
   for the [task-level
   app_engine_routing][google.cloud.tasks.v2.AppEngineHttpRequest.app_engine_routing].
        .google.cloud.tasks.v2.AppEngineRouting app_engine_routing = 2;
        Specified by:
        getAppEngineRouting in interface AppEngineHttpRequestOrBuilder
        Returns:
        The appEngineRouting.

      • getAppEngineRoutingOrBuilder

        public AppEngineRoutingOrBuilder getAppEngineRoutingOrBuilder()
         Task-level setting for App Engine routing.

 * If [app_engine_routing_override is set on the
   queue][google.cloud.tasks.v2.Queue.app_engine_routing_override], this
   value is used for all tasks in the queue, no matter what the setting is
   for the [task-level
   app_engine_routing][google.cloud.tasks.v2.AppEngineHttpRequest.app_engine_routing].
        .google.cloud.tasks.v2.AppEngineRouting app_engine_routing = 2;
        Specified by:
        getAppEngineRoutingOrBuilder in interface AppEngineHttpRequestOrBuilder

      • getRelativeUri

        public String getRelativeUri()
         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.
        string relative_uri = 3;
        Specified by:
        getRelativeUri in interface AppEngineHttpRequestOrBuilder
        Returns:
        The relativeUri.

      • getRelativeUriBytes

        public com.google.protobuf.ByteString getRelativeUriBytes()
         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.
        string relative_uri = 3;
        Specified by:
        getRelativeUriBytes in interface AppEngineHttpRequestOrBuilder
        Returns:
        The bytes for relativeUri.

      • getHeadersCount

        public int getHeadersCount()
        Description copied from interface: AppEngineHttpRequestOrBuilder
         HTTP request headers.

 This map contains the header field names and values.
 Headers can be set when the
 [task is created][google.cloud.tasks.v2.CloudTasks.CreateTask].
 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 [body][google.cloud.tasks.v2.AppEngineHttpRequest.body],
 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][google.cloud.tasks.v2.CloudTasks.CreateTask].
   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](https://cloud.google.com/tasks/docs/creating-appengine-handlers#reading_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][google.cloud.tasks.v2.Task]. For more information, see the
 [CreateTask][google.cloud.tasks.v2.CloudTasks.CreateTask] documentation.
        map<string, string> headers = 4;
        Specified by:
        getHeadersCount in interface AppEngineHttpRequestOrBuilder

      • containsHeaders

        public boolean containsHeaders​(String key)
         HTTP request headers.

 This map contains the header field names and values.
 Headers can be set when the
 [task is created][google.cloud.tasks.v2.CloudTasks.CreateTask].
 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 [body][google.cloud.tasks.v2.AppEngineHttpRequest.body],
 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][google.cloud.tasks.v2.CloudTasks.CreateTask].
   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](https://cloud.google.com/tasks/docs/creating-appengine-handlers#reading_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][google.cloud.tasks.v2.Task]. For more information, see the
 [CreateTask][google.cloud.tasks.v2.CloudTasks.CreateTask] documentation.
        map<string, string> headers = 4;
        Specified by:
        containsHeaders in interface AppEngineHttpRequestOrBuilder

      • getHeadersMap

        public Map<String,​String> getHeadersMap()
         HTTP request headers.

 This map contains the header field names and values.
 Headers can be set when the
 [task is created][google.cloud.tasks.v2.CloudTasks.CreateTask].
 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 [body][google.cloud.tasks.v2.AppEngineHttpRequest.body],
 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][google.cloud.tasks.v2.CloudTasks.CreateTask].
   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](https://cloud.google.com/tasks/docs/creating-appengine-handlers#reading_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][google.cloud.tasks.v2.Task]. For more information, see the
 [CreateTask][google.cloud.tasks.v2.CloudTasks.CreateTask] documentation.
        map<string, string> headers = 4;
        Specified by:
        getHeadersMap in interface AppEngineHttpRequestOrBuilder

      • getHeadersOrDefault

        public String getHeadersOrDefault​(String key,
                                  String defaultValue)
         HTTP request headers.

 This map contains the header field names and values.
 Headers can be set when the
 [task is created][google.cloud.tasks.v2.CloudTasks.CreateTask].
 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 [body][google.cloud.tasks.v2.AppEngineHttpRequest.body],
 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][google.cloud.tasks.v2.CloudTasks.CreateTask].
   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](https://cloud.google.com/tasks/docs/creating-appengine-handlers#reading_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][google.cloud.tasks.v2.Task]. For more information, see the
 [CreateTask][google.cloud.tasks.v2.CloudTasks.CreateTask] documentation.
        map<string, string> headers = 4;
        Specified by:
        getHeadersOrDefault in interface AppEngineHttpRequestOrBuilder

      • getHeadersOrThrow

        public String getHeadersOrThrow​(String key)
         HTTP request headers.

 This map contains the header field names and values.
 Headers can be set when the
 [task is created][google.cloud.tasks.v2.CloudTasks.CreateTask].
 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 [body][google.cloud.tasks.v2.AppEngineHttpRequest.body],
 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][google.cloud.tasks.v2.CloudTasks.CreateTask].
   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](https://cloud.google.com/tasks/docs/creating-appengine-handlers#reading_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][google.cloud.tasks.v2.Task]. For more information, see the
 [CreateTask][google.cloud.tasks.v2.CloudTasks.CreateTask] documentation.
        map<string, string> headers = 4;
        Specified by:
        getHeadersOrThrow in interface AppEngineHttpRequestOrBuilder

      • getBody

        public com.google.protobuf.ByteString getBody()
         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][google.cloud.tasks.v2.HttpMethod].
        bytes body = 5;
        Specified by:
        getBody in interface AppEngineHttpRequestOrBuilder
        Returns:
        The body.

      • isInitialized

        public final boolean isInitialized()
        Specified by:
        isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
        Overrides:
        isInitialized in class com.google.protobuf.GeneratedMessageV3

      • writeTo

        public void writeTo​(com.google.protobuf.CodedOutputStream output)
             throws IOException
        Specified by:
        writeTo in interface com.google.protobuf.MessageLite
        Overrides:
        writeTo in class com.google.protobuf.GeneratedMessageV3
        Throws:
        IOException

      • getSerializedSize

        public int getSerializedSize()
        Specified by:
        getSerializedSize in interface com.google.protobuf.MessageLite
        Overrides:
        getSerializedSize in class com.google.protobuf.GeneratedMessageV3

      • equals

        public boolean equals​(Object obj)
        Specified by:
        equals in interface com.google.protobuf.Message
        Overrides:
        equals in class com.google.protobuf.AbstractMessage

      • hashCode

        public int hashCode()
        Specified by:
        hashCode in interface com.google.protobuf.Message
        Overrides:
        hashCode in class com.google.protobuf.AbstractMessage

      • parseFrom

        public static AppEngineHttpRequest parseFrom​(ByteBuffer data)
                                      throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static AppEngineHttpRequest parseFrom​(ByteBuffer data,
                                             com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                      throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static AppEngineHttpRequest parseFrom​(com.google.protobuf.ByteString data)
                                      throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static AppEngineHttpRequest parseFrom​(com.google.protobuf.ByteString data,
                                             com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                      throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static AppEngineHttpRequest parseFrom​(byte[] data)
                                      throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static AppEngineHttpRequest parseFrom​(byte[] data,
                                             com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                      throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • newBuilderForType

        public AppEngineHttpRequest.Builder newBuilderForType()
        Specified by:
        newBuilderForType in interface com.google.protobuf.Message
        Specified by:
        newBuilderForType in interface com.google.protobuf.MessageLite

      • toBuilder

        public AppEngineHttpRequest.Builder toBuilder()
        Specified by:
        toBuilder in interface com.google.protobuf.Message
        Specified by:
        toBuilder in interface com.google.protobuf.MessageLite

      • newBuilderForType

        protected AppEngineHttpRequest.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
        Specified by:
        newBuilderForType in class com.google.protobuf.GeneratedMessageV3

      • getParserForType

        public com.google.protobuf.Parser<AppEngineHttpRequest> getParserForType()
        Specified by:
        getParserForType in interface com.google.protobuf.Message
        Specified by:
        getParserForType in interface com.google.protobuf.MessageLite
        Overrides:
        getParserForType in class com.google.protobuf.GeneratedMessageV3

      • getDefaultInstanceForType

        public AppEngineHttpRequest getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder