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][google.cloud.tasks.v2.Queue.retry_config], [rate limits][google.cloud.tasks.v2.Queue.rate_limits], and the [queue's state][google.cloud.tasks.v2.Queue.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][google.cloud.tasks.v2.Queue.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
Modifier and Type | Class and Description |
---|---|
static class |
HttpRequest.AuthorizationHeaderCase |
static class |
HttpRequest.Builder
HTTP request.
|
GeneratedMessageV3.BuilderParent, GeneratedMessageV3.ExtendableBuilder<MessageType extends GeneratedMessageV3.ExtendableMessage,BuilderType extends GeneratedMessageV3.ExtendableBuilder<MessageType,BuilderType>>, GeneratedMessageV3.ExtendableMessage<MessageType extends GeneratedMessageV3.ExtendableMessage>, GeneratedMessageV3.ExtendableMessageOrBuilder<MessageType extends GeneratedMessageV3.ExtendableMessage>, GeneratedMessageV3.FieldAccessorTable, GeneratedMessageV3.UnusedPrivateParameter
AbstractMessageLite.InternalOneOfEnum
Modifier and Type | Field and Description |
---|---|
static int |
BODY_FIELD_NUMBER |
static int |
HEADERS_FIELD_NUMBER |
static int |
HTTP_METHOD_FIELD_NUMBER |
static int |
OAUTH_TOKEN_FIELD_NUMBER |
static int |
OIDC_TOKEN_FIELD_NUMBER |
static int |
URL_FIELD_NUMBER |
alwaysUseFieldBuilders, unknownFields
memoizedSize
memoizedHashCode
Modifier and Type | Method and Description |
---|---|
boolean |
containsHeaders(String key)
HTTP request headers.
|
boolean |
equals(Object obj) |
HttpRequest.AuthorizationHeaderCase |
getAuthorizationHeaderCase() |
ByteString |
getBody()
HTTP request body.
|
static HttpRequest |
getDefaultInstance() |
HttpRequest |
getDefaultInstanceForType() |
static Descriptors.Descriptor |
getDescriptor() |
Map<String,String> |
getHeaders()
Deprecated.
|
int |
getHeadersCount()
HTTP request headers.
|
Map<String,String> |
getHeadersMap()
HTTP request headers.
|
String |
getHeadersOrDefault(String key,
String defaultValue)
HTTP request headers.
|
String |
getHeadersOrThrow(String key)
HTTP request headers.
|
HttpMethod |
getHttpMethod()
The HTTP method to use for the request.
|
int |
getHttpMethodValue()
The HTTP method to use for the request.
|
OAuthToken |
getOauthToken()
If specified, an
[OAuth token](https://developers.google.com/identity/protocols/OAuth2)
will be generated and attached as an `Authorization` header in the HTTP
request.
|
OAuthTokenOrBuilder |
getOauthTokenOrBuilder()
If specified, an
[OAuth token](https://developers.google.com/identity/protocols/OAuth2)
will be generated and attached as an `Authorization` header in the HTTP
request.
|
OidcToken |
getOidcToken()
If specified, an
[OIDC](https://developers.google.com/identity/protocols/OpenIDConnect)
token will be generated and attached as an `Authorization` header in the
HTTP request.
|
OidcTokenOrBuilder |
getOidcTokenOrBuilder()
If specified, an
[OIDC](https://developers.google.com/identity/protocols/OpenIDConnect)
token will be generated and attached as an `Authorization` header in the
HTTP request.
|
Parser<HttpRequest> |
getParserForType() |
int |
getSerializedSize() |
UnknownFieldSet |
getUnknownFields() |
String |
getUrl()
Required.
|
ByteString |
getUrlBytes()
Required.
|
int |
hashCode() |
boolean |
hasOauthToken()
If specified, an
[OAuth token](https://developers.google.com/identity/protocols/OAuth2)
will be generated and attached as an `Authorization` header in the HTTP
request.
|
boolean |
hasOidcToken()
If specified, an
[OIDC](https://developers.google.com/identity/protocols/OpenIDConnect)
token will be generated and attached as an `Authorization` header in the
HTTP request.
|
protected GeneratedMessageV3.FieldAccessorTable |
internalGetFieldAccessorTable() |
protected MapField |
internalGetMapField(int number) |
boolean |
isInitialized() |
static HttpRequest.Builder |
newBuilder() |
static HttpRequest.Builder |
newBuilder(HttpRequest prototype) |
HttpRequest.Builder |
newBuilderForType() |
protected HttpRequest.Builder |
newBuilderForType(GeneratedMessageV3.BuilderParent parent) |
protected Object |
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused) |
static HttpRequest |
parseDelimitedFrom(InputStream input) |
static HttpRequest |
parseDelimitedFrom(InputStream input,
ExtensionRegistryLite extensionRegistry) |
static HttpRequest |
parseFrom(byte[] data) |
static HttpRequest |
parseFrom(byte[] data,
ExtensionRegistryLite extensionRegistry) |
static HttpRequest |
parseFrom(ByteBuffer data) |
static HttpRequest |
parseFrom(ByteBuffer data,
ExtensionRegistryLite extensionRegistry) |
static HttpRequest |
parseFrom(ByteString data) |
static HttpRequest |
parseFrom(ByteString data,
ExtensionRegistryLite extensionRegistry) |
static HttpRequest |
parseFrom(CodedInputStream input) |
static HttpRequest |
parseFrom(CodedInputStream input,
ExtensionRegistryLite extensionRegistry) |
static HttpRequest |
parseFrom(InputStream input) |
static HttpRequest |
parseFrom(InputStream input,
ExtensionRegistryLite extensionRegistry) |
static Parser<HttpRequest> |
parser() |
HttpRequest.Builder |
toBuilder() |
void |
writeTo(CodedOutputStream output) |
canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof, isStringEmpty, makeExtensionsImmutable, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag
findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString
addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof
toByteArray, toByteString, writeDelimitedTo, writeTo
public static final int URL_FIELD_NUMBER
public static final int HTTP_METHOD_FIELD_NUMBER
public static final int HEADERS_FIELD_NUMBER
public static final int BODY_FIELD_NUMBER
public static final int OAUTH_TOKEN_FIELD_NUMBER
public static final int OIDC_TOKEN_FIELD_NUMBER
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
newInstance
in class GeneratedMessageV3
public final UnknownFieldSet getUnknownFields()
getUnknownFields
in interface MessageOrBuilder
getUnknownFields
in class GeneratedMessageV3
public static final Descriptors.Descriptor getDescriptor()
protected MapField internalGetMapField(int number)
internalGetMapField
in class GeneratedMessageV3
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
internalGetFieldAccessorTable
in class GeneratedMessageV3
public HttpRequest.AuthorizationHeaderCase getAuthorizationHeaderCase()
getAuthorizationHeaderCase
in interface HttpRequestOrBuilder
public String 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];
getUrl
in interface HttpRequestOrBuilder
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];
getUrlBytes
in interface HttpRequestOrBuilder
public int getHttpMethodValue()
The HTTP method to use for the request. The default is POST.
.google.cloud.tasks.v2.HttpMethod http_method = 2;
getHttpMethodValue
in interface HttpRequestOrBuilder
public HttpMethod getHttpMethod()
The HTTP method to use for the request. The default is POST.
.google.cloud.tasks.v2.HttpMethod http_method = 2;
getHttpMethod
in interface HttpRequestOrBuilder
public int getHeadersCount()
HttpRequestOrBuilder
HTTP request headers. This map contains the header field names and values. Headers can be set when the [task is created][google.cloud.tasks.v2beta3.CloudTasks.CreateTask]. 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][google.cloud.tasks.v2.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][google.cloud.tasks.v2beta3.CloudTasks.CreateTask]. 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;
getHeadersCount
in interface HttpRequestOrBuilder
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][google.cloud.tasks.v2beta3.CloudTasks.CreateTask]. 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][google.cloud.tasks.v2.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][google.cloud.tasks.v2beta3.CloudTasks.CreateTask]. 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;
containsHeaders
in interface HttpRequestOrBuilder
@Deprecated public Map<String,String> getHeaders()
getHeadersMap()
instead.getHeaders
in interface HttpRequestOrBuilder
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][google.cloud.tasks.v2beta3.CloudTasks.CreateTask]. 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][google.cloud.tasks.v2.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][google.cloud.tasks.v2beta3.CloudTasks.CreateTask]. 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;
getHeadersMap
in interface HttpRequestOrBuilder
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][google.cloud.tasks.v2beta3.CloudTasks.CreateTask]. 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][google.cloud.tasks.v2.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][google.cloud.tasks.v2beta3.CloudTasks.CreateTask]. 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;
getHeadersOrDefault
in interface HttpRequestOrBuilder
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][google.cloud.tasks.v2beta3.CloudTasks.CreateTask]. 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][google.cloud.tasks.v2.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][google.cloud.tasks.v2beta3.CloudTasks.CreateTask]. 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;
getHeadersOrThrow
in interface HttpRequestOrBuilder
public ByteString getBody()
HTTP request body. A request body is allowed only if the [HTTP method][google.cloud.tasks.v2.HttpRequest.http_method] is POST, PUT, or PATCH. It is an error to set body on a task with an incompatible [HttpMethod][google.cloud.tasks.v2.HttpMethod].
bytes body = 4;
getBody
in interface HttpRequestOrBuilder
public boolean hasOauthToken()
If specified, an [OAuth token](https://developers.google.com/identity/protocols/OAuth2) 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;
hasOauthToken
in interface HttpRequestOrBuilder
public OAuthToken getOauthToken()
If specified, an [OAuth token](https://developers.google.com/identity/protocols/OAuth2) 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;
getOauthToken
in interface HttpRequestOrBuilder
public OAuthTokenOrBuilder getOauthTokenOrBuilder()
If specified, an [OAuth token](https://developers.google.com/identity/protocols/OAuth2) 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
in interface HttpRequestOrBuilder
public boolean hasOidcToken()
If specified, an [OIDC](https://developers.google.com/identity/protocols/OpenIDConnect) 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;
hasOidcToken
in interface HttpRequestOrBuilder
public OidcToken getOidcToken()
If specified, an [OIDC](https://developers.google.com/identity/protocols/OpenIDConnect) 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;
getOidcToken
in interface HttpRequestOrBuilder
public OidcTokenOrBuilder getOidcTokenOrBuilder()
If specified, an [OIDC](https://developers.google.com/identity/protocols/OpenIDConnect) 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;
getOidcTokenOrBuilder
in interface HttpRequestOrBuilder
public final boolean isInitialized()
isInitialized
in interface MessageLiteOrBuilder
isInitialized
in class GeneratedMessageV3
public void writeTo(CodedOutputStream output) throws IOException
writeTo
in interface MessageLite
writeTo
in class GeneratedMessageV3
IOException
public int getSerializedSize()
getSerializedSize
in interface MessageLite
getSerializedSize
in class GeneratedMessageV3
public boolean equals(Object obj)
equals
in interface Message
equals
in class AbstractMessage
public int hashCode()
hashCode
in interface Message
hashCode
in class AbstractMessage
public static HttpRequest parseFrom(ByteBuffer data) throws InvalidProtocolBufferException
InvalidProtocolBufferException
public static HttpRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry) throws InvalidProtocolBufferException
InvalidProtocolBufferException
public static HttpRequest parseFrom(ByteString data) throws InvalidProtocolBufferException
InvalidProtocolBufferException
public static HttpRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry) throws InvalidProtocolBufferException
InvalidProtocolBufferException
public static HttpRequest parseFrom(byte[] data) throws InvalidProtocolBufferException
InvalidProtocolBufferException
public static HttpRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry) throws InvalidProtocolBufferException
InvalidProtocolBufferException
public static HttpRequest parseFrom(InputStream input) throws IOException
IOException
public static HttpRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry) throws IOException
IOException
public static HttpRequest parseDelimitedFrom(InputStream input) throws IOException
IOException
public static HttpRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry) throws IOException
IOException
public static HttpRequest parseFrom(CodedInputStream input) throws IOException
IOException
public static HttpRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry) throws IOException
IOException
public HttpRequest.Builder newBuilderForType()
newBuilderForType
in interface Message
newBuilderForType
in interface MessageLite
public static HttpRequest.Builder newBuilder()
public static HttpRequest.Builder newBuilder(HttpRequest prototype)
public HttpRequest.Builder toBuilder()
toBuilder
in interface Message
toBuilder
in interface MessageLite
protected HttpRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
newBuilderForType
in class GeneratedMessageV3
public static HttpRequest getDefaultInstance()
public static Parser<HttpRequest> parser()
public Parser<HttpRequest> getParserForType()
getParserForType
in interface Message
getParserForType
in interface MessageLite
getParserForType
in class GeneratedMessageV3
public HttpRequest getDefaultInstanceForType()
getDefaultInstanceForType
in interface MessageLiteOrBuilder
getDefaultInstanceForType
in interface MessageOrBuilder
Copyright © 2022 Google LLC. All rights reserved.