google-cloud-notebooks-v1beta1 0.1.0 → 0.2.0

Sign up to get free protection for your applications and to get access to all the features.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 5d80aff91f67c23bc276fc9d6a406293101884885804ffbc1de91a4a7a115383
4
- data.tar.gz: 53cc3c89b4911a405f0d05d720bd0444caae557e77179f9b36f6c47bf4dc7590
3
+ metadata.gz: addee86b6c86dcdbcf96fbf5a28b065282f4ad7de0c9a9e6d53f1c901b504ca4
4
+ data.tar.gz: 0d4fd8ad8562f3c37772b62e2d25860cab70239169c0d3649d81e284152cacf2
5
5
  SHA512:
6
- metadata.gz: 2a4d6d33e766791d3a8974f8b2545b432ca94a5ebfefc87b063998394eb2002b8628ac0769c7f828219d6c02f43fb89e668cf01071ed0dc5cd603344a051fd74
7
- data.tar.gz: c66b193f90a67f24fab86e30348f7474868606ffef5ff49452615e88643c8c5dd598f947ce80a217c181e9499ddc02d72e1b48d04a399855d44b827d3135e3c9
6
+ metadata.gz: 5d64b4fd3fd2832e61a2674fa2afbf6c090fa27290a3f4ca6dc13c84d62312f509f814f19c7ecd59ead93d2f660428787828c8a71ad2b1bf9edc0ec96017f1d6
7
+ data.tar.gz: 83a242287dfb5f77475c46ac3508afe0c4ee1a6da9a8d10852cfdae1224c0686d8537b5dc10ed687e9c6f28dac3c892bde4de033297242fc5c7ccf7d3a1f26f5
data/.yardopts CHANGED
@@ -1,5 +1,5 @@
1
1
  --no-private
2
- --title=AI Platform Notebooks V1 API
2
+ --title=AI Platform Notebooks V1beta1 API
3
3
  --exclude _pb\.rb$
4
4
  --markup markdown
5
5
  --markup-provider redcarpet
data/README.md CHANGED
@@ -1,6 +1,6 @@
1
- # Ruby Client for the AI Platform Notebooks V1 API
1
+ # Ruby Client for the AI Platform Notebooks V1beta1 API
2
2
 
3
- API Client library for the AI Platform Notebooks V1 API
3
+ API Client library for the AI Platform Notebooks V1beta1 API
4
4
 
5
5
  AI Platform Notebooks makes it easy to manage JupyterLab instances through a protected, publicly available notebook instance URL. A JupyterLab instance is a Deep Learning virtual machine instance with the latest machine learning and data science libraries pre-installed.
6
6
 
@@ -66,11 +66,15 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
66
66
  value :STOPPING, 4
67
67
  value :STOPPED, 5
68
68
  value :DELETED, 6
69
+ value :UPGRADING, 7
70
+ value :INITIALIZING, 8
71
+ value :REGISTERING, 9
69
72
  end
70
73
  add_enum "google.cloud.notebooks.v1beta1.Instance.DiskType" do
71
74
  value :DISK_TYPE_UNSPECIFIED, 0
72
75
  value :PD_STANDARD, 1
73
76
  value :PD_SSD, 2
77
+ value :PD_BALANCED, 3
74
78
  end
75
79
  add_enum "google.cloud.notebooks.v1beta1.Instance.DiskEncryption" do
76
80
  value :DISK_ENCRYPTION_UNSPECIFIED, 0
@@ -32,7 +32,7 @@ module Google
32
32
  module Notebooks
33
33
  module V1beta1
34
34
  ##
35
- # API service for Cloud AI Platform Notebooks.
35
+ # API v1beta1 service for Cloud AI Platform Notebooks.
36
36
  #
37
37
  # To load this service and instantiate a client:
38
38
  #
@@ -27,7 +27,7 @@ module Google
27
27
  ##
28
28
  # Client for the NotebookService service.
29
29
  #
30
- # API service for Cloud AI Platform Notebooks.
30
+ # API v1beta1 service for Cloud AI Platform Notebooks.
31
31
  #
32
32
  class Client
33
33
  include Paths
@@ -516,8 +516,8 @@ module Google
516
516
  # @param core_count [::Integer]
517
517
  # Required. Count of cores of this accelerator. Note that not all combinations
518
518
  # of `type` and `core_count` are valid. Check [GPUs on
519
- # Compute Engine](/compute/docs/gpus/#gpus-list) to find a valid
520
- # combination. TPUs are not supported.
519
+ # Compute Engine](https://cloud.google.com/compute/docs/gpus/#gpus-list) to
520
+ # find a valid combination. TPUs are not supported.
521
521
  #
522
522
  # @yield [response, operation] Access the result along with the RPC operation
523
523
  # @yieldparam response [::Gapic::Operation]
@@ -587,7 +587,8 @@ module Google
587
587
  # Required. Format:
588
588
  # `projects/{project_id}/locations/{location}/instances/{instance_id}`
589
589
  # @param machine_type [::String]
590
- # Required. The [Compute Engine machine type](/compute/docs/machine-types).
590
+ # Required. The [Compute Engine machine
591
+ # type](https://cloud.google.com/compute/docs/machine-types).
591
592
  #
592
593
  # @yield [response, operation] Access the result along with the RPC operation
593
594
  # @yieldparam response [::Gapic::Operation]
@@ -20,6 +20,7 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
20
20
  optional :status_message, :string, 5
21
21
  optional :requested_cancellation, :bool, 6
22
22
  optional :api_version, :string, 7
23
+ optional :endpoint, :string, 8
23
24
  end
24
25
  add_message "google.cloud.notebooks.v1beta1.ListInstancesRequest" do
25
26
  optional :parent, :string, 1
@@ -79,6 +80,7 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
79
80
  add_message "google.cloud.notebooks.v1beta1.IsInstanceUpgradeableResponse" do
80
81
  optional :upgradeable, :bool, 1
81
82
  optional :upgrade_version, :string, 2
83
+ optional :upgrade_info, :string, 3
82
84
  end
83
85
  add_message "google.cloud.notebooks.v1beta1.UpgradeInstanceRequest" do
84
86
  optional :name, :string, 1
@@ -24,7 +24,7 @@ module Google
24
24
  module Notebooks
25
25
  module V1beta1
26
26
  module NotebookService
27
- # API service for Cloud AI Platform Notebooks.
27
+ # API v1beta1 service for Cloud AI Platform Notebooks.
28
28
  class Service
29
29
 
30
30
  include GRPC::GenericService
@@ -34,50 +34,50 @@ module Google
34
34
  self.service_name = 'google.cloud.notebooks.v1beta1.NotebookService'
35
35
 
36
36
  # Lists instances in a given project and location.
37
- rpc :ListInstances, Google::Cloud::Notebooks::V1beta1::ListInstancesRequest, Google::Cloud::Notebooks::V1beta1::ListInstancesResponse
37
+ rpc :ListInstances, ::Google::Cloud::Notebooks::V1beta1::ListInstancesRequest, ::Google::Cloud::Notebooks::V1beta1::ListInstancesResponse
38
38
  # Gets details of a single Instance.
39
- rpc :GetInstance, Google::Cloud::Notebooks::V1beta1::GetInstanceRequest, Google::Cloud::Notebooks::V1beta1::Instance
39
+ rpc :GetInstance, ::Google::Cloud::Notebooks::V1beta1::GetInstanceRequest, ::Google::Cloud::Notebooks::V1beta1::Instance
40
40
  # Creates a new Instance in a given project and location.
41
- rpc :CreateInstance, Google::Cloud::Notebooks::V1beta1::CreateInstanceRequest, Google::Longrunning::Operation
41
+ rpc :CreateInstance, ::Google::Cloud::Notebooks::V1beta1::CreateInstanceRequest, ::Google::Longrunning::Operation
42
42
  # Registers an existing legacy notebook instance to the Notebooks API server.
43
43
  # Legacy instances are instances created with the legacy Compute Engine
44
44
  # calls. They are not manageable by the Notebooks API out of the box. This
45
45
  # call makes these instances manageable by the Notebooks API.
46
- rpc :RegisterInstance, Google::Cloud::Notebooks::V1beta1::RegisterInstanceRequest, Google::Longrunning::Operation
46
+ rpc :RegisterInstance, ::Google::Cloud::Notebooks::V1beta1::RegisterInstanceRequest, ::Google::Longrunning::Operation
47
47
  # Updates the guest accelerators of a single Instance.
48
- rpc :SetInstanceAccelerator, Google::Cloud::Notebooks::V1beta1::SetInstanceAcceleratorRequest, Google::Longrunning::Operation
48
+ rpc :SetInstanceAccelerator, ::Google::Cloud::Notebooks::V1beta1::SetInstanceAcceleratorRequest, ::Google::Longrunning::Operation
49
49
  # Updates the machine type of a single Instance.
50
- rpc :SetInstanceMachineType, Google::Cloud::Notebooks::V1beta1::SetInstanceMachineTypeRequest, Google::Longrunning::Operation
50
+ rpc :SetInstanceMachineType, ::Google::Cloud::Notebooks::V1beta1::SetInstanceMachineTypeRequest, ::Google::Longrunning::Operation
51
51
  # Updates the labels of an Instance.
52
- rpc :SetInstanceLabels, Google::Cloud::Notebooks::V1beta1::SetInstanceLabelsRequest, Google::Longrunning::Operation
52
+ rpc :SetInstanceLabels, ::Google::Cloud::Notebooks::V1beta1::SetInstanceLabelsRequest, ::Google::Longrunning::Operation
53
53
  # Deletes a single Instance.
54
- rpc :DeleteInstance, Google::Cloud::Notebooks::V1beta1::DeleteInstanceRequest, Google::Longrunning::Operation
54
+ rpc :DeleteInstance, ::Google::Cloud::Notebooks::V1beta1::DeleteInstanceRequest, ::Google::Longrunning::Operation
55
55
  # Starts a notebook instance.
56
- rpc :StartInstance, Google::Cloud::Notebooks::V1beta1::StartInstanceRequest, Google::Longrunning::Operation
56
+ rpc :StartInstance, ::Google::Cloud::Notebooks::V1beta1::StartInstanceRequest, ::Google::Longrunning::Operation
57
57
  # Stops a notebook instance.
58
- rpc :StopInstance, Google::Cloud::Notebooks::V1beta1::StopInstanceRequest, Google::Longrunning::Operation
58
+ rpc :StopInstance, ::Google::Cloud::Notebooks::V1beta1::StopInstanceRequest, ::Google::Longrunning::Operation
59
59
  # Resets a notebook instance.
60
- rpc :ResetInstance, Google::Cloud::Notebooks::V1beta1::ResetInstanceRequest, Google::Longrunning::Operation
60
+ rpc :ResetInstance, ::Google::Cloud::Notebooks::V1beta1::ResetInstanceRequest, ::Google::Longrunning::Operation
61
61
  # Allows notebook instances to
62
62
  # report their latest instance information to the Notebooks
63
63
  # API server. The server will merge the reported information to
64
64
  # the instance metadata store. Do not use this method directly.
65
- rpc :ReportInstanceInfo, Google::Cloud::Notebooks::V1beta1::ReportInstanceInfoRequest, Google::Longrunning::Operation
65
+ rpc :ReportInstanceInfo, ::Google::Cloud::Notebooks::V1beta1::ReportInstanceInfoRequest, ::Google::Longrunning::Operation
66
66
  # Check if a notebook instance is upgradable.
67
- rpc :IsInstanceUpgradeable, Google::Cloud::Notebooks::V1beta1::IsInstanceUpgradeableRequest, Google::Cloud::Notebooks::V1beta1::IsInstanceUpgradeableResponse
67
+ rpc :IsInstanceUpgradeable, ::Google::Cloud::Notebooks::V1beta1::IsInstanceUpgradeableRequest, ::Google::Cloud::Notebooks::V1beta1::IsInstanceUpgradeableResponse
68
68
  # Upgrades a notebook instance to the latest version.
69
- rpc :UpgradeInstance, Google::Cloud::Notebooks::V1beta1::UpgradeInstanceRequest, Google::Longrunning::Operation
69
+ rpc :UpgradeInstance, ::Google::Cloud::Notebooks::V1beta1::UpgradeInstanceRequest, ::Google::Longrunning::Operation
70
70
  # Allows notebook instances to
71
71
  # call this endpoint to upgrade themselves. Do not use this method directly.
72
- rpc :UpgradeInstanceInternal, Google::Cloud::Notebooks::V1beta1::UpgradeInstanceInternalRequest, Google::Longrunning::Operation
72
+ rpc :UpgradeInstanceInternal, ::Google::Cloud::Notebooks::V1beta1::UpgradeInstanceInternalRequest, ::Google::Longrunning::Operation
73
73
  # Lists environments in a project.
74
- rpc :ListEnvironments, Google::Cloud::Notebooks::V1beta1::ListEnvironmentsRequest, Google::Cloud::Notebooks::V1beta1::ListEnvironmentsResponse
74
+ rpc :ListEnvironments, ::Google::Cloud::Notebooks::V1beta1::ListEnvironmentsRequest, ::Google::Cloud::Notebooks::V1beta1::ListEnvironmentsResponse
75
75
  # Gets details of a single Environment.
76
- rpc :GetEnvironment, Google::Cloud::Notebooks::V1beta1::GetEnvironmentRequest, Google::Cloud::Notebooks::V1beta1::Environment
76
+ rpc :GetEnvironment, ::Google::Cloud::Notebooks::V1beta1::GetEnvironmentRequest, ::Google::Cloud::Notebooks::V1beta1::Environment
77
77
  # Creates a new Environment.
78
- rpc :CreateEnvironment, Google::Cloud::Notebooks::V1beta1::CreateEnvironmentRequest, Google::Longrunning::Operation
78
+ rpc :CreateEnvironment, ::Google::Cloud::Notebooks::V1beta1::CreateEnvironmentRequest, ::Google::Longrunning::Operation
79
79
  # Deletes a single Environment.
80
- rpc :DeleteEnvironment, Google::Cloud::Notebooks::V1beta1::DeleteEnvironmentRequest, Google::Longrunning::Operation
80
+ rpc :DeleteEnvironment, ::Google::Cloud::Notebooks::V1beta1::DeleteEnvironmentRequest, ::Google::Longrunning::Operation
81
81
  end
82
82
 
83
83
  Stub = Service.rpc_stub_class
@@ -21,7 +21,7 @@ module Google
21
21
  module Cloud
22
22
  module Notebooks
23
23
  module V1beta1
24
- VERSION = "0.1.0"
24
+ VERSION = "0.2.0"
25
25
  end
26
26
  end
27
27
  end
@@ -1,4 +1,4 @@
1
- # AI Platform Notebooks V1 Protocol Buffer Documentation
1
+ # AI Platform Notebooks V1beta1 Protocol Buffer Documentation
2
2
 
3
3
  These files are for the YARD documentation of the generated protobuf files.
4
4
  They are not intended to be required or loaded at runtime.
@@ -43,12 +43,12 @@ module Google
43
43
  #
44
44
  # The ResourceDescriptor Yaml config will look like:
45
45
  #
46
- # resources:
47
- # - type: "pubsub.googleapis.com/Topic"
48
- # name_descriptor:
49
- # - pattern: "projects/\\{project}/topics/\\{topic}"
50
- # parent_type: "cloudresourcemanager.googleapis.com/Project"
51
- # parent_name_extractor: "projects/\\{project}"
46
+ # resources:
47
+ # - type: "pubsub.googleapis.com/Topic"
48
+ # name_descriptor:
49
+ # - pattern: "projects/{project}/topics/{topic}"
50
+ # parent_type: "cloudresourcemanager.googleapis.com/Project"
51
+ # parent_name_extractor: "projects/{project}"
52
52
  #
53
53
  # Sometimes, resources have multiple patterns, typically because they can
54
54
  # live under multiple parents.
@@ -183,15 +183,24 @@ module Google
183
183
  # }
184
184
  # @!attribute [rw] plural
185
185
  # @return [::String]
186
- # The plural name used in the resource name, such as 'projects' for
187
- # the name of 'projects/\\{project}'. It is the same concept of the `plural`
188
- # field in k8s CRD spec
186
+ # The plural name used in the resource name and permission names, such as
187
+ # 'projects' for the resource name of 'projects/\\{project}' and the permission
188
+ # name of 'cloudresourcemanager.googleapis.com/projects.get'. It is the same
189
+ # concept of the `plural` field in k8s CRD spec
189
190
  # https://kubernetes.io/docs/tasks/access-kubernetes-api/custom-resources/custom-resource-definitions/
191
+ #
192
+ # Note: The plural form is required even for singleton resources. See
193
+ # https://aip.dev/156
190
194
  # @!attribute [rw] singular
191
195
  # @return [::String]
192
196
  # The same concept of the `singular` field in k8s CRD spec
193
197
  # https://kubernetes.io/docs/tasks/access-kubernetes-api/custom-resources/custom-resource-definitions/
194
198
  # Such as "project" for the `resourcemanager.googleapis.com/Project` type.
199
+ # @!attribute [rw] style
200
+ # @return [::Array<::Google::Api::ResourceDescriptor::Style>]
201
+ # Style flag(s) for this resource.
202
+ # These indicate that a resource is expected to conform to a given
203
+ # style. See the specific style flags for additional information.
195
204
  class ResourceDescriptor
196
205
  include ::Google::Protobuf::MessageExts
197
206
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -211,6 +220,22 @@ module Google
211
220
  # that from being necessary once there are multiple patterns.)
212
221
  FUTURE_MULTI_PATTERN = 2
213
222
  end
223
+
224
+ # A flag representing a specific style that a resource claims to conform to.
225
+ module Style
226
+ # The unspecified value. Do not use.
227
+ STYLE_UNSPECIFIED = 0
228
+
229
+ # This resource is intended to be "declarative-friendly".
230
+ #
231
+ # Declarative-friendly resources must be more strictly consistent, and
232
+ # setting this to true communicates to tools that this resource should
233
+ # adhere to declarative-friendly expectations.
234
+ #
235
+ # Note: This is used by the API linter (linter.aip.dev) to enable
236
+ # additional checks.
237
+ DECLARATIVE_FRIENDLY = 1
238
+ end
214
239
  end
215
240
 
216
241
  # Defines a proto annotation that describes a string field that refers to
@@ -226,6 +251,17 @@ module Google
226
251
  # type: "pubsub.googleapis.com/Topic"
227
252
  # }];
228
253
  # }
254
+ #
255
+ # Occasionally, a field may reference an arbitrary resource. In this case,
256
+ # APIs use the special value * in their resource reference.
257
+ #
258
+ # Example:
259
+ #
260
+ # message GetIamPolicyRequest {
261
+ # string resource = 2 [(google.api.resource_reference) = {
262
+ # type: "*"
263
+ # }];
264
+ # }
229
265
  # @!attribute [rw] child_type
230
266
  # @return [::String]
231
267
  # The resource type of a child collection that the annotated field
@@ -234,11 +270,11 @@ module Google
234
270
  #
235
271
  # Example:
236
272
  #
237
- # message ListLogEntriesRequest {
238
- # string parent = 1 [(google.api.resource_reference) = {
239
- # child_type: "logging.googleapis.com/LogEntry"
240
- # };
241
- # }
273
+ # message ListLogEntriesRequest {
274
+ # string parent = 1 [(google.api.resource_reference) = {
275
+ # child_type: "logging.googleapis.com/LogEntry"
276
+ # };
277
+ # }
242
278
  class ResourceReference
243
279
  include ::Google::Protobuf::MessageExts
244
280
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -239,6 +239,15 @@ module Google
239
239
 
240
240
  # The instance is deleted.
241
241
  DELETED = 6
242
+
243
+ # The instance is upgrading.
244
+ UPGRADING = 7
245
+
246
+ # The instance is being created.
247
+ INITIALIZING = 8
248
+
249
+ # The instance is getting registered.
250
+ REGISTERING = 9
242
251
  end
243
252
 
244
253
  # Possible disk types for notebook instances.
@@ -251,6 +260,9 @@ module Google
251
260
 
252
261
  # SSD persistent disk type.
253
262
  PD_SSD = 2
263
+
264
+ # Balanced persistent disk type.
265
+ PD_BALANCED = 3
254
266
  end
255
267
 
256
268
  # Definition of the disk encryption options.
@@ -46,6 +46,9 @@ module Google
46
46
  # @!attribute [rw] api_version
47
47
  # @return [::String]
48
48
  # API version used to start the operation.
49
+ # @!attribute [rw] endpoint
50
+ # @return [::String]
51
+ # API endpoint name of this operation.
49
52
  class OperationMetadata
50
53
  include ::Google::Protobuf::MessageExts
51
54
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -140,8 +143,8 @@ module Google
140
143
  # @return [::Integer]
141
144
  # Required. Count of cores of this accelerator. Note that not all combinations
142
145
  # of `type` and `core_count` are valid. Check [GPUs on
143
- # Compute Engine](/compute/docs/gpus/#gpus-list) to find a valid
144
- # combination. TPUs are not supported.
146
+ # Compute Engine](https://cloud.google.com/compute/docs/gpus/#gpus-list) to
147
+ # find a valid combination. TPUs are not supported.
145
148
  class SetInstanceAcceleratorRequest
146
149
  include ::Google::Protobuf::MessageExts
147
150
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -154,7 +157,8 @@ module Google
154
157
  # `projects/{project_id}/locations/{location}/instances/{instance_id}`
155
158
  # @!attribute [rw] machine_type
156
159
  # @return [::String]
157
- # Required. The [Compute Engine machine type](/compute/docs/machine-types).
160
+ # Required. The [Compute Engine machine
161
+ # type](https://cloud.google.com/compute/docs/machine-types).
158
162
  class SetInstanceMachineTypeRequest
159
163
  include ::Google::Protobuf::MessageExts
160
164
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -268,6 +272,9 @@ module Google
268
272
  # @return [::String]
269
273
  # The version this instance will be upgraded to if calling the upgrade
270
274
  # endpoint. This field will only be populated if field upgradeable is true.
275
+ # @!attribute [rw] upgrade_info
276
+ # @return [::String]
277
+ # Additional information about upgrade.
271
278
  class IsInstanceUpgradeableResponse
272
279
  include ::Google::Protobuf::MessageExts
273
280
  extend ::Google::Protobuf::MessageExts::ClassMethods
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: google-cloud-notebooks-v1beta1
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.1.0
4
+ version: 0.2.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: 2020-09-10 00:00:00.000000000 Z
11
+ date: 2020-09-24 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: gapic-common
@@ -205,8 +205,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
205
205
  - !ruby/object:Gem::Version
206
206
  version: '0'
207
207
  requirements: []
208
- rubygems_version: 3.1.3
208
+ rubygems_version: 3.1.4
209
209
  signing_key:
210
210
  specification_version: 4
211
- summary: API Client library for the AI Platform Notebooks V1 API
211
+ summary: API Client library for the AI Platform Notebooks V1beta1 API
212
212
  test_files: []