Interface HttpTargetOrBuilder (2.95.0)

2.95.0 (latest) 2.94.0 2.93.0 2.91.0 2.88.0 2.87.0 2.85.0 2.83.0 2.82.0 2.80.0 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

public interface HttpTargetOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getAuthorizationHeaderCase()

public abstract HttpTarget.AuthorizationHeaderCase getAuthorizationHeaderCase()

Returns
Type	Description
HttpTarget.AuthorizationHeaderCase

getHeaderOverrides(int index)

public abstract 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-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". 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.

  Do not put business sensitive or personally identifying data in the HTTP Header Override Configuration or other similar fields in accordance with Section 12 (Resource Fields) of the Service Specific Terms.

repeated .google.cloud.tasks.v2beta3.HttpTarget.HeaderOverride header_overrides = 3;

Parameter
Name	Description
index	int

Returns
Type	Description
HttpTarget.HeaderOverride

getHeaderOverridesCount()

public abstract 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-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". 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.

  Do not put business sensitive or personally identifying data in the HTTP Header Override Configuration or other similar fields in accordance with Section 12 (Resource Fields) of the Service Specific Terms.

repeated .google.cloud.tasks.v2beta3.HttpTarget.HeaderOverride header_overrides = 3;

Returns
Type	Description
int

getHeaderOverridesList()

public abstract 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-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". 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.

  Do not put business sensitive or personally identifying data in the HTTP Header Override Configuration or other similar fields in accordance with Section 12 (Resource Fields) of the Service Specific Terms.

repeated .google.cloud.tasks.v2beta3.HttpTarget.HeaderOverride header_overrides = 3;

Returns
Type	Description
List<HeaderOverride>

getHeaderOverridesOrBuilder(int index)

public abstract 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-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". 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.

  Do not put business sensitive or personally identifying data in the HTTP Header Override Configuration or other similar fields in accordance with Section 12 (Resource Fields) of the Service Specific Terms.

repeated .google.cloud.tasks.v2beta3.HttpTarget.HeaderOverride header_overrides = 3;

Parameter
Name	Description
index	int

Returns
Type	Description
HttpTarget.HeaderOverrideOrBuilder

getHeaderOverridesOrBuilderList()

public abstract 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-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". 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.

  Do not put business sensitive or personally identifying data in the HTTP Header Override Configuration or other similar fields in accordance with Section 12 (Resource Fields) of the Service Specific Terms.

repeated .google.cloud.tasks.v2beta3.HttpTarget.HeaderOverride header_overrides = 3;

Returns
Type	Description
List<? extends com.google.cloud.tasks.v2beta3.HttpTarget.HeaderOverrideOrBuilder>

getHttpMethod()

public abstract HttpMethod getHttpMethod()

The HTTP method to use for the request.

When specified, it overrides HttpRequest.http_method for the task. Note that if the value is set to HttpMethod.GET the HttpRequest.body 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 abstract int getHttpMethodValue()

The HTTP method to use for the request.

When specified, it overrides HttpRequest.http_method for the task. Note that if the value is set to HttpMethod.GET the HttpRequest.body 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 abstract OAuthToken getOauthToken()

If specified, an OAuth token is generated and attached as the Authorization header in the HTTP request.

This type of authorization should generally be used only when calling Google APIs hosted on *.googleapis.com. Note that both the service account email and the scope MUST be specified when using the queue-level authorization override.

.google.cloud.tasks.v2beta3.OAuthToken oauth_token = 5;

Returns
Type	Description
OAuthToken	The oauthToken.

getOauthTokenOrBuilder()

public abstract OAuthTokenOrBuilder getOauthTokenOrBuilder()

If specified, an OAuth token is generated and attached as the Authorization header in the HTTP request.

This type of authorization should generally be used only when calling Google APIs hosted on *.googleapis.com. Note that both the service account email and the scope MUST be specified when using the queue-level authorization override.

.google.cloud.tasks.v2beta3.OAuthToken oauth_token = 5;

Returns
Type	Description
OAuthTokenOrBuilder

getOidcToken()

public abstract OidcToken getOidcToken()

If specified, an OIDC token is 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. Note that both the service account email and the audience MUST be specified when using the queue-level authorization override.

.google.cloud.tasks.v2beta3.OidcToken oidc_token = 6;

Returns
Type	Description
OidcToken	The oidcToken.

getOidcTokenOrBuilder()

public abstract OidcTokenOrBuilder getOidcTokenOrBuilder()

If specified, an OIDC token is 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. Note that both the service account email and the audience MUST be specified when using the queue-level authorization override.

.google.cloud.tasks.v2beta3.OidcToken oidc_token = 6;

Returns
Type	Description
OidcTokenOrBuilder

getUriOverride()

public abstract 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.

getUriOverrideOrBuilder()

public abstract 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 abstract boolean hasOauthToken()

If specified, an OAuth token is generated and attached as the Authorization header in the HTTP request.

This type of authorization should generally be used only when calling Google APIs hosted on *.googleapis.com. Note that both the service account email and the scope MUST be specified when using the queue-level authorization override.

.google.cloud.tasks.v2beta3.OAuthToken oauth_token = 5;

Returns
Type	Description
boolean	Whether the oauthToken field is set.

hasOidcToken()

public abstract boolean hasOidcToken()

If specified, an OIDC token is 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. Note that both the service account email and the audience MUST be specified when using the queue-level authorization override.

.google.cloud.tasks.v2beta3.OidcToken oidc_token = 6;

Returns
Type	Description
boolean	Whether the oidcToken field is set.

hasUriOverride()

public abstract 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.