Class: Google::Apis::CloudschedulerV1::AppEngineHttpTarget
- Inherits:
-
Object
- Object
- Google::Apis::CloudschedulerV1::AppEngineHttpTarget
- Defined in:
- generated/google/apis/cloudscheduler_v1/classes.rb,
generated/google/apis/cloudscheduler_v1/representations.rb,
generated/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
-
#app_engine_routing ⇒ Google::Apis::CloudschedulerV1::AppEngineRouting
App Engine Routing.
-
#body ⇒ String
Body.
-
#headers ⇒ Hash<String,String>
HTTP request headers.
-
#http_method ⇒ String
The HTTP method to use for the request.
-
#relative_uri ⇒ String
The relative URI.
Instance Method Summary collapse
-
#initialize(**args) ⇒ AppEngineHttpTarget
constructor
A new instance of AppEngineHttpTarget.
-
#update!(**args) ⇒ Object
Update properties of this object.
Methods included from Google::Apis::Core::JsonObjectSupport
Methods included from Google::Apis::Core::Hashable
Constructor Details
#initialize(**args) ⇒ AppEngineHttpTarget
Returns a new instance of AppEngineHttpTarget.
107 108 109 |
# File 'generated/google/apis/cloudscheduler_v1/classes.rb', line 107 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
53 54 55 |
# File 'generated/google/apis/cloudscheduler_v1/classes.rb', line 53 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.
62 63 64 |
# File 'generated/google/apis/cloudscheduler_v1/classes.rb', line 62 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 modifiedUser-Agent
.X-CloudScheduler
: This header will be set to true. If the job has an body, Cloud Scheduler sets the following headers:Content-Type
: By default, theContent-Type
header is set to"application/octet-stream"
. The default can be overridden by explictly settingContent-Type
to a particular media type when the job is created. For example,Content-Type
can be set to"application/json"
.Content-Length
: This is computed by Cloud Scheduler. This value is output only. It cannot be changed. The headers below are output only. They cannot be set or overridden: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 propertyheaders
90 91 92 |
# File 'generated/google/apis/cloudscheduler_v1/classes.rb', line 90 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
96 97 98 |
# File 'generated/google/apis/cloudscheduler_v1/classes.rb', line 96 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
105 106 107 |
# File 'generated/google/apis/cloudscheduler_v1/classes.rb', line 105 def relative_uri @relative_uri end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
112 113 114 115 116 117 118 |
# File 'generated/google/apis/cloudscheduler_v1/classes.rb', line 112 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 |