Package com.google.cloud.tasks.v2

Interface AppEngineHttpRequestOrBuilder

  • All Superinterfaces:
    com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
    All Known Implementing Classes:
    AppEngineHttpRequest, AppEngineHttpRequest.Builder
    public interface AppEngineHttpRequestOrBuilder
extends com.google.protobuf.MessageOrBuilder

    • Method Detail

      • getHttpMethodValue

        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;
        Returns:
        The enum numeric value on the wire for httpMethod.

      • getHttpMethod

        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;
        Returns:
        The httpMethod.

      • hasAppEngineRouting

        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;
        Returns:
        Whether the appEngineRouting field is set.

      • getAppEngineRouting

        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;
        Returns:
        The appEngineRouting.

      • getAppEngineRoutingOrBuilder

        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;

      • getRelativeUri

        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;
        Returns:
        The relativeUri.

      • getRelativeUriBytes

        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;
        Returns:
        The bytes for relativeUri.

      • getHeadersCount

        int getHeadersCount()
         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;

      • containsHeaders

        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;

      • getHeadersMap

        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;

      • getHeadersOrDefault

        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;

      • getHeadersOrThrow

        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;

      • getBody

        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;
        Returns:
        The body.