Class: Google::Apis::CloudschedulerV1::AppEngineHttpTarget

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

Overview

App Engine target. The job will be pushed to a 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]. Error 503 is considered an App Engine system error instead of an application error. Requests returning error 503 will be retried regardless of retry configuration and not counted against retry counts. Any other response code, or a failure to receive a response before the deadline, constitutes a failed attempt.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ AppEngineHttpTarget

Returns a new instance of AppEngineHttpTarget.



91
92
93
 
# File 'lib/google/apis/cloudscheduler_v1/classes.rb', line 91

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

Instance Attribute Details

#app_engine_routing ⇒ Google::Apis::CloudschedulerV1::AppEngineRouting

App Engine Routing. For more information about services, versions, and instances see An Overview of App Engine, Microservices Architecture on Google App Engine, App Engine Standard request routing, and App Engine Flex request routing. Corresponds to the JSON property appEngineRouting

Returns:



45
46
47
 
# File 'lib/google/apis/cloudscheduler_v1/classes.rb', line 45

def app_engine_routing
  @app_engine_routing
end

#body ⇒ String

Body. HTTP request body. A request body is allowed only if the HTTP method is POST or PUT. It will result in invalid argument error to set a 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) 


53
54
55
 
# File 'lib/google/apis/cloudscheduler_v1/classes.rb', line 53

def body
  @body
end

#headers ⇒ Hash<String,String>

HTTP request headers. This map contains the header field names and values. Headers can be set when the job is created. Cloud Scheduler sets some headers to default values: * User-Agent: By default, this header is "AppEngine- Google; (+http://code.google.com/appengine)". This header can be modified, but Cloud Scheduler will append "AppEngine-Google; (+http://code.google.com/ appengine)" to the modified User-Agent. * 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. If the job has a body and the following headers are not set by the user, Cloud Scheduler sets default values:

  • Content-Type: This will be set to "application/octet-stream". You can override this default by explicitly setting Content-Type to a particular media type when creating the job. For example, you can set Content-Type to " application/json". The headers below are output only. They cannot be set or overridden: * Content-Length: This is computed by Cloud Scheduler. * X- Google-*: For Google internal use only. * X-AppEngine-*: For Google internal use only. In addition, some App Engine headers, which contain job- specific information, are also be sent to the job handler. Corresponds to the JSON property headers

Returns:

  • (Hash<String,String>) 


76
77
78
 
# File 'lib/google/apis/cloudscheduler_v1/classes.rb', line 76

def headers
  @headers
end

#http_method ⇒ String

The HTTP method to use for the request. PATCH and OPTIONS are not permitted. Corresponds to the JSON property httpMethod

Returns:

  • (String) 


81
82
83
 
# File 'lib/google/apis/cloudscheduler_v1/classes.rb', line 81

def http_method
  @http_method
end

#relative_uri ⇒ String

The relative URI. The relative URL must begin with "/" and must be a valid HTTP relative URL. It can contain a path, query string arguments, and # fragments. If the relative URL is empty, then the root path "/" will be used. No spaces are allowed, and the maximum length allowed is 2083 characters. Corresponds to the JSON property relativeUri

Returns:

  • (String) 


89
90
91
 
# File 'lib/google/apis/cloudscheduler_v1/classes.rb', line 89

def relative_uri
  @relative_uri
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



96
97
98
99
100
101
102
 
# File 'lib/google/apis/cloudscheduler_v1/classes.rb', line 96

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