Class HttpTarget (2.63.0)

publicfinalclass HttpTargetextendsGeneratedMessageV3implementsHttpTargetOrBuilder

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

Inherited Members

publicstaticfinalintHEADER_OVERRIDES_FIELD_NUMBER

publicstaticfinalintHTTP_METHOD_FIELD_NUMBER

publicstaticfinalintOAUTH_TOKEN_FIELD_NUMBER

publicstaticfinalintOIDC_TOKEN_FIELD_NUMBER

publicstaticfinalintURI_OVERRIDE_FIELD_NUMBER

publicstaticHttpTargetgetDefaultInstance()

publicstaticfinalDescriptors.DescriptorgetDescriptor()

publicstaticHttpTarget.BuildernewBuilder()

publicstaticHttpTarget.BuildernewBuilder(HttpTargetprototype)

publicstaticHttpTargetparseDelimitedFrom(InputStreaminput)

publicstaticHttpTargetparseDelimitedFrom(InputStreaminput,ExtensionRegistryLiteextensionRegistry)

publicstaticHttpTargetparseFrom(byte[]data)

publicstaticHttpTargetparseFrom(byte[]data,ExtensionRegistryLiteextensionRegistry)

publicstaticHttpTargetparseFrom(ByteStringdata)

publicstaticHttpTargetparseFrom(ByteStringdata,ExtensionRegistryLiteextensionRegistry)

publicstaticHttpTargetparseFrom(CodedInputStreaminput)

publicstaticHttpTargetparseFrom(CodedInputStreaminput,ExtensionRegistryLiteextensionRegistry)

publicstaticHttpTargetparseFrom(InputStreaminput)

publicstaticHttpTargetparseFrom(InputStreaminput,ExtensionRegistryLiteextensionRegistry)

publicstaticHttpTargetparseFrom(ByteBufferdata)

publicstaticHttpTargetparseFrom(ByteBufferdata,ExtensionRegistryLiteextensionRegistry)

publicstaticParser<HttpTarget>parser()

publicbooleanequals(Objectobj)

AbstractMessage.equals(Object other)

publicHttpTarget.AuthorizationHeaderCasegetAuthorizationHeaderCase()

publicHttpTargetgetDefaultInstanceForType()

publicHttpTarget.HeaderOverridegetHeaderOverrides(intindex)

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;

publicintgetHeaderOverridesCount()

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;

publicList<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;

publicHttpTarget.HeaderOverrideOrBuildergetHeaderOverridesOrBuilder(intindex)

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;

publicList<?extendsHttpTarget.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;

publicHttpMethodgetHttpMethod()

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;

publicintgetHttpMethodValue()

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;

publicOAuthTokengetOauthToken()

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;

publicOAuthTokenOrBuildergetOauthTokenOrBuilder()

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;

publicOidcTokengetOidcToken()

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;

publicOidcTokenOrBuildergetOidcTokenOrBuilder()

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;

publicParser<HttpTarget>getParserForType()

GeneratedMessageV3.getParserForType()

publicintgetSerializedSize()

GeneratedMessageV3.getSerializedSize()

publicUriOverridegetUriOverride()

URI override.

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

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

publicUriOverrideOrBuildergetUriOverrideOrBuilder()

URI override.

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

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

publicbooleanhasOauthToken()

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;

publicbooleanhasOidcToken()

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;

publicbooleanhasUriOverride()

URI override.

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

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

publicinthashCode()

AbstractMessage.hashCode()

protectedGeneratedMessageV3.FieldAccessorTableinternalGetFieldAccessorTable()

GeneratedMessageV3.internalGetFieldAccessorTable()

publicfinalbooleanisInitialized()

GeneratedMessageV3.isInitialized()

publicHttpTarget.BuildernewBuilderForType()

protectedHttpTarget.BuildernewBuilderForType(GeneratedMessageV3.BuilderParentparent)

GeneratedMessageV3.newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protectedObjectnewInstance(GeneratedMessageV3.UnusedPrivateParameterunused)

GeneratedMessageV3.newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

publicHttpTarget.BuildertoBuilder()

publicvoidwriteTo(CodedOutputStreamoutput)

GeneratedMessageV3.writeTo(CodedOutputStream output)