Cloud Scheduler V1beta1 Client - Class HttpTarget (1.8.3)

Version 1.8.3

• 2.0.2 (latest)
• 2.0.1
• 1.10.5
• 1.9.4
• 1.8.3
• 1.7.1
• 1.6.8

Beta

This library is covered by the Pre-GA Offerings Terms of the Terms of Service. Pre-GA libraries might have limited support, and changes to pre-GA libraries might not be compatible with other pre-GA versions. For more information, see the launch stage descriptions.

Reference documentation and code samples for the Cloud Scheduler V1beta1 Client class HttpTarget.

Http target. The job will be pushed to the job handler by means of an HTTP request via an 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.

Generated from protobuf message google.cloud.scheduler.v1beta1.HttpTarget

Methods

__construct

Constructor.

Parameters
Name	Description
data	array Optional. Data for populating the Message object.
↳ uri	string 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 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.
↳ http_method	int Which HTTP method to use for the request.
↳ headers	array|Google\Protobuf\Internal\MapField 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. * 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 time in RFC3339 UTC "Zulu" format. The total size of headers must be less than 80KB.
↳ body	string 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.
↳ oauth_token	Google\Cloud\Scheduler\V1beta1\OAuthToken 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.
↳ oidc_token	Google\Cloud\Scheduler\V1beta1\OidcToken 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.

getUri

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

Returns
Type	Description
string

setUri

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

Parameter
Name	Description
var	string

Returns
Type	Description
$this

getHttpMethod

Which HTTP method to use for the request.

Returns
Type	Description
int

setHttpMethod

Which HTTP method to use for the request.

Parameter
Name	Description
var	int

Returns
Type	Description
$this

getHeaders

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.

• 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 time in RFC3339 UTC "Zulu" format. The total size of headers must be less than 80KB.

Returns
Type	Description
Google\Protobuf\Internal\MapField

setHeaders

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.

• 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 time in RFC3339 UTC "Zulu" format. The total size of headers must be less than 80KB.

Parameter
Name	Description
var	array|Google\Protobuf\Internal\MapField

Returns
Type	Description
$this

getBody

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.

Returns
Type	Description
string

setBody

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.

Parameter
Name	Description
var	string

Returns
Type	Description
$this

getOauthToken

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.

Returns
Type	Description
Google\Cloud\Scheduler\V1beta1\OAuthToken|null

hasOauthToken

setOauthToken

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.

Parameter
Name	Description
var	Google\Cloud\Scheduler\V1beta1\OAuthToken

Returns
Type	Description
$this

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.

Returns
Type	Description
Google\Cloud\Scheduler\V1beta1\OidcToken|null

hasOidcToken

setOidcToken

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.

Parameter
Name	Description
var	Google\Cloud\Scheduler\V1beta1\OidcToken

Returns
Type	Description
$this

getAuthorizationHeader

Returns
Type	Description
string