public sealed class HttpTarget : IMessage<HttpTarget>, IEquatable<HttpTarget>, IDeepCloneable<HttpTarget>, IBufferMessage, IMessageReference documentation and code samples for the Google Cloud Tasks v2beta3 API class HttpTarget.
HTTP target.
When specified as a [Queue][target_type], all the tasks with [HttpRequest] will be overridden according to the target.
Implements
IMessageHttpTarget, IEquatableHttpTarget, IDeepCloneableHttpTarget, IBufferMessage, IMessageNamespace
Google.Cloud.Tasks.V2Beta3Assembly
Google.Cloud.Tasks.V2Beta3.dll
Constructors
HttpTarget()
public HttpTarget()HttpTarget(HttpTarget)
public HttpTarget(HttpTarget other)| Parameter | |
|---|---|
| Name | Description |
other | HttpTarget |
Properties
AuthorizationHeaderCase
public HttpTarget.AuthorizationHeaderOneofCase AuthorizationHeaderCase { get; }| Property Value | |
|---|---|
| Type | Description |
HttpTargetAuthorizationHeaderOneofCase | |
HeaderOverrides
public RepeatedField<HttpTarget.Types.HeaderOverride> HeaderOverrides { get; }HTTP target headers.
This map contains the header field names and values. Headers will be set when running the [CreateTask][google.cloud.tasks.v2beta3.CloudTasks.CreateTask] and/or [BufferTask][google.cloud.tasks.v2beta3.CloudTasks.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][google.cloud.tasks.v2beta3.Target.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][google.cloud.tasks.v2beta3.CloudTasks.CreateTask].
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.
| Property Value | |
|---|---|
| Type | Description |
RepeatedFieldHttpTargetTypesHeaderOverride | |
HttpMethod
public HttpMethod HttpMethod { get; set; }The HTTP method to use for the request.
When specified, it overrides [HttpRequest][google.cloud.tasks.v2beta3.HttpTarget.http_method] for the task. Note that if the value is set to [HttpMethod][GET] the [HttpRequest][body] of the task will be ignored at execution time.
| Property Value | |
|---|---|
| Type | Description |
HttpMethod | |
OauthToken
public OAuthToken OauthToken { get; set; }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.
| Property Value | |
|---|---|
| Type | Description |
OAuthToken | |
OidcToken
public OidcToken OidcToken { get; set; }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.
| Property Value | |
|---|---|
| Type | Description |
OidcToken | |
UriOverride
public UriOverride UriOverride { get; set; }URI override.
When specified, overrides the execution URI for all the tasks in the queue.
| Property Value | |
|---|---|
| Type | Description |
UriOverride | |