Cloud Scheduler V1 Client - Class HttpTarget (1.6.8)

Reference documentation and code samples for the Cloud Scheduler V1 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.v1.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. 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\V1\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\V1\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.

Generated from protobuf field string uri = 1;

Returns
Type	Description
`string`

setUri

Generated from protobuf field string uri = 1;

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getHttpMethod

Which HTTP method to use for the request.

Generated from protobuf field .google.cloud.scheduler.v1.HttpMethod http_method = 2;

Returns
Type	Description
`int`

setHttpMethod

Which HTTP method to use for the request.

Generated from protobuf field .google.cloud.scheduler.v1.HttpMethod http_method = 2;

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. The total size of headers must be less than 80KB.

Generated from protobuf field map<string, string> headers = 3;

Returns
Type	Description
`Google\Protobuf\Internal\MapField`

setHeaders

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. The total size of headers must be less than 80KB.

Generated from protobuf field map<string, string> headers = 3;

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.

Generated from protobuf field bytes body = 4;

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.

Generated from protobuf field bytes body = 4;

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.

Generated from protobuf field .google.cloud.scheduler.v1.OAuthToken oauth_token = 5;

Returns
Type	Description
`Google\Cloud\Scheduler\V1\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.

Generated from protobuf field .google.cloud.scheduler.v1.OAuthToken oauth_token = 5;

Parameter
Name	Description
`var`	`Google\Cloud\Scheduler\V1\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.

Generated from protobuf field .google.cloud.scheduler.v1.OidcToken oidc_token = 6;

Returns
Type	Description
`Google\Cloud\Scheduler\V1\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.

Generated from protobuf field .google.cloud.scheduler.v1.OidcToken oidc_token = 6;

Parameter
Name	Description
`var`	`Google\Cloud\Scheduler\V1\OidcToken`

Returns
Type	Description
`$this`

getAuthorizationHeader

Returns
Type	Description
`string`