Class HttpTarget

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

Inheritance

object

HttpTarget

Implements

IDirectResponseSchema

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Google.Apis.CloudTasks.v2.Data

Assembly: Google.Apis.CloudTasks.v2.dll

Syntax

public class HttpTarget : IDirectResponseSchema

Properties

ETag

The ETag of the item.

Declaration

public virtual string ETag { get; set; }

Property Value

Type	Description
string

HeaderOverrides

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. Do not put business sensitive or personally identifying data in the HTTP Header Override Configuration or other similar fields in accordance with Section 12 (Resource Fields) of the Service Specific Terms.

Declaration

[JsonProperty("headerOverrides")]
public virtual IList<HeaderOverride> HeaderOverrides { get; set; }

Property Value

Type	Description
IList<HeaderOverride>

HttpMethod

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.

Declaration

[JsonProperty("httpMethod")]
public virtual string HttpMethod { get; set; }

Property Value

Type	Description
string

OauthToken

If specified, an OAuth token is generated and attached as the Authorization header in the HTTP request. This type of authorization should generally be used only when calling Google APIs hosted on *.googleapis.com. Note that both the service account email and the scope MUST be specified when using the queue-level authorization override.

Declaration

[JsonProperty("oauthToken")]
public virtual OAuthToken OauthToken { get; set; }

Property Value

Type	Description
OAuthToken

OidcToken

If specified, an OIDC token is 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. Note that both the service account email and the audience MUST be specified when using the queue-level authorization override.

Declaration

[JsonProperty("oidcToken")]
public virtual OidcToken OidcToken { get; set; }

Property Value

Type	Description
OidcToken

UriOverride

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

Declaration

[JsonProperty("uriOverride")]
public virtual UriOverride UriOverride { get; set; }

Property Value

Type	Description
UriOverride

Implements

IDirectResponseSchema