Package com.google.cloud.tasks.v2beta2

Class AppEngineHttpRequest.Builder

  • All Implemented Interfaces:
    AppEngineHttpRequestOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable
    Enclosing class:
    AppEngineHttpRequest
    public static final class AppEngineHttpRequest.Builder
extends com.google.protobuf.GeneratedMessageV3.Builder<AppEngineHttpRequest.Builder>
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.

 This proto can only be used for tasks in a queue which has
 [app_engine_http_target][google.cloud.tasks.v2beta2.Queue.app_engine_http_target]
 set.

 Using [AppEngineHttpRequest][google.cloud.tasks.v2beta2.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.v2beta2.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][google.cloud.tasks.v2beta2.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][google.cloud.tasks.v2beta2.AppEngineHttpRequest.app_engine_routing].


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

 * `url =` [host][google.cloud.tasks.v2beta2.AppEngineRouting.host] `+`
   [relative_url][google.cloud.tasks.v2beta2.AppEngineHttpRequest.relative_url]

 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][Task.dispatch_deadline]. Failed
 tasks will be retried according to the
 [retry configuration][google.cloud.tasks.v2beta2.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.v2beta2.AppEngineHttpRequest

    • Method Detail

      • 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.Builder<AppEngineHttpRequest.Builder>

      • internalGetMutableMapField

        protected com.google.protobuf.MapField internalGetMutableMapField​(int number)
        Overrides:
        internalGetMutableMapField in class com.google.protobuf.GeneratedMessageV3.Builder<AppEngineHttpRequest.Builder>

      • internalGetFieldAccessorTable

        protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
        Specified by:
        internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3.Builder<AppEngineHttpRequest.Builder>

      • clear

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

      • getDescriptorForType

        public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
        Specified by:
        getDescriptorForType in interface com.google.protobuf.Message.Builder
        Specified by:
        getDescriptorForType in interface com.google.protobuf.MessageOrBuilder
        Overrides:
        getDescriptorForType in class com.google.protobuf.GeneratedMessageV3.Builder<AppEngineHttpRequest.Builder>

      • getDefaultInstanceForType

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

      • build

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

      • buildPartial

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

      • clone

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

      • setField

        public AppEngineHttpRequest.Builder setField​(com.google.protobuf.Descriptors.FieldDescriptor field,
                                             Object value)
        Specified by:
        setField in interface com.google.protobuf.Message.Builder
        Overrides:
        setField in class com.google.protobuf.GeneratedMessageV3.Builder<AppEngineHttpRequest.Builder>

      • clearField

        public AppEngineHttpRequest.Builder clearField​(com.google.protobuf.Descriptors.FieldDescriptor field)
        Specified by:
        clearField in interface com.google.protobuf.Message.Builder
        Overrides:
        clearField in class com.google.protobuf.GeneratedMessageV3.Builder<AppEngineHttpRequest.Builder>

      • clearOneof

        public AppEngineHttpRequest.Builder clearOneof​(com.google.protobuf.Descriptors.OneofDescriptor oneof)
        Specified by:
        clearOneof in interface com.google.protobuf.Message.Builder
        Overrides:
        clearOneof in class com.google.protobuf.GeneratedMessageV3.Builder<AppEngineHttpRequest.Builder>

      • setRepeatedField

        public AppEngineHttpRequest.Builder setRepeatedField​(com.google.protobuf.Descriptors.FieldDescriptor field,
                                                     int index,
                                                     Object value)
        Specified by:
        setRepeatedField in interface com.google.protobuf.Message.Builder
        Overrides:
        setRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<AppEngineHttpRequest.Builder>

      • addRepeatedField

        public AppEngineHttpRequest.Builder addRepeatedField​(com.google.protobuf.Descriptors.FieldDescriptor field,
                                                     Object value)
        Specified by:
        addRepeatedField in interface com.google.protobuf.Message.Builder
        Overrides:
        addRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<AppEngineHttpRequest.Builder>

      • isInitialized

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

      • mergeFrom

        public AppEngineHttpRequest.Builder mergeFrom​(com.google.protobuf.CodedInputStream input,
                                              com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                       throws IOException
        Specified by:
        mergeFrom in interface com.google.protobuf.Message.Builder
        Specified by:
        mergeFrom in interface com.google.protobuf.MessageLite.Builder
        Overrides:
        mergeFrom in class com.google.protobuf.AbstractMessage.Builder<AppEngineHttpRequest.Builder>
        Throws:
        IOException

      • 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.v2beta2.HttpMethod http_method = 1;
        Specified by:
        getHttpMethodValue in interface AppEngineHttpRequestOrBuilder
        Returns:
        The enum numeric value on the wire for httpMethod.

      • setHttpMethodValue

        public AppEngineHttpRequest.Builder setHttpMethodValue​(int value)
         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.v2beta2.HttpMethod http_method = 1;
        Parameters:
        value - The enum numeric value on the wire for httpMethod to set.
        Returns:
        This builder for chaining.

      • 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.v2beta2.HttpMethod http_method = 1;
        Specified by:
        getHttpMethod in interface AppEngineHttpRequestOrBuilder
        Returns:
        The httpMethod.

      • setHttpMethod

        public AppEngineHttpRequest.Builder setHttpMethod​(HttpMethod value)
         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.v2beta2.HttpMethod http_method = 1;
        Parameters:
        value - The httpMethod to set.
        Returns:
        This builder for chaining.

      • clearHttpMethod

        public AppEngineHttpRequest.Builder clearHttpMethod()
         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.v2beta2.HttpMethod http_method = 1;
        Returns:
        This builder for chaining.

      • hasAppEngineRouting

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

 If set,
 [app_engine_routing_override][google.cloud.tasks.v2beta2.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][google.cloud.tasks.v2beta2.AppEngineHttpRequest.app_engine_routing].
        .google.cloud.tasks.v2beta2.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 set,
 [app_engine_routing_override][google.cloud.tasks.v2beta2.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][google.cloud.tasks.v2beta2.AppEngineHttpRequest.app_engine_routing].
        .google.cloud.tasks.v2beta2.AppEngineRouting app_engine_routing = 2;
        Specified by:
        getAppEngineRouting in interface AppEngineHttpRequestOrBuilder
        Returns:
        The appEngineRouting.

      • setAppEngineRouting

        public AppEngineHttpRequest.Builder setAppEngineRouting​(AppEngineRouting value)
         Task-level setting for App Engine routing.

 If set,
 [app_engine_routing_override][google.cloud.tasks.v2beta2.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][google.cloud.tasks.v2beta2.AppEngineHttpRequest.app_engine_routing].
        .google.cloud.tasks.v2beta2.AppEngineRouting app_engine_routing = 2;

      • setAppEngineRouting

        public AppEngineHttpRequest.Builder setAppEngineRouting​(AppEngineRouting.Builder builderForValue)
         Task-level setting for App Engine routing.

 If set,
 [app_engine_routing_override][google.cloud.tasks.v2beta2.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][google.cloud.tasks.v2beta2.AppEngineHttpRequest.app_engine_routing].
        .google.cloud.tasks.v2beta2.AppEngineRouting app_engine_routing = 2;

      • mergeAppEngineRouting

        public AppEngineHttpRequest.Builder mergeAppEngineRouting​(AppEngineRouting value)
         Task-level setting for App Engine routing.

 If set,
 [app_engine_routing_override][google.cloud.tasks.v2beta2.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][google.cloud.tasks.v2beta2.AppEngineHttpRequest.app_engine_routing].
        .google.cloud.tasks.v2beta2.AppEngineRouting app_engine_routing = 2;

      • clearAppEngineRouting

        public AppEngineHttpRequest.Builder clearAppEngineRouting()
         Task-level setting for App Engine routing.

 If set,
 [app_engine_routing_override][google.cloud.tasks.v2beta2.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][google.cloud.tasks.v2beta2.AppEngineHttpRequest.app_engine_routing].
        .google.cloud.tasks.v2beta2.AppEngineRouting app_engine_routing = 2;

      • getAppEngineRoutingBuilder

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

 If set,
 [app_engine_routing_override][google.cloud.tasks.v2beta2.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][google.cloud.tasks.v2beta2.AppEngineHttpRequest.app_engine_routing].
        .google.cloud.tasks.v2beta2.AppEngineRouting app_engine_routing = 2;

      • getAppEngineRoutingOrBuilder

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

 If set,
 [app_engine_routing_override][google.cloud.tasks.v2beta2.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][google.cloud.tasks.v2beta2.AppEngineHttpRequest.app_engine_routing].
        .google.cloud.tasks.v2beta2.AppEngineRouting app_engine_routing = 2;
        Specified by:
        getAppEngineRoutingOrBuilder in interface AppEngineHttpRequestOrBuilder

      • getRelativeUrl

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

      • getRelativeUrlBytes

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

      • setRelativeUrl

        public AppEngineHttpRequest.Builder setRelativeUrl​(String value)
         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.
        string relative_url = 3;
        Parameters:
        value - The relativeUrl to set.
        Returns:
        This builder for chaining.

      • clearRelativeUrl

        public AppEngineHttpRequest.Builder clearRelativeUrl()
         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.
        string relative_url = 3;
        Returns:
        This builder for chaining.

      • setRelativeUrlBytes

        public AppEngineHttpRequest.Builder setRelativeUrlBytes​(com.google.protobuf.ByteString value)
         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.
        string relative_url = 3;
        Parameters:
        value - The bytes for relativeUrl to set.
        Returns:
        This builder for chaining.

      • 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.v2beta2.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
 [payload][google.cloud.tasks.v2beta2.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 explicitly
   setting `Content-Type` to a particular media type when the
   [task is created][google.cloud.tasks.v2beta2.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/appengine/docs/python/taskqueue/push/creating-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.v2beta2.Task]. For more information, see the
 [CreateTask][google.cloud.tasks.v2beta2.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.v2beta2.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
 [payload][google.cloud.tasks.v2beta2.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 explicitly
   setting `Content-Type` to a particular media type when the
   [task is created][google.cloud.tasks.v2beta2.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/appengine/docs/python/taskqueue/push/creating-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.v2beta2.Task]. For more information, see the
 [CreateTask][google.cloud.tasks.v2beta2.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.v2beta2.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
 [payload][google.cloud.tasks.v2beta2.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 explicitly
   setting `Content-Type` to a particular media type when the
   [task is created][google.cloud.tasks.v2beta2.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/appengine/docs/python/taskqueue/push/creating-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.v2beta2.Task]. For more information, see the
 [CreateTask][google.cloud.tasks.v2beta2.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.v2beta2.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
 [payload][google.cloud.tasks.v2beta2.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 explicitly
   setting `Content-Type` to a particular media type when the
   [task is created][google.cloud.tasks.v2beta2.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/appengine/docs/python/taskqueue/push/creating-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.v2beta2.Task]. For more information, see the
 [CreateTask][google.cloud.tasks.v2beta2.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.v2beta2.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
 [payload][google.cloud.tasks.v2beta2.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 explicitly
   setting `Content-Type` to a particular media type when the
   [task is created][google.cloud.tasks.v2beta2.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/appengine/docs/python/taskqueue/push/creating-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.v2beta2.Task]. For more information, see the
 [CreateTask][google.cloud.tasks.v2beta2.CloudTasks.CreateTask]
 documentation.
        map<string, string> headers = 4;
        Specified by:
        getHeadersOrThrow in interface AppEngineHttpRequestOrBuilder

      • removeHeaders

        public AppEngineHttpRequest.Builder removeHeaders​(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.v2beta2.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
 [payload][google.cloud.tasks.v2beta2.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 explicitly
   setting `Content-Type` to a particular media type when the
   [task is created][google.cloud.tasks.v2beta2.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/appengine/docs/python/taskqueue/push/creating-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.v2beta2.Task]. For more information, see the
 [CreateTask][google.cloud.tasks.v2beta2.CloudTasks.CreateTask]
 documentation.
        map<string, string> headers = 4;

      • getMutableHeaders

        @Deprecated
public Map<String,​String> getMutableHeaders()
        Deprecated.
        Use alternate mutation accessors instead.

      • putHeaders

        public AppEngineHttpRequest.Builder putHeaders​(String key,
                                               String value)
         HTTP request headers.

 This map contains the header field names and values.
 Headers can be set when the
 [task is created][google.cloud.tasks.v2beta2.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
 [payload][google.cloud.tasks.v2beta2.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 explicitly
   setting `Content-Type` to a particular media type when the
   [task is created][google.cloud.tasks.v2beta2.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/appengine/docs/python/taskqueue/push/creating-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.v2beta2.Task]. For more information, see the
 [CreateTask][google.cloud.tasks.v2beta2.CloudTasks.CreateTask]
 documentation.
        map<string, string> headers = 4;

      • putAllHeaders

        public AppEngineHttpRequest.Builder putAllHeaders​(Map<String,​String> values)
         HTTP request headers.

 This map contains the header field names and values.
 Headers can be set when the
 [task is created][google.cloud.tasks.v2beta2.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
 [payload][google.cloud.tasks.v2beta2.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 explicitly
   setting `Content-Type` to a particular media type when the
   [task is created][google.cloud.tasks.v2beta2.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/appengine/docs/python/taskqueue/push/creating-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.v2beta2.Task]. For more information, see the
 [CreateTask][google.cloud.tasks.v2beta2.CloudTasks.CreateTask]
 documentation.
        map<string, string> headers = 4;

      • getPayload

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

      • setPayload

        public AppEngineHttpRequest.Builder setPayload​(com.google.protobuf.ByteString value)
         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][google.cloud.tasks.v2beta2.HttpMethod].
        bytes payload = 5;
        Parameters:
        value - The payload to set.
        Returns:
        This builder for chaining.

      • clearPayload

        public AppEngineHttpRequest.Builder clearPayload()
         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][google.cloud.tasks.v2beta2.HttpMethod].
        bytes payload = 5;
        Returns:
        This builder for chaining.

      • setUnknownFields

        public final AppEngineHttpRequest.Builder setUnknownFields​(com.google.protobuf.UnknownFieldSet unknownFields)
        Specified by:
        setUnknownFields in interface com.google.protobuf.Message.Builder
        Overrides:
        setUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<AppEngineHttpRequest.Builder>

      • mergeUnknownFields

        public final AppEngineHttpRequest.Builder mergeUnknownFields​(com.google.protobuf.UnknownFieldSet unknownFields)
        Specified by:
        mergeUnknownFields in interface com.google.protobuf.Message.Builder
        Overrides:
        mergeUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<AppEngineHttpRequest.Builder>