Interface HttpRequestOrBuilder (2.42.0)
Stay organized with collections
Save and categorize content based on your preferences.
- 2.80.0 (latest)
- 2.78.0
- 2.76.0
- 2.75.0
- 2.74.0
- 2.73.0
- 2.72.0
- 2.70.0
- 2.68.0
- 2.67.0
- 2.64.0
- 2.63.0
- 2.62.0
- 2.60.0
- 2.59.0
- 2.58.0
- 2.57.0
- 2.56.0
- 2.55.0
- 2.54.0
- 2.53.0
- 2.52.0
- 2.51.0
- 2.49.0
- 2.48.0
- 2.47.0
- 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
publicinterface HttpRequestOrBuilderextendsMessageOrBuilderImplements
MessageOrBuilderMethods
containsHeaders(String key)
publicabstractbooleancontainsHeaders(Stringkey)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-Typewon't be set by Cloud Tasks. You can explicitly setContent-Typeto a media type when the task is created. For example,Content-Typecan 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 |
| Returns | |
|---|---|
| Type | Description |
boolean |
|
getAuthorizationHeaderCase()
publicabstractHttpRequest.AuthorizationHeaderCasegetAuthorizationHeaderCase()| Returns | |
|---|---|
| Type | Description |
HttpRequest.AuthorizationHeaderCase |
|
getBody()
publicabstractByteStringgetBody()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;
| Returns | |
|---|---|
| Type | Description |
ByteString |
The body. |
getHeaders() (deprecated)
publicabstractMap<String,String>getHeaders()Use #getHeadersMap() instead.
| Returns | |
|---|---|
| Type | Description |
Map<String,String> |
|
getHeadersCount()
publicabstractintgetHeadersCount()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-Typewon't be set by Cloud Tasks. You can explicitly setContent-Typeto a media type when the task is created. For example,Content-Typecan 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 |
|
getHeadersMap()
publicabstractMap<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-Typewon't be set by Cloud Tasks. You can explicitly setContent-Typeto a media type when the task is created. For example,Content-Typecan 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 |
Map<String,String> |
|
getHeadersOrDefault(String key, String defaultValue)
publicabstractStringgetHeadersOrDefault(Stringkey,StringdefaultValue)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-Typewon't be set by Cloud Tasks. You can explicitly setContent-Typeto a media type when the task is created. For example,Content-Typecan 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;
| Parameters | |
|---|---|
| Name | Description |
key |
String |
defaultValue |
String |
| Returns | |
|---|---|
| Type | Description |
String |
|
getHeadersOrThrow(String key)
publicabstractStringgetHeadersOrThrow(Stringkey)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-Typewon't be set by Cloud Tasks. You can explicitly setContent-Typeto a media type when the task is created. For example,Content-Typecan 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 |
| Returns | |
|---|---|
| Type | Description |
String |
|
getHttpMethod()
publicabstractHttpMethodgetHttpMethod()The HTTP method to use for the request. The default is POST.
.google.cloud.tasks.v2.HttpMethod http_method = 2;
| Returns | |
|---|---|
| Type | Description |
HttpMethod |
The httpMethod. |
getHttpMethodValue()
publicabstractintgetHttpMethodValue()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()
publicabstractOAuthTokengetOauthToken() 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 |
OAuthToken |
The oauthToken. |
getOauthTokenOrBuilder()
publicabstractOAuthTokenOrBuildergetOauthTokenOrBuilder() 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 |
OAuthTokenOrBuilder |
|
getOidcToken()
publicabstractOidcTokengetOidcToken() 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()
publicabstractOidcTokenOrBuildergetOidcTokenOrBuilder() 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 |
OidcTokenOrBuilder |
|
getUrl()
publicabstractStringgetUrl()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()
publicabstractByteStringgetUrlBytes()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()
publicabstractbooleanhasOauthToken() 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()
publicabstractbooleanhasOidcToken() 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. |