HttpRequest.Builder (Google Cloud Tasks Parent 2.3.12 API)

java.lang.Object
- com.google.protobuf.AbstractMessageLite.Builder
- - com.google.protobuf.AbstractMessage.Builder<BuilderType>
  - - com.google.protobuf.GeneratedMessageV3.Builder<HttpRequest.Builder>
    - - com.google.cloud.tasks.v2.HttpRequest.Builder

All Implemented Interfaces:: HttpRequestOrBuilder, Message.Builder, MessageLite.Builder, MessageLiteOrBuilder, MessageOrBuilder, Cloneable

Enclosing class:: HttpRequest

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][google.cloud.tasks.v2.Queue.retry_config],
   [rate limits][google.cloud.tasks.v2.Queue.rate_limits], and the [queue's state][google.cloud.tasks.v2.Queue.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][google.cloud.tasks.v2.Queue.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.v2.HttpRequest

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`HttpRequest.Builder`	`addRepeatedField(Descriptors.FieldDescriptor field, Object value)`
`HttpRequest`	`build()`
`HttpRequest`	`buildPartial()`
`HttpRequest.Builder`	`clear()`
`HttpRequest.Builder`	`clearAuthorizationHeader()`
`HttpRequest.Builder`	`clearBody()` HTTP request body.
`HttpRequest.Builder`	`clearField(Descriptors.FieldDescriptor field)`
`HttpRequest.Builder`	`clearHeaders()`
`HttpRequest.Builder`	`clearHttpMethod()` The HTTP method to use for the request.
`HttpRequest.Builder`	`clearOauthToken()` 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.
`HttpRequest.Builder`	`clearOidcToken()` 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.
`HttpRequest.Builder`	`clearOneof(Descriptors.OneofDescriptor oneof)`
`HttpRequest.Builder`	`clearUrl()` Required.
`HttpRequest.Builder`	`clone()`
`boolean`	`containsHeaders(String key)` HTTP request headers.
`HttpRequest.AuthorizationHeaderCase`	`getAuthorizationHeaderCase()`
`ByteString`	`getBody()` HTTP request body.
`HttpRequest`	`getDefaultInstanceForType()`
`static Descriptors.Descriptor`	`getDescriptor()`
`Descriptors.Descriptor`	`getDescriptorForType()`
`Map<String,String>`	`getHeaders()` Deprecated.
`int`	`getHeadersCount()` HTTP request headers.
`Map<String,String>`	`getHeadersMap()` HTTP request headers.
`String`	`getHeadersOrDefault(String key, String defaultValue)` HTTP request headers.
`String`	`getHeadersOrThrow(String key)` HTTP request headers.
`HttpMethod`	`getHttpMethod()` The HTTP method to use for the request.
`int`	`getHttpMethodValue()` The HTTP method to use for the request.
`Map<String,String>`	`getMutableHeaders()` Deprecated.
`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.
`OAuthToken.Builder`	`getOauthTokenBuilder()` 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.
`OidcToken.Builder`	`getOidcTokenBuilder()` 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.
`String`	`getUrl()` Required.
`ByteString`	`getUrlBytes()` Required.
`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.
`protected GeneratedMessageV3.FieldAccessorTable`	`internalGetFieldAccessorTable()`
`protected MapField`	`internalGetMapField(int number)`
`protected MapField`	`internalGetMutableMapField(int number)`
`boolean`	`isInitialized()`
`HttpRequest.Builder`	`mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)`
`HttpRequest.Builder`	`mergeFrom(HttpRequest other)`
`HttpRequest.Builder`	`mergeFrom(Message other)`
`HttpRequest.Builder`	`mergeOauthToken(OAuthToken value)` 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.
`HttpRequest.Builder`	`mergeOidcToken(OidcToken value)` 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.
`HttpRequest.Builder`	`mergeUnknownFields(UnknownFieldSet unknownFields)`
`HttpRequest.Builder`	`putAllHeaders(Map<String,String> values)` HTTP request headers.
`HttpRequest.Builder`	`putHeaders(String key, String value)` HTTP request headers.
`HttpRequest.Builder`	`removeHeaders(String key)` HTTP request headers.
`HttpRequest.Builder`	`setBody(ByteString value)` HTTP request body.
`HttpRequest.Builder`	`setField(Descriptors.FieldDescriptor field, Object value)`
`HttpRequest.Builder`	`setHttpMethod(HttpMethod value)` The HTTP method to use for the request.
`HttpRequest.Builder`	`setHttpMethodValue(int value)` The HTTP method to use for the request.
`HttpRequest.Builder`	`setOauthToken(OAuthToken.Builder builderForValue)` 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.
`HttpRequest.Builder`	`setOauthToken(OAuthToken value)` 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.
`HttpRequest.Builder`	`setOidcToken(OidcToken.Builder builderForValue)` 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.
`HttpRequest.Builder`	`setOidcToken(OidcToken value)` 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.
`HttpRequest.Builder`	`setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)`
`HttpRequest.Builder`	`setUnknownFields(UnknownFieldSet unknownFields)`
`HttpRequest.Builder`	`setUrl(String value)` Required.
`HttpRequest.Builder`	`setUrlBytes(ByteString value)` Required.

Methods inherited from class com.google.protobuf.AbstractMessage.Builder
findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite.Builder
addAll, addAll, mergeDelimitedFrom, mergeDelimitedFrom, mergeFrom, newUninitializedMessageException

Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.Message.Builder
mergeDelimitedFrom, mergeDelimitedFrom

Methods inherited from interface com.google.protobuf.MessageLite.Builder
mergeFrom

Method Detail

getDescriptor

public static final Descriptors.Descriptor getDescriptor()

internalGetMapField
```
protected MapField internalGetMapField(int number)
```
Overrides:

internalGetMapField in class GeneratedMessageV3.Builder<HttpRequest.Builder>

internalGetMutableMapField
```
protected MapField internalGetMutableMapField(int number)
```
Overrides:

internalGetMutableMapField in class GeneratedMessageV3.Builder<HttpRequest.Builder>

internalGetFieldAccessorTable
```
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
```
Specified by:

internalGetFieldAccessorTable in class GeneratedMessageV3.Builder<HttpRequest.Builder>

clear
```
public HttpRequest.Builder clear()
```
Specified by:

clear in interface Message.Builder

Specified by:

clear in interface MessageLite.Builder

Overrides:

clear in class GeneratedMessageV3.Builder<HttpRequest.Builder>

getDescriptorForType
```
public Descriptors.Descriptor getDescriptorForType()
```
Specified by:

getDescriptorForType in interface Message.Builder

Specified by:

getDescriptorForType in interface MessageOrBuilder

Overrides:

getDescriptorForType in class GeneratedMessageV3.Builder<HttpRequest.Builder>

getDefaultInstanceForType
```
public HttpRequest getDefaultInstanceForType()
```
Specified by:

getDefaultInstanceForType in interface MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface MessageOrBuilder

build
```
public HttpRequest build()
```
Specified by:

build in interface Message.Builder

Specified by:

build in interface MessageLite.Builder

buildPartial
```
public HttpRequest buildPartial()
```
Specified by:

buildPartial in interface Message.Builder

Specified by:

buildPartial in interface MessageLite.Builder

clone
```
public HttpRequest.Builder clone()
```
Specified by:

clone in interface Message.Builder

Specified by:

clone in interface MessageLite.Builder

Overrides:

clone in class GeneratedMessageV3.Builder<HttpRequest.Builder>

setField

public HttpRequest.Builder setField(Descriptors.FieldDescriptor field,
                                    Object value)

Specified by:: setField in interface Message.Builder
Overrides:: setField in class GeneratedMessageV3.Builder<HttpRequest.Builder>

clearField
```
public HttpRequest.Builder clearField(Descriptors.FieldDescriptor field)
```
Specified by:

clearField in interface Message.Builder

Overrides:

clearField in class GeneratedMessageV3.Builder<HttpRequest.Builder>

clearOneof
```
public HttpRequest.Builder clearOneof(Descriptors.OneofDescriptor oneof)
```
Specified by:

clearOneof in interface Message.Builder

Overrides:

clearOneof in class GeneratedMessageV3.Builder<HttpRequest.Builder>

setRepeatedField

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

Specified by:: setRepeatedField in interface Message.Builder
Overrides:: setRepeatedField in class GeneratedMessageV3.Builder<HttpRequest.Builder>

addRepeatedField

public HttpRequest.Builder addRepeatedField(Descriptors.FieldDescriptor field,
                                            Object value)

Specified by:: addRepeatedField in interface Message.Builder
Overrides:: addRepeatedField in class GeneratedMessageV3.Builder<HttpRequest.Builder>

mergeFrom
```
public HttpRequest.Builder mergeFrom(Message other)
```
Specified by:

mergeFrom in interface Message.Builder

Overrides:

mergeFrom in class AbstractMessage.Builder<HttpRequest.Builder>

mergeFrom

public HttpRequest.Builder mergeFrom(HttpRequest other)

isInitialized
```
public final boolean isInitialized()
```
Specified by:

isInitialized in interface MessageLiteOrBuilder

Overrides:

isInitialized in class GeneratedMessageV3.Builder<HttpRequest.Builder>

mergeFrom

public HttpRequest.Builder mergeFrom(CodedInputStream input,
                                     ExtensionRegistryLite extensionRegistry)
                              throws IOException

Specified by:: mergeFrom in interface Message.Builder
Specified by:: mergeFrom in interface MessageLite.Builder
Overrides:: mergeFrom in class AbstractMessage.Builder<HttpRequest.Builder>
Throws:: IOException

getAuthorizationHeaderCase
```
public HttpRequest.AuthorizationHeaderCase getAuthorizationHeaderCase()
```
Specified by:

getAuthorizationHeaderCase in interface HttpRequestOrBuilder

clearAuthorizationHeader

public HttpRequest.Builder clearAuthorizationHeader()

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 [(.google.api.field_behavior) = REQUIRED];

Specified by:: getUrl in interface HttpRequestOrBuilder
Returns:: 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 [(.google.api.field_behavior) = REQUIRED];

Specified by:: getUrlBytes in interface HttpRequestOrBuilder
Returns:: The bytes for url.

setUrl

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 [(.google.api.field_behavior) = REQUIRED];

Parameters:: value - The url to set.
Returns:: This builder for chaining.

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 [(.google.api.field_behavior) = REQUIRED];

Returns:: This builder for chaining.

setUrlBytes

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 [(.google.api.field_behavior) = REQUIRED];

Parameters:: value - The bytes for url to set.
Returns:: This builder for chaining.

getHttpMethodValue
```
public int getHttpMethodValue()
```
```
 The HTTP method to use for the request. The default is POST.
 
```
.google.cloud.tasks.v2.HttpMethod http_method = 2;
Specified by:

getHttpMethodValue in interface HttpRequestOrBuilder

Returns:

The enum numeric value on the wire for httpMethod.

setHttpMethodValue
```
public HttpRequest.Builder setHttpMethodValue(int value)
```
```
 The HTTP method to use for the request. The default is POST.
 
```
.google.cloud.tasks.v2.HttpMethod http_method = 2;
Parameters:

value - The enum numeric value on the wire for httpMethod to set.

Returns:

This builder for chaining.

getHttpMethod
```
public HttpMethod getHttpMethod()
```
```
 The HTTP method to use for the request. The default is POST.
 
```
.google.cloud.tasks.v2.HttpMethod http_method = 2;
Specified by:

getHttpMethod in interface HttpRequestOrBuilder

Returns:

The httpMethod.

setHttpMethod
```
public HttpRequest.Builder setHttpMethod(HttpMethod value)
```
```
 The HTTP method to use for the request. The default is POST.
 
```
.google.cloud.tasks.v2.HttpMethod http_method = 2;
Parameters:

value - The httpMethod to set.

Returns:

This builder for chaining.

clearHttpMethod

public HttpRequest.Builder clearHttpMethod()

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

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

Returns:: This builder for chaining.

getHeadersCount

public int getHeadersCount()

Description copied from interface: HttpRequestOrBuilder

 HTTP request headers.
 This map contains the header field names and values.
 Headers can be set when the
 [task is created][google.cloud.tasks.v2beta3.CloudTasks.CreateTask].
 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:
 * Host: This will be computed by Cloud Tasks and derived from
   [HttpRequest.url][google.cloud.tasks.v2.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][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.

map<string, string> headers = 3;

Specified by:: getHeadersCount in interface HttpRequestOrBuilder

containsHeaders

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][google.cloud.tasks.v2beta3.CloudTasks.CreateTask].
 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:
 * Host: This will be computed by Cloud Tasks and derived from
   [HttpRequest.url][google.cloud.tasks.v2.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][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.

map<string, string> headers = 3;

Specified by:: containsHeaders in interface HttpRequestOrBuilder

getHeaders
```
@Deprecated
public Map<String,String> getHeaders()
```
Deprecated.

Use getHeadersMap() instead.

Specified by:

getHeaders in interface HttpRequestOrBuilder

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][google.cloud.tasks.v2beta3.CloudTasks.CreateTask].
 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:
 * Host: This will be computed by Cloud Tasks and derived from
   [HttpRequest.url][google.cloud.tasks.v2.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][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.

map<string, string> headers = 3;

Specified by:: getHeadersMap in interface HttpRequestOrBuilder

getHeadersOrDefault

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][google.cloud.tasks.v2beta3.CloudTasks.CreateTask].
 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:
 * Host: This will be computed by Cloud Tasks and derived from
   [HttpRequest.url][google.cloud.tasks.v2.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][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.

map<string, string> headers = 3;

Specified by:: getHeadersOrDefault in interface HttpRequestOrBuilder

getHeadersOrThrow

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][google.cloud.tasks.v2beta3.CloudTasks.CreateTask].
 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:
 * Host: This will be computed by Cloud Tasks and derived from
   [HttpRequest.url][google.cloud.tasks.v2.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][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.

map<string, string> headers = 3;

Specified by:: getHeadersOrThrow in interface HttpRequestOrBuilder

clearHeaders

public HttpRequest.Builder clearHeaders()

removeHeaders

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][google.cloud.tasks.v2beta3.CloudTasks.CreateTask].
 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:
 * Host: This will be computed by Cloud Tasks and derived from
   [HttpRequest.url][google.cloud.tasks.v2.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][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.

map<string, string> headers = 3;

getMutableHeaders
```
@Deprecated
public Map<String,String> getMutableHeaders()
```
Deprecated.

Use alternate mutation accessors instead.

putHeaders

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][google.cloud.tasks.v2beta3.CloudTasks.CreateTask].
 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:
 * Host: This will be computed by Cloud Tasks and derived from
   [HttpRequest.url][google.cloud.tasks.v2.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][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.

map<string, string> headers = 3;

putAllHeaders

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][google.cloud.tasks.v2beta3.CloudTasks.CreateTask].
 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:
 * Host: This will be computed by Cloud Tasks and derived from
   [HttpRequest.url][google.cloud.tasks.v2.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][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.

map<string, string> headers = 3;

getBody

public ByteString getBody()

 HTTP request body.
 A request body is allowed only if the
 [HTTP method][google.cloud.tasks.v2.HttpRequest.http_method] is POST, PUT, or PATCH. It is an
 error to set body on a task with an incompatible [HttpMethod][google.cloud.tasks.v2.HttpMethod].

bytes body = 4;

Specified by:: getBody in interface HttpRequestOrBuilder
Returns:: The body.

setBody

public HttpRequest.Builder setBody(ByteString value)

 HTTP request body.
 A request body is allowed only if the
 [HTTP method][google.cloud.tasks.v2.HttpRequest.http_method] is POST, PUT, or PATCH. It is an
 error to set body on a task with an incompatible [HttpMethod][google.cloud.tasks.v2.HttpMethod].

bytes body = 4;

Parameters:: value - The body to set.
Returns:: This builder for chaining.

clearBody

public HttpRequest.Builder clearBody()

 HTTP request body.
 A request body is allowed only if the
 [HTTP method][google.cloud.tasks.v2.HttpRequest.http_method] is POST, PUT, or PATCH. It is an
 error to set body on a task with an incompatible [HttpMethod][google.cloud.tasks.v2.HttpMethod].

bytes body = 4;

Returns:: This builder for chaining.

hasOauthToken

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

Specified by:: hasOauthToken in interface HttpRequestOrBuilder
Returns:: Whether the oauthToken field is set.

getOauthToken

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

Specified by:: getOauthToken in interface HttpRequestOrBuilder
Returns:: The oauthToken.

setOauthToken

public HttpRequest.Builder setOauthToken(OAuthToken value)

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

setOauthToken

public HttpRequest.Builder setOauthToken(OAuthToken.Builder builderForValue)

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

mergeOauthToken

public HttpRequest.Builder mergeOauthToken(OAuthToken value)

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

clearOauthToken

public HttpRequest.Builder clearOauthToken()

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

getOauthTokenBuilder

public OAuthToken.Builder getOauthTokenBuilder()

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

getOauthTokenOrBuilder

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

Specified by:: getOauthTokenOrBuilder in interface HttpRequestOrBuilder

hasOidcToken

public 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.v2.OidcToken oidc_token = 6;

Specified by:: hasOidcToken in interface HttpRequestOrBuilder
Returns:: Whether the oidcToken field is set.

getOidcToken

public 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.v2.OidcToken oidc_token = 6;

Specified by:: getOidcToken in interface HttpRequestOrBuilder
Returns:: The oidcToken.

setOidcToken

public HttpRequest.Builder setOidcToken(OidcToken value)

 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.v2.OidcToken oidc_token = 6;

setOidcToken

public HttpRequest.Builder setOidcToken(OidcToken.Builder builderForValue)

 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.v2.OidcToken oidc_token = 6;

mergeOidcToken

public HttpRequest.Builder mergeOidcToken(OidcToken value)

 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.v2.OidcToken oidc_token = 6;

clearOidcToken

public HttpRequest.Builder clearOidcToken()

 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.v2.OidcToken oidc_token = 6;

getOidcTokenBuilder

public OidcToken.Builder getOidcTokenBuilder()

 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.v2.OidcToken oidc_token = 6;

getOidcTokenOrBuilder

public 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.v2.OidcToken oidc_token = 6;

Specified by:: getOidcTokenOrBuilder in interface HttpRequestOrBuilder

setUnknownFields
```
public final HttpRequest.Builder setUnknownFields(UnknownFieldSet unknownFields)
```
Specified by:

setUnknownFields in interface Message.Builder

Overrides:

setUnknownFields in class GeneratedMessageV3.Builder<HttpRequest.Builder>

mergeUnknownFields
```
public final HttpRequest.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
```
Specified by:

mergeUnknownFields in interface Message.Builder

Overrides:

mergeUnknownFields in class GeneratedMessageV3.Builder<HttpRequest.Builder>

Class HttpRequest.Builder

Method Summary

Methods inherited from class com.google.protobuf.GeneratedMessageV3.Builder

Methods inherited from class com.google.protobuf.AbstractMessage.Builder

Methods inherited from class com.google.protobuf.AbstractMessageLite.Builder

Methods inherited from class java.lang.Object

Methods inherited from interface com.google.protobuf.MessageOrBuilder

Methods inherited from interface com.google.protobuf.Message.Builder

Methods inherited from interface com.google.protobuf.MessageLite.Builder

Method Detail

getDescriptor

internalGetMapField

internalGetMutableMapField

internalGetFieldAccessorTable

clear

getDescriptorForType

getDefaultInstanceForType

build

buildPartial

clone

setField

clearField

clearOneof

setRepeatedField

addRepeatedField

mergeFrom

mergeFrom

isInitialized

mergeFrom

getAuthorizationHeaderCase

clearAuthorizationHeader

getUrl

getUrlBytes

setUrl

clearUrl

setUrlBytes

getHttpMethodValue

setHttpMethodValue

getHttpMethod

setHttpMethod

clearHttpMethod

getHeadersCount

containsHeaders

getHeaders

getHeadersMap

getHeadersOrDefault

getHeadersOrThrow

clearHeaders

removeHeaders

getMutableHeaders

putHeaders

putAllHeaders

getBody

setBody

clearBody

hasOauthToken

getOauthToken

setOauthToken

setOauthToken

mergeOauthToken

clearOauthToken

getOauthTokenBuilder

getOauthTokenOrBuilder

hasOidcToken

getOidcToken

setOidcToken

setOidcToken

mergeOidcToken

clearOidcToken

getOidcTokenBuilder

getOidcTokenOrBuilder

setUnknownFields

mergeUnknownFields