google-cloud-workflows-executions-v1beta 0.1.0

data/proto_docs/google/cloud/workflows/executions/v1beta/executions.rb

@@ -0,0 +1,200 @@
+# frozen_string_literal: true
+
+# Copyright 2020 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.
+
+# Auto-generated by gapic-generator-ruby. DO NOT EDIT!
+
+
+module Google
+  module Cloud
+    module Workflows
+      module Executions
+        module V1beta
+          # A running instance of a [Workflow][google.cloud.workflows.v1beta.Workflow].
+          # @!attribute [r] name
+          #   @return [::String]
+          #     Output only. The resource name of the execution.
+          #     Format:
+          #     projects/\\{project}/locations/\\{location}/workflows/\\{workflow}/executions/\\{execution}
+          # @!attribute [r] start_time
+          #   @return [::Google::Protobuf::Timestamp]
+          #     Output only. Marks the beginning of execution.
+          # @!attribute [r] end_time
+          #   @return [::Google::Protobuf::Timestamp]
+          #     Output only. Marks the end of execution, successful or not.
+          # @!attribute [r] state
+          #   @return [::Google::Cloud::Workflows::Executions::V1beta::Execution::State]
+          #     Output only. Current state of the execution.
+          # @!attribute [rw] argument
+          #   @return [::String]
+          #     Input parameters of the execution represented as a JSON string.
+          #     The size limit is 32KB.
+          # @!attribute [r] result
+          #   @return [::String]
+          #     Output only. Output of the execution represented as a JSON string. The
+          #     value can only be present if the execution's state is `SUCCEEDED`.
+          # @!attribute [r] error
+          #   @return [::Google::Cloud::Workflows::Executions::V1beta::Execution::Error]
+          #     Output only. The error which caused the execution to finish prematurely.
+          #     The value is only present if the execution's state is `FAILED`
+          #     or `CANCELLED`.
+          # @!attribute [r] workflow_revision_id
+          #   @return [::String]
+          #     Output only. Revision of the workflow this execution is using.
+          class Execution
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+
+            # Error describes why the execution was abnormally terminated.
+            # @!attribute [rw] payload
+            #   @return [::String]
+            #     Error payload returned by the execution, represented as a JSON string.
+            # @!attribute [rw] context
+            #   @return [::String]
+            #     Human readable error context, helpful for debugging purposes.
+            class Error
+              include ::Google::Protobuf::MessageExts
+              extend ::Google::Protobuf::MessageExts::ClassMethods
+            end
+
+            # Describes the current state of the execution. More states may be added
+            # in the future.
+            module State
+              # Invalid state.
+              STATE_UNSPECIFIED = 0
+
+              # The execution is in progress.
+              ACTIVE = 1
+
+              # The execution finished successfully.
+              SUCCEEDED = 2
+
+              # The execution failed with an error.
+              FAILED = 3
+
+              # The execution was stopped intentionally.
+              CANCELLED = 4
+            end
+          end
+
+          # Request for the
+          # {::Google::Cloud::Workflows::Executions::V1beta::Executions::Client#list_executions ListExecutions}
+          # method.
+          # @!attribute [rw] parent
+          #   @return [::String]
+          #     Required. Name of the workflow for which the executions should be listed.
+          #     Format: projects/\\{project}/locations/\\{location}/workflows/\\{workflow}
+          # @!attribute [rw] page_size
+          #   @return [::Integer]
+          #     Maximum number of executions to return per call.
+          #     Max supported value depends on the selected Execution view: it's 10000 for
+          #     BASIC and 100 for FULL. The default value used if the field is not
+          #     specified is 100, regardless of the selected view. Values greater than
+          #     the max value will be coerced down to it.
+          # @!attribute [rw] page_token
+          #   @return [::String]
+          #     A page token, received from a previous `ListExecutions` call.
+          #     Provide this to retrieve the subsequent page.
+          #
+          #     When paginating, all other parameters provided to `ListExecutions` must
+          #     match the call that provided the page token.
+          # @!attribute [rw] view
+          #   @return [::Google::Cloud::Workflows::Executions::V1beta::ExecutionView]
+          #     Optional. A view defining which fields should be filled in the returned executions.
+          #     The API will default to the BASIC view.
+          class ListExecutionsRequest
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # Response for the
+          # {::Google::Cloud::Workflows::Executions::V1beta::Executions::Client#list_executions ListExecutions}
+          # method.
+          # @!attribute [rw] executions
+          #   @return [::Array<::Google::Cloud::Workflows::Executions::V1beta::Execution>]
+          #     The executions which match the request.
+          # @!attribute [rw] next_page_token
+          #   @return [::String]
+          #     A token, which can be sent as `page_token` to retrieve the next page.
+          #     If this field is omitted, there are no subsequent pages.
+          class ListExecutionsResponse
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # Request for the
+          # {::Google::Cloud::Workflows::Executions::V1beta::Executions::Client#create_execution CreateExecution}
+          # method.
+          # @!attribute [rw] parent
+          #   @return [::String]
+          #     Required. Name of the workflow for which an execution should be created.
+          #     Format: projects/\\{project}/locations/\\{location}/workflows/\\{workflow}
+          #     The latest revision of the workflow will be used.
+          # @!attribute [rw] execution
+          #   @return [::Google::Cloud::Workflows::Executions::V1beta::Execution]
+          #     Required. Execution to be created.
+          class CreateExecutionRequest
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # Request for the
+          # {::Google::Cloud::Workflows::Executions::V1beta::Executions::Client#get_execution GetExecution}
+          # method.
+          # @!attribute [rw] name
+          #   @return [::String]
+          #     Required. Name of the execution to be retrieved.
+          #     Format:
+          #     projects/\\{project}/locations/\\{location}/workflows/\\{workflow}/executions/\\{execution}
+          # @!attribute [rw] view
+          #   @return [::Google::Cloud::Workflows::Executions::V1beta::ExecutionView]
+          #     Optional. A view defining which fields should be filled in the returned execution.
+          #     The API will default to the FULL view.
+          class GetExecutionRequest
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # Request for the
+          # {::Google::Cloud::Workflows::Executions::V1beta::Executions::Client#cancel_execution CancelExecution}
+          # method.
+          # @!attribute [rw] name
+          #   @return [::String]
+          #     Required. Name of the execution to be cancelled.
+          #     Format:
+          #     projects/\\{project}/locations/\\{location}/workflows/\\{workflow}/executions/\\{execution}
+          class CancelExecutionRequest
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # Defines possible views for execution resource.
+          module ExecutionView
+            # The default / unset value.
+            EXECUTION_VIEW_UNSPECIFIED = 0
+
+            # Includes only basic metadata about the execution.
+            # Following fields are returned: name, start_time, end_time, state
+            # and workflow_revision_id.
+            BASIC = 1
+
+            # Includes all data.
+            FULL = 2
+          end
+        end
+      end
+    end
+  end
+end

data/proto_docs/google/protobuf/timestamp.rb

@@ -0,0 +1,120 @@
+# frozen_string_literal: true
+
+# Copyright 2020 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.
+
+# Auto-generated by gapic-generator-ruby. DO NOT EDIT!
+
+
+module Google
+  module Protobuf
+    # A Timestamp represents a point in time independent of any time zone or local
+    # calendar, encoded as a count of seconds and fractions of seconds at
+    # nanosecond resolution. The count is relative to an epoch at UTC midnight on
+    # January 1, 1970, in the proleptic Gregorian calendar which extends the
+    # Gregorian calendar backwards to year one.
+    #
+    # All minutes are 60 seconds long. Leap seconds are "smeared" so that no leap
+    # second table is needed for interpretation, using a [24-hour linear
+    # smear](https://developers.google.com/time/smear).
+    #
+    # The range is from 0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z. By
+    # restricting to that range, we ensure that we can convert to and from [RFC
+    # 3339](https://www.ietf.org/rfc/rfc3339.txt) date strings.
+    #
+    # # Examples
+    #
+    # Example 1: Compute Timestamp from POSIX `time()`.
+    #
+    #     Timestamp timestamp;
+    #     timestamp.set_seconds(time(NULL));
+    #     timestamp.set_nanos(0);
+    #
+    # Example 2: Compute Timestamp from POSIX `gettimeofday()`.
+    #
+    #     struct timeval tv;
+    #     gettimeofday(&tv, NULL);
+    #
+    #     Timestamp timestamp;
+    #     timestamp.set_seconds(tv.tv_sec);
+    #     timestamp.set_nanos(tv.tv_usec * 1000);
+    #
+    # Example 3: Compute Timestamp from Win32 `GetSystemTimeAsFileTime()`.
+    #
+    #     FILETIME ft;
+    #     GetSystemTimeAsFileTime(&ft);
+    #     UINT64 ticks = (((UINT64)ft.dwHighDateTime) << 32) | ft.dwLowDateTime;
+    #
+    #     // A Windows tick is 100 nanoseconds. Windows epoch 1601-01-01T00:00:00Z
+    #     // is 11644473600 seconds before Unix epoch 1970-01-01T00:00:00Z.
+    #     Timestamp timestamp;
+    #     timestamp.set_seconds((INT64) ((ticks / 10000000) - 11644473600LL));
+    #     timestamp.set_nanos((INT32) ((ticks % 10000000) * 100));
+    #
+    # Example 4: Compute Timestamp from Java `System.currentTimeMillis()`.
+    #
+    #     long millis = System.currentTimeMillis();
+    #
+    #     Timestamp timestamp = Timestamp.newBuilder().setSeconds(millis / 1000)
+    #         .setNanos((int) ((millis % 1000) * 1000000)).build();
+    #
+    #
+    # Example 5: Compute Timestamp from current time in Python.
+    #
+    #     timestamp = Timestamp()
+    #     timestamp.GetCurrentTime()
+    #
+    # # JSON Mapping
+    #
+    # In JSON format, the Timestamp type is encoded as a string in the
+    # [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) format. That is, the
+    # format is "\\{year}-\\{month}-\\{day}T\\{hour}:\\{min}:\\{sec}[.\\{frac_sec}]Z"
+    # where \\{year} is always expressed using four digits while \\{month}, \\{day},
+    # \\{hour}, \\{min}, and \\{sec} are zero-padded to two digits each. The fractional
+    # seconds, which can go up to 9 digits (i.e. up to 1 nanosecond resolution),
+    # are optional. The "Z" suffix indicates the timezone ("UTC"); the timezone
+    # is required. A proto3 JSON serializer should always use UTC (as indicated by
+    # "Z") when printing the Timestamp type and a proto3 JSON parser should be
+    # able to accept both UTC and other timezones (as indicated by an offset).
+    #
+    # For example, "2017-01-15T01:30:15.01Z" encodes 15.01 seconds past
+    # 01:30 UTC on January 15, 2017.
+    #
+    # In JavaScript, one can convert a Date object to this format using the
+    # standard
+    # [toISOString()](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date/toISOString)
+    # method. In Python, a standard `datetime.datetime` object can be converted
+    # to this format using
+    # [`strftime`](https://docs.python.org/2/library/time.html#time.strftime) with
+    # the time format spec '%Y-%m-%dT%H:%M:%S.%fZ'. Likewise, in Java, one can use
+    # the Joda Time's [`ISODateTimeFormat.dateTime()`](
+    # http://www.joda.org/joda-time/apidocs/org/joda/time/format/ISODateTimeFormat.html#dateTime%2D%2D
+    # ) to obtain a formatter capable of generating timestamps in this format.
+    # @!attribute [rw] seconds
+    #   @return [::Integer]
+    #     Represents seconds of UTC time since Unix epoch
+    #     1970-01-01T00:00:00Z. Must be from 0001-01-01T00:00:00Z to
+    #     9999-12-31T23:59:59Z inclusive.
+    # @!attribute [rw] nanos
+    #   @return [::Integer]
+    #     Non-negative fractions of a second at nanosecond resolution. Negative
+    #     second values with fractions must still have non-negative nanos values
+    #     that count forward in time. Must be from 0 to 999,999,999
+    #     inclusive.
+    class Timestamp
+      include ::Google::Protobuf::MessageExts
+      extend ::Google::Protobuf::MessageExts::ClassMethods
+    end
+  end
+end

metadata

@@ -0,0 +1,204 @@
+--- !ruby/object:Gem::Specification
+name: google-cloud-workflows-executions-v1beta
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Google LLC
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2020-11-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: gapic-common
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.3'
+- !ruby/object:Gem::Dependency
+  name: google-cloud-errors
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: google-style
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.24.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.24.0
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.14'
+- !ruby/object:Gem::Dependency
+  name: minitest-focus
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+- !ruby/object:Gem::Dependency
+  name: minitest-rg
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.2'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '12.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '12.0'
+- !ruby/object:Gem::Dependency
+  name: redcarpet
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.18'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.18'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+description: Workflows link series of serverless tasks together in an order you define.
+  Combine the power of Google Cloud's APIs, serverless products like Cloud Functions
+  and Cloud Run, and calls to external APIs to create flexible serverless applications.
+  Workflows requires no infrastructure management and scales seamlessly with demand,
+  including scaling down to zero..
+email: googleapis-packages@google.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".yardopts"
+- AUTHENTICATION.md
+- LICENSE.md
+- README.md
+- lib/google-cloud-workflows-executions-v1beta.rb
+- lib/google/cloud/workflows/executions/v1beta.rb
+- lib/google/cloud/workflows/executions/v1beta/executions.rb
+- lib/google/cloud/workflows/executions/v1beta/executions/client.rb
+- lib/google/cloud/workflows/executions/v1beta/executions/credentials.rb
+- lib/google/cloud/workflows/executions/v1beta/executions/paths.rb
+- lib/google/cloud/workflows/executions/v1beta/executions_pb.rb
+- lib/google/cloud/workflows/executions/v1beta/executions_services_pb.rb
+- lib/google/cloud/workflows/executions/v1beta/version.rb
+- proto_docs/README.md
+- proto_docs/google/api/field_behavior.rb
+- proto_docs/google/api/resource.rb
+- proto_docs/google/cloud/workflows/executions/v1beta/executions.rb
+- proto_docs/google/protobuf/timestamp.rb
+homepage: https://github.com/googleapis/google-cloud-ruby
+licenses:
+- Apache-2.0
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.4'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.4
+signing_key: 
+specification_version: 4
+summary: API Client library for the Workflows Executions V1beta API
+test_files: []