# Interface AppEngineHttpRequestOrBuilder (2.93.0)

2.93.0 (latest) 2.91.0 2.88.0 2.87.0 2.85.0 2.83.0 2.82.0 2.80.0 2.78.0 2.76.0 2.75.0 2.74.0 2.73.0 2.72.0 2.70.0 2.68.0 2.67.0 2.64.0 2.63.0 2.62.0 2.60.0 2.59.0 2.58.0 2.57.0 2.56.0 2.55.0 2.54.0 2.53.0 2.52.0 2.51.0 2.49.0 2.48.0 2.47.0 2.46.0 2.45.0 2.44.0 2.43.0 2.42.0 2.41.0 2.40.0 2.39.0 2.37.0 2.36.0 2.35.0 2.34.0 2.33.0 2.32.0 2.31.0 2.30.0 2.29.0 2.28.0 2.27.0 2.24.0 2.23.0 2.22.0 2.21.0 2.20.0 2.19.0 2.18.0 2.17.0 2.16.0 2.15.0 2.14.0 2.13.0 2.12.0 2.11.0 2.9.0 2.8.0 2.7.0 2.6.0 2.5.0 2.4.0 2.3.12 2.2.0 2.1.11

    public interface AppEngineHttpRequestOrBuilder extends MessageOrBuilder

## Implements

[MessageOrBuilder](https://cloud.google.com/java/docs/reference/protobuf/latest/com.google.protobuf.MessageOrBuilder.html)

## Methods

### containsHeaders(String key)

    public abstract 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.
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](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. For more information, see the
  CreateTask
  documentation.

`map<string, string> headers = 4;`

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `key` | `https://docs.oracle.com/javase/8/docs/api/java/lang/String.html` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.oracle.com/javase/tutorial/java/nutsandbolts/datatypes.html` |   |

### getAppEngineRouting()

    public abstract AppEngineRouting getAppEngineRouting()

Task-level setting for App Engine routing.

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.

`.google.cloud.tasks.v2beta2.AppEngineRouting app_engine_routing = 2;`

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/java/docs/reference/google-cloud-tasks/latest/com.google.cloud.tasks.v2beta2.AppEngineRouting` | The appEngineRouting. |

### getAppEngineRoutingOrBuilder()

    public abstract AppEngineRoutingOrBuilder getAppEngineRoutingOrBuilder()

Task-level setting for App Engine routing.

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.

`.google.cloud.tasks.v2beta2.AppEngineRouting app_engine_routing = 2;`

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/java/docs/reference/google-cloud-tasks/latest/com.google.cloud.tasks.v2beta2.AppEngineRoutingOrBuilder` |   |

### getHeaders() (deprecated)

    public abstract Map<String,String> getHeaders()

Use [#getHeadersMap()](https://docs.cloud.google.com/java/docs/reference/google-cloud-tasks/latest/com.google.cloud.tasks.v2beta2.AppEngineHttpRequestOrBuilder#com_google_cloud_tasks_v2beta2_AppEngineHttpRequestOrBuilder_getHeadersMap__) instead.

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.oracle.com/javase/8/docs/api/java/util/Map.html<https://docs.oracle.com/javase/8/docs/api/java/lang/String.html,https://docs.oracle.com/javase/8/docs/api/java/lang/String.html>` |   |

### getHeadersCount()

    public abstract int getHeadersCount()

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](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. For more information, see the
  CreateTask
  documentation.

`map<string, string> headers = 4;`

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.oracle.com/javase/tutorial/java/nutsandbolts/datatypes.html` |   |

### getHeadersMap()

    public abstract 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.
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](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. For more information, see the
  CreateTask
  documentation.

`map<string, string> headers = 4;`

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.oracle.com/javase/8/docs/api/java/util/Map.html<https://docs.oracle.com/javase/8/docs/api/java/lang/String.html,https://docs.oracle.com/javase/8/docs/api/java/lang/String.html>` |   |

### getHeadersOrDefault(String key, String defaultValue)

    public abstract 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.
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](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. For more information, see the
  CreateTask
  documentation.

`map<string, string> headers = 4;`

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `key` | `https://docs.oracle.com/javase/8/docs/api/java/lang/String.html` |
| `defaultValue` | `https://docs.oracle.com/javase/8/docs/api/java/lang/String.html` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.oracle.com/javase/8/docs/api/java/lang/String.html` |   |

### getHeadersOrThrow(String key)

    public abstract 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.
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](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. For more information, see the
  CreateTask
  documentation.

`map<string, string> headers = 4;`

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `key` | `https://docs.oracle.com/javase/8/docs/api/java/lang/String.html` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.oracle.com/javase/8/docs/api/java/lang/String.html` |   |

### getHttpMethod()

    public abstract 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;`

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/java/docs/reference/google-cloud-tasks/latest/com.google.cloud.tasks.v2beta2.HttpMethod` | The httpMethod. |

### getHttpMethodValue()

    public abstract 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;`

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.oracle.com/javase/tutorial/java/nutsandbolts/datatypes.html` | The enum numeric value on the wire for httpMethod. |

### getPayload()

    public abstract 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.

`bytes payload = 5;`

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://cloud.google.com/java/docs/reference/protobuf/latest/com.google.protobuf.ByteString.html` | The payload. |

### getRelativeUrl()

    public abstract 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;`

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.oracle.com/javase/8/docs/api/java/lang/String.html` | The relativeUrl. |

### getRelativeUrlBytes()

    public abstract 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;`

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://cloud.google.com/java/docs/reference/protobuf/latest/com.google.protobuf.ByteString.html` | The bytes for relativeUrl. |

### hasAppEngineRouting()

    public abstract boolean hasAppEngineRouting()

Task-level setting for App Engine routing.

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.

`.google.cloud.tasks.v2beta2.AppEngineRouting app_engine_routing = 2;`

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.oracle.com/javase/tutorial/java/nutsandbolts/datatypes.html` | Whether the appEngineRouting field is set. |