public static final class AppEngineHttpRequest.Builder extends 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.
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][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][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.AppEngineHttpRequestgetAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, getUnknownFieldSetBuilder, hasField, hasOneof, isClean, markClean, mergeUnknownLengthDelimitedField, mergeUnknownVarintField, newBuilderForField, onBuilt, onChanged, parseUnknownField, setUnknownFieldSetBuilder, setUnknownFieldsProto3findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toStringaddAll, addAll, mergeDelimitedFrom, mergeDelimitedFrom, mergeFrom, newUninitializedMessageExceptionequals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, waitfindInitializationErrors, getAllFields, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneofmergeDelimitedFrom, mergeDelimitedFrommergeFrompublic static final Descriptors.Descriptor getDescriptor()
protected MapField internalGetMapField(int number)
internalGetMapField in class GeneratedMessageV3.Builder<AppEngineHttpRequest.Builder>protected MapField internalGetMutableMapField(int number)
internalGetMutableMapField in class GeneratedMessageV3.Builder<AppEngineHttpRequest.Builder>protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
internalGetFieldAccessorTable in class GeneratedMessageV3.Builder<AppEngineHttpRequest.Builder>public AppEngineHttpRequest.Builder clear()
clear in interface Message.Builderclear in interface MessageLite.Builderclear in class GeneratedMessageV3.Builder<AppEngineHttpRequest.Builder>public Descriptors.Descriptor getDescriptorForType()
getDescriptorForType in interface Message.BuildergetDescriptorForType in interface MessageOrBuildergetDescriptorForType in class GeneratedMessageV3.Builder<AppEngineHttpRequest.Builder>public AppEngineHttpRequest getDefaultInstanceForType()
getDefaultInstanceForType in interface MessageLiteOrBuildergetDefaultInstanceForType in interface MessageOrBuilderpublic AppEngineHttpRequest build()
build in interface Message.Builderbuild in interface MessageLite.Builderpublic AppEngineHttpRequest buildPartial()
buildPartial in interface Message.BuilderbuildPartial in interface MessageLite.Builderpublic AppEngineHttpRequest.Builder clone()
clone in interface Message.Builderclone in interface MessageLite.Builderclone in class GeneratedMessageV3.Builder<AppEngineHttpRequest.Builder>public AppEngineHttpRequest.Builder setField(Descriptors.FieldDescriptor field, Object value)
setField in interface Message.BuildersetField in class GeneratedMessageV3.Builder<AppEngineHttpRequest.Builder>public AppEngineHttpRequest.Builder clearField(Descriptors.FieldDescriptor field)
clearField in interface Message.BuilderclearField in class GeneratedMessageV3.Builder<AppEngineHttpRequest.Builder>public AppEngineHttpRequest.Builder clearOneof(Descriptors.OneofDescriptor oneof)
clearOneof in interface Message.BuilderclearOneof in class GeneratedMessageV3.Builder<AppEngineHttpRequest.Builder>public AppEngineHttpRequest.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
setRepeatedField in interface Message.BuildersetRepeatedField in class GeneratedMessageV3.Builder<AppEngineHttpRequest.Builder>public AppEngineHttpRequest.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
addRepeatedField in interface Message.BuilderaddRepeatedField in class GeneratedMessageV3.Builder<AppEngineHttpRequest.Builder>public AppEngineHttpRequest.Builder mergeFrom(Message other)
mergeFrom in interface Message.BuildermergeFrom in class AbstractMessage.Builder<AppEngineHttpRequest.Builder>public AppEngineHttpRequest.Builder mergeFrom(AppEngineHttpRequest other)
public final boolean isInitialized()
isInitialized in interface MessageLiteOrBuilderisInitialized in class GeneratedMessageV3.Builder<AppEngineHttpRequest.Builder>public AppEngineHttpRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry) throws IOException
mergeFrom in interface Message.BuildermergeFrom in interface MessageLite.BuildermergeFrom in class AbstractMessage.Builder<AppEngineHttpRequest.Builder>IOExceptionpublic 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 will fail 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 documentation for the request handlers in the language your app is written in e.g. [Python Request Handler](https://cloud.google.com/appengine/docs/python/tools/webapp/requesthandlerclass).
.google.cloud.tasks.v2.HttpMethod http_method = 1;getHttpMethodValue in interface AppEngineHttpRequestOrBuilderpublic 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 will fail 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 documentation for the request handlers in the language your app is written in e.g. [Python Request Handler](https://cloud.google.com/appengine/docs/python/tools/webapp/requesthandlerclass).
.google.cloud.tasks.v2.HttpMethod http_method = 1;value - The enum numeric value on the wire for httpMethod to set.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 will fail 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 documentation for the request handlers in the language your app is written in e.g. [Python Request Handler](https://cloud.google.com/appengine/docs/python/tools/webapp/requesthandlerclass).
.google.cloud.tasks.v2.HttpMethod http_method = 1;getHttpMethod in interface AppEngineHttpRequestOrBuilderpublic 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 will fail 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 documentation for the request handlers in the language your app is written in e.g. [Python Request Handler](https://cloud.google.com/appengine/docs/python/tools/webapp/requesthandlerclass).
.google.cloud.tasks.v2.HttpMethod http_method = 1;value - The httpMethod to set.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 will fail 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 documentation for the request handlers in the language your app is written in e.g. [Python Request Handler](https://cloud.google.com/appengine/docs/python/tools/webapp/requesthandlerclass).
.google.cloud.tasks.v2.HttpMethod http_method = 1;public boolean hasAppEngineRouting()
Task-level setting for App Engine routing.
* If [app_engine_routing_override is set on the
queue][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][AppEngineHttpRequest.app_engine_routing].
.google.cloud.tasks.v2.AppEngineRouting app_engine_routing = 2;hasAppEngineRouting in interface AppEngineHttpRequestOrBuilderpublic AppEngineRouting getAppEngineRouting()
Task-level setting for App Engine routing.
* If [app_engine_routing_override is set on the
queue][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][AppEngineHttpRequest.app_engine_routing].
.google.cloud.tasks.v2.AppEngineRouting app_engine_routing = 2;getAppEngineRouting in interface AppEngineHttpRequestOrBuilderpublic AppEngineHttpRequest.Builder setAppEngineRouting(AppEngineRouting value)
Task-level setting for App Engine routing.
* If [app_engine_routing_override is set on the
queue][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][AppEngineHttpRequest.app_engine_routing].
.google.cloud.tasks.v2.AppEngineRouting app_engine_routing = 2;public AppEngineHttpRequest.Builder setAppEngineRouting(AppEngineRouting.Builder builderForValue)
Task-level setting for App Engine routing.
* If [app_engine_routing_override is set on the
queue][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][AppEngineHttpRequest.app_engine_routing].
.google.cloud.tasks.v2.AppEngineRouting app_engine_routing = 2;public AppEngineHttpRequest.Builder mergeAppEngineRouting(AppEngineRouting value)
Task-level setting for App Engine routing.
* If [app_engine_routing_override is set on the
queue][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][AppEngineHttpRequest.app_engine_routing].
.google.cloud.tasks.v2.AppEngineRouting app_engine_routing = 2;public AppEngineHttpRequest.Builder clearAppEngineRouting()
Task-level setting for App Engine routing.
* If [app_engine_routing_override is set on the
queue][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][AppEngineHttpRequest.app_engine_routing].
.google.cloud.tasks.v2.AppEngineRouting app_engine_routing = 2;public AppEngineRouting.Builder getAppEngineRoutingBuilder()
Task-level setting for App Engine routing.
* If [app_engine_routing_override is set on the
queue][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][AppEngineHttpRequest.app_engine_routing].
.google.cloud.tasks.v2.AppEngineRouting app_engine_routing = 2;public AppEngineRoutingOrBuilder getAppEngineRoutingOrBuilder()
Task-level setting for App Engine routing.
* If [app_engine_routing_override is set on the
queue][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][AppEngineHttpRequest.app_engine_routing].
.google.cloud.tasks.v2.AppEngineRouting app_engine_routing = 2;getAppEngineRoutingOrBuilder in interface AppEngineHttpRequestOrBuilderpublic 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;getRelativeUri in interface AppEngineHttpRequestOrBuilderpublic 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;getRelativeUriBytes in interface AppEngineHttpRequestOrBuilderpublic AppEngineHttpRequest.Builder setRelativeUri(String value)
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;value - The relativeUri to set.public AppEngineHttpRequest.Builder clearRelativeUri()
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;public AppEngineHttpRequest.Builder setRelativeUriBytes(ByteString value)
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;value - The bytes for relativeUri to set.public int getHeadersCount()
AppEngineHttpRequestOrBuilderHTTP 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;getHeadersCount in interface AppEngineHttpRequestOrBuilderpublic 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;containsHeaders in interface AppEngineHttpRequestOrBuilder@Deprecated public Map<String,String> getHeaders()
getHeadersMap() instead.getHeaders in interface AppEngineHttpRequestOrBuilderpublic 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;getHeadersMap in interface AppEngineHttpRequestOrBuilderpublic 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;getHeadersOrDefault in interface AppEngineHttpRequestOrBuilderpublic 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;getHeadersOrThrow in interface AppEngineHttpRequestOrBuilderpublic AppEngineHttpRequest.Builder clearHeaders()
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.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;@Deprecated public Map<String,String> getMutableHeaders()
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.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;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.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;public 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;getBody in interface AppEngineHttpRequestOrBuilderpublic AppEngineHttpRequest.Builder setBody(ByteString value)
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;value - The body to set.public AppEngineHttpRequest.Builder clearBody()
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;public final AppEngineHttpRequest.Builder setUnknownFields(UnknownFieldSet unknownFields)
setUnknownFields in interface Message.BuildersetUnknownFields in class GeneratedMessageV3.Builder<AppEngineHttpRequest.Builder>public final AppEngineHttpRequest.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
mergeUnknownFields in interface Message.BuildermergeUnknownFields in class GeneratedMessageV3.Builder<AppEngineHttpRequest.Builder>Copyright © 2022 Google LLC. All rights reserved.