Class HttpTarget (2.52.0) 

public final class HttpTarget extends GeneratedMessageV3 implements HttpTargetOrBuilder

HTTP target.

When specified as a Queue, all the tasks with [HttpRequest] will be overridden according to the target.

Protobuf type google.cloud.tasks.v2beta3.HttpTarget

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > HttpTarget

Implements

HttpTargetOrBuilder

Static Fields

HEADER_OVERRIDES_FIELD_NUMBER

public static final int HEADER_OVERRIDES_FIELD_NUMBER
Field Value
Type Description
int

HTTP_METHOD_FIELD_NUMBER

public static final int HTTP_METHOD_FIELD_NUMBER
Field Value
Type Description
int

OAUTH_TOKEN_FIELD_NUMBER

public static final int OAUTH_TOKEN_FIELD_NUMBER
Field Value
Type Description
int

OIDC_TOKEN_FIELD_NUMBER

public static final int OIDC_TOKEN_FIELD_NUMBER
Field Value
Type Description
int

URI_OVERRIDE_FIELD_NUMBER

public static final int URI_OVERRIDE_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static HttpTarget getDefaultInstance()
Returns
Type Description
HttpTarget

getDescriptor()

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

newBuilder()

public static HttpTarget.Builder newBuilder()
Returns
Type Description
HttpTarget.Builder

newBuilder(HttpTarget prototype)

public static HttpTarget.Builder newBuilder(HttpTarget prototype)
Parameter
Name Description
prototype HttpTarget
Returns
Type Description
HttpTarget.Builder

parseDelimitedFrom(InputStream input)

public static HttpTarget parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
HttpTarget
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static HttpTarget parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
HttpTarget
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static HttpTarget parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
HttpTarget
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static HttpTarget parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
HttpTarget
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static HttpTarget parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
HttpTarget
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static HttpTarget parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
HttpTarget
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static HttpTarget parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
HttpTarget
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static HttpTarget parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
HttpTarget
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static HttpTarget parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
HttpTarget
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static HttpTarget parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
HttpTarget
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static HttpTarget parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
HttpTarget
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static HttpTarget parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
HttpTarget
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<HttpTarget> parser()
Returns
Type Description
Parser<HttpTarget>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getAuthorizationHeaderCase()

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

getDefaultInstanceForType()

public HttpTarget getDefaultInstanceForType()
Returns
Type Description
HttpTarget

getHeaderOverrides(int index)

public HttpTarget.HeaderOverride getHeaderOverrides(int index)

HTTP target headers.

This map contains the header field names and values. Headers will be set when running the CreateTask and/or BufferTask.

These headers represent a subset of the headers that will be configured for 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:

  • Several predefined headers, prefixed with "X-CloudTasks-", can be used to define properties of the task.
  • Host: This will be computed by Cloud Tasks and derived from HttpRequest.url.

  • Content-Length: This will be computed by Cloud Tasks.

    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". The default value is set to "application/json".

  • User-Agent: This will be set to "Google-Cloud-Tasks".

    Headers which can have multiple values (according to RFC2616) can be specified using comma-separated values.

    The size of the headers must be less than 80KB. Queue-level headers to override headers of all the tasks in the queue.

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

Parameter
Name Description
index int
Returns
Type Description
HttpTarget.HeaderOverride

getHeaderOverridesCount()

public int getHeaderOverridesCount()

HTTP target headers.

This map contains the header field names and values. Headers will be set when running the CreateTask and/or BufferTask.

These headers represent a subset of the headers that will be configured for 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:

  • Several predefined headers, prefixed with "X-CloudTasks-", can be used to define properties of the task.
  • Host: This will be computed by Cloud Tasks and derived from HttpRequest.url.

  • Content-Length: This will be computed by Cloud Tasks.

    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". The default value is set to "application/json".

  • User-Agent: This will be set to "Google-Cloud-Tasks".

    Headers which can have multiple values (according to RFC2616) can be specified using comma-separated values.

    The size of the headers must be less than 80KB. Queue-level headers to override headers of all the tasks in the queue.

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

Returns
Type Description
int

getHeaderOverridesList()

public List<HttpTarget.HeaderOverride> getHeaderOverridesList()

HTTP target headers.

This map contains the header field names and values. Headers will be set when running the CreateTask and/or BufferTask.

These headers represent a subset of the headers that will be configured for 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:

  • Several predefined headers, prefixed with "X-CloudTasks-", can be used to define properties of the task.
  • Host: This will be computed by Cloud Tasks and derived from HttpRequest.url.

  • Content-Length: This will be computed by Cloud Tasks.

    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". The default value is set to "application/json".

  • User-Agent: This will be set to "Google-Cloud-Tasks".

    Headers which can have multiple values (according to RFC2616) can be specified using comma-separated values.

    The size of the headers must be less than 80KB. Queue-level headers to override headers of all the tasks in the queue.

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

Returns
Type Description
List<HeaderOverride>

getHeaderOverridesOrBuilder(int index)

public HttpTarget.HeaderOverrideOrBuilder getHeaderOverridesOrBuilder(int index)

HTTP target headers.

This map contains the header field names and values. Headers will be set when running the CreateTask and/or BufferTask.

These headers represent a subset of the headers that will be configured for 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:

  • Several predefined headers, prefixed with "X-CloudTasks-", can be used to define properties of the task.
  • Host: This will be computed by Cloud Tasks and derived from HttpRequest.url.

  • Content-Length: This will be computed by Cloud Tasks.

    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". The default value is set to "application/json".

  • User-Agent: This will be set to "Google-Cloud-Tasks".

    Headers which can have multiple values (according to RFC2616) can be specified using comma-separated values.

    The size of the headers must be less than 80KB. Queue-level headers to override headers of all the tasks in the queue.

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

Parameter
Name Description
index int
Returns
Type Description
HttpTarget.HeaderOverrideOrBuilder

getHeaderOverridesOrBuilderList()

public List<? extends HttpTarget.HeaderOverrideOrBuilder> getHeaderOverridesOrBuilderList()

HTTP target headers.

This map contains the header field names and values. Headers will be set when running the CreateTask and/or BufferTask.

These headers represent a subset of the headers that will be configured for 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:

  • Several predefined headers, prefixed with "X-CloudTasks-", can be used to define properties of the task.
  • Host: This will be computed by Cloud Tasks and derived from HttpRequest.url.

  • Content-Length: This will be computed by Cloud Tasks.

    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". The default value is set to "application/json".

  • User-Agent: This will be set to "Google-Cloud-Tasks".

    Headers which can have multiple values (according to RFC2616) can be specified using comma-separated values.

    The size of the headers must be less than 80KB. Queue-level headers to override headers of all the tasks in the queue.

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

Returns
Type Description
List<? extends com.google.cloud.tasks.v2beta3.HttpTarget.HeaderOverrideOrBuilder>

getHttpMethod()

public HttpMethod getHttpMethod()

The HTTP method to use for the request.

When specified, it overrides HttpRequest for the task. Note that if the value is set to HttpMethod the HttpRequest of the task will be ignored at execution time.

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

When specified, it overrides HttpRequest for the task. Note that if the value is set to HttpMethod the HttpRequest of the task will be ignored at execution time.

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

Returns
Type Description
int

The enum numeric value on the wire for httpMethod.

getOauthToken()

public OAuthToken getOauthToken()

If specified, an OAuth token will be generated and attached as the 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.

getOauthTokenOrBuilder()

public OAuthTokenOrBuilder getOauthTokenOrBuilder()

If specified, an OAuth token will be generated and attached as the 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.

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

getParserForType()

public Parser<HttpTarget> getParserForType()
Returns
Type Description
Parser<HttpTarget>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getUriOverride()

public UriOverride getUriOverride()

URI override.

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

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

Returns
Type Description
UriOverride

The uriOverride.

getUriOverrideOrBuilder()

public UriOverrideOrBuilder getUriOverrideOrBuilder()

URI override.

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

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

Returns
Type Description
UriOverrideOrBuilder

hasOauthToken()

public boolean hasOauthToken()

If specified, an OAuth token will be generated and attached as the 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.

hasUriOverride()

public boolean hasUriOverride()

URI override.

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

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

Returns
Type Description
boolean

Whether the uriOverride field is set.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public HttpTarget.Builder newBuilderForType()
Returns
Type Description
HttpTarget.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected HttpTarget.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
HttpTarget.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public HttpTarget.Builder toBuilder()
Returns
Type Description
HttpTarget.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException