public final class HttpRequest extends GeneratedMessageV3 implements HttpRequestOrBuilder
HTTP request.
The task will be pushed to the worker as an HTTP request. An HTTP request embodies a url, an http method, headers, body and authorization for the http task.
Protobuf type google.cloud.tasks.v2beta2.HttpRequest
Inherited Members
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
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 )
public static HttpRequest.Builder newBuilder(HttpRequest )
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 running the task is created or 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:
- Any header that is prefixed with "X-CloudTasks-" will be treated as service header. Service headers define properties of the task and are predefined in CloudTask.
- 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
|
Overridespublic HttpRequest.AuthorizationHeaderCase getAuthorizationHeaderCase()
getBody()
public ByteString getBody()
HTTP request body.
A request body is allowed only if the HTTP method is POST, PUT, or . 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 running the task is created or 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:
- Any header that is prefixed with "X-CloudTasks-" will be treated as service header. Service headers define properties of the task and are predefined in CloudTask.
- 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 running the task is created or 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:
- Any header that is prefixed with "X-CloudTasks-" will be treated as service header. Service headers define properties of the task and are predefined in CloudTask.
- 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 running the task is created or 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:
- Any header that is prefixed with "X-CloudTasks-" will be treated as service header. Service headers define properties of the task and are predefined in CloudTask.
- 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 running the task is created or 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:
- Any header that is prefixed with "X-CloudTasks-" will be treated as service header. Service headers define properties of the task and are predefined in CloudTask.
- 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.v2beta2.HttpMethod http_method = 2;
getHttpMethodValue()
public int getHttpMethodValue()
The HTTP method to use for the request. The default is POST.
.google.cloud.tasks.v2beta2.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.v2beta2.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.v2beta2.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.v2beta2.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.v2beta2.OidcToken oidc_token = 6;
getParserForType()
public Parser<HttpRequest> getParserForType()
getSerializedSize()
public int getSerializedSize()
| Returns |
|---|
| Type | Description |
int | |
OverridesgetUrl()
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.v2beta2.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.v2beta2.OidcToken oidc_token = 6;
| Returns |
|---|
| Type | Description |
boolean | Whether the oidcToken field is set. |
hashCode()
| Returns |
|---|
| Type | Description |
int | |
OverridesinternalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
internalGetMapField(int number)
protected MapField internalGetMapField(int number)
| Parameter |
|---|
| Name | Description |
number | int
|
OverridesisInitialized()
public final boolean isInitialized()
newBuilderForType()
public HttpRequest.Builder newBuilderForType()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected HttpRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
toBuilder()
public HttpRequest.Builder toBuilder()
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)