com.google.cloud.tasks.v2beta2

Interface HttpTargetOrBuilder

All Superinterfaces:

com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder

All Known Implementing Classes:

HttpTarget, HttpTarget.Builder

public interface HttpTargetOrBuilder
extends com.google.protobuf.MessageOrBuilder

Method Summary

Modifier and Type	Method and Description
HttpTarget.AuthorizationHeaderCase	getAuthorizationHeaderCase()
HttpTarget.HeaderOverride	getHeaderOverrides(int index) HTTP target headers.
int	getHeaderOverridesCount() HTTP target headers.
List<HttpTarget.HeaderOverride>	getHeaderOverridesList() HTTP target headers.
HttpTarget.HeaderOverrideOrBuilder	getHeaderOverridesOrBuilder(int index) HTTP target headers.
List<? extends HttpTarget.HeaderOverrideOrBuilder>	getHeaderOverridesOrBuilderList() HTTP target headers.
HttpMethod	getHttpMethod() The HTTP method to use for the request.
int	getHttpMethodValue() The HTTP method to use for the request.
OAuthToken	getOauthToken() If specified, an [OAuth token](https://developers.google.com/identity/protocols/OAuth2) will be generated and attached as an `Authorization` header in the HTTP request.
OAuthTokenOrBuilder	getOauthTokenOrBuilder() If specified, an [OAuth token](https://developers.google.com/identity/protocols/OAuth2) will be generated and attached as an `Authorization` header in the HTTP request.
OidcToken	getOidcToken() If specified, an [OIDC](https://developers.google.com/identity/protocols/OpenIDConnect) token will be generated and attached as an `Authorization` header in the HTTP request.
OidcTokenOrBuilder	getOidcTokenOrBuilder() If specified, an [OIDC](https://developers.google.com/identity/protocols/OpenIDConnect) token will be generated and attached as an `Authorization` header in the HTTP request.
UriOverride	getUriOverride() Uri override.
UriOverrideOrBuilder	getUriOverrideOrBuilder() Uri override.
boolean	hasOauthToken() If specified, an [OAuth token](https://developers.google.com/identity/protocols/OAuth2) will be generated and attached as an `Authorization` header in the HTTP request.
boolean	hasOidcToken() If specified, an [OIDC](https://developers.google.com/identity/protocols/OpenIDConnect) token will be generated and attached as an `Authorization` header in the HTTP request.
boolean	hasUriOverride() Uri override.

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

isInitialized

Method Detail

hasUriOverride

boolean hasUriOverride()

 Uri override.

 When specified, overrides the execution Uri for all the tasks in the queue.
 

.google.cloud.tasks.v2beta2.UriOverride uri_override = 1;

Returns:

Whether the uriOverride field is set.

getUriOverride

UriOverride getUriOverride()

 Uri override.

 When specified, overrides the execution Uri for all the tasks in the queue.
 

.google.cloud.tasks.v2beta2.UriOverride uri_override = 1;

Returns:

The uriOverride.

getUriOverrideOrBuilder

UriOverrideOrBuilder getUriOverrideOrBuilder()

 Uri override.

 When specified, overrides the execution Uri for all the tasks in the queue.
 

.google.cloud.tasks.v2beta2.UriOverride uri_override = 1;

getHttpMethodValue

int getHttpMethodValue()

 The HTTP method to use for the request.

 When specified, it overrides
 [HttpRequest][google.cloud.tasks.v2beta2.HttpTarget.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.v2beta2.HttpMethod http_method = 2;

Returns:

The enum numeric value on the wire for httpMethod.

getHttpMethod

HttpMethod getHttpMethod()

 The HTTP method to use for the request.

 When specified, it overrides
 [HttpRequest][google.cloud.tasks.v2beta2.HttpTarget.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.v2beta2.HttpMethod http_method = 2;

Returns:

The httpMethod.

getHeaderOverridesList

List<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][google.cloud.tasks.v2beta2.CloudTasks.CreateTask] and/or
 [task is created][google.cloud.tasks.v2beta2.CloudTasks.BufferTask].

 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][google.cloud.tasks.v2beta2.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-Type` won't be set by Cloud Tasks. You can explicitly set
 `Content-Type` to a media type when the
  [task is created][google.cloud.tasks.v2beta3.CloudTasks.CreateTask].
  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.
 Queue-level headers to override headers of all the tasks in the queue.
 

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

getHeaderOverrides

HttpTarget.HeaderOverride getHeaderOverrides(int index)

 HTTP target headers.

 This map contains the header field names and values.
 Headers will be set when running the
 [task is created][google.cloud.tasks.v2beta2.CloudTasks.CreateTask] and/or
 [task is created][google.cloud.tasks.v2beta2.CloudTasks.BufferTask].

 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][google.cloud.tasks.v2beta2.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-Type` won't be set by Cloud Tasks. You can explicitly set
 `Content-Type` to a media type when the
  [task is created][google.cloud.tasks.v2beta3.CloudTasks.CreateTask].
  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.
 Queue-level headers to override headers of all the tasks in the queue.
 

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

getHeaderOverridesCount

int getHeaderOverridesCount()

 HTTP target headers.

 This map contains the header field names and values.
 Headers will be set when running the
 [task is created][google.cloud.tasks.v2beta2.CloudTasks.CreateTask] and/or
 [task is created][google.cloud.tasks.v2beta2.CloudTasks.BufferTask].

 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][google.cloud.tasks.v2beta2.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-Type` won't be set by Cloud Tasks. You can explicitly set
 `Content-Type` to a media type when the
  [task is created][google.cloud.tasks.v2beta3.CloudTasks.CreateTask].
  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.
 Queue-level headers to override headers of all the tasks in the queue.
 

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

getHeaderOverridesOrBuilderList

List<? extends HttpTarget.HeaderOverrideOrBuilder> getHeaderOverridesOrBuilderList()

 HTTP target headers.

 This map contains the header field names and values.
 Headers will be set when running the
 [task is created][google.cloud.tasks.v2beta2.CloudTasks.CreateTask] and/or
 [task is created][google.cloud.tasks.v2beta2.CloudTasks.BufferTask].

 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][google.cloud.tasks.v2beta2.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-Type` won't be set by Cloud Tasks. You can explicitly set
 `Content-Type` to a media type when the
  [task is created][google.cloud.tasks.v2beta3.CloudTasks.CreateTask].
  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.
 Queue-level headers to override headers of all the tasks in the queue.
 

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

getHeaderOverridesOrBuilder

HttpTarget.HeaderOverrideOrBuilder getHeaderOverridesOrBuilder(int index)

 HTTP target headers.

 This map contains the header field names and values.
 Headers will be set when running the
 [task is created][google.cloud.tasks.v2beta2.CloudTasks.CreateTask] and/or
 [task is created][google.cloud.tasks.v2beta2.CloudTasks.BufferTask].

 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][google.cloud.tasks.v2beta2.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-Type` won't be set by Cloud Tasks. You can explicitly set
 `Content-Type` to a media type when the
  [task is created][google.cloud.tasks.v2beta3.CloudTasks.CreateTask].
  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.
 Queue-level headers to override headers of all the tasks in the queue.
 

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

hasOauthToken

boolean hasOauthToken()

 If specified, an
 [OAuth token](https://developers.google.com/identity/protocols/OAuth2)
 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:

Whether the oauthToken field is set.

getOauthToken

OAuthToken getOauthToken()

 If specified, an
 [OAuth token](https://developers.google.com/identity/protocols/OAuth2)
 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:

The oauthToken.

getOauthTokenOrBuilder

OAuthTokenOrBuilder getOauthTokenOrBuilder()

 If specified, an
 [OAuth token](https://developers.google.com/identity/protocols/OAuth2)
 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;

hasOidcToken

boolean hasOidcToken()

 If specified, an
 [OIDC](https://developers.google.com/identity/protocols/OpenIDConnect)
 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:

Whether the oidcToken field is set.

getOidcToken

OidcToken getOidcToken()

 If specified, an
 [OIDC](https://developers.google.com/identity/protocols/OpenIDConnect)
 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:

The oidcToken.

getOidcTokenOrBuilder

OidcTokenOrBuilder getOidcTokenOrBuilder()

 If specified, an
 [OIDC](https://developers.google.com/identity/protocols/OpenIDConnect)
 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;

getAuthorizationHeaderCase

HttpTarget.AuthorizationHeaderCase getAuthorizationHeaderCase()