- 2.47.0 (latest)
- 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 final class AppEngineHttpRequest extends GeneratedMessageV3 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_urlTasks 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 withlogin: 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, a429
(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<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > AppEngineHttpRequestImplements
AppEngineHttpRequestOrBuilderStatic Fields
APP_ENGINE_ROUTING_FIELD_NUMBER
public static final int APP_ENGINE_ROUTING_FIELD_NUMBER
Field Value | |
---|---|
Type | Description |
int |
HEADERS_FIELD_NUMBER
public static final int HEADERS_FIELD_NUMBER
Field Value | |
---|---|
Type | Description |
int |
HTTP_METHOD_FIELD_NUMBER
public static final int HTTP_METHOD_FIELD_NUMBER
Field Value | |
---|---|
Type | Description |
int |
PAYLOAD_FIELD_NUMBER
public static final int PAYLOAD_FIELD_NUMBER
Field Value | |
---|---|
Type | Description |
int |
RELATIVE_URL_FIELD_NUMBER
public static final int RELATIVE_URL_FIELD_NUMBER
Field Value | |
---|---|
Type | Description |
int |
Static Methods
getDefaultInstance()
public static AppEngineHttpRequest getDefaultInstance()
Returns | |
---|---|
Type | Description |
AppEngineHttpRequest |
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Returns | |
---|---|
Type | Description |
Descriptor |
newBuilder()
public static AppEngineHttpRequest.Builder newBuilder()
Returns | |
---|---|
Type | Description |
AppEngineHttpRequest.Builder |
newBuilder(AppEngineHttpRequest prototype)
public static AppEngineHttpRequest.Builder newBuilder(AppEngineHttpRequest prototype)
Parameter | |
---|---|
Name | Description |
prototype |
AppEngineHttpRequest |
Returns | |
---|---|
Type | Description |
AppEngineHttpRequest.Builder |
parseDelimitedFrom(InputStream input)
public static AppEngineHttpRequest parseDelimitedFrom(InputStream input)
Parameter | |
---|---|
Name | Description |
input |
InputStream |
Returns | |
---|---|
Type | Description |
AppEngineHttpRequest |
Exceptions | |
---|---|
Type | Description |
IOException |
parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static AppEngineHttpRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters | |
---|---|
Name | Description |
input |
InputStream |
extensionRegistry |
ExtensionRegistryLite |
Returns | |
---|---|
Type | Description |
AppEngineHttpRequest |
Exceptions | |
---|---|
Type | Description |
IOException |
parseFrom(byte[] data)
public static AppEngineHttpRequest parseFrom(byte[] data)
Parameter | |
---|---|
Name | Description |
data |
byte[] |
Returns | |
---|---|
Type | Description |
AppEngineHttpRequest |
Exceptions | |
---|---|
Type | Description |
InvalidProtocolBufferException |
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static AppEngineHttpRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters | |
---|---|
Name | Description |
data |
byte[] |
extensionRegistry |
ExtensionRegistryLite |
Returns | |
---|---|
Type | Description |
AppEngineHttpRequest |
Exceptions | |
---|---|
Type | Description |
InvalidProtocolBufferException |
parseFrom(ByteString data)
public static AppEngineHttpRequest parseFrom(ByteString data)
Parameter | |
---|---|
Name | Description |
data |
ByteString |
Returns | |
---|---|
Type | Description |
AppEngineHttpRequest |
Exceptions | |
---|---|
Type | Description |
InvalidProtocolBufferException |
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static AppEngineHttpRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters | |
---|---|
Name | Description |
data |
ByteString |
extensionRegistry |
ExtensionRegistryLite |
Returns | |
---|---|
Type | Description |
AppEngineHttpRequest |
Exceptions | |
---|---|
Type | Description |
InvalidProtocolBufferException |
parseFrom(CodedInputStream input)
public static AppEngineHttpRequest parseFrom(CodedInputStream input)
Parameter | |
---|---|
Name | Description |
input |
CodedInputStream |
Returns | |
---|---|
Type | Description |
AppEngineHttpRequest |
Exceptions | |
---|---|
Type | Description |
IOException |
parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static AppEngineHttpRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters | |
---|---|
Name | Description |
input |
CodedInputStream |
extensionRegistry |
ExtensionRegistryLite |
Returns | |
---|---|
Type | Description |
AppEngineHttpRequest |
Exceptions | |
---|---|
Type | Description |
IOException |
parseFrom(InputStream input)
public static AppEngineHttpRequest parseFrom(InputStream input)
Parameter | |
---|---|
Name | Description |
input |
InputStream |
Returns | |
---|---|
Type | Description |
AppEngineHttpRequest |
Exceptions | |
---|---|
Type | Description |
IOException |
parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static AppEngineHttpRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters | |
---|---|
Name | Description |
input |
InputStream |
extensionRegistry |
ExtensionRegistryLite |
Returns | |
---|---|
Type | Description |
AppEngineHttpRequest |
Exceptions | |
---|---|
Type | Description |
IOException |
parseFrom(ByteBuffer data)
public static AppEngineHttpRequest parseFrom(ByteBuffer data)
Parameter | |
---|---|
Name | Description |
data |
ByteBuffer |
Returns | |
---|---|
Type | Description |
AppEngineHttpRequest |
Exceptions | |
---|---|
Type | Description |
InvalidProtocolBufferException |
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static AppEngineHttpRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters | |
---|---|
Name | Description |
data |
ByteBuffer |
extensionRegistry |
ExtensionRegistryLite |
Returns | |
---|---|
Type | Description |
AppEngineHttpRequest |
Exceptions | |
---|---|
Type | Description |
InvalidProtocolBufferException |
parser()
public static Parser<AppEngineHttpRequest> parser()
Returns | |
---|---|
Type | Description |
Parser<AppEngineHttpRequest> |
Methods
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 modifiedUser-Agent
.If the task has a payload, Cloud Tasks sets the following headers:
Content-Type
: By default, theContent-Type
header is set to"application/octet-stream"
. The default can be overridden by explicitly settingContent-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 |
equals(Object obj)
public boolean equals(Object obj)
Parameter | |
---|---|
Name | Description |
obj |
Object |
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. |
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 |
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 modifiedUser-Agent
.If the task has a payload, Cloud Tasks sets the following headers:
Content-Type
: By default, theContent-Type
header is set to"application/octet-stream"
. The default can be overridden by explicitly settingContent-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 modifiedUser-Agent
.If the task has a payload, Cloud Tasks sets the following headers:
Content-Type
: By default, theContent-Type
header is set to"application/octet-stream"
. The default can be overridden by explicitly settingContent-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 modifiedUser-Agent
.If the task has a payload, Cloud Tasks sets the following headers:
Content-Type
: By default, theContent-Type
header is set to"application/octet-stream"
. The default can be overridden by explicitly settingContent-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 modifiedUser-Agent
.If the task has a payload, Cloud Tasks sets the following headers:
Content-Type
: By default, theContent-Type
header is set to"application/octet-stream"
. The default can be overridden by explicitly settingContent-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.
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 |
HttpMethod |
The httpMethod. |
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 and the App Engine documentation for your runtime on How Requests are Handled.
.google.cloud.tasks.v2beta2.HttpMethod http_method = 1;
Returns | |
---|---|
Type | Description |
int |
The enum numeric value on the wire for httpMethod. |
getParserForType()
public Parser<AppEngineHttpRequest> getParserForType()
Returns | |
---|---|
Type | Description |
Parser<AppEngineHttpRequest> |
getPayload()
public 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 |
ByteString |
The payload. |
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;
Returns | |
---|---|
Type | Description |
String |
The relativeUrl. |
getRelativeUrlBytes()
public 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 |
ByteString |
The bytes for relativeUrl. |
getSerializedSize()
public int getSerializedSize()
Returns | |
---|---|
Type | Description |
int |
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. |
hashCode()
public int hashCode()
Returns | |
---|---|
Type | Description |
int |
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns | |
---|---|
Type | Description |
FieldAccessorTable |
internalGetMapFieldReflection(int number)
protected MapFieldReflectionAccessor internalGetMapFieldReflection(int number)
Parameter | |
---|---|
Name | Description |
number |
int |
Returns | |
---|---|
Type | Description |
com.google.protobuf.MapFieldReflectionAccessor |
isInitialized()
public final boolean isInitialized()
Returns | |
---|---|
Type | Description |
boolean |
newBuilderForType()
public AppEngineHttpRequest.Builder newBuilderForType()
Returns | |
---|---|
Type | Description |
AppEngineHttpRequest.Builder |
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected AppEngineHttpRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter | |
---|---|
Name | Description |
parent |
BuilderParent |
Returns | |
---|---|
Type | Description |
AppEngineHttpRequest.Builder |
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter | |
---|---|
Name | Description |
unused |
UnusedPrivateParameter |
Returns | |
---|---|
Type | Description |
Object |
toBuilder()
public AppEngineHttpRequest.Builder toBuilder()
Returns | |
---|---|
Type | Description |
AppEngineHttpRequest.Builder |
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Parameter | |
---|---|
Name | Description |
output |
CodedOutputStream |
Exceptions | |
---|---|
Type | Description |
IOException |