google-apis-datapipelines_v1 0.2.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 136b198af712e3e7dc420bb43a35a82b6e87ff1a62605c82c8e69f33621562d6
-  data.tar.gz: 506852d4b79ac5c4fa8323c960cda3e569e050444edd59ed4593efcbad600674
+  metadata.gz: 80d81a8e1398a93157445c4514dd56a349140ae6075b9c0260f55dd942f52468
+  data.tar.gz: 4d7e3274e699850a0339579f5eaa69186e183eb92fc8ebc9abf07add94f0bc3f
 SHA512:
-  metadata.gz: 80b5647ef27f639b88dd12059749a3f981a33244ec2d00f9db45a2e81b84fb41fdb837c4244fc910aad2dce438f405421d50b88bf6b909740c80114f310126a0
-  data.tar.gz: 7de9e304b12698f8aa145a50c22251af062a58be947ac057fa8a4fdbff304a6a02a57b950521951568e494d49ee49b4df83a7dd4d5a2a955ee12e1023a696f1e
+  metadata.gz: 7ef61e3f774eb0dd67b0abbf0a1c7138b1e9c8d996c9c49ae7984ff2e61d0968836498ed21c24ca0235ee5830b11f67d3af41c0719cef53f300b158213b25581
+  data.tar.gz: fa63556e5b50c416da6980cfd8ee7b5e5416f0e9d91ad8f5aa8dabc68815b3152afff20344e74fffdec7875e02f26028e072c60aa06fe49520c86d331ab0e9b6

data/CHANGELOG.md

@@ -1,5 +1,19 @@
 # Release history for google-apis-datapipelines_v1
 
+### v0.5.0 (2022-03-30)
+
+* Regenerated from discovery document revision 20220319
+
+### v0.4.0 (2022-01-13)
+
+* Regenerated from discovery document revision 20220103
+* Regenerated using generator version 0.4.1
+
+### v0.3.0 (2021-12-16)
+
+* Regenerated from discovery document revision 20211203
+* Unspecified changes
+
 ### v0.2.0 (2021-11-10)
 
 * Regenerated from discovery document revision 20211029

data/OVERVIEW.md

@@ -51,7 +51,7 @@ require "google/apis/datapipelines_v1"
 client = Google::Apis::DatapipelinesV1::DatapipelinesService.new
 
 # Authenticate calls
-client.authentication = # ... use the googleauth gem to create credentials
+client.authorization = # ... use the googleauth gem to create credentials
 ```
 
 See the class reference docs for information on the methods you can call from a client.

data/lib/google/apis/datapipelines_v1/classes.rb

@@ -447,6 +447,33 @@ module Google
         end
       end
       
+      # Response message for ListJobs
+      class GoogleCloudDatapipelinesV1ListJobsResponse
+        include Google::Apis::Core::Hashable
+      
+        # Results that were accessible to the caller. Results are always in descending
+        # order of job creation date.
+        # Corresponds to the JSON property `jobs`
+        # @return [Array<Google::Apis::DatapipelinesV1::GoogleCloudDatapipelinesV1Job>]
+        attr_accessor :jobs
+      
+        # A token, which can be sent as `page_token` to retrieve the next page. If this
+        # field is omitted, there are no subsequent pages.
+        # Corresponds to the JSON property `nextPageToken`
+        # @return [String]
+        attr_accessor :next_page_token
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @jobs = args[:jobs] if args.key?(:jobs)
+          @next_page_token = args[:next_page_token] if args.key?(:next_page_token)
+        end
+      end
+      
       # Response message for ListPipelines.
       class GoogleCloudDatapipelinesV1ListPipelinesResponse
         include Google::Apis::Core::Hashable
@@ -474,8 +501,8 @@ module Google
         end
       end
       
-      # The main pipeline entity and all the needed metadata to launch and manage
-      # linked jobs.
+      # The main pipeline entity and all the necessary metadata for launching and
+      # managing linked jobs.
       class GoogleCloudDatapipelinesV1Pipeline
         include Google::Apis::Core::Hashable
       
@@ -506,13 +533,13 @@ module Google
         # pipelines/PIPELINE_ID`. * `PROJECT_ID` can contain letters ([A-Za-z]), numbers
         # ([0-9]), hyphens (-), colons (:), and periods (.). For more information, see [
         # Identifying projects](https://cloud.google.com/resource-manager/docs/creating-
-        # managing-projects#identifying_projects) * `LOCATION_ID` is the canonical ID
+        # managing-projects#identifying_projects). * `LOCATION_ID` is the canonical ID
         # for the pipeline's location. The list of available locations can be obtained
-        # by calling ListLocations. Note that the Data Pipelines service is not
-        # available in all regions. It depends on Cloud Scheduler, an App Engine
-        # application, so it's only available in [App Engine regions](https://cloud.
-        # google.com/about/locations#region). * `PIPELINE_ID` is the ID of the pipeline.
-        # Must be unique for the selected project and location.
+        # by calling `google.cloud.location.Locations.ListLocations`. Note that the Data
+        # Pipelines service is not available in all regions. It depends on Cloud
+        # Scheduler, an App Engine application, so it's only available in [App Engine
+        # regions](https://cloud.google.com/about/locations#region). * `PIPELINE_ID` is
+        # the ID of the pipeline. Must be unique for the selected project and location.
         # Corresponds to the JSON property `name`
         # @return [String]
         attr_accessor :name
@@ -847,8 +874,7 @@ module Google
       # A generic empty message that you can re-use to avoid defining duplicated empty
       # messages in your APIs. A typical example is to use it as the request or the
       # response type of an API method. For instance: service Foo ` rpc Bar(google.
-      # protobuf.Empty) returns (google.protobuf.Empty); ` The JSON representation for
-      # `Empty` is empty JSON object ````.
+      # protobuf.Empty) returns (google.protobuf.Empty); `
       class GoogleProtobufEmpty
         include Google::Apis::Core::Hashable
       

data/lib/google/apis/datapipelines_v1/gem_version.rb

@@ -16,13 +16,13 @@ module Google
   module Apis
     module DatapipelinesV1
       # Version of the google-apis-datapipelines_v1 gem
-      GEM_VERSION = "0.2.0"
+      GEM_VERSION = "0.5.0"
 
       # Version of the code generator used to generate this client
-      GENERATOR_VERSION = "0.4.0"
+      GENERATOR_VERSION = "0.4.1"
 
       # Revision of the discovery document this client was generated from
-      REVISION = "20211029"
+      REVISION = "20220319"
     end
   end
 end

data/lib/google/apis/datapipelines_v1/representations.rb

@@ -64,6 +64,12 @@ module Google
         include Google::Apis::Core::JsonObjectSupport
       end
       
+      class GoogleCloudDatapipelinesV1ListJobsResponse
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
       class GoogleCloudDatapipelinesV1ListPipelinesResponse
         class Representation < Google::Apis::Core::JsonRepresentation; end
       
@@ -226,6 +232,15 @@ module Google
         end
       end
       
+      class GoogleCloudDatapipelinesV1ListJobsResponse
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          collection :jobs, as: 'jobs', class: Google::Apis::DatapipelinesV1::GoogleCloudDatapipelinesV1Job, decorator: Google::Apis::DatapipelinesV1::GoogleCloudDatapipelinesV1Job::Representation
+      
+          property :next_page_token, as: 'nextPageToken'
+        end
+      end
+      
       class GoogleCloudDatapipelinesV1ListPipelinesResponse
         # @private
         class Representation < Google::Apis::Core::JsonRepresentation

data/lib/google/apis/datapipelines_v1/service.rb

@@ -50,8 +50,8 @@ module Google
           @batch_path = 'batch'
         end
         
-        # Lists pipelines. Returns a "NOT_FOUND" error if the list is empty. Returns a "
-        # FORBIDDEN" error if the caller doesn't have permission to access it.
+        # Lists pipelines. Returns a "FORBIDDEN" error if the caller doesn't have
+        # permission to access it.
         # @param [String] parent
         #   Required. The location name. For example: `projects/PROJECT_ID/locations/
         #   LOCATION_ID`.
@@ -60,11 +60,9 @@ module Google
         #   pipelines will be returned. Multiple filters can be applied and must be comma
         #   separated. Fields eligible for filtering are: + `type`: The type of the
         #   pipeline (streaming or batch). Allowed values are `ALL`, `BATCH`, and `
-        #   STREAMING`. + `executor_type`: The type of pipeline execution layer. This is
-        #   always Dataflow for now, but more executors may be added later. Allowed values
-        #   are `ALL` and `DATAFLOW`. + `status`: The activity status of the pipeline.
-        #   Allowed values are `ALL`, `ACTIVE`, `ARCHIVED`, and `PAUSED`. For example, to
-        #   limit results to active batch processing pipelines: type:BATCH,status:ACTIVE
+        #   STREAMING`. + `status`: The activity status of the pipeline. Allowed values
+        #   are `ALL`, `ACTIVE`, `ARCHIVED`, and `PAUSED`. For example, to limit results
+        #   to active batch processing pipelines: type:BATCH,status:ACTIVE
         # @param [Fixnum] page_size
         #   The maximum number of entities to return. The service may return fewer than
         #   this value, even if there are additional pages. If unspecified, the max limit
@@ -176,7 +174,7 @@ module Google
         # exists. Returns a "FORBIDDEN" error if the caller doesn't have permission to
         # access it.
         # @param [String] name
-        #   Required. The pipeeline name. For example: `projects/PROJECT_ID/locations/
+        #   Required. The pipeline name. For example: `projects/PROJECT_ID/locations/
         #   LOCATION_ID/pipelines/PIPELINE_ID`.
         # @param [String] fields
         #   Selector specifying which fields to include in a partial response.
@@ -205,8 +203,8 @@ module Google
           execute_or_queue_command(command, &block)
         end
         
-        # Updates a pipeline. If successful, the updated [Pipeline] is returned. Returns
-        # `NOT_FOUND` if the pipeline doesn't exist. If UpdatePipeline does not return
+        # Updates a pipeline. If successful, the updated Pipeline is returned. Returns `
+        # NOT_FOUND` if the pipeline doesn't exist. If UpdatePipeline does not return
         # successfully, you can retry the UpdatePipeline request until you receive a
         # successful response.
         # @param [String] name
@@ -214,13 +212,13 @@ module Google
         #   pipelines/PIPELINE_ID`. * `PROJECT_ID` can contain letters ([A-Za-z]), numbers
         #   ([0-9]), hyphens (-), colons (:), and periods (.). For more information, see [
         #   Identifying projects](https://cloud.google.com/resource-manager/docs/creating-
-        #   managing-projects#identifying_projects) * `LOCATION_ID` is the canonical ID
+        #   managing-projects#identifying_projects). * `LOCATION_ID` is the canonical ID
         #   for the pipeline's location. The list of available locations can be obtained
-        #   by calling ListLocations. Note that the Data Pipelines service is not
-        #   available in all regions. It depends on Cloud Scheduler, an App Engine
-        #   application, so it's only available in [App Engine regions](https://cloud.
-        #   google.com/about/locations#region). * `PIPELINE_ID` is the ID of the pipeline.
-        #   Must be unique for the selected project and location.
+        #   by calling `google.cloud.location.Locations.ListLocations`. Note that the Data
+        #   Pipelines service is not available in all regions. It depends on Cloud
+        #   Scheduler, an App Engine application, so it's only available in [App Engine
+        #   regions](https://cloud.google.com/about/locations#region). * `PIPELINE_ID` is
+        #   the ID of the pipeline. Must be unique for the selected project and location.
         # @param [Google::Apis::DatapipelinesV1::GoogleCloudDatapipelinesV1Pipeline] google_cloud_datapipelines_v1_pipeline_object
         # @param [String] update_mask
         #   The list of fields to be updated.
@@ -257,7 +255,7 @@ module Google
         # Creates a job for the specified pipeline directly. You can use this method
         # when the internal scheduler is not configured and you want to trigger the job
         # directly or through an external system. Returns a "NOT_FOUND" error if the
-        # pipeline doesn't exist. Returns a "FOBIDDEN" error if the user doesn't have
+        # pipeline doesn't exist. Returns a "FORBIDDEN" error if the user doesn't have
         # permission to access the pipeline or run jobs for the pipeline.
         # @param [String] name
         #   Required. The pipeline name. For example: `projects/PROJECT_ID/locations/
@@ -294,8 +292,7 @@ module Google
         
         # Freezes pipeline execution permanently. If there's a corresponding scheduler
         # entry, it's deleted, and the pipeline state is changed to "ARCHIVED". However,
-        # pipeline metadata is retained. Upon success, the pipeline state is updated to
-        # ARCHIVED.
+        # pipeline metadata is retained.
         # @param [String] name
         #   Required. The pipeline name. For example: `projects/PROJECT_ID/locations/
         #   LOCATION_ID/pipelines/PIPELINE_ID`.
@@ -328,6 +325,48 @@ module Google
           command.query['quotaUser'] = quota_user unless quota_user.nil?
           execute_or_queue_command(command, &block)
         end
+        
+        # Lists jobs for a given pipeline. Throws a "FORBIDDEN" error if the caller
+        # doesn't have permission to access it.
+        # @param [String] parent
+        #   Required. The pipeline name. For example: `projects/PROJECT_ID/locations/
+        #   LOCATION_ID/pipelines/PIPELINE_ID`.
+        # @param [Fixnum] page_size
+        #   The maximum number of entities to return. The service may return fewer than
+        #   this value, even if there are additional pages. If unspecified, the max limit
+        #   will be determined by the backend implementation.
+        # @param [String] page_token
+        #   A page token, received from a previous `ListJobs` call. Provide this to
+        #   retrieve the subsequent page. When paginating, all other parameters provided
+        #   to `ListJobs` must match the call that provided the page token.
+        # @param [String] fields
+        #   Selector specifying which fields to include in a partial response.
+        # @param [String] quota_user
+        #   Available to use for quota purposes for server-side applications. Can be any
+        #   arbitrary string assigned to a user, but should not exceed 40 characters.
+        # @param [Google::Apis::RequestOptions] options
+        #   Request-specific options
+        #
+        # @yield [result, err] Result & error if block supplied
+        # @yieldparam result [Google::Apis::DatapipelinesV1::GoogleCloudDatapipelinesV1ListJobsResponse] parsed result object
+        # @yieldparam err [StandardError] error object if request failed
+        #
+        # @return [Google::Apis::DatapipelinesV1::GoogleCloudDatapipelinesV1ListJobsResponse]
+        #
+        # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
+        # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
+        # @raise [Google::Apis::AuthorizationError] Authorization is required
+        def list_project_location_pipeline_jobs(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
+          command = make_simple_command(:get, 'v1/{+parent}/jobs', options)
+          command.response_representation = Google::Apis::DatapipelinesV1::GoogleCloudDatapipelinesV1ListJobsResponse::Representation
+          command.response_class = Google::Apis::DatapipelinesV1::GoogleCloudDatapipelinesV1ListJobsResponse
+          command.params['parent'] = parent unless parent.nil?
+          command.query['pageSize'] = page_size unless page_size.nil?
+          command.query['pageToken'] = page_token unless page_token.nil?
+          command.query['fields'] = fields unless fields.nil?
+          command.query['quotaUser'] = quota_user unless quota_user.nil?
+          execute_or_queue_command(command, &block)
+        end
 
         protected
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: google-apis-datapipelines_v1
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Google LLC
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-11-15 00:00:00.000000000 Z
+date: 2022-04-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: google-apis-core
@@ -58,7 +58,7 @@ licenses:
 metadata:
   bug_tracker_uri: https://github.com/googleapis/google-api-ruby-client/issues
   changelog_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-datapipelines_v1/CHANGELOG.md
-  documentation_uri: https://googleapis.dev/ruby/google-apis-datapipelines_v1/v0.2.0
+  documentation_uri: https://googleapis.dev/ruby/google-apis-datapipelines_v1/v0.5.0
   source_code_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-datapipelines_v1
 post_install_message: 
 rdoc_options: []
@@ -75,7 +75,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.17
+rubygems_version: 3.3.5
 signing_key: 
 specification_version: 4
 summary: Simple REST client for Data pipelines API V1