Class HttpRequest.Builder (2.42.0) 

public static final class HttpRequest.Builder extends GeneratedMessageV3.Builder<HttpRequest.Builder> implements HttpRequestOrBuilder

HTTP request.

The task will be pushed to the worker as an HTTP request. If the worker or the redirected worker acknowledges the task by returning a successful HTTP response code ([200 - 299]), the task will be removed from the queue. If any other HTTP response code is returned or no response is received, the task will be retried according to the following:

  • User-specified throttling: retry configuration, rate limits, and the queue's state.

  • System throttling: To prevent the worker from overloading, Cloud Tasks may temporarily reduce the queue's effective rate. User-specified settings will not be changed.

    System throttling happens because:

    • Cloud Tasks backs off on all errors. Normally the backoff specified in rate limits will be used. But if the worker returns 429 (Too Many Requests), 503 (Service Unavailable), or the rate of errors is high, Cloud Tasks will use a higher backoff rate. The retry specified in the Retry-After HTTP response header is considered.

    • To prevent traffic spikes and to smooth sudden increases in traffic, dispatches ramp up slowly when the queue is newly created or idle and if large numbers of tasks suddenly become available to dispatch (due to spikes in create task rates, the queue being unpaused, or many tasks that are scheduled at the same time).

Protobuf type google.cloud.tasks.v2beta3.HttpRequest

Inheritance

Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > HttpRequest.Builder

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public HttpRequest.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
HttpRequest.Builder
Overrides

build()

public HttpRequest build()
Returns
Type Description
HttpRequest

buildPartial()

public HttpRequest buildPartial()
Returns
Type Description
HttpRequest

clear()

public HttpRequest.Builder clear()
Returns
Type Description
HttpRequest.Builder
Overrides

clearAuthorizationHeader()

public HttpRequest.Builder clearAuthorizationHeader()
Returns
Type Description
HttpRequest.Builder

clearBody()

public HttpRequest.Builder clearBody()

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
HttpRequest.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public HttpRequest.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
HttpRequest.Builder
Overrides

clearHeaders()

public HttpRequest.Builder clearHeaders()
Returns
Type Description
HttpRequest.Builder

clearHttpMethod()

public HttpRequest.Builder clearHttpMethod()

The HTTP method to use for the request. The default is POST.

.google.cloud.tasks.v2beta3.HttpMethod http_method = 2;

Returns
Type Description
HttpRequest.Builder

This builder for chaining.

clearOauthToken()

public HttpRequest.Builder clearOauthToken()

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.v2beta3.OAuthToken oauth_token = 5;

Returns
Type Description
HttpRequest.Builder

clearOidcToken()

public HttpRequest.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
HttpRequest.Builder

clearOneof(Descriptors.OneofDescriptor oneof)

public HttpRequest.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
HttpRequest.Builder
Overrides

clearUrl()

public HttpRequest.Builder clearUrl()

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;

Returns
Type Description
HttpRequest.Builder

This builder for chaining.

clone()

public HttpRequest.Builder clone()
Returns
Type Description
HttpRequest.Builder
Overrides

containsHeaders(String key)

public boolean containsHeaders(String key)

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:

  • 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-Cloud-Tasks".
  • 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. 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.

map<string, string> headers = 3;

Parameter
Name Description
key String
Returns
Type Description
boolean

getAuthorizationHeaderCase()

public HttpRequest.AuthorizationHeaderCase getAuthorizationHeaderCase()
Returns
Type Description
HttpRequest.AuthorizationHeaderCase

getBody()

public ByteString getBody()

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.

getDefaultInstanceForType()

public HttpRequest getDefaultInstanceForType()
Returns
Type Description
HttpRequest

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

getHeaders() (deprecated)

public Map<String,String> getHeaders()

Use #getHeadersMap() instead.

Returns
Type Description
Map<String,String>

getHeadersCount()

public int getHeadersCount()

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:

  • 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-Cloud-Tasks".
  • 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. 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.

map<string, string> headers = 3;

Returns
Type Description
int

getHeadersMap()

public Map<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:

  • 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-Cloud-Tasks".
  • 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. 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.

map<string, string> headers = 3;

Returns
Type Description
Map<String,String>

getHeadersOrDefault(String key, String defaultValue)

public String getHeadersOrDefault(String key, String defaultValue)

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:

  • 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-Cloud-Tasks".
  • 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. 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.

map<string, string> headers = 3;

Parameters
Name Description
key String
defaultValue String
Returns
Type Description
String

getHeadersOrThrow(String key)

public String getHeadersOrThrow(String key)

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:

  • 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-Cloud-Tasks".
  • 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. 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.

map<string, string> headers = 3;

Parameter
Name Description
key String
Returns
Type Description
String

getHttpMethod()

public HttpMethod getHttpMethod()

The HTTP method to use for the request. The default is POST.

.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. The default is POST.

.google.cloud.tasks.v2beta3.HttpMethod http_method = 2;

Returns
Type Description
int

The enum numeric value on the wire for httpMethod.

getMutableHeaders() (deprecated)

public Map<String,String> getMutableHeaders()

Use alternate mutation accessors instead.

Returns
Type Description
Map<String,String>

getOauthToken()

public OAuthToken getOauthToken()

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

getUrl()

public String getUrl()

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;

Returns
Type Description
String

The url.

getUrlBytes()

public ByteString getUrlBytes()

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;

Returns
Type Description
ByteString

The bytes for url.

hasOauthToken()

public boolean hasOauthToken()

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

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

internalGetMapFieldReflection(int number)

protected MapFieldReflectionAccessor internalGetMapFieldReflection(int number)
Parameter
Name Description
number int
Returns
Type Description
com.google.protobuf.MapFieldReflectionAccessor
Overrides
com.google.protobuf.GeneratedMessageV3.Builder.internalGetMapFieldReflection(int)

internalGetMutableMapFieldReflection(int number)

protected MapFieldReflectionAccessor internalGetMutableMapFieldReflection(int number)
Parameter
Name Description
number int
Returns
Type Description
com.google.protobuf.MapFieldReflectionAccessor
Overrides
com.google.protobuf.GeneratedMessageV3.Builder.internalGetMutableMapFieldReflection(int)

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(HttpRequest other)

public HttpRequest.Builder mergeFrom(HttpRequest other)
Parameter
Name Description
other HttpRequest
Returns
Type Description
HttpRequest.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public HttpRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
HttpRequest.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public HttpRequest.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
HttpRequest.Builder
Overrides

mergeOauthToken(OAuthToken value)

public HttpRequest.Builder mergeOauthToken(OAuthToken value)

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.v2beta3.OAuthToken oauth_token = 5;

Parameter
Name Description
value OAuthToken
Returns
Type Description
HttpRequest.Builder

mergeOidcToken(OidcToken value)

public HttpRequest.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
HttpRequest.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final HttpRequest.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
HttpRequest.Builder
Overrides

putAllHeaders(Map<String,String> values)

public HttpRequest.Builder putAllHeaders(Map<String,String> values)

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:

  • 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-Cloud-Tasks".
  • 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. 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.

map<string, string> headers = 3;

Parameter
Name Description
values Map<String,String>
Returns
Type Description
HttpRequest.Builder

putHeaders(String key, String value)

public HttpRequest.Builder putHeaders(String key, String value)

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:

  • 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-Cloud-Tasks".
  • 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. 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.

map<string, string> headers = 3;

Parameters
Name Description
key String
value String
Returns
Type Description
HttpRequest.Builder

removeHeaders(String key)

public HttpRequest.Builder removeHeaders(String key)

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:

  • 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-Cloud-Tasks".
  • 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. 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.

map<string, string> headers = 3;

Parameter
Name Description
key String
Returns
Type Description
HttpRequest.Builder

setBody(ByteString value)

public HttpRequest.Builder setBody(ByteString value)

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;

Parameter
Name Description
value ByteString

The body to set.
Returns
Type Description
HttpRequest.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public HttpRequest.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
HttpRequest.Builder
Overrides

setHttpMethod(HttpMethod value)

public HttpRequest.Builder setHttpMethod(HttpMethod value)

The HTTP method to use for the request. The default is POST.

.google.cloud.tasks.v2beta3.HttpMethod http_method = 2;

Parameter
Name Description
value HttpMethod

The httpMethod to set.
Returns
Type Description
HttpRequest.Builder

This builder for chaining.

setHttpMethodValue(int value)

public HttpRequest.Builder setHttpMethodValue(int value)

The HTTP method to use for the request. The default is POST.

.google.cloud.tasks.v2beta3.HttpMethod http_method = 2;

Parameter
Name Description
value int

The enum numeric value on the wire for httpMethod to set.
Returns
Type Description
HttpRequest.Builder

This builder for chaining.

setOauthToken(OAuthToken value)

public HttpRequest.Builder setOauthToken(OAuthToken value)

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.v2beta3.OAuthToken oauth_token = 5;

Parameter
Name Description
value OAuthToken
Returns
Type Description
HttpRequest.Builder

setOauthToken(OAuthToken.Builder builderForValue)

public HttpRequest.Builder setOauthToken(OAuthToken.Builder builderForValue)

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.v2beta3.OAuthToken oauth_token = 5;

Parameter
Name Description
builderForValue OAuthToken.Builder
Returns
Type Description
HttpRequest.Builder

setOidcToken(OidcToken value)

public HttpRequest.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
HttpRequest.Builder

setOidcToken(OidcToken.Builder builderForValue)

public HttpRequest.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
HttpRequest.Builder

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public HttpRequest.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
HttpRequest.Builder
Overrides

setUnknownFields(UnknownFieldSet unknownFields)

public final HttpRequest.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
HttpRequest.Builder
Overrides

setUrl(String value)

public HttpRequest.Builder setUrl(String value)

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;

Parameter
Name Description
value String

The url to set.
Returns
Type Description
HttpRequest.Builder

This builder for chaining.

setUrlBytes(ByteString value)

public HttpRequest.Builder setUrlBytes(ByteString value)

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;

Parameter
Name Description
value ByteString

The bytes for url to set.
Returns
Type Description
HttpRequest.Builder

This builder for chaining.