google-apis-datapipelines_v1 0.11.0 → 0.12.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -50,103 +50,6 @@ module Google
50
50
  @batch_path = 'batch'
51
51
  end
52
52
 
53
- # Computes the schema for the transform. Computation from `raw_schema` will
54
- # always occur if it is set. This requires that the transform supports that
55
- # encoding. If no raw schema is provided and if the transform is for an IO, then
56
- # this will attempt to connect to the resource using the details provided in `
57
- # config` and infer the schema from that. If the transform is not an IO, is a
58
- # sink that doesn't exist yet, or is a sink with no schema requirement, then
59
- # this will fall back to basing the schema off the one provided in `
60
- # input_schemas`. The computed schema will be validated.
61
- # @param [String] location
62
- # Required. The full location formatted as "projects/`your-project`/locations/`
63
- # google-cloud-region`". If attempting to infer the schema from an existing
64
- # Google Cloud resource, the default Data Pipelines service account for this
65
- # project will be used in making requests for the resource. If the region given
66
- # for "`google-cloud-region`" is different than the region where the resource is
67
- # stored, then the data will be transferred to and processed in the region
68
- # specified here, but it will not be persistently stored in this region.
69
- # @param [Google::Apis::DatapipelinesV1::GoogleCloudDatapipelinesV1ComputeSchemaRequest] google_cloud_datapipelines_v1_compute_schema_request_object
70
- # @param [String] fields
71
- # Selector specifying which fields to include in a partial response.
72
- # @param [String] quota_user
73
- # Available to use for quota purposes for server-side applications. Can be any
74
- # arbitrary string assigned to a user, but should not exceed 40 characters.
75
- # @param [Google::Apis::RequestOptions] options
76
- # Request-specific options
77
- #
78
- # @yield [result, err] Result & error if block supplied
79
- # @yieldparam result [Google::Apis::DatapipelinesV1::GoogleCloudDatapipelinesV1Schema] parsed result object
80
- # @yieldparam err [StandardError] error object if request failed
81
- #
82
- # @return [Google::Apis::DatapipelinesV1::GoogleCloudDatapipelinesV1Schema]
83
- #
84
- # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
85
- # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
86
- # @raise [Google::Apis::AuthorizationError] Authorization is required
87
- def compute_project_location_schema(location, google_cloud_datapipelines_v1_compute_schema_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
88
- command = make_simple_command(:post, 'v1/{+location}:computeSchema', options)
89
- command.request_representation = Google::Apis::DatapipelinesV1::GoogleCloudDatapipelinesV1ComputeSchemaRequest::Representation
90
- command.request_object = google_cloud_datapipelines_v1_compute_schema_request_object
91
- command.response_representation = Google::Apis::DatapipelinesV1::GoogleCloudDatapipelinesV1Schema::Representation
92
- command.response_class = Google::Apis::DatapipelinesV1::GoogleCloudDatapipelinesV1Schema
93
- command.params['location'] = location unless location.nil?
94
- command.query['fields'] = fields unless fields.nil?
95
- command.query['quotaUser'] = quota_user unless quota_user.nil?
96
- execute_or_queue_command(command, &block)
97
- end
98
-
99
- # Lists pipelines. Returns a "FORBIDDEN" error if the caller doesn't have
100
- # permission to access it.
101
- # @param [String] parent
102
- # Required. The location name. For example: `projects/PROJECT_ID/locations/
103
- # LOCATION_ID`.
104
- # @param [String] filter
105
- # An expression for filtering the results of the request. If unspecified, all
106
- # pipelines will be returned. Multiple filters can be applied and must be comma
107
- # separated. Fields eligible for filtering are: + `type`: The type of the
108
- # pipeline (streaming or batch). Allowed values are `ALL`, `BATCH`, and `
109
- # STREAMING`. + `status`: The activity status of the pipeline. Allowed values
110
- # are `ALL`, `ACTIVE`, `ARCHIVED`, and `PAUSED`. For example, to limit results
111
- # to active batch processing pipelines: type:BATCH,status:ACTIVE
112
- # @param [Fixnum] page_size
113
- # The maximum number of entities to return. The service may return fewer than
114
- # this value, even if there are additional pages. If unspecified, the max limit
115
- # is yet to be determined by the backend implementation.
116
- # @param [String] page_token
117
- # A page token, received from a previous `ListPipelines` call. Provide this to
118
- # retrieve the subsequent page. When paginating, all other parameters provided
119
- # to `ListPipelines` must match the call that provided the page token.
120
- # @param [String] fields
121
- # Selector specifying which fields to include in a partial response.
122
- # @param [String] quota_user
123
- # Available to use for quota purposes for server-side applications. Can be any
124
- # arbitrary string assigned to a user, but should not exceed 40 characters.
125
- # @param [Google::Apis::RequestOptions] options
126
- # Request-specific options
127
- #
128
- # @yield [result, err] Result & error if block supplied
129
- # @yieldparam result [Google::Apis::DatapipelinesV1::GoogleCloudDatapipelinesV1ListPipelinesResponse] parsed result object
130
- # @yieldparam err [StandardError] error object if request failed
131
- #
132
- # @return [Google::Apis::DatapipelinesV1::GoogleCloudDatapipelinesV1ListPipelinesResponse]
133
- #
134
- # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
135
- # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
136
- # @raise [Google::Apis::AuthorizationError] Authorization is required
137
- def list_project_location_pipelines(parent, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
138
- command = make_simple_command(:get, 'v1/{+parent}', options)
139
- command.response_representation = Google::Apis::DatapipelinesV1::GoogleCloudDatapipelinesV1ListPipelinesResponse::Representation
140
- command.response_class = Google::Apis::DatapipelinesV1::GoogleCloudDatapipelinesV1ListPipelinesResponse
141
- command.params['parent'] = parent unless parent.nil?
142
- command.query['filter'] = filter unless filter.nil?
143
- command.query['pageSize'] = page_size unless page_size.nil?
144
- command.query['pageToken'] = page_token unless page_token.nil?
145
- command.query['fields'] = fields unless fields.nil?
146
- command.query['quotaUser'] = quota_user unless quota_user.nil?
147
- execute_or_queue_command(command, &block)
148
- end
149
-
150
53
  # Creates a pipeline. For a batch pipeline, you can pass scheduler information.
151
54
  # Data Pipelines uses the scheduler information to create an internal scheduler
152
55
  # that runs jobs periodically. If the internal scheduler is not configured, you
@@ -249,6 +152,57 @@ module Google
249
152
  execute_or_queue_command(command, &block)
250
153
  end
251
154
 
155
+ # Lists pipelines. Returns a "FORBIDDEN" error if the caller doesn't have
156
+ # permission to access it.
157
+ # @param [String] parent
158
+ # Required. The location name. For example: `projects/PROJECT_ID/locations/
159
+ # LOCATION_ID`.
160
+ # @param [String] filter
161
+ # An expression for filtering the results of the request. If unspecified, all
162
+ # pipelines will be returned. Multiple filters can be applied and must be comma
163
+ # separated. Fields eligible for filtering are: + `type`: The type of the
164
+ # pipeline (streaming or batch). Allowed values are `ALL`, `BATCH`, and `
165
+ # STREAMING`. + `status`: The activity status of the pipeline. Allowed values
166
+ # are `ALL`, `ACTIVE`, `ARCHIVED`, and `PAUSED`. For example, to limit results
167
+ # to active batch processing pipelines: type:BATCH,status:ACTIVE
168
+ # @param [Fixnum] page_size
169
+ # The maximum number of entities to return. The service may return fewer than
170
+ # this value, even if there are additional pages. If unspecified, the max limit
171
+ # is yet to be determined by the backend implementation.
172
+ # @param [String] page_token
173
+ # A page token, received from a previous `ListPipelines` call. Provide this to
174
+ # retrieve the subsequent page. When paginating, all other parameters provided
175
+ # to `ListPipelines` must match the call that provided the page token.
176
+ # @param [String] fields
177
+ # Selector specifying which fields to include in a partial response.
178
+ # @param [String] quota_user
179
+ # Available to use for quota purposes for server-side applications. Can be any
180
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
181
+ # @param [Google::Apis::RequestOptions] options
182
+ # Request-specific options
183
+ #
184
+ # @yield [result, err] Result & error if block supplied
185
+ # @yieldparam result [Google::Apis::DatapipelinesV1::GoogleCloudDatapipelinesV1ListPipelinesResponse] parsed result object
186
+ # @yieldparam err [StandardError] error object if request failed
187
+ #
188
+ # @return [Google::Apis::DatapipelinesV1::GoogleCloudDatapipelinesV1ListPipelinesResponse]
189
+ #
190
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
191
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
192
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
193
+ def list_project_location_pipelines(parent, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
194
+ command = make_simple_command(:get, 'v1/{+parent}/pipelines', options)
195
+ command.response_representation = Google::Apis::DatapipelinesV1::GoogleCloudDatapipelinesV1ListPipelinesResponse::Representation
196
+ command.response_class = Google::Apis::DatapipelinesV1::GoogleCloudDatapipelinesV1ListPipelinesResponse
197
+ command.params['parent'] = parent unless parent.nil?
198
+ command.query['filter'] = filter unless filter.nil?
199
+ command.query['pageSize'] = page_size unless page_size.nil?
200
+ command.query['pageToken'] = page_token unless page_token.nil?
201
+ command.query['fields'] = fields unless fields.nil?
202
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
203
+ execute_or_queue_command(command, &block)
204
+ end
205
+
252
206
  # Updates a pipeline. If successful, the updated Pipeline is returned. Returns `
253
207
  # NOT_FOUND` if the pipeline doesn't exist. If UpdatePipeline does not return
254
208
  # successfully, you can retry the UpdatePipeline request until you receive a
@@ -413,76 +367,6 @@ module Google
413
367
  command.query['quotaUser'] = quota_user unless quota_user.nil?
414
368
  execute_or_queue_command(command, &block)
415
369
  end
416
-
417
- # Gets transform descriptions in a batch, associated with a list of provided
418
- # uniform resource names.
419
- # @param [String] parent
420
- # Required. The project and location shared by all transform descriptions being
421
- # retrieved, formatted as "projects/`project`/locations/`location`".
422
- # @param [Array<String>, String] names
423
- # Optional. The names of the transform descriptions being retrieved, formatted
424
- # as "projects/`project`/locations/`location`/transformdescriptions/`
425
- # transform_description`". If no name is provided, all of the transform
426
- # descriptions will be returned.
427
- # @param [String] fields
428
- # Selector specifying which fields to include in a partial response.
429
- # @param [String] quota_user
430
- # Available to use for quota purposes for server-side applications. Can be any
431
- # arbitrary string assigned to a user, but should not exceed 40 characters.
432
- # @param [Google::Apis::RequestOptions] options
433
- # Request-specific options
434
- #
435
- # @yield [result, err] Result & error if block supplied
436
- # @yieldparam result [Google::Apis::DatapipelinesV1::GoogleCloudDatapipelinesV1BatchGetTransformDescriptionsResponse] parsed result object
437
- # @yieldparam err [StandardError] error object if request failed
438
- #
439
- # @return [Google::Apis::DatapipelinesV1::GoogleCloudDatapipelinesV1BatchGetTransformDescriptionsResponse]
440
- #
441
- # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
442
- # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
443
- # @raise [Google::Apis::AuthorizationError] Authorization is required
444
- def batch_project_location_transform_description_get(parent, names: nil, fields: nil, quota_user: nil, options: nil, &block)
445
- command = make_simple_command(:get, 'v1/{+parent}/transformDescriptions:batchGet', options)
446
- command.response_representation = Google::Apis::DatapipelinesV1::GoogleCloudDatapipelinesV1BatchGetTransformDescriptionsResponse::Representation
447
- command.response_class = Google::Apis::DatapipelinesV1::GoogleCloudDatapipelinesV1BatchGetTransformDescriptionsResponse
448
- command.params['parent'] = parent unless parent.nil?
449
- command.query['names'] = names unless names.nil?
450
- command.query['fields'] = fields unless fields.nil?
451
- command.query['quotaUser'] = quota_user unless quota_user.nil?
452
- execute_or_queue_command(command, &block)
453
- end
454
-
455
- # Gets the transform description associated with the provided uniform resource
456
- # name.
457
- # @param [String] name
458
- # Required. The full name formatted as "projects/`your-project`/locations/`
459
- # google-cloud-region`/transformdescriptions/`uniform-resource-name`".
460
- # @param [String] fields
461
- # Selector specifying which fields to include in a partial response.
462
- # @param [String] quota_user
463
- # Available to use for quota purposes for server-side applications. Can be any
464
- # arbitrary string assigned to a user, but should not exceed 40 characters.
465
- # @param [Google::Apis::RequestOptions] options
466
- # Request-specific options
467
- #
468
- # @yield [result, err] Result & error if block supplied
469
- # @yieldparam result [Google::Apis::DatapipelinesV1::GoogleCloudDatapipelinesV1TransformDescription] parsed result object
470
- # @yieldparam err [StandardError] error object if request failed
471
- #
472
- # @return [Google::Apis::DatapipelinesV1::GoogleCloudDatapipelinesV1TransformDescription]
473
- #
474
- # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
475
- # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
476
- # @raise [Google::Apis::AuthorizationError] Authorization is required
477
- def get_project_location_transform_description(name, fields: nil, quota_user: nil, options: nil, &block)
478
- command = make_simple_command(:get, 'v1/{+name}', options)
479
- command.response_representation = Google::Apis::DatapipelinesV1::GoogleCloudDatapipelinesV1TransformDescription::Representation
480
- command.response_class = Google::Apis::DatapipelinesV1::GoogleCloudDatapipelinesV1TransformDescription
481
- command.params['name'] = name unless name.nil?
482
- command.query['fields'] = fields unless fields.nil?
483
- command.query['quotaUser'] = quota_user unless quota_user.nil?
484
- execute_or_queue_command(command, &block)
485
- end
486
370
 
487
371
  protected
488
372
 
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: google-apis-datapipelines_v1
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.11.0
4
+ version: 0.12.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - Google LLC
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2022-12-12 00:00:00.000000000 Z
11
+ date: 2023-01-04 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: google-apis-core
@@ -58,7 +58,7 @@ licenses:
58
58
  metadata:
59
59
  bug_tracker_uri: https://github.com/googleapis/google-api-ruby-client/issues
60
60
  changelog_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-datapipelines_v1/CHANGELOG.md
61
- documentation_uri: https://googleapis.dev/ruby/google-apis-datapipelines_v1/v0.11.0
61
+ documentation_uri: https://googleapis.dev/ruby/google-apis-datapipelines_v1/v0.12.0
62
62
  source_code_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-datapipelines_v1
63
63
  post_install_message:
64
64
  rdoc_options: []