Class AppEngineHttpRequest.Builder (2.41.0)

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.

This proto can only be used for tasks in a queue which has app_engine_http_target set.

Using AppEngineHttpRequest requires appengine.applications.get 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 and how routing is affected by dispatch files. 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 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 is used for all tasks in the queue, no matter what the setting is for the task-level app_engine_routing.

The url that the task will be sent to is:

url = host + relative_url

Tasks can be dispatched to secure app handlers, unsecure app handlers, and URIs restricted with login: admin. Because tasks are not run as any user, they cannot be dispatched to URIs restricted with login: required 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. Failed tasks will be retried according to the retry configuration. 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

Inheritance

Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > AppEngineHttpRequest.Builder

Implements

AppEngineHttpRequestOrBuilder

Inherited Members

AbstractMessage.Builder.findInitializationErrors()

AbstractMessage.Builder.getInitializationErrorString()

AbstractMessage.Builder.internalMergeFrom(AbstractMessageLite)

AbstractMessage.Builder.mergeFrom(byte[])

AbstractMessage.Builder.mergeFrom(byte[],ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(byte[],int,int)

AbstractMessage.Builder.mergeFrom(byte[],int,int,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(ByteString)

AbstractMessage.Builder.mergeFrom(ByteString,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(CodedInputStream)

AbstractMessage.Builder.mergeFrom(CodedInputStream,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(Message)

AbstractMessage.Builder.mergeFrom(InputStream)

AbstractMessage.Builder.mergeFrom(InputStream,ExtensionRegistryLite)

AbstractMessage.Builder.newUninitializedMessageException(Message)

AbstractMessage.Builder.toString()

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,Collection<? super T>)

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.Builder.internalMergeFrom(MessageType)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream,ExtensionRegistryLite)

AbstractMessageLite.Builder.mergeFrom(MessageLite)

AbstractMessageLite.Builder.newUninitializedMessageException(MessageLite)

GeneratedMessageV3.Builder.addRepeatedField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.clear()

GeneratedMessageV3.Builder.clearField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.clearOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.clone()

GeneratedMessageV3.Builder.getAllFields()

GeneratedMessageV3.Builder.getDescriptorForType()

GeneratedMessageV3.Builder.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getFieldBuilder(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.getParentForChildren()

GeneratedMessageV3.Builder.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldBuilder(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldCount(Descriptors.FieldDescriptor)

com.google.protobuf.GeneratedMessageV3.Builder.getUnknownFieldSetBuilder()

GeneratedMessageV3.Builder.getUnknownFields()

GeneratedMessageV3.Builder.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.internalGetFieldAccessorTable()

GeneratedMessageV3.Builder.internalGetMapField(int)

com.google.protobuf.GeneratedMessageV3.Builder.internalGetMapFieldReflection(int)

GeneratedMessageV3.Builder.internalGetMutableMapField(int)

com.google.protobuf.GeneratedMessageV3.Builder.internalGetMutableMapFieldReflection(int)

GeneratedMessageV3.Builder.isClean()

GeneratedMessageV3.Builder.isInitialized()

GeneratedMessageV3.Builder.markClean()

GeneratedMessageV3.Builder.mergeUnknownFields(UnknownFieldSet)

com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownLengthDelimitedField(int,com.google.protobuf.ByteString)

com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownVarintField(int,int)

GeneratedMessageV3.Builder.newBuilderForField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.onBuilt()

GeneratedMessageV3.Builder.onChanged()

com.google.protobuf.GeneratedMessageV3.Builder.parseUnknownField(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite,int)

GeneratedMessageV3.Builder.setField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.setRepeatedField(Descriptors.FieldDescriptor,int,Object)

com.google.protobuf.GeneratedMessageV3.Builder.setUnknownFieldSetBuilder(com.google.protobuf.UnknownFieldSet.Builder)

GeneratedMessageV3.Builder.setUnknownFields(UnknownFieldSet)

GeneratedMessageV3.Builder.setUnknownFieldsProto3(UnknownFieldSet)

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns
Type	Description
`Descriptor`

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public AppEngineHttpRequest.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)

Parameters
Name	Description
`field`	`FieldDescriptor`
`value`	`Object`

Returns
Type	Description
`AppEngineHttpRequest.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.addRepeatedField(Descriptors.FieldDescriptor field, Object value)

build()

public AppEngineHttpRequest build()

Returns
Type	Description
`AppEngineHttpRequest`

buildPartial()

public AppEngineHttpRequest buildPartial()

Returns
Type	Description
`AppEngineHttpRequest`

clear()

public AppEngineHttpRequest.Builder clear()

Returns
Type	Description
`AppEngineHttpRequest.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.clear()

clearAppEngineRouting()

public AppEngineHttpRequest.Builder clearAppEngineRouting()

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

clearField(Descriptors.FieldDescriptor field)

public AppEngineHttpRequest.Builder clearField(Descriptors.FieldDescriptor field)

Parameter
Name	Description
`field`	`FieldDescriptor`

Returns
Type	Description
`AppEngineHttpRequest.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearField(Descriptors.FieldDescriptor field)

clearHeaders()

public AppEngineHttpRequest.Builder clearHeaders()

Returns
Type	Description
`AppEngineHttpRequest.Builder`

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 and the App Engine documentation for your runtime on How Requests are Handled.

.google.cloud.tasks.v2beta2.HttpMethod http_method = 1;

Returns
Type	Description
`AppEngineHttpRequest.Builder`	This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public AppEngineHttpRequest.Builder clearOneof(Descriptors.OneofDescriptor oneof)

Parameter
Name	Description
`oneof`	`OneofDescriptor`

Returns
Type	Description
`AppEngineHttpRequest.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearOneof(Descriptors.OneofDescriptor oneof)

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.

bytes payload = 5;

Returns
Type	Description
`AppEngineHttpRequest.Builder`	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
Type	Description
`AppEngineHttpRequest.Builder`	This builder for chaining.

clone()

public AppEngineHttpRequest.Builder clone()

Returns
Type	Description
`AppEngineHttpRequest.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.clone()

containsHeaders(String key)

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. 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. 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`	`String`

Returns
Type	Description
`boolean`

getAppEngineRouting()

public 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
`AppEngineRouting`	The appEngineRouting.

getAppEngineRoutingBuilder()

public AppEngineRouting.Builder getAppEngineRoutingBuilder()

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
`AppEngineRouting.Builder`

getAppEngineRoutingOrBuilder()

public 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
`AppEngineRoutingOrBuilder`

getDefaultInstanceForType()

public AppEngineHttpRequest getDefaultInstanceForType()

Returns
Type	Description
`AppEngineHttpRequest`

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()

Returns
Type	Description
`Descriptor`

Overrides

GeneratedMessageV3.Builder<BuilderType>.getDescriptorForType()

getHeaders() (deprecated)

public Map<String,String> getHeaders()

Use #getHeadersMap() instead.

Returns
Type	Description
`Map<String,String>`

getHeadersCount()

public 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. 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
`int`

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. 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. 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
`Map<String,String>`

getHeadersOrDefault(String key, String defaultValue)

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. 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. 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`	`String`
`defaultValue`	`String`

Returns
Type	Description
`String`

getHeadersOrThrow(String key)

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. 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. 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`	`String`

Returns
Type	Description
`String`

getHttpMethod()

public HttpMethod getHttpMethod()

The HTTP method to use for the request. The default is POST.

.google.cloud.tasks.v2beta2.HttpMethod http_method = 1;

Returns
Type	Description
`HttpMethod`	The httpMethod.

getHttpMethodValue()

public int getHttpMethodValue()

The HTTP method to use for the request. The default is POST.

.google.cloud.tasks.v2beta2.HttpMethod http_method = 1;

Returns
Type	Description
`int`	The enum numeric value on the wire for httpMethod.

getMutableHeaders() (deprecated)

public Map<String,String> getMutableHeaders()

Use alternate mutation accessors instead.

Returns
Type	Description
`Map<String,String>`

getPayload()

public ByteString getPayload()

Payload.

bytes payload = 5;

Returns
Type	Description
`ByteString`	The payload.

getRelativeUrl()

public String getRelativeUrl()

The relative URL.

string relative_url = 3;

Returns
Type	Description
`String`	The relativeUrl.

getRelativeUrlBytes()

public ByteString getRelativeUrlBytes()

The relative URL.

string relative_url = 3;

Returns
Type	Description
`ByteString`	The bytes for relativeUrl.

hasAppEngineRouting()

public 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
`boolean`	Whether the appEngineRouting field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Returns
Type	Description
`FieldAccessorTable`

Overrides

GeneratedMessageV3.Builder<BuilderType>.internalGetFieldAccessorTable()

internalGetMapFieldReflection(int number)

protected MapFieldReflectionAccessor internalGetMapFieldReflection(int number)

Parameter
Name	Description
`number`	`int`

Returns
Type	Description
`com.google.protobuf.MapFieldReflectionAccessor`

Overrides

com.google.protobuf.GeneratedMessageV3.Builder.internalGetMapFieldReflection(int)

internalGetMutableMapFieldReflection(int number)

protected MapFieldReflectionAccessor internalGetMutableMapFieldReflection(int number)

Parameter
Name	Description
`number`	`int`

Returns
Type	Description
`com.google.protobuf.MapFieldReflectionAccessor`

Overrides

com.google.protobuf.GeneratedMessageV3.Builder.internalGetMutableMapFieldReflection(int)

isInitialized()

public final boolean isInitialized()

Returns
Type	Description
`boolean`

Overrides

GeneratedMessageV3.Builder<BuilderType>.isInitialized()

mergeAppEngineRouting(AppEngineRouting value)

public AppEngineHttpRequest.Builder mergeAppEngineRouting(AppEngineRouting value)

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;

Parameter
Name	Description
`value`	`AppEngineRouting`

Returns
Type	Description
`AppEngineHttpRequest.Builder`

mergeFrom(AppEngineHttpRequest other)

public AppEngineHttpRequest.Builder mergeFrom(AppEngineHttpRequest other)

Parameter
Name	Description
`other`	`AppEngineHttpRequest`

Returns
Type	Description
`AppEngineHttpRequest.Builder`

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public AppEngineHttpRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`input`	`CodedInputStream`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`AppEngineHttpRequest.Builder`

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Exceptions
Type	Description
`IOException`

mergeFrom(Message other)

public AppEngineHttpRequest.Builder mergeFrom(Message other)

Parameter
Name	Description
`other`	`Message`

Returns
Type	Description
`AppEngineHttpRequest.Builder`

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(Message other)

mergeUnknownFields(UnknownFieldSet unknownFields)

public final AppEngineHttpRequest.Builder mergeUnknownFields(UnknownFieldSet unknownFields)

Parameter
Name	Description
`unknownFields`	`UnknownFieldSet`

Returns
Type	Description
`AppEngineHttpRequest.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.mergeUnknownFields(UnknownFieldSet unknownFields)

putAllHeaders(Map<String,String> values)

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. 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. 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
`values`	`Map<String,String>`

Returns
Type	Description
`AppEngineHttpRequest.Builder`

putHeaders(String key, String value)

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. 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. 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`	`String`
`value`	`String`

Returns
Type	Description
`AppEngineHttpRequest.Builder`

removeHeaders(String key)

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. 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. 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`	`String`

Returns
Type	Description
`AppEngineHttpRequest.Builder`

setAppEngineRouting(AppEngineRouting value)

public AppEngineHttpRequest.Builder setAppEngineRouting(AppEngineRouting value)

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;

Parameter
Name	Description
`value`	`AppEngineRouting`

Returns
Type	Description
`AppEngineHttpRequest.Builder`

setAppEngineRouting(AppEngineRouting.Builder builderForValue)

public AppEngineHttpRequest.Builder setAppEngineRouting(AppEngineRouting.Builder builderForValue)

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;

Parameter
Name	Description
`builderForValue`	`AppEngineRouting.Builder`

Returns
Type	Description
`AppEngineHttpRequest.Builder`

setField(Descriptors.FieldDescriptor field, Object value)

public AppEngineHttpRequest.Builder setField(Descriptors.FieldDescriptor field, Object value)

Parameters
Name	Description
`field`	`FieldDescriptor`
`value`	`Object`

Returns
Type	Description
`AppEngineHttpRequest.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.setField(Descriptors.FieldDescriptor field, Object value)

setHttpMethod(HttpMethod value)

public AppEngineHttpRequest.Builder setHttpMethod(HttpMethod value)

The HTTP method to use for the request. The default is POST.

.google.cloud.tasks.v2beta2.HttpMethod http_method = 1;

Parameter
Name	Description
`value`	`HttpMethod` The httpMethod to set.

Returns
Type	Description
`AppEngineHttpRequest.Builder`	This builder for chaining.

setHttpMethodValue(int value)

public AppEngineHttpRequest.Builder setHttpMethodValue(int value)

The HTTP method to use for the request. The default is POST.

.google.cloud.tasks.v2beta2.HttpMethod http_method = 1;

Parameter
Name	Description
`value`	`int` The enum numeric value on the wire for httpMethod to set.

Returns
Type	Description
`AppEngineHttpRequest.Builder`	This builder for chaining.

setPayload(ByteString value)

public AppEngineHttpRequest.Builder setPayload(ByteString value)

Payload.

bytes payload = 5;

Parameter
Name	Description
`value`	`ByteString` The payload to set.

Returns
Type	Description
`AppEngineHttpRequest.Builder`	This builder for chaining.

setRelativeUrl(String value)

public AppEngineHttpRequest.Builder setRelativeUrl(String value)

The relative URL.

string relative_url = 3;

Parameter
Name	Description
`value`	`String` The relativeUrl to set.

Returns
Type	Description
`AppEngineHttpRequest.Builder`	This builder for chaining.

setRelativeUrlBytes(ByteString value)

public AppEngineHttpRequest.Builder setRelativeUrlBytes(ByteString value)

The relative URL.

string relative_url = 3;

Parameter
Name	Description
`value`	`ByteString` The bytes for relativeUrl to set.

Returns
Type	Description
`AppEngineHttpRequest.Builder`	This builder for chaining.

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public AppEngineHttpRequest.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

Parameters
Name	Description
`field`	`FieldDescriptor`
`index`	`int`
`value`	`Object`

Returns
Type	Description
`AppEngineHttpRequest.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

setUnknownFields(UnknownFieldSet unknownFields)

public final AppEngineHttpRequest.Builder setUnknownFields(UnknownFieldSet unknownFields)

Parameter
Name	Description
`unknownFields`	`UnknownFieldSet`

Returns
Type	Description
`AppEngineHttpRequest.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.setUnknownFields(UnknownFieldSet unknownFields)