HttpRequest (Cloud Tasks API v2beta3 (Rev. 33) 1.25.0)

java.lang.Object
- java.util.AbstractMap<java.lang.String,java.lang.Object>
- - com.google.api.client.util.GenericData
  - - com.google.api.client.json.GenericJson
    - - com.google.api.services.cloudtasks.v2beta3.model.HttpRequest

All Implemented Interfaces:

java.lang.Cloneable, java.util.Map<java.lang.String,java.lang.Object>
```
public final class HttpRequest
extends com.google.api.client.json.GenericJson
```
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).
This is the Java data model class that specifies how to parse/serialize into the JSON that is transmitted over HTTP when working with the Cloud Tasks API. For a detailed explanation see: https://developers.google.com/api-client-library/java/google-http-java-client/json

Author:

Google, Inc.

Nested Class Summary
- Nested classes/interfaces inherited from class com.google.api.client.util.GenericData
  com.google.api.client.util.GenericData.Flags
- Nested classes/interfaces inherited from class java.util.AbstractMap
  java.util.AbstractMap.SimpleEntry<K,V>, java.util.AbstractMap.SimpleImmutableEntry<K,V>
- Nested classes/interfaces inherited from interface java.util.Map
  java.util.Map.Entry<K,V>

Constructor Summary

Constructors
Constructor and Description

HttpRequest()

Constructors
Constructor and Description
`HttpRequest()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`HttpRequest`	`clone()`
`byte[]`	`decodeBody()` HTTP request body.
`HttpRequest`	`encodeBody(byte[] body)` HTTP request body.
`java.lang.String`	`getBody()` HTTP request body.
`java.util.Map<java.lang.String,java.lang.String>`	`getHeaders()` HTTP request headers.
`java.lang.String`	`getHttpMethod()` 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.
`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.
`java.lang.String`	`getUrl()` Required.
`HttpRequest`	`set(java.lang.String fieldName, java.lang.Object value)`
`HttpRequest`	`setBody(java.lang.String body)` HTTP request body.
`HttpRequest`	`setHeaders(java.util.Map<java.lang.String,java.lang.String> headers)` HTTP request headers.
`HttpRequest`	`setHttpMethod(java.lang.String httpMethod)` The HTTP method to use for the request.
`HttpRequest`	`setOauthToken(OAuthToken oauthToken)` 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`	`setOidcToken(OidcToken oidcToken)` 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`	`setUrl(java.lang.String url)` Required.

Methods inherited from class com.google.api.client.json.GenericJson
getFactory, setFactory, toPrettyString, toString

Methods inherited from class com.google.api.client.util.GenericData
entrySet, get, getClassInfo, getUnknownKeys, put, putAll, remove, setUnknownKeys

Methods inherited from class java.util.AbstractMap
clear, containsKey, containsValue, equals, hashCode, isEmpty, keySet, size, values

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

Methods inherited from interface java.util.Map
compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

- Constructor Detail
  - HttpRequest
```
public HttpRequest()
```
- Method Detail
  - getBody
```
public java.lang.String 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.
    
    Returns:
    
    value or null for none
    
    See Also:
    
    decodeBody()
  - decodeBody
```
public byte[] decodeBody()
```
    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.
    
    Returns:
    
    Base64 decoded value or null for none
    
    Since:
    
    1.14
    
    See Also:
    
    getBody()
  - setBody
```
public HttpRequest setBody(java.lang.String body)
```
    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.
    
    Parameters:
    
    body - body or null for none
    
    See Also:
    
    #encodeBody()
  - encodeBody
```
public HttpRequest encodeBody(byte[] body)
```
    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.
    
    Since:
    
    1.14
    
    See Also:
    
    The value is encoded Base64 or {@code null} for none.
  - getHeaders
```
public java.util.Map<java.lang.String,java.lang.String> getHeaders()
```
    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: * 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.
    
    Returns:
    
    value or null for none
  - setHeaders
```
public HttpRequest setHeaders(java.util.Map<java.lang.String,java.lang.String> headers)
```
    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: * 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.
    
    Parameters:
    
    headers - headers or null for none
  - getHttpMethod
```
public java.lang.String getHttpMethod()
```
    The HTTP method to use for the request. The default is POST.
    
    Returns:
    
    value or null for none
  - setHttpMethod
```
public HttpRequest setHttpMethod(java.lang.String httpMethod)
```
    The HTTP method to use for the request. The default is POST.
    
    Parameters:
    
    httpMethod - httpMethod or null for none
  - 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.
    
    Returns:
    
    value or null for none
  - setOauthToken
```
public HttpRequest setOauthToken(OAuthToken oauthToken)
```
    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.
    
    Parameters:
    
    oauthToken - oauthToken or null for none
  - 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.
    
    Returns:
    
    value or null for none
  - setOidcToken
```
public HttpRequest setOidcToken(OidcToken oidcToken)
```
    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.
    
    Parameters:
    
    oidcToken - oidcToken or null for none
  - getUrl
```
public java.lang.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.
    
    Returns:
    
    value or null for none
  - setUrl
```
public HttpRequest setUrl(java.lang.String url)
```
    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.
    
    Parameters:
    
    url - url or null for none
  - set
```
public HttpRequest set(java.lang.String fieldName,
                       java.lang.Object value)
```
    Overrides:
    
    set in class com.google.api.client.json.GenericJson
  - clone
```
public HttpRequest clone()
```
    Overrides:
    
    clone in class com.google.api.client.json.GenericJson

Cloud Tasks API v2beta3 (revision 33)

Class HttpRequest

Nested Class Summary

Nested classes/interfaces inherited from class com.google.api.client.util.GenericData

Nested classes/interfaces inherited from class java.util.AbstractMap

Nested classes/interfaces inherited from interface java.util.Map

Constructor Summary

Method Summary

Methods inherited from class com.google.api.client.json.GenericJson

Methods inherited from class com.google.api.client.util.GenericData

Methods inherited from class java.util.AbstractMap

Methods inherited from class java.lang.Object

Methods inherited from interface java.util.Map

Constructor Detail

HttpRequest

Method Detail

getBody

decodeBody

setBody

encodeBody

getHeaders

setHeaders

getHttpMethod

setHttpMethod

getOauthToken

setOauthToken

getOidcToken

setOidcToken

getUrl

setUrl

set

clone