- 2.53.0 (latest)
- 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
public static final class HttpTarget.Builder extends GeneratedMessageV3.Builder<HttpTarget.Builder> implements HttpTargetOrBuilderHTTP target.
When specified as a Queue, all the tasks with [HttpRequest] will be overridden according to the target.
Protobuf type google.cloud.tasks.v2beta3.HttpTarget
Inheritance
Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > HttpTarget.BuilderImplements
HttpTargetOrBuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()| Returns | |
|---|---|
| Type | Description |
Descriptor | |
Methods
addAllHeaderOverrides(Iterable<? extends HttpTarget.HeaderOverride> values)
public HttpTarget.Builder addAllHeaderOverrides(Iterable<? extends HttpTarget.HeaderOverride> values)HTTP target headers.
This map contains the header field names and values. Headers will be set when running the CreateTask and/or BufferTask.
These headers represent a subset of the headers that will be configured for 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:
- Several predefined headers, prefixed with "X-CloudTasks-", can be used to define properties of the task.
- Host: This will be computed by Cloud Tasks and derived from HttpRequest.url.
Content-Length: This will be computed by Cloud Tasks.
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". The default value is set to"application/json".User-Agent: This will be set to
"Google-Cloud-Tasks".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.v2beta3.HttpTarget.HeaderOverride header_overrides = 3;
| Parameter | |
|---|---|
| Name | Description |
values | Iterable<? extends com.google.cloud.tasks.v2beta3.HttpTarget.HeaderOverride> |
| Returns | |
|---|---|
| Type | Description |
HttpTarget.Builder | |
addHeaderOverrides(HttpTarget.HeaderOverride value)
public HttpTarget.Builder addHeaderOverrides(HttpTarget.HeaderOverride value)HTTP target headers.
This map contains the header field names and values. Headers will be set when running the CreateTask and/or BufferTask.
These headers represent a subset of the headers that will be configured for 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:
- Several predefined headers, prefixed with "X-CloudTasks-", can be used to define properties of the task.
- Host: This will be computed by Cloud Tasks and derived from HttpRequest.url.
Content-Length: This will be computed by Cloud Tasks.
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". The default value is set to"application/json".User-Agent: This will be set to
"Google-Cloud-Tasks".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.v2beta3.HttpTarget.HeaderOverride header_overrides = 3;
| Parameter | |
|---|---|
| Name | Description |
value | HttpTarget.HeaderOverride |
| Returns | |
|---|---|
| Type | Description |
HttpTarget.Builder | |
addHeaderOverrides(HttpTarget.HeaderOverride.Builder builderForValue)
public HttpTarget.Builder addHeaderOverrides(HttpTarget.HeaderOverride.Builder builderForValue)HTTP target headers.
This map contains the header field names and values. Headers will be set when running the CreateTask and/or BufferTask.
These headers represent a subset of the headers that will be configured for 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:
- Several predefined headers, prefixed with "X-CloudTasks-", can be used to define properties of the task.
- Host: This will be computed by Cloud Tasks and derived from HttpRequest.url.
Content-Length: This will be computed by Cloud Tasks.
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". The default value is set to"application/json".User-Agent: This will be set to
"Google-Cloud-Tasks".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.v2beta3.HttpTarget.HeaderOverride header_overrides = 3;
| Parameter | |
|---|---|
| Name | Description |
builderForValue | HttpTarget.HeaderOverride.Builder |
| Returns | |
|---|---|
| Type | Description |
HttpTarget.Builder | |
addHeaderOverrides(int index, HttpTarget.HeaderOverride value)
public HttpTarget.Builder addHeaderOverrides(int index, HttpTarget.HeaderOverride value)HTTP target headers.
This map contains the header field names and values. Headers will be set when running the CreateTask and/or BufferTask.
These headers represent a subset of the headers that will be configured for 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:
- Several predefined headers, prefixed with "X-CloudTasks-", can be used to define properties of the task.
- Host: This will be computed by Cloud Tasks and derived from HttpRequest.url.
Content-Length: This will be computed by Cloud Tasks.
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". The default value is set to"application/json".User-Agent: This will be set to
"Google-Cloud-Tasks".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.v2beta3.HttpTarget.HeaderOverride header_overrides = 3;
| Parameters | |
|---|---|
| Name | Description |
index | int |
value | HttpTarget.HeaderOverride |
| Returns | |
|---|---|
| Type | Description |
HttpTarget.Builder | |
addHeaderOverrides(int index, HttpTarget.HeaderOverride.Builder builderForValue)
public HttpTarget.Builder addHeaderOverrides(int index, HttpTarget.HeaderOverride.Builder builderForValue)HTTP target headers.
This map contains the header field names and values. Headers will be set when running the CreateTask and/or BufferTask.
These headers represent a subset of the headers that will be configured for 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:
- Several predefined headers, prefixed with "X-CloudTasks-", can be used to define properties of the task.
- Host: This will be computed by Cloud Tasks and derived from HttpRequest.url.
Content-Length: This will be computed by Cloud Tasks.
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". The default value is set to"application/json".User-Agent: This will be set to
"Google-Cloud-Tasks".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.v2beta3.HttpTarget.HeaderOverride header_overrides = 3;
| Parameters | |
|---|---|
| Name | Description |
index | int |
builderForValue | HttpTarget.HeaderOverride.Builder |
| Returns | |
|---|---|
| Type | Description |
HttpTarget.Builder | |
addHeaderOverridesBuilder()
public HttpTarget.HeaderOverride.Builder addHeaderOverridesBuilder()HTTP target headers.
This map contains the header field names and values. Headers will be set when running the CreateTask and/or BufferTask.
These headers represent a subset of the headers that will be configured for 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:
- Several predefined headers, prefixed with "X-CloudTasks-", can be used to define properties of the task.
- Host: This will be computed by Cloud Tasks and derived from HttpRequest.url.
Content-Length: This will be computed by Cloud Tasks.
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". The default value is set to"application/json".User-Agent: This will be set to
"Google-Cloud-Tasks".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.v2beta3.HttpTarget.HeaderOverride header_overrides = 3;
| Returns | |
|---|---|
| Type | Description |
HttpTarget.HeaderOverride.Builder | |
addHeaderOverridesBuilder(int index)
public HttpTarget.HeaderOverride.Builder addHeaderOverridesBuilder(int index)HTTP target headers.
This map contains the header field names and values. Headers will be set when running the CreateTask and/or BufferTask.
These headers represent a subset of the headers that will be configured for 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:
- Several predefined headers, prefixed with "X-CloudTasks-", can be used to define properties of the task.
- Host: This will be computed by Cloud Tasks and derived from HttpRequest.url.
Content-Length: This will be computed by Cloud Tasks.
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". The default value is set to"application/json".User-Agent: This will be set to
"Google-Cloud-Tasks".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.v2beta3.HttpTarget.HeaderOverride header_overrides = 3;
| Parameter | |
|---|---|
| Name | Description |
index | int |
| Returns | |
|---|---|
| Type | Description |
HttpTarget.HeaderOverride.Builder | |
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public HttpTarget.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)| Parameters | |
|---|---|
| Name | Description |
field | FieldDescriptor |
value | Object |
| Returns | |
|---|---|
| Type | Description |
HttpTarget.Builder | |
build()
public HttpTarget build()| Returns | |
|---|---|
| Type | Description |
HttpTarget | |
buildPartial()
public HttpTarget buildPartial()| Returns | |
|---|---|
| Type | Description |
HttpTarget | |
clear()
public HttpTarget.Builder clear()| Returns | |
|---|---|
| Type | Description |
HttpTarget.Builder | |
clearAuthorizationHeader()
public HttpTarget.Builder clearAuthorizationHeader()| Returns | |
|---|---|
| Type | Description |
HttpTarget.Builder | |
clearField(Descriptors.FieldDescriptor field)
public HttpTarget.Builder clearField(Descriptors.FieldDescriptor field)| Parameter | |
|---|---|
| Name | Description |
field | FieldDescriptor |
| Returns | |
|---|---|
| Type | Description |
HttpTarget.Builder | |
clearHeaderOverrides()
public HttpTarget.Builder clearHeaderOverrides()HTTP target headers.
This map contains the header field names and values. Headers will be set when running the CreateTask and/or BufferTask.
These headers represent a subset of the headers that will be configured for 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:
- Several predefined headers, prefixed with "X-CloudTasks-", can be used to define properties of the task.
- Host: This will be computed by Cloud Tasks and derived from HttpRequest.url.
Content-Length: This will be computed by Cloud Tasks.
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". The default value is set to"application/json".User-Agent: This will be set to
"Google-Cloud-Tasks".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.v2beta3.HttpTarget.HeaderOverride header_overrides = 3;
| Returns | |
|---|---|
| Type | Description |
HttpTarget.Builder | |
clearHttpMethod()
public HttpTarget.Builder clearHttpMethod()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.v2beta3.HttpMethod http_method = 2;
| Returns | |
|---|---|
| Type | Description |
HttpTarget.Builder | This builder for chaining. |
clearOauthToken()
public HttpTarget.Builder clearOauthToken() If specified, an
OAuth token
will be generated and attached as the 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.v2beta3.OAuthToken oauth_token = 5;
| Returns | |
|---|---|
| Type | Description |
HttpTarget.Builder | |
clearOidcToken()
public HttpTarget.Builder clearOidcToken() 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.v2beta3.OidcToken oidc_token = 6;
| Returns | |
|---|---|
| Type | Description |
HttpTarget.Builder | |
clearOneof(Descriptors.OneofDescriptor oneof)
public HttpTarget.Builder clearOneof(Descriptors.OneofDescriptor oneof)| Parameter | |
|---|---|
| Name | Description |
oneof | OneofDescriptor |
| Returns | |
|---|---|
| Type | Description |
HttpTarget.Builder | |
clearUriOverride()
public HttpTarget.Builder clearUriOverride()URI override.
When specified, overrides the execution URI for all the tasks in the queue.
.google.cloud.tasks.v2beta3.UriOverride uri_override = 1;
| Returns | |
|---|---|
| Type | Description |
HttpTarget.Builder | |
clone()
public HttpTarget.Builder clone()| Returns | |
|---|---|
| Type | Description |
HttpTarget.Builder | |
getAuthorizationHeaderCase()
public HttpTarget.AuthorizationHeaderCase getAuthorizationHeaderCase()| Returns | |
|---|---|
| Type | Description |
HttpTarget.AuthorizationHeaderCase | |
getDefaultInstanceForType()
public HttpTarget getDefaultInstanceForType()| Returns | |
|---|---|
| Type | Description |
HttpTarget | |
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()| Returns | |
|---|---|
| Type | Description |
Descriptor | |
getHeaderOverrides(int index)
public HttpTarget.HeaderOverride getHeaderOverrides(int index)HTTP target headers.
This map contains the header field names and values. Headers will be set when running the CreateTask and/or BufferTask.
These headers represent a subset of the headers that will be configured for 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:
- Several predefined headers, prefixed with "X-CloudTasks-", can be used to define properties of the task.
- Host: This will be computed by Cloud Tasks and derived from HttpRequest.url.
Content-Length: This will be computed by Cloud Tasks.
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". The default value is set to"application/json".User-Agent: This will be set to
"Google-Cloud-Tasks".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.v2beta3.HttpTarget.HeaderOverride header_overrides = 3;
| Parameter | |
|---|---|
| Name | Description |
index | int |
| Returns | |
|---|---|
| Type | Description |
HttpTarget.HeaderOverride | |
getHeaderOverridesBuilder(int index)
public HttpTarget.HeaderOverride.Builder getHeaderOverridesBuilder(int index)HTTP target headers.
This map contains the header field names and values. Headers will be set when running the CreateTask and/or BufferTask.
These headers represent a subset of the headers that will be configured for 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:
- Several predefined headers, prefixed with "X-CloudTasks-", can be used to define properties of the task.
- Host: This will be computed by Cloud Tasks and derived from HttpRequest.url.
Content-Length: This will be computed by Cloud Tasks.
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". The default value is set to"application/json".User-Agent: This will be set to
"Google-Cloud-Tasks".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.v2beta3.HttpTarget.HeaderOverride header_overrides = 3;
| Parameter | |
|---|---|
| Name | Description |
index | int |
| Returns | |
|---|---|
| Type | Description |
HttpTarget.HeaderOverride.Builder | |
getHeaderOverridesBuilderList()
public List<HttpTarget.HeaderOverride.Builder> getHeaderOverridesBuilderList()HTTP target headers.
This map contains the header field names and values. Headers will be set when running the CreateTask and/or BufferTask.
These headers represent a subset of the headers that will be configured for 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:
- Several predefined headers, prefixed with "X-CloudTasks-", can be used to define properties of the task.
- Host: This will be computed by Cloud Tasks and derived from HttpRequest.url.
Content-Length: This will be computed by Cloud Tasks.
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". The default value is set to"application/json".User-Agent: This will be set to
"Google-Cloud-Tasks".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.v2beta3.HttpTarget.HeaderOverride header_overrides = 3;
| Returns | |
|---|---|
| Type | Description |
List<Builder> | |
getHeaderOverridesCount()
public int getHeaderOverridesCount()HTTP target headers.
This map contains the header field names and values. Headers will be set when running the CreateTask and/or BufferTask.
These headers represent a subset of the headers that will be configured for 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:
- Several predefined headers, prefixed with "X-CloudTasks-", can be used to define properties of the task.
- Host: This will be computed by Cloud Tasks and derived from HttpRequest.url.
Content-Length: This will be computed by Cloud Tasks.
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". The default value is set to"application/json".User-Agent: This will be set to
"Google-Cloud-Tasks".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.v2beta3.HttpTarget.HeaderOverride header_overrides = 3;
| Returns | |
|---|---|
| Type | Description |
int | |
getHeaderOverridesList()
public List<HttpTarget.HeaderOverride> getHeaderOverridesList()HTTP target headers.
This map contains the header field names and values. Headers will be set when running the CreateTask and/or BufferTask.
These headers represent a subset of the headers that will be configured for 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:
- Several predefined headers, prefixed with "X-CloudTasks-", can be used to define properties of the task.
- Host: This will be computed by Cloud Tasks and derived from HttpRequest.url.
Content-Length: This will be computed by Cloud Tasks.
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". The default value is set to"application/json".User-Agent: This will be set to
"Google-Cloud-Tasks".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.v2beta3.HttpTarget.HeaderOverride header_overrides = 3;
| Returns | |
|---|---|
| Type | Description |
List<HeaderOverride> | |
getHeaderOverridesOrBuilder(int index)
public HttpTarget.HeaderOverrideOrBuilder getHeaderOverridesOrBuilder(int index)HTTP target headers.
This map contains the header field names and values. Headers will be set when running the CreateTask and/or BufferTask.
These headers represent a subset of the headers that will be configured for 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:
- Several predefined headers, prefixed with "X-CloudTasks-", can be used to define properties of the task.
- Host: This will be computed by Cloud Tasks and derived from HttpRequest.url.
Content-Length: This will be computed by Cloud Tasks.
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". The default value is set to"application/json".User-Agent: This will be set to
"Google-Cloud-Tasks".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.v2beta3.HttpTarget.HeaderOverride header_overrides = 3;
| Parameter | |
|---|---|
| Name | Description |
index | int |
| Returns | |
|---|---|
| Type | Description |
HttpTarget.HeaderOverrideOrBuilder | |
getHeaderOverridesOrBuilderList()
public List<? extends HttpTarget.HeaderOverrideOrBuilder> getHeaderOverridesOrBuilderList()HTTP target headers.
This map contains the header field names and values. Headers will be set when running the CreateTask and/or BufferTask.
These headers represent a subset of the headers that will be configured for 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:
- Several predefined headers, prefixed with "X-CloudTasks-", can be used to define properties of the task.
- Host: This will be computed by Cloud Tasks and derived from HttpRequest.url.
Content-Length: This will be computed by Cloud Tasks.
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". The default value is set to"application/json".User-Agent: This will be set to
"Google-Cloud-Tasks".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.v2beta3.HttpTarget.HeaderOverride header_overrides = 3;
| Returns | |
|---|---|
| Type | Description |
List<? extends com.google.cloud.tasks.v2beta3.HttpTarget.HeaderOverrideOrBuilder> | |
getHttpMethod()
public HttpMethod getHttpMethod()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.v2beta3.HttpMethod http_method = 2;
| Returns | |
|---|---|
| Type | Description |
HttpMethod | The httpMethod. |
getHttpMethodValue()
public int getHttpMethodValue()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.v2beta3.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 the 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.v2beta3.OAuthToken oauth_token = 5;
| Returns | |
|---|---|
| Type | Description |
OAuthToken | The oauthToken. |
getOauthTokenBuilder()
public OAuthToken.Builder getOauthTokenBuilder() If specified, an
OAuth token
will be generated and attached as the 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.v2beta3.OAuthToken oauth_token = 5;
| Returns | |
|---|---|
| Type | Description |
OAuthToken.Builder | |
getOauthTokenOrBuilder()
public OAuthTokenOrBuilder getOauthTokenOrBuilder() If specified, an
OAuth token
will be generated and attached as the 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.v2beta3.OAuthToken oauth_token = 5;
| Returns | |
|---|---|
| Type | Description |
OAuthTokenOrBuilder | |
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.v2beta3.OidcToken oidc_token = 6;
| Returns | |
|---|---|
| Type | Description |
OidcToken | The oidcToken. |
getOidcTokenBuilder()
public OidcToken.Builder getOidcTokenBuilder() 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.v2beta3.OidcToken oidc_token = 6;
| Returns | |
|---|---|
| Type | Description |
OidcToken.Builder | |
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.v2beta3.OidcToken oidc_token = 6;
| Returns | |
|---|---|
| Type | Description |
OidcTokenOrBuilder | |
getUriOverride()
public UriOverride getUriOverride()URI override.
When specified, overrides the execution URI for all the tasks in the queue.
.google.cloud.tasks.v2beta3.UriOverride uri_override = 1;
| Returns | |
|---|---|
| Type | Description |
UriOverride | The uriOverride. |
getUriOverrideBuilder()
public UriOverride.Builder getUriOverrideBuilder()URI override.
When specified, overrides the execution URI for all the tasks in the queue.
.google.cloud.tasks.v2beta3.UriOverride uri_override = 1;
| Returns | |
|---|---|
| Type | Description |
UriOverride.Builder | |
getUriOverrideOrBuilder()
public UriOverrideOrBuilder getUriOverrideOrBuilder()URI override.
When specified, overrides the execution URI for all the tasks in the queue.
.google.cloud.tasks.v2beta3.UriOverride uri_override = 1;
| Returns | |
|---|---|
| Type | Description |
UriOverrideOrBuilder | |
hasOauthToken()
public boolean hasOauthToken() If specified, an
OAuth token
will be generated and attached as the 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.v2beta3.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.v2beta3.OidcToken oidc_token = 6;
| Returns | |
|---|---|
| Type | Description |
boolean | Whether the oidcToken field is set. |
hasUriOverride()
public boolean hasUriOverride()URI override.
When specified, overrides the execution URI for all the tasks in the queue.
.google.cloud.tasks.v2beta3.UriOverride uri_override = 1;
| Returns | |
|---|---|
| Type | Description |
boolean | Whether the uriOverride field is set. |
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()| Returns | |
|---|---|
| Type | Description |
FieldAccessorTable | |
isInitialized()
public final boolean isInitialized()| Returns | |
|---|---|
| Type | Description |
boolean | |
mergeFrom(HttpTarget other)
public HttpTarget.Builder mergeFrom(HttpTarget other)| Parameter | |
|---|---|
| Name | Description |
other | HttpTarget |
| Returns | |
|---|---|
| Type | Description |
HttpTarget.Builder | |
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public HttpTarget.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input | CodedInputStream |
extensionRegistry | ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
HttpTarget.Builder | |
| Exceptions | |
|---|---|
| Type | Description |
IOException | |
mergeFrom(Message other)
public HttpTarget.Builder mergeFrom(Message other)| Parameter | |
|---|---|
| Name | Description |
other | Message |
| Returns | |
|---|---|
| Type | Description |
HttpTarget.Builder | |
mergeOauthToken(OAuthToken value)
public HttpTarget.Builder mergeOauthToken(OAuthToken value) If specified, an
OAuth token
will be generated and attached as the 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.v2beta3.OAuthToken oauth_token = 5;
| Parameter | |
|---|---|
| Name | Description |
value | OAuthToken |
| Returns | |
|---|---|
| Type | Description |
HttpTarget.Builder | |
mergeOidcToken(OidcToken value)
public HttpTarget.Builder mergeOidcToken(OidcToken value) 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.v2beta3.OidcToken oidc_token = 6;
| Parameter | |
|---|---|
| Name | Description |
value | OidcToken |
| Returns | |
|---|---|
| Type | Description |
HttpTarget.Builder | |
mergeUnknownFields(UnknownFieldSet unknownFields)
public final HttpTarget.Builder mergeUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields | UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
HttpTarget.Builder | |
mergeUriOverride(UriOverride value)
public HttpTarget.Builder mergeUriOverride(UriOverride value)URI override.
When specified, overrides the execution URI for all the tasks in the queue.
.google.cloud.tasks.v2beta3.UriOverride uri_override = 1;
| Parameter | |
|---|---|
| Name | Description |
value | UriOverride |
| Returns | |
|---|---|
| Type | Description |
HttpTarget.Builder | |
removeHeaderOverrides(int index)
public HttpTarget.Builder removeHeaderOverrides(int index)HTTP target headers.
This map contains the header field names and values. Headers will be set when running the CreateTask and/or BufferTask.
These headers represent a subset of the headers that will be configured for 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:
- Several predefined headers, prefixed with "X-CloudTasks-", can be used to define properties of the task.
- Host: This will be computed by Cloud Tasks and derived from HttpRequest.url.
Content-Length: This will be computed by Cloud Tasks.
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". The default value is set to"application/json".User-Agent: This will be set to
"Google-Cloud-Tasks".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.v2beta3.HttpTarget.HeaderOverride header_overrides = 3;
| Parameter | |
|---|---|
| Name | Description |
index | int |
| Returns | |
|---|---|
| Type | Description |
HttpTarget.Builder | |
setField(Descriptors.FieldDescriptor field, Object value)
public HttpTarget.Builder setField(Descriptors.FieldDescriptor field, Object value)| Parameters | |
|---|---|
| Name | Description |
field | FieldDescriptor |
value | Object |
| Returns | |
|---|---|
| Type | Description |
HttpTarget.Builder | |
setHeaderOverrides(int index, HttpTarget.HeaderOverride value)
public HttpTarget.Builder setHeaderOverrides(int index, HttpTarget.HeaderOverride value)HTTP target headers.
This map contains the header field names and values. Headers will be set when running the CreateTask and/or BufferTask.
These headers represent a subset of the headers that will be configured for 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:
- Several predefined headers, prefixed with "X-CloudTasks-", can be used to define properties of the task.
- Host: This will be computed by Cloud Tasks and derived from HttpRequest.url.
Content-Length: This will be computed by Cloud Tasks.
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". The default value is set to"application/json".User-Agent: This will be set to
"Google-Cloud-Tasks".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.v2beta3.HttpTarget.HeaderOverride header_overrides = 3;
| Parameters | |
|---|---|
| Name | Description |
index | int |
value | HttpTarget.HeaderOverride |
| Returns | |
|---|---|
| Type | Description |
HttpTarget.Builder | |
setHeaderOverrides(int index, HttpTarget.HeaderOverride.Builder builderForValue)
public HttpTarget.Builder setHeaderOverrides(int index, HttpTarget.HeaderOverride.Builder builderForValue)HTTP target headers.
This map contains the header field names and values. Headers will be set when running the CreateTask and/or BufferTask.
These headers represent a subset of the headers that will be configured for 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:
- Several predefined headers, prefixed with "X-CloudTasks-", can be used to define properties of the task.
- Host: This will be computed by Cloud Tasks and derived from HttpRequest.url.
Content-Length: This will be computed by Cloud Tasks.
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". The default value is set to"application/json".User-Agent: This will be set to
"Google-Cloud-Tasks".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.v2beta3.HttpTarget.HeaderOverride header_overrides = 3;
| Parameters | |
|---|---|
| Name | Description |
index | int |
builderForValue | HttpTarget.HeaderOverride.Builder |
| Returns | |
|---|---|
| Type | Description |
HttpTarget.Builder | |
setHttpMethod(HttpMethod value)
public HttpTarget.Builder setHttpMethod(HttpMethod value)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.v2beta3.HttpMethod http_method = 2;
| Parameter | |
|---|---|
| Name | Description |
value | HttpMethodThe httpMethod to set. |
| Returns | |
|---|---|
| Type | Description |
HttpTarget.Builder | This builder for chaining. |
setHttpMethodValue(int value)
public HttpTarget.Builder setHttpMethodValue(int value)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.v2beta3.HttpMethod http_method = 2;
| Parameter | |
|---|---|
| Name | Description |
value | intThe enum numeric value on the wire for httpMethod to set. |
| Returns | |
|---|---|
| Type | Description |
HttpTarget.Builder | This builder for chaining. |
setOauthToken(OAuthToken value)
public HttpTarget.Builder setOauthToken(OAuthToken value) If specified, an
OAuth token
will be generated and attached as the 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.v2beta3.OAuthToken oauth_token = 5;
| Parameter | |
|---|---|
| Name | Description |
value | OAuthToken |
| Returns | |
|---|---|
| Type | Description |
HttpTarget.Builder | |
setOauthToken(OAuthToken.Builder builderForValue)
public HttpTarget.Builder setOauthToken(OAuthToken.Builder builderForValue) If specified, an
OAuth token
will be generated and attached as the 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.v2beta3.OAuthToken oauth_token = 5;
| Parameter | |
|---|---|
| Name | Description |
builderForValue | OAuthToken.Builder |
| Returns | |
|---|---|
| Type | Description |
HttpTarget.Builder | |
setOidcToken(OidcToken value)
public HttpTarget.Builder setOidcToken(OidcToken value) 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.v2beta3.OidcToken oidc_token = 6;
| Parameter | |
|---|---|
| Name | Description |
value | OidcToken |
| Returns | |
|---|---|
| Type | Description |
HttpTarget.Builder | |
setOidcToken(OidcToken.Builder builderForValue)
public HttpTarget.Builder setOidcToken(OidcToken.Builder builderForValue) 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.v2beta3.OidcToken oidc_token = 6;
| Parameter | |
|---|---|
| Name | Description |
builderForValue | OidcToken.Builder |
| Returns | |
|---|---|
| Type | Description |
HttpTarget.Builder | |
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
public HttpTarget.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)| Parameters | |
|---|---|
| Name | Description |
field | FieldDescriptor |
index | int |
value | Object |
| Returns | |
|---|---|
| Type | Description |
HttpTarget.Builder | |
setUnknownFields(UnknownFieldSet unknownFields)
public final HttpTarget.Builder setUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields | UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
HttpTarget.Builder | |
setUriOverride(UriOverride value)
public HttpTarget.Builder setUriOverride(UriOverride value)URI override.
When specified, overrides the execution URI for all the tasks in the queue.
.google.cloud.tasks.v2beta3.UriOverride uri_override = 1;
| Parameter | |
|---|---|
| Name | Description |
value | UriOverride |
| Returns | |
|---|---|
| Type | Description |
HttpTarget.Builder | |
setUriOverride(UriOverride.Builder builderForValue)
public HttpTarget.Builder setUriOverride(UriOverride.Builder builderForValue)URI override.
When specified, overrides the execution URI for all the tasks in the queue.
.google.cloud.tasks.v2beta3.UriOverride uri_override = 1;
| Parameter | |
|---|---|
| Name | Description |
builderForValue | UriOverride.Builder |
| Returns | |
|---|---|
| Type | Description |
HttpTarget.Builder | |