google-cloud-scheduler 0.1.0 → 0.2.0

data/lib/google/cloud/scheduler/v1/doc/google/cloud/scheduler/v1/target.rb

@@ -0,0 +1,286 @@
+# Copyright 2019 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     https://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+
+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
+        # 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
+        #   @return [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 {Google::Cloud::Scheduler::V1::HttpTarget#uri 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.
+        # @!attribute [rw] http_method
+        #   @return [Google::Cloud::Scheduler::V1::HttpMethod]
+        #     Which HTTP method to use for the request.
+        # @!attribute [rw] headers
+        #   @return [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
+        #       {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.
+        #
+        #     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
+        #     method is POST, PUT, or PATCH. It is an error to set body on a job with an
+        #     incompatible {Google::Cloud::Scheduler::V1::HttpMethod HttpMethod}.
+        class HttpTarget; 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
+        # 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.
+        # @!attribute [rw] http_method
+        #   @return [Google::Cloud::Scheduler::V1::HttpMethod]
+        #     The HTTP method to use for the request. PATCH and OPTIONS are not
+        #     permitted.
+        # @!attribute [rw] app_engine_routing
+        #   @return [Google::Cloud::Scheduler::V1::AppEngineRouting]
+        #     App Engine Routing setting for the job.
+        # @!attribute [rw] relative_uri
+        #   @return [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.
+        # @!attribute [rw] headers
+        #   @return [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.
+        #
+        #     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.
+        #       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.
+        # @!attribute [rw] body
+        #   @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}.
+        class AppEngineHttpTarget; end
+
+        # Pub/Sub target. The job will be delivered by publishing a message to
+        # 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
+        #     [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
+        #   @return [String]
+        #     The message payload for PubsubMessage.
+        #
+        #     Pubsub message must contain either non-empty data, or at least one
+        #     attribute.
+        # @!attribute [rw] attributes
+        #   @return [Hash{String => String}]
+        #     Attributes for PubsubMessage.
+        #
+        #     Pubsub message must contain either non-empty data, or at least one
+        #     attribute.
+        class PubsubTarget; end
+
+        # App Engine Routing.
+        #
+        # For more information about services, versions, and instances see
+        # [An Overview of App
+        # Engine](https://cloud.google.com/appengine/docs/python/an-overview-of-app-engine),
+        # [Microservices Architecture on Google App
+        # Engine](https://cloud.google.com/appengine/docs/python/microservices-on-app-engine),
+        # [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).
+        # @!attribute [rw] service
+        #   @return [String]
+        #     App service.
+        #
+        #     By default, the job is sent to the service which is the default
+        #     service when the job is attempted.
+        # @!attribute [rw] version
+        #   @return [String]
+        #     App version.
+        #
+        #     By default, the job is sent to the version which is the default
+        #     version when the job is attempted.
+        # @!attribute [rw] instance
+        #   @return [String]
+        #     App instance.
+        #
+        #     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).
+        #     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).
+        # @!attribute [rw] host
+        #   @return [String]
+        #     Output only. The host that the job is sent to.
+        #
+        #     For more information about how App Engine requests are routed, see
+        #     [here](https://cloud.google.com/appengine/docs/standard/python/how-requests-are-routed).
+        #
+        #     The host is constructed as:
+        #
+        #
+        #     * `host = [application_domain_name]`</br>
+        #       `| [service] + '.' + [application_domain_name]`</br>
+        #       `| [version] + '.' + [application_domain_name]`</br>
+        #       `| [version_dot_service]+ '.' + [application_domain_name]`</br>
+        #       `| [instance] + '.' + [application_domain_name]`</br>
+        #       `| [instance_dot_service] + '.' + [application_domain_name]`</br>
+        #       `| [instance_dot_version] + '.' + [application_domain_name]`</br>
+        #       `| [instance_dot_version_dot_service] + '.' + [application_domain_name]`
+        #
+        #     * `application_domain_name` = The domain name of the app, for
+        #       example <app-id>.appspot.com, which is associated with the
+        #       job's project ID.
+        #
+        #     * `service =` {Google::Cloud::Scheduler::V1::AppEngineRouting#service service}
+        #
+        #     * `version =` {Google::Cloud::Scheduler::V1::AppEngineRouting#version version}
+        #
+        #     * `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_dot_service =`
+        #       {Google::Cloud::Scheduler::V1::AppEngineRouting#instance instance} `+ '.' +`
+        #       {Google::Cloud::Scheduler::V1::AppEngineRouting#service service}
+        #
+        #     * `instance_dot_version =`
+        #       {Google::Cloud::Scheduler::V1::AppEngineRouting#instance instance} `+ '.' +`
+        #       {Google::Cloud::Scheduler::V1::AppEngineRouting#version version}
+        #
+        #     * `instance_dot_version_dot_service =`
+        #       {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#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#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.
+        class AppEngineRouting; end
+
+        # The HTTP method used to execute the job.
+        module HttpMethod
+          # HTTP method unspecified. Defaults to POST.
+          HTTP_METHOD_UNSPECIFIED = 0
+
+          # HTTP POST
+          POST = 1
+
+          # HTTP GET
+          GET = 2
+
+          # HTTP HEAD
+          HEAD = 3
+
+          # HTTP PUT
+          PUT = 4
+
+          # HTTP DELETE
+          DELETE = 5
+
+          # HTTP PATCH
+          PATCH = 6
+
+          # HTTP OPTIONS
+          OPTIONS = 7
+        end
+      end
+    end
+  end
+end

data/lib/google/cloud/scheduler/v1/doc/google/protobuf/any.rb

@@ -0,0 +1,130 @@
+# Copyright 2019 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     https://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+
+module Google
+  module Protobuf
+    # `Any` contains an arbitrary serialized protocol buffer message along with a
+    # URL that describes the type of the serialized message.
+    #
+    # Protobuf library provides support to pack/unpack Any values in the form
+    # of utility functions or additional generated methods of the Any type.
+    #
+    # Example 1: Pack and unpack a message in C++.
+    #
+    #     Foo foo = ...;
+    #     Any any;
+    #     any.PackFrom(foo);
+    #     ...
+    #     if (any.UnpackTo(&foo)) {
+    #       ...
+    #     }
+    #
+    # Example 2: Pack and unpack a message in Java.
+    #
+    #     Foo foo = ...;
+    #     Any any = Any.pack(foo);
+    #     ...
+    #     if (any.is(Foo.class)) {
+    #       foo = any.unpack(Foo.class);
+    #     }
+    #
+    #  Example 3: Pack and unpack a message in Python.
+    #
+    #     foo = Foo(...)
+    #     any = Any()
+    #     any.Pack(foo)
+    #     ...
+    #     if any.Is(Foo.DESCRIPTOR):
+    #       any.Unpack(foo)
+    #       ...
+    #
+    #  Example 4: Pack and unpack a message in Go
+    #
+    #      foo := &pb.Foo{...}
+    #      any, err := ptypes.MarshalAny(foo)
+    #      ...
+    #      foo := &pb.Foo{}
+    #      if err := ptypes.UnmarshalAny(any, foo); err != nil {
+    #        ...
+    #      }
+    #
+    # The pack methods provided by protobuf library will by default use
+    # 'type.googleapis.com/full.type.name' as the type URL and the unpack
+    # methods only use the fully qualified type name after the last '/'
+    # in the type URL, for example "foo.bar.com/x/y.z" will yield type
+    # name "y.z".
+    #
+    #
+    # = JSON
+    #
+    # The JSON representation of an `Any` value uses the regular
+    # representation of the deserialized, embedded message, with an
+    # additional field `@type` which contains the type URL. Example:
+    #
+    #     package google.profile;
+    #     message Person {
+    #       string first_name = 1;
+    #       string last_name = 2;
+    #     }
+    #
+    #     {
+    #       "@type": "type.googleapis.com/google.profile.Person",
+    #       "firstName": <string>,
+    #       "lastName": <string>
+    #     }
+    #
+    # If the embedded message type is well-known and has a custom JSON
+    # representation, that representation will be embedded adding a field
+    # `value` which holds the custom JSON in addition to the `@type`
+    # field. Example (for message {Google::Protobuf::Duration}):
+    #
+    #     {
+    #       "@type": "type.googleapis.com/google.protobuf.Duration",
+    #       "value": "1.212s"
+    #     }
+    # @!attribute [rw] type_url
+    #   @return [String]
+    #     A URL/resource name that uniquely identifies the type of the serialized
+    #     protocol buffer message. The last segment of the URL's path must represent
+    #     the fully qualified name of the type (as in
+    #     `path/google.protobuf.Duration`). The name should be in a canonical form
+    #     (e.g., leading "." is not accepted).
+    #
+    #     In practice, teams usually precompile into the binary all types that they
+    #     expect it to use in the context of Any. However, for URLs which use the
+    #     scheme `http`, `https`, or no scheme, one can optionally set up a type
+    #     server that maps type URLs to message definitions as follows:
+    #
+    #     * If no scheme is provided, `https` is assumed.
+    #     * An HTTP GET on the URL must yield a {Google::Protobuf::Type}
+    #       value in binary format, or produce an error.
+    #     * Applications are allowed to cache lookup results based on the
+    #       URL, or have them precompiled into a binary to avoid any
+    #       lookup. Therefore, binary compatibility needs to be preserved
+    #       on changes to types. (Use versioned type names to manage
+    #       breaking changes.)
+    #
+    #     Note: this functionality is not currently available in the official
+    #     protobuf release, and it is not used for type URLs beginning with
+    #     type.googleapis.com.
+    #
+    #     Schemes other than `http`, `https` (or the empty scheme) might be
+    #     used with implementation specific semantics.
+    # @!attribute [rw] value
+    #   @return [String]
+    #     Must be a valid serialized protocol buffer of the above specified type.
+    class Any; end
+  end
+end

data/lib/google/cloud/scheduler/v1/doc/google/protobuf/duration.rb

@@ -0,0 +1,91 @@
+# Copyright 2019 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     https://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+
+module Google
+  module Protobuf
+    # A Duration represents a signed, fixed-length span of time represented
+    # as a count of seconds and fractions of seconds at nanosecond
+    # resolution. It is independent of any calendar and concepts like "day"
+    # or "month". It is related to Timestamp in that the difference between
+    # two Timestamp values is a Duration and it can be added or subtracted
+    # from a Timestamp. Range is approximately +-10,000 years.
+    #
+    # = Examples
+    #
+    # Example 1: Compute Duration from two Timestamps in pseudo code.
+    #
+    #     Timestamp start = ...;
+    #     Timestamp end = ...;
+    #     Duration duration = ...;
+    #
+    #     duration.seconds = end.seconds - start.seconds;
+    #     duration.nanos = end.nanos - start.nanos;
+    #
+    #     if (duration.seconds < 0 && duration.nanos > 0) {
+    #       duration.seconds += 1;
+    #       duration.nanos -= 1000000000;
+    #     } else if (durations.seconds > 0 && duration.nanos < 0) {
+    #       duration.seconds -= 1;
+    #       duration.nanos += 1000000000;
+    #     }
+    #
+    # Example 2: Compute Timestamp from Timestamp + Duration in pseudo code.
+    #
+    #     Timestamp start = ...;
+    #     Duration duration = ...;
+    #     Timestamp end = ...;
+    #
+    #     end.seconds = start.seconds + duration.seconds;
+    #     end.nanos = start.nanos + duration.nanos;
+    #
+    #     if (end.nanos < 0) {
+    #       end.seconds -= 1;
+    #       end.nanos += 1000000000;
+    #     } else if (end.nanos >= 1000000000) {
+    #       end.seconds += 1;
+    #       end.nanos -= 1000000000;
+    #     }
+    #
+    # Example 3: Compute Duration from datetime.timedelta in Python.
+    #
+    #     td = datetime.timedelta(days=3, minutes=10)
+    #     duration = Duration()
+    #     duration.FromTimedelta(td)
+    #
+    # = JSON Mapping
+    #
+    # In JSON format, the Duration type is encoded as a string rather than an
+    # object, where the string ends in the suffix "s" (indicating seconds) and
+    # is preceded by the number of seconds, with nanoseconds expressed as
+    # fractional seconds. For example, 3 seconds with 0 nanoseconds should be
+    # encoded in JSON format as "3s", while 3 seconds and 1 nanosecond should
+    # be expressed in JSON format as "3.000000001s", and 3 seconds and 1
+    # microsecond should be expressed in JSON format as "3.000001s".
+    # @!attribute [rw] seconds
+    #   @return [Integer]
+    #     Signed seconds of the span of time. Must be from -315,576,000,000
+    #     to +315,576,000,000 inclusive. Note: these bounds are computed from:
+    #     60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
+    # @!attribute [rw] nanos
+    #   @return [Integer]
+    #     Signed fractions of a second at nanosecond resolution of the span
+    #     of time. Durations less than one second are represented with a 0
+    #     `seconds` field and a positive or negative `nanos` field. For durations
+    #     of one second or more, a non-zero value for the `nanos` field must be
+    #     of the same sign as the `seconds` field. Must be from -999,999,999
+    #     to +999,999,999 inclusive.
+    class Duration; end
+  end
+end