proto_docs/google/cloud/scheduler/v1/target.rb in google-cloud-scheduler-v1-0.5.0 vs proto_docs/google/cloud/scheduler/v1/target.rb in google-cloud-scheduler-v1-0.6.0

- old
+ new

@@ -20,11 +20,12 @@ module Google module Cloud module Scheduler module V1 # Http target. The job will be pushed to the job handler by means of - # an HTTP request via an {::Google::Cloud::Scheduler::V1::HttpTarget#http_method http_method} such as HTTP + # an HTTP request via an + # {::Google::Cloud::Scheduler::V1::HttpTarget#http_method 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. # @!attribute [rw] uri @@ -51,10 +52,15 @@ # {::Google::Cloud::Scheduler::V1::HttpTarget#uri 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 time in + # RFC3339 UTC "Zulu" format. # # The total size of headers must be less than 80KB. # @!attribute [rw] body # @return [::String] # HTTP request body. A request body is allowed only if the HTTP @@ -92,11 +98,12 @@ extend ::Google::Protobuf::MessageExts::ClassMethods end end # App Engine target. The job will be pushed to a job handler by means - # of an HTTP request via an {::Google::Cloud::Scheduler::V1::AppEngineHttpTarget#http_method http_method} such + # of an HTTP request via an + # {::Google::Cloud::Scheduler::V1::AppEngineHttpTarget#http_method 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 @@ -130,13 +137,18 @@ # `"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 time in + # RFC3339 UTC "Zulu" format. # - # If the job has an {::Google::Cloud::Scheduler::V1::AppEngineHttpTarget#body body}, Cloud Scheduler sets - # the following headers: + # If the job has an + # {::Google::Cloud::Scheduler::V1::AppEngineHttpTarget#body body}, Cloud Scheduler + # sets the following headers: # # * `Content-Type`: By default, the `Content-Type` header is set to # `"application/octet-stream"`. The default can be overridden by explictly # setting `Content-Type` to a particular media type when the job is # created. @@ -155,11 +167,12 @@ # @return [::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 {::Google::Cloud::Scheduler::V1::HttpMethod HttpMethod}. + # job with an incompatible + # {::Google::Cloud::Scheduler::V1::HttpMethod HttpMethod}. class AppEngineHttpTarget include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # @!attribute [rw] key @@ -176,11 +189,11 @@ # the given Pub/Sub topic. # @!attribute [rw] topic_name # @return [::String] # Required. The name of the Cloud Pub/Sub topic to which messages will # be published when a job is delivered. The topic name must be in the - # same format as required by PubSub's + # same format as required by Pub/Sub's # [PublishRequest.name](https://cloud.google.com/pubsub/docs/reference/rpc/google.pubsub.v1#publishrequest), # for example `projects/PROJECT_ID/topics/TOPIC_ID`. # # The topic must be in the same project as the Cloud Scheduler job. # @!attribute [rw] data @@ -239,11 +252,11 @@ # By default, the job is sent to an instance which is available when # the job is attempted. # # Requests can only be sent to a specific instance if # [manual scaling is used in App Engine - # Standard](https://cloud.google.com/appengine/docs/python/an-overview-of-app-engine?hl=en_US#scaling_types_and_instance_classes). + # Standard](https://cloud.google.com/appengine/docs/python/an-overview-of-app-engine?#scaling_types_and_instance_classes). # App Engine Flex does not support instances. For more information, see # [App Engine Standard request # routing](https://cloud.google.com/appengine/docs/standard/python/how-requests-are-routed) # and [App Engine Flex request # routing](https://cloud.google.com/appengine/docs/flexible/python/how-requests-are-routed). @@ -276,11 +289,12 @@ # # * `version_dot_service =` # {::Google::Cloud::Scheduler::V1::AppEngineRouting#version version} `+ '.' +` # {::Google::Cloud::Scheduler::V1::AppEngineRouting#service service} # - # * `instance =` {::Google::Cloud::Scheduler::V1::AppEngineRouting#instance instance} + # * `instance =` + # {::Google::Cloud::Scheduler::V1::AppEngineRouting#instance instance} # # * `instance_dot_service =` # {::Google::Cloud::Scheduler::V1::AppEngineRouting#instance instance} `+ '.' +` # {::Google::Cloud::Scheduler::V1::AppEngineRouting#service service} # @@ -292,22 +306,26 @@ # {::Google::Cloud::Scheduler::V1::AppEngineRouting#instance instance} `+ '.' +` # {::Google::Cloud::Scheduler::V1::AppEngineRouting#version version} `+ '.' +` # {::Google::Cloud::Scheduler::V1::AppEngineRouting#service service} # # - # If {::Google::Cloud::Scheduler::V1::AppEngineRouting#service service} is empty, then the job will be sent - # to the service which is the default service when the job is attempted. + # If {::Google::Cloud::Scheduler::V1::AppEngineRouting#service service} is empty, + # then the job will be sent to the service which is the default service when + # the job is attempted. # - # If {::Google::Cloud::Scheduler::V1::AppEngineRouting#version version} is empty, then the job will be sent - # to the version which is the default version when the job is attempted. + # If {::Google::Cloud::Scheduler::V1::AppEngineRouting#version version} is empty, + # then the job will be sent to the version which is the default version when + # the job is attempted. # - # If {::Google::Cloud::Scheduler::V1::AppEngineRouting#instance instance} is empty, then the job will be - # sent to an instance which is available when the job is attempted. + # If {::Google::Cloud::Scheduler::V1::AppEngineRouting#instance instance} is + # empty, then the job will be sent to an instance which is available when the + # job is attempted. # # If {::Google::Cloud::Scheduler::V1::AppEngineRouting#service service}, # {::Google::Cloud::Scheduler::V1::AppEngineRouting#version version}, or - # {::Google::Cloud::Scheduler::V1::AppEngineRouting#instance instance} is invalid, then the job will be sent - # to the default version of the default service when the job is attempted. + # {::Google::Cloud::Scheduler::V1::AppEngineRouting#instance instance} is invalid, + # then the job will be sent to the default version of the default service + # when the job is attempted. class AppEngineRouting include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end