Interface HttpTargetOrBuilder (2.22.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 HttpTargetOrBuilderextendsMessageOrBuilderImplements
MessageOrBuilderMethods
getAuthorizationHeaderCase()
publicabstractHttpTarget.AuthorizationHeaderCasegetAuthorizationHeaderCase()| Returns | |
|---|---|
| Type | Description |
HttpTarget.AuthorizationHeaderCase |
|
getHeaderOverrides(int index)
publicabstractHttpTarget.HeaderOverridegetHeaderOverrides(intindex)HTTP target headers.
This map contains the header field names and values. Headers will be set when running the task is created and/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-CloudTasks". 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. Queue-level headers to override headers of all the tasks in the queue.
repeated .google.cloud.tasks.v2beta2.HttpTarget.HeaderOverride header_overrides = 3;
| Parameter | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| Type | Description |
HttpTarget.HeaderOverride |
|
getHeaderOverridesCount()
publicabstractintgetHeaderOverridesCount()HTTP target headers.
This map contains the header field names and values. Headers will be set when running the task is created and/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-CloudTasks". 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. Queue-level headers to override headers of all the tasks in the queue.
repeated .google.cloud.tasks.v2beta2.HttpTarget.HeaderOverride header_overrides = 3;
| Returns | |
|---|---|
| Type | Description |
int |
|
getHeaderOverridesList()
publicabstractList<HttpTarget.HeaderOverride>getHeaderOverridesList()HTTP target headers.
This map contains the header field names and values. Headers will be set when running the task is created and/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-CloudTasks". 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. Queue-level headers to override headers of all the tasks in the queue.
repeated .google.cloud.tasks.v2beta2.HttpTarget.HeaderOverride header_overrides = 3;
| Returns | |
|---|---|
| Type | Description |
List<HeaderOverride> |
|
getHeaderOverridesOrBuilder(int index)
publicabstractHttpTarget.HeaderOverrideOrBuildergetHeaderOverridesOrBuilder(intindex)HTTP target headers.
This map contains the header field names and values. Headers will be set when running the task is created and/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-CloudTasks". 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. Queue-level headers to override headers of all the tasks in the queue.
repeated .google.cloud.tasks.v2beta2.HttpTarget.HeaderOverride header_overrides = 3;
| Parameter | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| Type | Description |
HttpTarget.HeaderOverrideOrBuilder |
|
getHeaderOverridesOrBuilderList()
publicabstractList<?extendsHttpTarget.HeaderOverrideOrBuilder>getHeaderOverridesOrBuilderList()HTTP target headers.
This map contains the header field names and values. Headers will be set when running the task is created and/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-CloudTasks". 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. Queue-level headers to override headers of all the tasks in the queue.
repeated .google.cloud.tasks.v2beta2.HttpTarget.HeaderOverride header_overrides = 3;
| Returns | |
|---|---|
| Type | Description |
List<? extends com.google.cloud.tasks.v2beta2.HttpTarget.HeaderOverrideOrBuilder> |
|
getHttpMethod()
publicabstractHttpMethodgetHttpMethod()The HTTP method to use for the request.
When specified, it overrides HttpRequest for the task. Note that if the value is set to HttpMethod the HttpRequest of the task will be ignored at execution time.
.google.cloud.tasks.v2beta2.HttpMethod http_method = 2;
| Returns | |
|---|---|
| Type | Description |
HttpMethod |
The httpMethod. |
getHttpMethodValue()
publicabstractintgetHttpMethodValue()The HTTP method to use for the request.
When specified, it overrides HttpRequest for the task. Note that if the value is set to HttpMethod the HttpRequest of the task will be ignored at execution time.
.google.cloud.tasks.v2beta2.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.v2beta2.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.v2beta2.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.v2beta2.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.v2beta2.OidcToken oidc_token = 6;
| Returns | |
|---|---|
| Type | Description |
OidcTokenOrBuilder |
|
getUriOverride()
publicabstractUriOverridegetUriOverride()Uri override.
When specified, overrides the execution Uri for all the tasks in the queue.
.google.cloud.tasks.v2beta2.UriOverride uri_override = 1;
| Returns | |
|---|---|
| Type | Description |
UriOverride |
The uriOverride. |
getUriOverrideOrBuilder()
publicabstractUriOverrideOrBuildergetUriOverrideOrBuilder()Uri override.
When specified, overrides the execution Uri for all the tasks in the queue.
.google.cloud.tasks.v2beta2.UriOverride uri_override = 1;
| Returns | |
|---|---|
| Type | Description |
UriOverrideOrBuilder |
|
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.v2beta2.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.v2beta2.OidcToken oidc_token = 6;
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the oidcToken field is set. |
hasUriOverride()
publicabstractbooleanhasUriOverride()Uri override.
When specified, overrides the execution Uri for all the tasks in the queue.
.google.cloud.tasks.v2beta2.UriOverride uri_override = 1;
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the uriOverride field is set. |