HttpRequest (Google Cloud Tasks Parent 2.3.12 API)

java.lang.Object
- com.google.protobuf.AbstractMessageLite
- - com.google.protobuf.AbstractMessage
  - - com.google.protobuf.GeneratedMessageV3
    - - com.google.cloud.tasks.v2beta3.HttpRequest

All Implemented Interfaces:: HttpRequestOrBuilder, Message, MessageLite, MessageLiteOrBuilder, MessageOrBuilder, Serializable

public final class HttpRequest
extends GeneratedMessageV3
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.v2beta3.Queue.retry_config],
   [rate limits][google.cloud.tasks.v2beta3.Queue.rate_limits], and the [queue's state][google.cloud.tasks.v2beta3.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.v2beta3.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.v2beta3.HttpRequest

See Also:: Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class HttpRequest.AuthorizationHeaderCase

static class HttpRequest.Builder
HTTP request.
- Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3
  GeneratedMessageV3.BuilderParent, GeneratedMessageV3.ExtendableBuilder<MessageType extends GeneratedMessageV3.ExtendableMessage,BuilderType extends GeneratedMessageV3.ExtendableBuilder<MessageType,BuilderType>>, GeneratedMessageV3.ExtendableMessage<MessageType extends GeneratedMessageV3.ExtendableMessage>, GeneratedMessageV3.ExtendableMessageOrBuilder<MessageType extends GeneratedMessageV3.ExtendableMessage>, GeneratedMessageV3.FieldAccessorTable, GeneratedMessageV3.UnusedPrivateParameter
- Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite
  AbstractMessageLite.InternalOneOfEnum

Nested Classes
Modifier and Type	Class and Description
`static class`	`HttpRequest.AuthorizationHeaderCase`
`static class`	`HttpRequest.Builder` HTTP request.

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`BODY_FIELD_NUMBER`
`static int`	`HEADERS_FIELD_NUMBER`
`static int`	`HTTP_METHOD_FIELD_NUMBER`
`static int`	`OAUTH_TOKEN_FIELD_NUMBER`
`static int`	`OIDC_TOKEN_FIELD_NUMBER`
`static int`	`URL_FIELD_NUMBER`

Fields inherited from class com.google.protobuf.GeneratedMessageV3
alwaysUseFieldBuilders, unknownFields

Fields inherited from class com.google.protobuf.AbstractMessage
memoizedSize

Fields inherited from class com.google.protobuf.AbstractMessageLite
memoizedHashCode

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`boolean`	`containsHeaders(String key)` HTTP request headers.
`boolean`	`equals(Object obj)`
`HttpRequest.AuthorizationHeaderCase`	`getAuthorizationHeaderCase()`
`ByteString`	`getBody()` HTTP request body.
`static HttpRequest`	`getDefaultInstance()`
`HttpRequest`	`getDefaultInstanceForType()`
`static Descriptors.Descriptor`	`getDescriptor()`
`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.
`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.
`Parser<HttpRequest>`	`getParserForType()`
`int`	`getSerializedSize()`
`UnknownFieldSet`	`getUnknownFields()`
`String`	`getUrl()` Required.
`ByteString`	`getUrlBytes()` Required.
`int`	`hashCode()`
`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)`
`boolean`	`isInitialized()`
`static HttpRequest.Builder`	`newBuilder()`
`static HttpRequest.Builder`	`newBuilder(HttpRequest prototype)`
`HttpRequest.Builder`	`newBuilderForType()`
`protected HttpRequest.Builder`	`newBuilderForType(GeneratedMessageV3.BuilderParent parent)`
`protected Object`	`newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)`
`static HttpRequest`	`parseDelimitedFrom(InputStream input)`
`static HttpRequest`	`parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)`
`static HttpRequest`	`parseFrom(byte[] data)`
`static HttpRequest`	`parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)`
`static HttpRequest`	`parseFrom(ByteBuffer data)`
`static HttpRequest`	`parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)`
`static HttpRequest`	`parseFrom(ByteString data)`
`static HttpRequest`	`parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)`
`static HttpRequest`	`parseFrom(CodedInputStream input)`
`static HttpRequest`	`parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)`
`static HttpRequest`	`parseFrom(InputStream input)`
`static HttpRequest`	`parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)`
`static Parser<HttpRequest>`	`parser()`
`HttpRequest.Builder`	`toBuilder()`
`void`	`writeTo(CodedOutputStream output)`

Methods inherited from class com.google.protobuf.GeneratedMessageV3
canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof, isStringEmpty, makeExtensionsImmutable, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

Methods inherited from class com.google.protobuf.AbstractMessage
findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite
addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

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

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

Methods inherited from interface com.google.protobuf.MessageLite
toByteArray, toByteString, writeDelimitedTo, writeTo

Field Detail
- URL_FIELD_NUMBER
```
public static final int URL_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- HTTP_METHOD_FIELD_NUMBER
```
public static final int HTTP_METHOD_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- HEADERS_FIELD_NUMBER
```
public static final int HEADERS_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- BODY_FIELD_NUMBER
```
public static final int BODY_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- OAUTH_TOKEN_FIELD_NUMBER
```
public static final int OAUTH_TOKEN_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- OIDC_TOKEN_FIELD_NUMBER
```
public static final int OIDC_TOKEN_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values

Method Detail

newInstance

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

Overrides:: newInstance in class GeneratedMessageV3

getUnknownFields
```
public final UnknownFieldSet getUnknownFields()
```
Specified by:

getUnknownFields in interface MessageOrBuilder

Overrides:

getUnknownFields in class GeneratedMessageV3

getDescriptor

public static final Descriptors.Descriptor getDescriptor()

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

internalGetMapField in class GeneratedMessageV3

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

internalGetFieldAccessorTable in class GeneratedMessageV3

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

getAuthorizationHeaderCase in interface HttpRequestOrBuilder

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;

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;

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

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

getHttpMethodValue in interface HttpRequestOrBuilder

Returns:

The enum numeric value on the wire for httpMethod.

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

getHttpMethod in interface HttpRequestOrBuilder

Returns:

The httpMethod.