Class: Google::Apis::CloudschedulerV1beta1::HttpTarget

Inherits:
Object
  • Object
show all
Includes:
Google::Apis::Core::Hashable, Google::Apis::Core::JsonObjectSupport
Defined in:
generated/google/apis/cloudscheduler_v1beta1/classes.rb,
generated/google/apis/cloudscheduler_v1beta1/representations.rb,
generated/google/apis/cloudscheduler_v1beta1/representations.rb

Overview

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.

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Google::Apis::Core::JsonObjectSupport

#to_json

Methods included from Google::Apis::Core::Hashable

process_value, #to_h

Constructor Details

#initialize(**args) ⇒ HttpTarget

Returns a new instance of HttpTarget



292
293
294
 
# File 'generated/google/apis/cloudscheduler_v1beta1/classes.rb', line 292

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#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. Corresponds to the JSON property body NOTE: Values are automatically base64 encoded/decoded in the client library.

Returns:

  • (String) 


256
257
258
 
# File 'generated/google/apis/cloudscheduler_v1beta1/classes.rb', line 256

def body
  @body
end

#headers ⇒ Hash<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. The total size of headers must be less than 80KB. Corresponds to the JSON property headers

Returns:

  • (Hash<String,String>) 


274
275
276
 
# File 'generated/google/apis/cloudscheduler_v1beta1/classes.rb', line 274

def headers
  @headers
end

#http_method ⇒ String

Which HTTP method to use for the request. Corresponds to the JSON property httpMethod

Returns:

  • (String) 


279
280
281
 
# File 'generated/google/apis/cloudscheduler_v1beta1/classes.rb', line 279

def http_method
  @http_method
end

#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. Corresponds to the JSON property uri

Returns:

  • (String) 


290
291
292
 
# File 'generated/google/apis/cloudscheduler_v1beta1/classes.rb', line 290

def uri
  @uri
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



297
298
299
300
301
302
 
# File 'generated/google/apis/cloudscheduler_v1beta1/classes.rb', line 297

def update!(**args)
  @body = args[:body] if args.key?(:body)
  @headers = args[:headers] if args.key?(:headers)
  @http_method = args[:http_method] if args.key?(:http_method)
  @uri = args[:uri] if args.key?(:uri)
end