public final class HttpRequest extends GeneratedMessageV3 implements HttpRequestOrBuilder
HTTP request.
The task will be pushed to the worker as an HTTP request. If the worker
or the redirected worker acknowledges the task by returning a successful HTTP
response code ([200 - 299]), the task will be removed from the queue. If
any other HTTP response code is returned or no response is received, the
task will be retried according to the following:
User-specified throttling: retry
configuration,
rate limits, and the queue's
state.
System throttling: To prevent the worker from overloading, Cloud Tasks may
temporarily reduce the queue's effective rate. User-specified settings
will not be changed.
System throttling happens because:
Cloud Tasks backs off on all errors. Normally the backoff specified in
rate limits will be used. But
if the worker returns 429 (Too Many Requests), 503 (Service
Unavailable), or the rate of errors is high, Cloud Tasks will use a
higher backoff rate. The retry specified in the Retry-After HTTP
response header is considered.
To prevent traffic spikes and to smooth sudden increases in traffic,
dispatches ramp up slowly when the queue is newly created or idle and
if large numbers of tasks suddenly become available to dispatch (due to
spikes in create task rates, the queue being unpaused, or many tasks
that are scheduled at the same time).
Protobuf type google.cloud.tasks.v2.HttpRequest
Inherited Members
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)
com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)
Static Fields
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 | |
OAUTH_TOKEN_FIELD_NUMBER
public static final int OAUTH_TOKEN_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
OIDC_TOKEN_FIELD_NUMBER
public static final int OIDC_TOKEN_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
URL_FIELD_NUMBER
public static final int URL_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
Static Methods
getDefaultInstance()
public static HttpRequest getDefaultInstance()
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
newBuilder()
public static HttpRequest.Builder newBuilder()
newBuilder(HttpRequest prototype)
public static HttpRequest.Builder newBuilder(HttpRequest prototype)
public static HttpRequest parseDelimitedFrom(InputStream input)
public static HttpRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(byte[] data)
public static HttpRequest parseFrom(byte[] data)
| Parameter |
|---|
| Name | Description |
data | byte[]
|
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static HttpRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteString data)
public static HttpRequest parseFrom(ByteString data)
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static HttpRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static HttpRequest parseFrom(CodedInputStream input)
public static HttpRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static HttpRequest parseFrom(InputStream input)
public static HttpRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteBuffer data)
public static HttpRequest parseFrom(ByteBuffer data)
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static HttpRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
parser()
public static Parser<HttpRequest> 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.
These headers represent a subset of the headers that will accompany the
task's HTTP request. Some HTTP request headers will be ignored or replaced.
A partial list of headers that will be ignored or replaced is:
- Host: This will be computed by Cloud Tasks and derived from
HttpRequest.url.
- Content-Length: This will be computed by Cloud Tasks.
- User-Agent: This will be set to
"Google-Cloud-Tasks".
X-Google-*: Google use only.X-AppEngine-*: Google use only.
Content-Type won't be set by Cloud Tasks. You can explicitly set
Content-Type to a media type when the
task is created.
For example, Content-Type can be set to "application/octet-stream" or
"application/json".
Headers which can have multiple values (according to RFC2616) can be
specified using comma-separated values.
The size of the headers must be less than 80KB.
map<string, string> headers = 3;
| Parameter |
|---|
| Name | Description |
key | String
|
equals(Object obj)
public boolean equals(Object obj)
| Parameter |
|---|
| Name | Description |
obj | Object
|
Overrides
public HttpRequest.AuthorizationHeaderCase getAuthorizationHeaderCase()
getBody()
public ByteString getBody()
HTTP request body.
A request body is allowed only if the
HTTP method is POST, PUT,
or PATCH. It is an error to set body on a task with an incompatible
HttpMethod.
bytes body = 4;
getDefaultInstanceForType()
public HttpRequest 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.
These headers represent a subset of the headers that will accompany the
task's HTTP request. Some HTTP request headers will be ignored or replaced.
A partial list of headers that will be ignored or replaced is:
- Host: This will be computed by Cloud Tasks and derived from
HttpRequest.url.
- Content-Length: This will be computed by Cloud Tasks.
- User-Agent: This will be set to
"Google-Cloud-Tasks".
X-Google-*: Google use only.X-AppEngine-*: Google use only.
Content-Type won't be set by Cloud Tasks. You can explicitly set
Content-Type to a media type when the
task is created.
For example, Content-Type can be set to "application/octet-stream" or
"application/json".
Headers which can have multiple values (according to RFC2616) can be
specified using comma-separated values.
The size of the headers must be less than 80KB.
map<string, string> headers = 3;
| 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.
These headers represent a subset of the headers that will accompany the
task's HTTP request. Some HTTP request headers will be ignored or replaced.
A partial list of headers that will be ignored or replaced is:
- Host: This will be computed by Cloud Tasks and derived from
HttpRequest.url.
- Content-Length: This will be computed by Cloud Tasks.
- User-Agent: This will be set to
"Google-Cloud-Tasks".
X-Google-*: Google use only.X-AppEngine-*: Google use only.
Content-Type won't be set by Cloud Tasks. You can explicitly set
Content-Type to a media type when the
task is created.
For example, Content-Type can be set to "application/octet-stream" or
"application/json".
Headers which can have multiple values (according to RFC2616) can be
specified using comma-separated values.
The size of the headers must be less than 80KB.
map<string, string> headers = 3;
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.
These headers represent a subset of the headers that will accompany the
task's HTTP request. Some HTTP request headers will be ignored or replaced.
A partial list of headers that will be ignored or replaced is:
- Host: This will be computed by Cloud Tasks and derived from
HttpRequest.url.
- Content-Length: This will be computed by Cloud Tasks.
- User-Agent: This will be set to
"Google-Cloud-Tasks".
X-Google-*: Google use only.X-AppEngine-*: Google use only.
Content-Type won't be set by Cloud Tasks. You can explicitly set
Content-Type to a media type when the
task is created.
For example, Content-Type can be set to "application/octet-stream" or
"application/json".
Headers which can have multiple values (according to RFC2616) can be
specified using comma-separated values.
The size of the headers must be less than 80KB.
map<string, string> headers = 3;
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.
These headers represent a subset of the headers that will accompany the
task's HTTP request. Some HTTP request headers will be ignored or replaced.
A partial list of headers that will be ignored or replaced is:
- Host: This will be computed by Cloud Tasks and derived from
HttpRequest.url.
- Content-Length: This will be computed by Cloud Tasks.
- User-Agent: This will be set to
"Google-Cloud-Tasks".
X-Google-*: Google use only.X-AppEngine-*: Google use only.
Content-Type won't be set by Cloud Tasks. You can explicitly set
Content-Type to a media type when the
task is created.
For example, Content-Type can be set to "application/octet-stream" or
"application/json".
Headers which can have multiple values (according to RFC2616) can be
specified using comma-separated values.
The size of the headers must be less than 80KB.
map<string, string> headers = 3;
| Parameter |
|---|
| Name | Description |
key | String
|
getHttpMethod()
public HttpMethod getHttpMethod()
The HTTP method to use for the request. The default is POST.
.google.cloud.tasks.v2.HttpMethod http_method = 2;
getHttpMethodValue()
public int getHttpMethodValue()
The HTTP method to use for the request. The default is POST.
.google.cloud.tasks.v2.HttpMethod http_method = 2;
| Returns |
|---|
| Type | Description |
int | The enum numeric value on the wire for httpMethod.
|
getOauthToken()
public OAuthToken getOauthToken()
If specified, an
OAuth token
will be generated and attached as an Authorization header in the HTTP
request.
This type of authorization should generally only be used when calling
Google APIs hosted on *.googleapis.com.
.google.cloud.tasks.v2.OAuthToken oauth_token = 5;
getOauthTokenOrBuilder()
public OAuthTokenOrBuilder getOauthTokenOrBuilder()
If specified, an
OAuth token
will be generated and attached as an Authorization header in the HTTP
request.
This type of authorization should generally only be used when calling
Google APIs hosted on *.googleapis.com.
.google.cloud.tasks.v2.OAuthToken oauth_token = 5;
getOidcToken()
public OidcToken getOidcToken()
If specified, an
OIDC
token will be generated and attached as an Authorization header in the
HTTP request.
This type of authorization can be used for many scenarios, including
calling Cloud Run, or endpoints where you intend to validate the token
yourself.
.google.cloud.tasks.v2.OidcToken oidc_token = 6;
| Returns |
|---|
| Type | Description |
OidcToken | The oidcToken.
|
getOidcTokenOrBuilder()
public OidcTokenOrBuilder getOidcTokenOrBuilder()
If specified, an
OIDC
token will be generated and attached as an Authorization header in the
HTTP request.
This type of authorization can be used for many scenarios, including
calling Cloud Run, or endpoints where you intend to validate the token
yourself.
.google.cloud.tasks.v2.OidcToken oidc_token = 6;
getParserForType()
public Parser<HttpRequest> getParserForType()
Overrides
getSerializedSize()
public int getSerializedSize()
| Returns |
|---|
| Type | Description |
int | |
Overrides
getUrl()
Required. The full url path that the request will be sent to.
This string must begin with either "http://" or "https://". Some examples
are: http://acme.com and https://acme.com/sales:8080. Cloud Tasks will
encode some characters for safety and compatibility. The maximum allowed
URL length is 2083 characters after encoding.
The Location header response from a redirect response [300 - 399]
may be followed. The redirect is not counted as a separate attempt.
string url = 1 [(.google.api.field_behavior) = REQUIRED];
| Returns |
|---|
| Type | Description |
String | The url.
|
getUrlBytes()
public ByteString getUrlBytes()
Required. The full url path that the request will be sent to.
This string must begin with either "http://" or "https://". Some examples
are: http://acme.com and https://acme.com/sales:8080. Cloud Tasks will
encode some characters for safety and compatibility. The maximum allowed
URL length is 2083 characters after encoding.
The Location header response from a redirect response [300 - 399]
may be followed. The redirect is not counted as a separate attempt.
string url = 1 [(.google.api.field_behavior) = REQUIRED];
| Returns |
|---|
| Type | Description |
ByteString | The bytes for url.
|
hasOauthToken()
public boolean hasOauthToken()
If specified, an
OAuth token
will be generated and attached as an Authorization header in the HTTP
request.
This type of authorization should generally only be used when calling
Google APIs hosted on *.googleapis.com.
.google.cloud.tasks.v2.OAuthToken oauth_token = 5;
| Returns |
|---|
| Type | Description |
boolean | Whether the oauthToken field is set.
|
hasOidcToken()
public boolean hasOidcToken()
If specified, an
OIDC
token will be generated and attached as an Authorization header in the
HTTP request.
This type of authorization can be used for many scenarios, including
calling Cloud Run, or endpoints where you intend to validate the token
yourself.
.google.cloud.tasks.v2.OidcToken oidc_token = 6;
| Returns |
|---|
| Type | Description |
boolean | Whether the oidcToken field is set.
|
hashCode()
| Returns |
|---|
| Type | Description |
int | |
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
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.internalGetMapFieldReflection(int)
isInitialized()
public final boolean isInitialized()
Overrides
newBuilderForType()
public HttpRequest.Builder newBuilderForType()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected HttpRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Overrides
toBuilder()
public HttpRequest.Builder toBuilder()
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Overrides
