google-cloud-notebooks-v1 0.10.0 → 1.0.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.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 947a3e792468868bcac7bc6184e06a1649959a1ecd82ea010295e928ee7122c5
4
- data.tar.gz: 5add96fb707c1443850c86082896f8c0bca9653f285aac6a50c37fe59a45e68f
3
+ metadata.gz: 915729e5939bc27e9e7f46f19389550964ad8bdb8f3567fbcd29d3fe6671c3c5
4
+ data.tar.gz: 7a5667c358551d4be9d6d6bed80347cb98e207b35ec800e84189557589fb323e
5
5
  SHA512:
6
- metadata.gz: 3653e88c9870c00d5587e5b7884cff615abbae175ea0e119d02d293be56bb1f9d1b8a749c44fd9268ce24e1f735b4ee1df480e5ff6bb1bd2d84c2475dc115040
7
- data.tar.gz: 9278ebfba33f0286ba7b52c7447bb38c9ac42b312eadfc7890a5d956794fba75012ded58a7e9e5d5bc3e98c02fa91c55f36981946fed7fd51a7e9a3bb1a52495
6
+ metadata.gz: 0c2b6f8fa0d8d26e688ec3c0103e853a1ac1386ce6263692d0cc02140e72f72a76b6ad4b99246fd84f35e05214b1df2447aaf8b41e8198b11155bc95fe8628b1
7
+ data.tar.gz: 5edb9cb6201a4fdeefd75d88a070acc776df805380bada3d5ea0c37c19224069a1843df50e44723b05e3de9f06f7c2d5ca5f13ba8f0a247d9b4c73274257d0ef
data/README.md CHANGED
@@ -86,7 +86,7 @@ To browse ready to use code samples check [Google Cloud Samples](https://cloud.g
86
86
 
87
87
  ## Supported Ruby Versions
88
88
 
89
- This library is supported on Ruby 2.7+.
89
+ This library is supported on Ruby 3.0+.
90
90
 
91
91
  Google provides official support for Ruby versions that are actively supported
92
92
  by Ruby Core—that is, Ruby versions that are either in normal maintenance or
@@ -1584,6 +1584,13 @@ module Google
1584
1584
  # * (`GRPC::Core::Channel`) a gRPC channel with included credentials
1585
1585
  # * (`GRPC::Core::ChannelCredentials`) a gRPC credentails object
1586
1586
  # * (`nil`) indicating no credentials
1587
+ #
1588
+ # Warning: If you accept a credential configuration (JSON file or Hash) from an
1589
+ # external source for authentication to Google Cloud, you must validate it before
1590
+ # providing it to a Google API client library. Providing an unvalidated credential
1591
+ # configuration to Google APIs can compromise the security of your systems and data.
1592
+ # For more information, refer to [Validate credential configurations from external
1593
+ # sources](https://cloud.google.com/docs/authentication/external/externally-sourced-credentials).
1587
1594
  # @return [::Object]
1588
1595
  # @!attribute [rw] scope
1589
1596
  # The OAuth scopes
@@ -640,6 +640,13 @@ module Google
640
640
  # * (`GRPC::Core::Channel`) a gRPC channel with included credentials
641
641
  # * (`GRPC::Core::ChannelCredentials`) a gRPC credentails object
642
642
  # * (`nil`) indicating no credentials
643
+ #
644
+ # Warning: If you accept a credential configuration (JSON file or Hash) from an
645
+ # external source for authentication to Google Cloud, you must validate it before
646
+ # providing it to a Google API client library. Providing an unvalidated credential
647
+ # configuration to Google APIs can compromise the security of your systems and data.
648
+ # For more information, refer to [Validate credential configurations from external
649
+ # sources](https://cloud.google.com/docs/authentication/external/externally-sourced-credentials).
643
650
  # @return [::Object]
644
651
  # @!attribute [rw] scope
645
652
  # The OAuth scopes
@@ -276,10 +276,10 @@ module Google
276
276
  # A previous returned page token that can be used to continue listing
277
277
  # from the last result.
278
278
  # @yield [result, operation] Access the result along with the TransportOperation object
279
- # @yieldparam result [::Google::Cloud::Notebooks::V1::ListRuntimesResponse]
279
+ # @yieldparam result [::Gapic::Rest::PagedEnumerable<::Google::Cloud::Notebooks::V1::Runtime>]
280
280
  # @yieldparam operation [::Gapic::Rest::TransportOperation]
281
281
  #
282
- # @return [::Google::Cloud::Notebooks::V1::ListRuntimesResponse]
282
+ # @return [::Gapic::Rest::PagedEnumerable<::Google::Cloud::Notebooks::V1::Runtime>]
283
283
  #
284
284
  # @raise [::Google::Cloud::Error] if the REST call is aborted.
285
285
  #
@@ -331,7 +331,9 @@ module Google
331
331
  retry_policy: @config.retry_policy
332
332
 
333
333
  @managed_notebook_service_stub.list_runtimes request, options do |result, operation|
334
+ result = ::Gapic::Rest::PagedEnumerable.new @managed_notebook_service_stub, :list_runtimes, "runtimes", request, result, options
334
335
  yield result, operation if block_given?
336
+ throw :response, result
335
337
  end
336
338
  rescue ::Gapic::Rest::Error => e
337
339
  raise ::Google::Cloud::Error.from_error(e)
@@ -1484,6 +1486,13 @@ module Google
1484
1486
  # * (`Signet::OAuth2::Client`) A signet oauth2 client object
1485
1487
  # (see the [signet docs](https://rubydoc.info/gems/signet/Signet/OAuth2/Client))
1486
1488
  # * (`nil`) indicating no credentials
1489
+ #
1490
+ # Warning: If you accept a credential configuration (JSON file or Hash) from an
1491
+ # external source for authentication to Google Cloud, you must validate it before
1492
+ # providing it to a Google API client library. Providing an unvalidated credential
1493
+ # configuration to Google APIs can compromise the security of your systems and data.
1494
+ # For more information, refer to [Validate credential configurations from external
1495
+ # sources](https://cloud.google.com/docs/authentication/external/externally-sourced-credentials).
1487
1496
  # @return [::Object]
1488
1497
  # @!attribute [rw] scope
1489
1498
  # The OAuth scopes
@@ -502,6 +502,13 @@ module Google
502
502
  # * (`Signet::OAuth2::Client`) A signet oauth2 client object
503
503
  # (see the [signet docs](https://rubydoc.info/gems/signet/Signet/OAuth2/Client))
504
504
  # * (`nil`) indicating no credentials
505
+ #
506
+ # Warning: If you accept a credential configuration (JSON file or Hash) from an
507
+ # external source for authentication to Google Cloud, you must validate it before
508
+ # providing it to a Google API client library. Providing an unvalidated credential
509
+ # configuration to Google APIs can compromise the security of your systems and data.
510
+ # For more information, refer to [Validate credential configurations from external
511
+ # sources](https://cloud.google.com/docs/authentication/external/externally-sourced-credentials).
505
512
  # @return [::Object]
506
513
  # @!attribute [rw] scope
507
514
  # The OAuth scopes
@@ -3598,6 +3598,13 @@ module Google
3598
3598
  # * (`GRPC::Core::Channel`) a gRPC channel with included credentials
3599
3599
  # * (`GRPC::Core::ChannelCredentials`) a gRPC credentails object
3600
3600
  # * (`nil`) indicating no credentials
3601
+ #
3602
+ # Warning: If you accept a credential configuration (JSON file or Hash) from an
3603
+ # external source for authentication to Google Cloud, you must validate it before
3604
+ # providing it to a Google API client library. Providing an unvalidated credential
3605
+ # configuration to Google APIs can compromise the security of your systems and data.
3606
+ # For more information, refer to [Validate credential configurations from external
3607
+ # sources](https://cloud.google.com/docs/authentication/external/externally-sourced-credentials).
3601
3608
  # @return [::Object]
3602
3609
  # @!attribute [rw] scope
3603
3610
  # The OAuth scopes
@@ -640,6 +640,13 @@ module Google
640
640
  # * (`GRPC::Core::Channel`) a gRPC channel with included credentials
641
641
  # * (`GRPC::Core::ChannelCredentials`) a gRPC credentails object
642
642
  # * (`nil`) indicating no credentials
643
+ #
644
+ # Warning: If you accept a credential configuration (JSON file or Hash) from an
645
+ # external source for authentication to Google Cloud, you must validate it before
646
+ # providing it to a Google API client library. Providing an unvalidated credential
647
+ # configuration to Google APIs can compromise the security of your systems and data.
648
+ # For more information, refer to [Validate credential configurations from external
649
+ # sources](https://cloud.google.com/docs/authentication/external/externally-sourced-credentials).
643
650
  # @return [::Object]
644
651
  # @!attribute [rw] scope
645
652
  # The OAuth scopes
@@ -320,10 +320,10 @@ module Google
320
320
  # A previous returned page token that can be used to continue listing
321
321
  # from the last result.
322
322
  # @yield [result, operation] Access the result along with the TransportOperation object
323
- # @yieldparam result [::Google::Cloud::Notebooks::V1::ListInstancesResponse]
323
+ # @yieldparam result [::Gapic::Rest::PagedEnumerable<::Google::Cloud::Notebooks::V1::Instance>]
324
324
  # @yieldparam operation [::Gapic::Rest::TransportOperation]
325
325
  #
326
- # @return [::Google::Cloud::Notebooks::V1::ListInstancesResponse]
326
+ # @return [::Gapic::Rest::PagedEnumerable<::Google::Cloud::Notebooks::V1::Instance>]
327
327
  #
328
328
  # @raise [::Google::Cloud::Error] if the REST call is aborted.
329
329
  #
@@ -375,7 +375,9 @@ module Google
375
375
  retry_policy: @config.retry_policy
376
376
 
377
377
  @notebook_service_stub.list_instances request, options do |result, operation|
378
+ result = ::Gapic::Rest::PagedEnumerable.new @notebook_service_stub, :list_instances, "instances", request, result, options
378
379
  yield result, operation if block_given?
380
+ throw :response, result
379
381
  end
380
382
  rescue ::Gapic::Rest::Error => e
381
383
  raise ::Google::Cloud::Error.from_error(e)
@@ -2189,10 +2191,10 @@ module Google
2189
2191
  # A previous returned page token that can be used to continue listing from
2190
2192
  # the last result.
2191
2193
  # @yield [result, operation] Access the result along with the TransportOperation object
2192
- # @yieldparam result [::Google::Cloud::Notebooks::V1::ListEnvironmentsResponse]
2194
+ # @yieldparam result [::Gapic::Rest::PagedEnumerable<::Google::Cloud::Notebooks::V1::Environment>]
2193
2195
  # @yieldparam operation [::Gapic::Rest::TransportOperation]
2194
2196
  #
2195
- # @return [::Google::Cloud::Notebooks::V1::ListEnvironmentsResponse]
2197
+ # @return [::Gapic::Rest::PagedEnumerable<::Google::Cloud::Notebooks::V1::Environment>]
2196
2198
  #
2197
2199
  # @raise [::Google::Cloud::Error] if the REST call is aborted.
2198
2200
  #
@@ -2244,7 +2246,9 @@ module Google
2244
2246
  retry_policy: @config.retry_policy
2245
2247
 
2246
2248
  @notebook_service_stub.list_environments request, options do |result, operation|
2249
+ result = ::Gapic::Rest::PagedEnumerable.new @notebook_service_stub, :list_environments, "environments", request, result, options
2247
2250
  yield result, operation if block_given?
2251
+ throw :response, result
2248
2252
  end
2249
2253
  rescue ::Gapic::Rest::Error => e
2250
2254
  raise ::Google::Cloud::Error.from_error(e)
@@ -2542,10 +2546,10 @@ module Google
2542
2546
  # @param order_by [::String]
2543
2547
  # Field to order results by.
2544
2548
  # @yield [result, operation] Access the result along with the TransportOperation object
2545
- # @yieldparam result [::Google::Cloud::Notebooks::V1::ListSchedulesResponse]
2549
+ # @yieldparam result [::Gapic::Rest::PagedEnumerable<::Google::Cloud::Notebooks::V1::Schedule>]
2546
2550
  # @yieldparam operation [::Gapic::Rest::TransportOperation]
2547
2551
  #
2548
- # @return [::Google::Cloud::Notebooks::V1::ListSchedulesResponse]
2552
+ # @return [::Gapic::Rest::PagedEnumerable<::Google::Cloud::Notebooks::V1::Schedule>]
2549
2553
  #
2550
2554
  # @raise [::Google::Cloud::Error] if the REST call is aborted.
2551
2555
  #
@@ -2597,7 +2601,9 @@ module Google
2597
2601
  retry_policy: @config.retry_policy
2598
2602
 
2599
2603
  @notebook_service_stub.list_schedules request, options do |result, operation|
2604
+ result = ::Gapic::Rest::PagedEnumerable.new @notebook_service_stub, :list_schedules, "schedules", request, result, options
2600
2605
  yield result, operation if block_given?
2606
+ throw :response, result
2601
2607
  end
2602
2608
  rescue ::Gapic::Rest::Error => e
2603
2609
  raise ::Google::Cloud::Error.from_error(e)
@@ -2983,10 +2989,10 @@ module Google
2983
2989
  # @param order_by [::String]
2984
2990
  # Sort by field.
2985
2991
  # @yield [result, operation] Access the result along with the TransportOperation object
2986
- # @yieldparam result [::Google::Cloud::Notebooks::V1::ListExecutionsResponse]
2992
+ # @yieldparam result [::Gapic::Rest::PagedEnumerable<::Google::Cloud::Notebooks::V1::Execution>]
2987
2993
  # @yieldparam operation [::Gapic::Rest::TransportOperation]
2988
2994
  #
2989
- # @return [::Google::Cloud::Notebooks::V1::ListExecutionsResponse]
2995
+ # @return [::Gapic::Rest::PagedEnumerable<::Google::Cloud::Notebooks::V1::Execution>]
2990
2996
  #
2991
2997
  # @raise [::Google::Cloud::Error] if the REST call is aborted.
2992
2998
  #
@@ -3038,7 +3044,9 @@ module Google
3038
3044
  retry_policy: @config.retry_policy
3039
3045
 
3040
3046
  @notebook_service_stub.list_executions request, options do |result, operation|
3047
+ result = ::Gapic::Rest::PagedEnumerable.new @notebook_service_stub, :list_executions, "executions", request, result, options
3041
3048
  yield result, operation if block_given?
3049
+ throw :response, result
3042
3050
  end
3043
3051
  rescue ::Gapic::Rest::Error => e
3044
3052
  raise ::Google::Cloud::Error.from_error(e)
@@ -3345,6 +3353,13 @@ module Google
3345
3353
  # * (`Signet::OAuth2::Client`) A signet oauth2 client object
3346
3354
  # (see the [signet docs](https://rubydoc.info/gems/signet/Signet/OAuth2/Client))
3347
3355
  # * (`nil`) indicating no credentials
3356
+ #
3357
+ # Warning: If you accept a credential configuration (JSON file or Hash) from an
3358
+ # external source for authentication to Google Cloud, you must validate it before
3359
+ # providing it to a Google API client library. Providing an unvalidated credential
3360
+ # configuration to Google APIs can compromise the security of your systems and data.
3361
+ # For more information, refer to [Validate credential configurations from external
3362
+ # sources](https://cloud.google.com/docs/authentication/external/externally-sourced-credentials).
3348
3363
  # @return [::Object]
3349
3364
  # @!attribute [rw] scope
3350
3365
  # The OAuth scopes
@@ -502,6 +502,13 @@ module Google
502
502
  # * (`Signet::OAuth2::Client`) A signet oauth2 client object
503
503
  # (see the [signet docs](https://rubydoc.info/gems/signet/Signet/OAuth2/Client))
504
504
  # * (`nil`) indicating no credentials
505
+ #
506
+ # Warning: If you accept a credential configuration (JSON file or Hash) from an
507
+ # external source for authentication to Google Cloud, you must validate it before
508
+ # providing it to a Google API client library. Providing an unvalidated credential
509
+ # configuration to Google APIs can compromise the security of your systems and data.
510
+ # For more information, refer to [Validate credential configurations from external
511
+ # sources](https://cloud.google.com/docs/authentication/external/externally-sourced-credentials).
505
512
  # @return [::Object]
506
513
  # @!attribute [rw] scope
507
514
  # The OAuth scopes
@@ -21,7 +21,7 @@ module Google
21
21
  module Cloud
22
22
  module Notebooks
23
23
  module V1
24
- VERSION = "0.10.0"
24
+ VERSION = "1.0.0"
25
25
  end
26
26
  end
27
27
  end
@@ -409,6 +409,14 @@ module Google
409
409
  # @return [::Array<::String>]
410
410
  # An allowlist of the fully qualified names of RPCs that should be included
411
411
  # on public client surfaces.
412
+ # @!attribute [rw] generate_omitted_as_internal
413
+ # @return [::Boolean]
414
+ # Setting this to true indicates to the client generators that methods
415
+ # that would be excluded from the generation should instead be generated
416
+ # in a way that indicates these methods should not be consumed by
417
+ # end users. How this is expressed is up to individual language
418
+ # implementations to decide. Some examples may be: added annotations,
419
+ # obfuscated identifiers, or other language idiomatic patterns.
412
420
  class SelectiveGapicGeneration
413
421
  include ::Google::Protobuf::MessageExts
414
422
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -37,9 +37,13 @@ module Google
37
37
  # @!attribute [rw] vm_image
38
38
  # @return [::Google::Cloud::Notebooks::V1::VmImage]
39
39
  # Use a Compute Engine VM image to start the notebook instance.
40
+ #
41
+ # Note: The following fields are mutually exclusive: `vm_image`, `container_image`. If a field in that set is populated, all other fields in the set will automatically be cleared.
40
42
  # @!attribute [rw] container_image
41
43
  # @return [::Google::Cloud::Notebooks::V1::ContainerImage]
42
44
  # Use a container image to start the notebook instance.
45
+ #
46
+ # Note: The following fields are mutually exclusive: `container_image`, `vm_image`. If a field in that set is populated, all other fields in the set will automatically be cleared.
43
47
  # @!attribute [rw] post_startup_script
44
48
  # @return [::String]
45
49
  # Path to a Bash script that automatically runs after a notebook instance
@@ -62,10 +66,14 @@ module Google
62
66
  # @!attribute [rw] image_name
63
67
  # @return [::String]
64
68
  # Use VM image name to find the image.
69
+ #
70
+ # Note: The following fields are mutually exclusive: `image_name`, `image_family`. If a field in that set is populated, all other fields in the set will automatically be cleared.
65
71
  # @!attribute [rw] image_family
66
72
  # @return [::String]
67
73
  # Use this VM image family to find the image; the newest image in this
68
74
  # family will be used.
75
+ #
76
+ # Note: The following fields are mutually exclusive: `image_family`, `image_name`. If a field in that set is populated, all other fields in the set will automatically be cleared.
69
77
  class VmImage
70
78
  include ::Google::Protobuf::MessageExts
71
79
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -127,9 +127,13 @@ module Google
127
127
  # @!attribute [rw] dataproc_parameters
128
128
  # @return [::Google::Cloud::Notebooks::V1::ExecutionTemplate::DataprocParameters]
129
129
  # Parameters used in Dataproc JobType executions.
130
+ #
131
+ # Note: The following fields are mutually exclusive: `dataproc_parameters`, `vertex_ai_parameters`. If a field in that set is populated, all other fields in the set will automatically be cleared.
130
132
  # @!attribute [rw] vertex_ai_parameters
131
133
  # @return [::Google::Cloud::Notebooks::V1::ExecutionTemplate::VertexAIParameters]
132
134
  # Parameters used in Vertex AI JobType executions.
135
+ #
136
+ # Note: The following fields are mutually exclusive: `vertex_ai_parameters`, `dataproc_parameters`. If a field in that set is populated, all other fields in the set will automatically be cleared.
133
137
  # @!attribute [rw] kernel_spec
134
138
  # @return [::String]
135
139
  # Name of the kernel spec to use. This must be specified if the
@@ -60,9 +60,13 @@ module Google
60
60
  # @!attribute [rw] vm_image
61
61
  # @return [::Google::Cloud::Notebooks::V1::VmImage]
62
62
  # Use a Compute Engine VM image to start the notebook instance.
63
+ #
64
+ # Note: The following fields are mutually exclusive: `vm_image`, `container_image`. If a field in that set is populated, all other fields in the set will automatically be cleared.
63
65
  # @!attribute [rw] container_image
64
66
  # @return [::Google::Cloud::Notebooks::V1::ContainerImage]
65
67
  # Use a container image to start the notebook instance.
68
+ #
69
+ # Note: The following fields are mutually exclusive: `container_image`, `vm_image`. If a field in that set is populated, all other fields in the set will automatically be cleared.
66
70
  # @!attribute [rw] post_startup_script
67
71
  # @return [::String]
68
72
  # Path to a Bash script that automatically runs after a notebook instance
@@ -40,6 +40,8 @@ module Google
40
40
  # @!attribute [rw] error
41
41
  # @return [::Google::Rpc::Status]
42
42
  # The error result of the operation in case of failure or cancellation.
43
+ #
44
+ # Note: The following fields are mutually exclusive: `error`, `response`. If a field in that set is populated, all other fields in the set will automatically be cleared.
43
45
  # @!attribute [rw] response
44
46
  # @return [::Google::Protobuf::Any]
45
47
  # The normal, successful response of the operation. If the original
@@ -50,6 +52,8 @@ module Google
50
52
  # is the original method name. For example, if the original method name
51
53
  # is `TakeSnapshot()`, the inferred response type is
52
54
  # `TakeSnapshotResponse`.
55
+ #
56
+ # Note: The following fields are mutually exclusive: `response`, `error`. If a field in that set is populated, all other fields in the set will automatically be cleared.
53
57
  class Operation
54
58
  include ::Google::Protobuf::MessageExts
55
59
  extend ::Google::Protobuf::MessageExts::ClassMethods
metadata CHANGED
@@ -1,14 +1,13 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: google-cloud-notebooks-v1
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.10.0
4
+ version: 1.0.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - Google LLC
8
- autorequire:
9
8
  bindir: bin
10
9
  cert_chain: []
11
- date: 2024-12-10 00:00:00.000000000 Z
10
+ date: 2025-02-07 00:00:00.000000000 Z
12
11
  dependencies:
13
12
  - !ruby/object:Gem::Dependency
14
13
  name: gapic-common
@@ -16,7 +15,7 @@ dependencies:
16
15
  requirements:
17
16
  - - ">="
18
17
  - !ruby/object:Gem::Version
19
- version: 0.24.0
18
+ version: 0.25.0
20
19
  - - "<"
21
20
  - !ruby/object:Gem::Version
22
21
  version: 2.a
@@ -26,7 +25,7 @@ dependencies:
26
25
  requirements:
27
26
  - - ">="
28
27
  - !ruby/object:Gem::Version
29
- version: 0.24.0
28
+ version: 0.25.0
30
29
  - - "<"
31
30
  - !ruby/object:Gem::Version
32
31
  version: 2.a
@@ -161,7 +160,6 @@ homepage: https://github.com/googleapis/google-cloud-ruby
161
160
  licenses:
162
161
  - Apache-2.0
163
162
  metadata: {}
164
- post_install_message:
165
163
  rdoc_options: []
166
164
  require_paths:
167
165
  - lib
@@ -169,15 +167,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
169
167
  requirements:
170
168
  - - ">="
171
169
  - !ruby/object:Gem::Version
172
- version: '2.7'
170
+ version: '3.0'
173
171
  required_rubygems_version: !ruby/object:Gem::Requirement
174
172
  requirements:
175
173
  - - ">="
176
174
  - !ruby/object:Gem::Version
177
175
  version: '0'
178
176
  requirements: []
179
- rubygems_version: 3.5.23
180
- signing_key:
177
+ rubygems_version: 3.6.3
181
178
  specification_version: 4
182
179
  summary: Notebooks API is used to manage notebook resources in Google Cloud.
183
180
  test_files: []