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.
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 app_engine_routing_override is set on the
queue, this value 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_uri
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.v2.AppEngineHttpRequest
Static Fields
APP_ENGINE_ROUTING_FIELD_NUMBER
public static final int APP_ENGINE_ROUTING_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
BODY_FIELD_NUMBER
public static final int BODY_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
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 | |
RELATIVE_URI_FIELD_NUMBER
public static final int RELATIVE_URI_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
Static Methods
getDefaultInstance()
public static AppEngineHttpRequest getDefaultInstance()
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
newBuilder()
public static AppEngineHttpRequest.Builder newBuilder()
newBuilder(AppEngineHttpRequest prototype)
public static AppEngineHttpRequest.Builder newBuilder(AppEngineHttpRequest prototype)
public static AppEngineHttpRequest parseDelimitedFrom(InputStream input)
public static AppEngineHttpRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(byte[] data)
public static AppEngineHttpRequest parseFrom(byte[] data)
| Parameter |
|---|
| Name | Description |
data | byte[]
|
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static AppEngineHttpRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteString data)
public static AppEngineHttpRequest parseFrom(ByteString data)
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static AppEngineHttpRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static AppEngineHttpRequest parseFrom(CodedInputStream input)
public static AppEngineHttpRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static AppEngineHttpRequest parseFrom(InputStream input)
public static AppEngineHttpRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteBuffer data)
public static AppEngineHttpRequest parseFrom(ByteBuffer data)
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static AppEngineHttpRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
parser()
public static Parser<AppEngineHttpRequest> parser()
Methods
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 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.
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:HostX-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
|
equals(Object obj)
public boolean equals(Object obj)
| Parameter |
|---|
| Name | Description |
obj | Object
|
Overrides
getAppEngineRouting()
public AppEngineRouting getAppEngineRouting()
Task-level setting for App Engine routing.
- If app_engine_routing_override is set on the
queue, this value is used for all
tasks in the queue, no matter what the setting is for the task-level
app_engine_routing.
.google.cloud.tasks.v2.AppEngineRouting app_engine_routing = 2;
getAppEngineRoutingOrBuilder()
public AppEngineRoutingOrBuilder getAppEngineRoutingOrBuilder()
Task-level setting for App Engine routing.
- If app_engine_routing_override is set on the
queue, this value is used for all
tasks in the queue, no matter what the setting is for the task-level
app_engine_routing.
.google.cloud.tasks.v2.AppEngineRouting app_engine_routing = 2;
getBody()
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.
bytes body = 5;
getDefaultInstanceForType()
public AppEngineHttpRequest getDefaultInstanceForType()
public Map<String,String> getHeaders()
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 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.
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:HostX-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 | |
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 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.
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:HostX-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;
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 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.
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:HostX-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;
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 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.
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:HostX-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
|
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 will fail
with error code 405 (Method Not Allowed). See
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.
.google.cloud.tasks.v2.HttpMethod http_method = 1;
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 will fail
with error code 405 (Method Not Allowed). See
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.
.google.cloud.tasks.v2.HttpMethod http_method = 1;
| Returns |
|---|
| Type | Description |
int | The enum numeric value on the wire for httpMethod.
|
getParserForType()
public Parser<AppEngineHttpRequest> getParserForType()
Overrides
getRelativeUri()
public 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;
| Returns |
|---|
| Type | Description |
String | The relativeUri.
|
getRelativeUriBytes()
public 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;
| Returns |
|---|
| Type | Description |
ByteString | The bytes for relativeUri.
|
getSerializedSize()
public int getSerializedSize()
| Returns |
|---|
| Type | Description |
int | |
Overrides
getUnknownFields()
public final UnknownFieldSet getUnknownFields()
Overrides
hasAppEngineRouting()
public boolean hasAppEngineRouting()
Task-level setting for App Engine routing.
- If app_engine_routing_override is set on the
queue, this value is used for all
tasks in the queue, no matter what the setting is for the task-level
app_engine_routing.
.google.cloud.tasks.v2.AppEngineRouting app_engine_routing = 2;
| Returns |
|---|
| Type | Description |
boolean | Whether the appEngineRouting field is set.
|
hashCode()
| Returns |
|---|
| Type | Description |
int | |
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
internalGetMapField(int number)
protected MapField internalGetMapField(int number)
| Parameter |
|---|
| Name | Description |
number | int
|
Overrides
isInitialized()
public final boolean isInitialized()
Overrides
newBuilderForType()
public AppEngineHttpRequest.Builder newBuilderForType()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected AppEngineHttpRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Overrides
toBuilder()
public AppEngineHttpRequest.Builder toBuilder()
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Overrides
