Cloud Scheduler V1 API - Class Google::Cloud::Scheduler::V1::HttpTarget (v1.1.0)

Reference documentation and code samples for the Cloud Scheduler V1 API class Google::Cloud::Scheduler::V1::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.

Inherits

Object

Extended By

Google::Protobuf::MessageExts::ClassMethods

Includes

Google::Protobuf::MessageExts

Methods

#body

def body() -> ::String

Returns

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

#body=

def body=(value) -> ::String

Parameter

value (::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.

Returns

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

#headers

def headers() -> ::Google::Protobuf::Map{::String => ::String}

Returns

(::Google::Protobuf::Map{::String => ::String}) — 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 as an offset of UTC parsed according to RFC3339.
The total size of headers must be less than 80KB.

#headers=

def headers=(value) -> ::Google::Protobuf::Map{::String => ::String}

Parameter

value (::Google::Protobuf::Map{::String => ::String}) — 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 as an offset of UTC parsed according to RFC3339.
The total size of headers must be less than 80KB.

Returns

(::Google::Protobuf::Map{::String => ::String}) — 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 as an offset of UTC parsed according to RFC3339.
The total size of headers must be less than 80KB.

#http_method

def http_method() -> ::Google::Cloud::Scheduler::V1::HttpMethod

Returns

(::Google::Cloud::Scheduler::V1::HttpMethod) — Which HTTP method to use for the request.

#http_method=

def http_method=(value) -> ::Google::Cloud::Scheduler::V1::HttpMethod

Parameter

value (::Google::Cloud::Scheduler::V1::HttpMethod) — Which HTTP method to use for the request.

Returns

(::Google::Cloud::Scheduler::V1::HttpMethod) — Which HTTP method to use for the request.

#oauth_token

def oauth_token() -> ::Google::Cloud::Scheduler::V1::OAuthToken

Returns

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

#oauth_token=

def oauth_token=(value) -> ::Google::Cloud::Scheduler::V1::OAuthToken

Parameter

value (::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.

Returns

(::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

def oidc_token() -> ::Google::Cloud::Scheduler::V1::OidcToken

Returns

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

#oidc_token=

def oidc_token=(value) -> ::Google::Cloud::Scheduler::V1::OidcToken

Parameter

value (::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.

Returns

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

#uri

def uri() -> ::String

Returns

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

#uri=

def uri=(value) -> ::String

Parameter

value (::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.

Returns

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