Google Cloud Scheduler v1 API - Class HttpTarget (3.5.0) 

public sealed class HttpTarget : IMessage<HttpTarget>, IEquatable<HttpTarget>, IDeepCloneable<HttpTarget>, IBufferMessage, IMessage

Reference documentation and code samples for the Google Cloud Scheduler v1 API class HttpTarget.

Http target. The job will be pushed to the job handler by means of an HTTP request via an [http_method][google.cloud.scheduler.v1.HttpTarget.http_method] such as HTTP POST, HTTP GET, etc. The job is acknowledged by means of an HTTP response code in the range [200 - 299]. A failure to receive a response constitutes a failed execution. For a redirected request, the response returned by the redirected request is considered.

Inheritance

object > HttpTarget

Namespace

Google.Cloud.Scheduler.V1

Assembly

Google.Cloud.Scheduler.V1.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

Body

public ByteString Body { get; set; }

HTTP request body. A request body is allowed only if the HTTP method is POST, PUT, or PATCH. It is an error to set body on a job with an incompatible [HttpMethod][google.cloud.scheduler.v1.HttpMethod].

Property Value
Type Description
ByteString

Headers

public MapField<string, string> Headers { get; }

The user can specify HTTP request headers to send with the job's HTTP request. This map contains the header field names and values. Repeated headers are not supported, but a header value can contain commas. These headers represent a subset of the headers that will accompany the job's HTTP request. Some HTTP request headers will be ignored or replaced. A partial list of headers that will be ignored or replaced is below:

  • Host: This will be computed by Cloud Scheduler and derived from [uri][google.cloud.scheduler.v1.HttpTarget.uri].
  • Content-Length: This will be computed by Cloud Scheduler.
  • User-Agent: This will be set to "Google-Cloud-Scheduler".
  • X-Google-*: Google internal use only.
  • X-AppEngine-*: Google internal use only.
  • X-CloudScheduler: This header will be set to true.
  • X-CloudScheduler-JobName: This header will contain the job name.
  • X-CloudScheduler-ScheduleTime: For Cloud Scheduler jobs specified in the unix-cron format, this header will contain the job schedule as an offset of UTC parsed according to RFC3339.

The total size of headers must be less than 80KB.

Property Value
Type Description
MapFieldstringstring

HttpMethod

public HttpMethod HttpMethod { get; set; }

Which HTTP method to use for the request.

Property Value
Type Description
HttpMethod

OauthToken

public OAuthToken OauthToken { get; set; }

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

Uri

public string Uri { get; set; }

Required. The full URI path that the request will be sent to. This string must begin with either "http://" or "https://". Some examples of valid values for [uri][google.cloud.scheduler.v1.HttpTarget.uri] are: http://acme.com and https://acme.com/sales:8080. Cloud Scheduler will encode some characters for safety and compatibility. The maximum allowed URL length is 2083 characters after encoding.

Property Value
Type Description
string