google-cloud-notebooks-v1 0.1.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 +7 -0
- data/.yardopts +12 -0
- data/AUTHENTICATION.md +151 -0
- data/LICENSE.md +201 -0
- data/README.md +139 -0
- data/lib/google/cloud/notebooks/v1/environment_pb.rb +46 -0
- data/lib/google/cloud/notebooks/v1/event_pb.rb +29 -0
- data/lib/google/cloud/notebooks/v1/execution_pb.rb +99 -0
- data/lib/google/cloud/notebooks/v1/instance_config_pb.rb +23 -0
- data/lib/google/cloud/notebooks/v1/instance_pb.rb +177 -0
- data/lib/google/cloud/notebooks/v1/managed_notebook_service/client.rb +1256 -0
- data/lib/google/cloud/notebooks/v1/managed_notebook_service/credentials.rb +51 -0
- data/lib/google/cloud/notebooks/v1/managed_notebook_service/operations.rb +767 -0
- data/lib/google/cloud/notebooks/v1/managed_notebook_service/paths.rb +52 -0
- data/lib/google/cloud/notebooks/v1/managed_notebook_service.rb +50 -0
- data/lib/google/cloud/notebooks/v1/managed_service_pb.rb +75 -0
- data/lib/google/cloud/notebooks/v1/managed_service_services_pb.rb +70 -0
- data/lib/google/cloud/notebooks/v1/notebook_service/client.rb +3643 -0
- data/lib/google/cloud/notebooks/v1/notebook_service/credentials.rb +51 -0
- data/lib/google/cloud/notebooks/v1/notebook_service/operations.rb +767 -0
- data/lib/google/cloud/notebooks/v1/notebook_service/paths.rb +105 -0
- data/lib/google/cloud/notebooks/v1/notebook_service.rb +50 -0
- data/lib/google/cloud/notebooks/v1/runtime_pb.rb +173 -0
- data/lib/google/cloud/notebooks/v1/schedule_pb.rb +45 -0
- data/lib/google/cloud/notebooks/v1/service_pb.rb +243 -0
- data/lib/google/cloud/notebooks/v1/service_services_pb.rb +114 -0
- data/lib/google/cloud/notebooks/v1/version.rb +28 -0
- data/lib/google/cloud/notebooks/v1.rb +41 -0
- data/lib/google-cloud-notebooks-v1.rb +21 -0
- data/proto_docs/README.md +4 -0
- data/proto_docs/google/api/field_behavior.rb +71 -0
- data/proto_docs/google/api/resource.rb +222 -0
- data/proto_docs/google/cloud/notebooks/v1/environment.rb +91 -0
- data/proto_docs/google/cloud/notebooks/v1/event.rb +47 -0
- data/proto_docs/google/cloud/notebooks/v1/execution.rb +330 -0
- data/proto_docs/google/cloud/notebooks/v1/instance.rb +551 -0
- data/proto_docs/google/cloud/notebooks/v1/instance_config.rb +39 -0
- data/proto_docs/google/cloud/notebooks/v1/managed_service.rb +160 -0
- data/proto_docs/google/cloud/notebooks/v1/runtime.rb +607 -0
- data/proto_docs/google/cloud/notebooks/v1/schedule.rb +104 -0
- data/proto_docs/google/cloud/notebooks/v1/service.rb +656 -0
- data/proto_docs/google/longrunning/operations.rb +164 -0
- data/proto_docs/google/protobuf/any.rb +141 -0
- data/proto_docs/google/protobuf/duration.rb +98 -0
- data/proto_docs/google/protobuf/empty.rb +36 -0
- data/proto_docs/google/protobuf/timestamp.rb +129 -0
- data/proto_docs/google/rpc/status.rb +46 -0
- metadata +239 -0
@@ -0,0 +1,656 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
# Copyright 2022 Google LLC
|
4
|
+
#
|
5
|
+
# Licensed under the Apache License, Version 2.0 (the "License");
|
6
|
+
# you may not use this file except in compliance with the License.
|
7
|
+
# You may obtain a copy of the License at
|
8
|
+
#
|
9
|
+
# https://www.apache.org/licenses/LICENSE-2.0
|
10
|
+
#
|
11
|
+
# Unless required by applicable law or agreed to in writing, software
|
12
|
+
# distributed under the License is distributed on an "AS IS" BASIS,
|
13
|
+
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
14
|
+
# See the License for the specific language governing permissions and
|
15
|
+
# limitations under the License.
|
16
|
+
|
17
|
+
# Auto-generated by gapic-generator-ruby. DO NOT EDIT!
|
18
|
+
|
19
|
+
|
20
|
+
module Google
|
21
|
+
module Cloud
|
22
|
+
module Notebooks
|
23
|
+
module V1
|
24
|
+
# Represents the metadata of the long-running operation.
|
25
|
+
# @!attribute [rw] create_time
|
26
|
+
# @return [::Google::Protobuf::Timestamp]
|
27
|
+
# The time the operation was created.
|
28
|
+
# @!attribute [rw] end_time
|
29
|
+
# @return [::Google::Protobuf::Timestamp]
|
30
|
+
# The time the operation finished running.
|
31
|
+
# @!attribute [rw] target
|
32
|
+
# @return [::String]
|
33
|
+
# Server-defined resource path for the target of the operation.
|
34
|
+
# @!attribute [rw] verb
|
35
|
+
# @return [::String]
|
36
|
+
# Name of the verb executed by the operation.
|
37
|
+
# @!attribute [rw] status_message
|
38
|
+
# @return [::String]
|
39
|
+
# Human-readable status of the operation, if any.
|
40
|
+
# @!attribute [rw] requested_cancellation
|
41
|
+
# @return [::Boolean]
|
42
|
+
# Identifies whether the user has requested cancellation
|
43
|
+
# of the operation. Operations that have successfully been cancelled
|
44
|
+
# have [Operation.error][] value with a
|
45
|
+
# {::Google::Rpc::Status#code google.rpc.Status.code} of 1, corresponding to `Code.CANCELLED`.
|
46
|
+
# @!attribute [rw] api_version
|
47
|
+
# @return [::String]
|
48
|
+
# API version used to start the operation.
|
49
|
+
# @!attribute [rw] endpoint
|
50
|
+
# @return [::String]
|
51
|
+
# API endpoint name of this operation.
|
52
|
+
class OperationMetadata
|
53
|
+
include ::Google::Protobuf::MessageExts
|
54
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
55
|
+
end
|
56
|
+
|
57
|
+
# Request for listing notebook instances.
|
58
|
+
# @!attribute [rw] parent
|
59
|
+
# @return [::String]
|
60
|
+
# Required. Format:
|
61
|
+
# `parent=projects/{project_id}/locations/{location}`
|
62
|
+
# @!attribute [rw] page_size
|
63
|
+
# @return [::Integer]
|
64
|
+
# Maximum return size of the list call.
|
65
|
+
# @!attribute [rw] page_token
|
66
|
+
# @return [::String]
|
67
|
+
# A previous returned page token that can be used to continue listing
|
68
|
+
# from the last result.
|
69
|
+
class ListInstancesRequest
|
70
|
+
include ::Google::Protobuf::MessageExts
|
71
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
72
|
+
end
|
73
|
+
|
74
|
+
# Response for listing notebook instances.
|
75
|
+
# @!attribute [rw] instances
|
76
|
+
# @return [::Array<::Google::Cloud::Notebooks::V1::Instance>]
|
77
|
+
# A list of returned instances.
|
78
|
+
# @!attribute [rw] next_page_token
|
79
|
+
# @return [::String]
|
80
|
+
# Page token that can be used to continue listing from the last result in the
|
81
|
+
# next list call.
|
82
|
+
# @!attribute [rw] unreachable
|
83
|
+
# @return [::Array<::String>]
|
84
|
+
# Locations that could not be reached. For example,
|
85
|
+
# ['us-west1-a', 'us-central1-b'].
|
86
|
+
# A ListInstancesResponse will only contain either instances or unreachables,
|
87
|
+
class ListInstancesResponse
|
88
|
+
include ::Google::Protobuf::MessageExts
|
89
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
90
|
+
end
|
91
|
+
|
92
|
+
# Request for getting a notebook instance.
|
93
|
+
# @!attribute [rw] name
|
94
|
+
# @return [::String]
|
95
|
+
# Required. Format:
|
96
|
+
# `projects/{project_id}/locations/{location}/instances/{instance_id}`
|
97
|
+
class GetInstanceRequest
|
98
|
+
include ::Google::Protobuf::MessageExts
|
99
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
100
|
+
end
|
101
|
+
|
102
|
+
# Request for creating a notebook instance.
|
103
|
+
# @!attribute [rw] parent
|
104
|
+
# @return [::String]
|
105
|
+
# Required. Format:
|
106
|
+
# `parent=projects/{project_id}/locations/{location}`
|
107
|
+
# @!attribute [rw] instance_id
|
108
|
+
# @return [::String]
|
109
|
+
# Required. User-defined unique ID of this instance.
|
110
|
+
# @!attribute [rw] instance
|
111
|
+
# @return [::Google::Cloud::Notebooks::V1::Instance]
|
112
|
+
# Required. The instance to be created.
|
113
|
+
class CreateInstanceRequest
|
114
|
+
include ::Google::Protobuf::MessageExts
|
115
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
116
|
+
end
|
117
|
+
|
118
|
+
# Request for registering a notebook instance.
|
119
|
+
# @!attribute [rw] parent
|
120
|
+
# @return [::String]
|
121
|
+
# Required. Format:
|
122
|
+
# `parent=projects/{project_id}/locations/{location}`
|
123
|
+
# @!attribute [rw] instance_id
|
124
|
+
# @return [::String]
|
125
|
+
# Required. User defined unique ID of this instance. The `instance_id` must
|
126
|
+
# be 1 to 63 characters long and contain only lowercase letters,
|
127
|
+
# numeric characters, and dashes. The first character must be a lowercase
|
128
|
+
# letter and the last character cannot be a dash.
|
129
|
+
class RegisterInstanceRequest
|
130
|
+
include ::Google::Protobuf::MessageExts
|
131
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
132
|
+
end
|
133
|
+
|
134
|
+
# Request for setting instance accelerator.
|
135
|
+
# @!attribute [rw] name
|
136
|
+
# @return [::String]
|
137
|
+
# Required. Format:
|
138
|
+
# `projects/{project_id}/locations/{location}/instances/{instance_id}`
|
139
|
+
# @!attribute [rw] type
|
140
|
+
# @return [::Google::Cloud::Notebooks::V1::Instance::AcceleratorType]
|
141
|
+
# Required. Type of this accelerator.
|
142
|
+
# @!attribute [rw] core_count
|
143
|
+
# @return [::Integer]
|
144
|
+
# Required. Count of cores of this accelerator. Note that not all combinations
|
145
|
+
# of `type` and `core_count` are valid. Check [GPUs on
|
146
|
+
# Compute Engine](https://cloud.google.com/compute/docs/gpus/#gpus-list) to
|
147
|
+
# find a valid combination. TPUs are not supported.
|
148
|
+
class SetInstanceAcceleratorRequest
|
149
|
+
include ::Google::Protobuf::MessageExts
|
150
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
151
|
+
end
|
152
|
+
|
153
|
+
# Request for setting instance machine type.
|
154
|
+
# @!attribute [rw] name
|
155
|
+
# @return [::String]
|
156
|
+
# Required. Format:
|
157
|
+
# `projects/{project_id}/locations/{location}/instances/{instance_id}`
|
158
|
+
# @!attribute [rw] machine_type
|
159
|
+
# @return [::String]
|
160
|
+
# Required. The [Compute Engine machine
|
161
|
+
# type](https://cloud.google.com/compute/docs/machine-types).
|
162
|
+
class SetInstanceMachineTypeRequest
|
163
|
+
include ::Google::Protobuf::MessageExts
|
164
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
165
|
+
end
|
166
|
+
|
167
|
+
# Request for updating instance configurations.
|
168
|
+
# @!attribute [rw] name
|
169
|
+
# @return [::String]
|
170
|
+
# Required. Format:
|
171
|
+
# `projects/{project_id}/locations/{location}/instances/{instance_id}`
|
172
|
+
# @!attribute [rw] config
|
173
|
+
# @return [::Google::Cloud::Notebooks::V1::InstanceConfig]
|
174
|
+
# The instance configurations to be updated.
|
175
|
+
class UpdateInstanceConfigRequest
|
176
|
+
include ::Google::Protobuf::MessageExts
|
177
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
178
|
+
end
|
179
|
+
|
180
|
+
# Request for setting instance labels.
|
181
|
+
# @!attribute [rw] name
|
182
|
+
# @return [::String]
|
183
|
+
# Required. Format:
|
184
|
+
# `projects/{project_id}/locations/{location}/instances/{instance_id}`
|
185
|
+
# @!attribute [rw] labels
|
186
|
+
# @return [::Google::Protobuf::Map{::String => ::String}]
|
187
|
+
# Labels to apply to this instance.
|
188
|
+
# These can be later modified by the setLabels method
|
189
|
+
class SetInstanceLabelsRequest
|
190
|
+
include ::Google::Protobuf::MessageExts
|
191
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
192
|
+
|
193
|
+
# @!attribute [rw] key
|
194
|
+
# @return [::String]
|
195
|
+
# @!attribute [rw] value
|
196
|
+
# @return [::String]
|
197
|
+
class LabelsEntry
|
198
|
+
include ::Google::Protobuf::MessageExts
|
199
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
200
|
+
end
|
201
|
+
end
|
202
|
+
|
203
|
+
# Request for updating the Shielded Instance config for a notebook instance.
|
204
|
+
# You can only use this method on a stopped instance
|
205
|
+
# @!attribute [rw] name
|
206
|
+
# @return [::String]
|
207
|
+
# Required. Format:
|
208
|
+
# `projects/{project_id}/locations/{location}/instances/{instance_id}`
|
209
|
+
# @!attribute [rw] shielded_instance_config
|
210
|
+
# @return [::Google::Cloud::Notebooks::V1::Instance::ShieldedInstanceConfig]
|
211
|
+
# ShieldedInstance configuration to be updated.
|
212
|
+
class UpdateShieldedInstanceConfigRequest
|
213
|
+
include ::Google::Protobuf::MessageExts
|
214
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
215
|
+
end
|
216
|
+
|
217
|
+
# Request for deleting a notebook instance.
|
218
|
+
# @!attribute [rw] name
|
219
|
+
# @return [::String]
|
220
|
+
# Required. Format:
|
221
|
+
# `projects/{project_id}/locations/{location}/instances/{instance_id}`
|
222
|
+
class DeleteInstanceRequest
|
223
|
+
include ::Google::Protobuf::MessageExts
|
224
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
225
|
+
end
|
226
|
+
|
227
|
+
# Request for starting a notebook instance
|
228
|
+
# @!attribute [rw] name
|
229
|
+
# @return [::String]
|
230
|
+
# Required. Format:
|
231
|
+
# `projects/{project_id}/locations/{location}/instances/{instance_id}`
|
232
|
+
class StartInstanceRequest
|
233
|
+
include ::Google::Protobuf::MessageExts
|
234
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
235
|
+
end
|
236
|
+
|
237
|
+
# Request for stopping a notebook instance
|
238
|
+
# @!attribute [rw] name
|
239
|
+
# @return [::String]
|
240
|
+
# Required. Format:
|
241
|
+
# `projects/{project_id}/locations/{location}/instances/{instance_id}`
|
242
|
+
class StopInstanceRequest
|
243
|
+
include ::Google::Protobuf::MessageExts
|
244
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
245
|
+
end
|
246
|
+
|
247
|
+
# Request for reseting a notebook instance
|
248
|
+
# @!attribute [rw] name
|
249
|
+
# @return [::String]
|
250
|
+
# Required. Format:
|
251
|
+
# `projects/{project_id}/locations/{location}/instances/{instance_id}`
|
252
|
+
class ResetInstanceRequest
|
253
|
+
include ::Google::Protobuf::MessageExts
|
254
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
255
|
+
end
|
256
|
+
|
257
|
+
# Request for notebook instances to report information to Notebooks API.
|
258
|
+
# @!attribute [rw] name
|
259
|
+
# @return [::String]
|
260
|
+
# Required. Format:
|
261
|
+
# `projects/{project_id}/locations/{location}/instances/{instance_id}`
|
262
|
+
# @!attribute [rw] vm_id
|
263
|
+
# @return [::String]
|
264
|
+
# Required. The VM hardware token for authenticating the VM.
|
265
|
+
# https://cloud.google.com/compute/docs/instances/verifying-instance-identity
|
266
|
+
# @!attribute [rw] metadata
|
267
|
+
# @return [::Google::Protobuf::Map{::String => ::String}]
|
268
|
+
# The metadata reported to Notebooks API. This will be merged to the instance
|
269
|
+
# metadata store
|
270
|
+
class ReportInstanceInfoRequest
|
271
|
+
include ::Google::Protobuf::MessageExts
|
272
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
273
|
+
|
274
|
+
# @!attribute [rw] key
|
275
|
+
# @return [::String]
|
276
|
+
# @!attribute [rw] value
|
277
|
+
# @return [::String]
|
278
|
+
class MetadataEntry
|
279
|
+
include ::Google::Protobuf::MessageExts
|
280
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
281
|
+
end
|
282
|
+
end
|
283
|
+
|
284
|
+
# Request for checking if a notebook instance is upgradeable.
|
285
|
+
# @!attribute [rw] notebook_instance
|
286
|
+
# @return [::String]
|
287
|
+
# Required. Format:
|
288
|
+
# `projects/{project_id}/locations/{location}/instances/{instance_id}`
|
289
|
+
class IsInstanceUpgradeableRequest
|
290
|
+
include ::Google::Protobuf::MessageExts
|
291
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
292
|
+
end
|
293
|
+
|
294
|
+
# Response for checking if a notebook instance is upgradeable.
|
295
|
+
# @!attribute [rw] upgradeable
|
296
|
+
# @return [::Boolean]
|
297
|
+
# If an instance is upgradeable.
|
298
|
+
# @!attribute [rw] upgrade_version
|
299
|
+
# @return [::String]
|
300
|
+
# The version this instance will be upgraded to if calling the upgrade
|
301
|
+
# endpoint. This field will only be populated if field upgradeable is true.
|
302
|
+
# @!attribute [rw] upgrade_info
|
303
|
+
# @return [::String]
|
304
|
+
# Additional information about upgrade.
|
305
|
+
# @!attribute [rw] upgrade_image
|
306
|
+
# @return [::String]
|
307
|
+
# The new image self link this instance will be upgraded to if calling the
|
308
|
+
# upgrade endpoint. This field will only be populated if field upgradeable
|
309
|
+
# is true.
|
310
|
+
class IsInstanceUpgradeableResponse
|
311
|
+
include ::Google::Protobuf::MessageExts
|
312
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
313
|
+
end
|
314
|
+
|
315
|
+
# Request for checking if a notebook instance is healthy.
|
316
|
+
# @!attribute [rw] name
|
317
|
+
# @return [::String]
|
318
|
+
# Required. Format:
|
319
|
+
# `projects/{project_id}/locations/{location}/instances/{instance_id}`
|
320
|
+
class GetInstanceHealthRequest
|
321
|
+
include ::Google::Protobuf::MessageExts
|
322
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
323
|
+
end
|
324
|
+
|
325
|
+
# Response for checking if a notebook instance is healthy.
|
326
|
+
# @!attribute [r] health_state
|
327
|
+
# @return [::Google::Cloud::Notebooks::V1::GetInstanceHealthResponse::HealthState]
|
328
|
+
# Output only. Runtime health_state.
|
329
|
+
# @!attribute [r] health_info
|
330
|
+
# @return [::Google::Protobuf::Map{::String => ::String}]
|
331
|
+
# Output only. Additional information about instance health.
|
332
|
+
# Example:
|
333
|
+
# healthInfo": {
|
334
|
+
# "docker_proxy_agent_status": "1",
|
335
|
+
# "docker_status": "1",
|
336
|
+
# "jupyterlab_api_status": "-1",
|
337
|
+
# "jupyterlab_status": "-1",
|
338
|
+
# "updated": "2020-10-18 09:40:03.573409"
|
339
|
+
# }
|
340
|
+
class GetInstanceHealthResponse
|
341
|
+
include ::Google::Protobuf::MessageExts
|
342
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
343
|
+
|
344
|
+
# @!attribute [rw] key
|
345
|
+
# @return [::String]
|
346
|
+
# @!attribute [rw] value
|
347
|
+
# @return [::String]
|
348
|
+
class HealthInfoEntry
|
349
|
+
include ::Google::Protobuf::MessageExts
|
350
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
351
|
+
end
|
352
|
+
|
353
|
+
# If an instance is healthy or not.
|
354
|
+
module HealthState
|
355
|
+
# The instance substate is unknown.
|
356
|
+
HEALTH_STATE_UNSPECIFIED = 0
|
357
|
+
|
358
|
+
# The instance is known to be in an healthy state
|
359
|
+
# (for example, critical daemons are running)
|
360
|
+
# Applies to ACTIVE state.
|
361
|
+
HEALTHY = 1
|
362
|
+
|
363
|
+
# The instance is known to be in an unhealthy state
|
364
|
+
# (for example, critical daemons are not running)
|
365
|
+
# Applies to ACTIVE state.
|
366
|
+
UNHEALTHY = 2
|
367
|
+
|
368
|
+
# The instance has not installed health monitoring agent.
|
369
|
+
# Applies to ACTIVE state.
|
370
|
+
AGENT_NOT_INSTALLED = 3
|
371
|
+
|
372
|
+
# The instance health monitoring agent is not running.
|
373
|
+
# Applies to ACTIVE state.
|
374
|
+
AGENT_NOT_RUNNING = 4
|
375
|
+
end
|
376
|
+
end
|
377
|
+
|
378
|
+
# Request for upgrading a notebook instance
|
379
|
+
# @!attribute [rw] name
|
380
|
+
# @return [::String]
|
381
|
+
# Required. Format:
|
382
|
+
# `projects/{project_id}/locations/{location}/instances/{instance_id}`
|
383
|
+
class UpgradeInstanceRequest
|
384
|
+
include ::Google::Protobuf::MessageExts
|
385
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
386
|
+
end
|
387
|
+
|
388
|
+
# Request for rollbacking a notebook instance
|
389
|
+
# @!attribute [rw] name
|
390
|
+
# @return [::String]
|
391
|
+
# Required. Format:
|
392
|
+
# `projects/{project_id}/locations/{location}/instances/{instance_id}`
|
393
|
+
# @!attribute [rw] target_snapshot
|
394
|
+
# @return [::String]
|
395
|
+
# Required. The snapshot for rollback.
|
396
|
+
# Example: "projects/test-project/global/snapshots/krwlzipynril".
|
397
|
+
class RollbackInstanceRequest
|
398
|
+
include ::Google::Protobuf::MessageExts
|
399
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
400
|
+
end
|
401
|
+
|
402
|
+
# Request for upgrading a notebook instance from within the VM
|
403
|
+
# @!attribute [rw] name
|
404
|
+
# @return [::String]
|
405
|
+
# Required. Format:
|
406
|
+
# `projects/{project_id}/locations/{location}/instances/{instance_id}`
|
407
|
+
# @!attribute [rw] vm_id
|
408
|
+
# @return [::String]
|
409
|
+
# Required. The VM hardware token for authenticating the VM.
|
410
|
+
# https://cloud.google.com/compute/docs/instances/verifying-instance-identity
|
411
|
+
class UpgradeInstanceInternalRequest
|
412
|
+
include ::Google::Protobuf::MessageExts
|
413
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
414
|
+
end
|
415
|
+
|
416
|
+
# Request for listing environments.
|
417
|
+
# @!attribute [rw] parent
|
418
|
+
# @return [::String]
|
419
|
+
# Required. Format: `projects/{project_id}/locations/{location}`
|
420
|
+
# @!attribute [rw] page_size
|
421
|
+
# @return [::Integer]
|
422
|
+
# Maximum return size of the list call.
|
423
|
+
# @!attribute [rw] page_token
|
424
|
+
# @return [::String]
|
425
|
+
# A previous returned page token that can be used to continue listing from
|
426
|
+
# the last result.
|
427
|
+
class ListEnvironmentsRequest
|
428
|
+
include ::Google::Protobuf::MessageExts
|
429
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
430
|
+
end
|
431
|
+
|
432
|
+
# Response for listing environments.
|
433
|
+
# @!attribute [rw] environments
|
434
|
+
# @return [::Array<::Google::Cloud::Notebooks::V1::Environment>]
|
435
|
+
# A list of returned environments.
|
436
|
+
# @!attribute [rw] next_page_token
|
437
|
+
# @return [::String]
|
438
|
+
# A page token that can be used to continue listing from the last result
|
439
|
+
# in the next list call.
|
440
|
+
# @!attribute [rw] unreachable
|
441
|
+
# @return [::Array<::String>]
|
442
|
+
# Locations that could not be reached.
|
443
|
+
class ListEnvironmentsResponse
|
444
|
+
include ::Google::Protobuf::MessageExts
|
445
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
446
|
+
end
|
447
|
+
|
448
|
+
# Request for getting a notebook environment.
|
449
|
+
# @!attribute [rw] name
|
450
|
+
# @return [::String]
|
451
|
+
# Required. Format:
|
452
|
+
# `projects/{project_id}/locations/{location}/environments/{environment_id}`
|
453
|
+
class GetEnvironmentRequest
|
454
|
+
include ::Google::Protobuf::MessageExts
|
455
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
456
|
+
end
|
457
|
+
|
458
|
+
# Request for creating a notebook environment.
|
459
|
+
# @!attribute [rw] parent
|
460
|
+
# @return [::String]
|
461
|
+
# Required. Format: `projects/{project_id}/locations/{location}`
|
462
|
+
# @!attribute [rw] environment_id
|
463
|
+
# @return [::String]
|
464
|
+
# Required. User-defined unique ID of this environment. The `environment_id` must
|
465
|
+
# be 1 to 63 characters long and contain only lowercase letters,
|
466
|
+
# numeric characters, and dashes. The first character must be a lowercase
|
467
|
+
# letter and the last character cannot be a dash.
|
468
|
+
# @!attribute [rw] environment
|
469
|
+
# @return [::Google::Cloud::Notebooks::V1::Environment]
|
470
|
+
# Required. The environment to be created.
|
471
|
+
class CreateEnvironmentRequest
|
472
|
+
include ::Google::Protobuf::MessageExts
|
473
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
474
|
+
end
|
475
|
+
|
476
|
+
# Request for deleting a notebook environment.
|
477
|
+
# @!attribute [rw] name
|
478
|
+
# @return [::String]
|
479
|
+
# Required. Format:
|
480
|
+
# `projects/{project_id}/locations/{location}/environments/{environment_id}`
|
481
|
+
class DeleteEnvironmentRequest
|
482
|
+
include ::Google::Protobuf::MessageExts
|
483
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
484
|
+
end
|
485
|
+
|
486
|
+
# Request for listing scheduled notebook job.
|
487
|
+
# @!attribute [rw] parent
|
488
|
+
# @return [::String]
|
489
|
+
# Required. Format:
|
490
|
+
# `parent=projects/{project_id}/locations/{location}`
|
491
|
+
# @!attribute [rw] page_size
|
492
|
+
# @return [::Integer]
|
493
|
+
# Maximum return size of the list call.
|
494
|
+
# @!attribute [rw] page_token
|
495
|
+
# @return [::String]
|
496
|
+
# A previous returned page token that can be used to continue listing
|
497
|
+
# from the last result.
|
498
|
+
# @!attribute [rw] filter
|
499
|
+
# @return [::String]
|
500
|
+
# Filter applied to resulting schedules.
|
501
|
+
# @!attribute [rw] order_by
|
502
|
+
# @return [::String]
|
503
|
+
# Field to order results by.
|
504
|
+
class ListSchedulesRequest
|
505
|
+
include ::Google::Protobuf::MessageExts
|
506
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
507
|
+
end
|
508
|
+
|
509
|
+
# Response for listing scheduled notebook job.
|
510
|
+
# @!attribute [rw] schedules
|
511
|
+
# @return [::Array<::Google::Cloud::Notebooks::V1::Schedule>]
|
512
|
+
# A list of returned instances.
|
513
|
+
# @!attribute [rw] next_page_token
|
514
|
+
# @return [::String]
|
515
|
+
# Page token that can be used to continue listing from the last result in the
|
516
|
+
# next list call.
|
517
|
+
# @!attribute [rw] unreachable
|
518
|
+
# @return [::Array<::String>]
|
519
|
+
# Schedules that could not be reached. For example:
|
520
|
+
#
|
521
|
+
# ['projects/{project_id}/location/{location}/schedules/monthly_digest',
|
522
|
+
# 'projects/{project_id}/location/{location}/schedules/weekly_sentiment']
|
523
|
+
class ListSchedulesResponse
|
524
|
+
include ::Google::Protobuf::MessageExts
|
525
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
526
|
+
end
|
527
|
+
|
528
|
+
# Request for getting scheduled notebook.
|
529
|
+
# @!attribute [rw] name
|
530
|
+
# @return [::String]
|
531
|
+
# Required. Format:
|
532
|
+
# `projects/{project_id}/locations/{location}/schedules/{schedule_id}`
|
533
|
+
class GetScheduleRequest
|
534
|
+
include ::Google::Protobuf::MessageExts
|
535
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
536
|
+
end
|
537
|
+
|
538
|
+
# Request for deleting an Schedule
|
539
|
+
# @!attribute [rw] name
|
540
|
+
# @return [::String]
|
541
|
+
# Required. Format:
|
542
|
+
# `projects/{project_id}/locations/{location}/schedules/{schedule_id}`
|
543
|
+
class DeleteScheduleRequest
|
544
|
+
include ::Google::Protobuf::MessageExts
|
545
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
546
|
+
end
|
547
|
+
|
548
|
+
# Request for created scheduled notebooks
|
549
|
+
# @!attribute [rw] parent
|
550
|
+
# @return [::String]
|
551
|
+
# Required. Format:
|
552
|
+
# `parent=projects/{project_id}/locations/{location}`
|
553
|
+
# @!attribute [rw] schedule_id
|
554
|
+
# @return [::String]
|
555
|
+
# Required. User-defined unique ID of this schedule.
|
556
|
+
# @!attribute [rw] schedule
|
557
|
+
# @return [::Google::Cloud::Notebooks::V1::Schedule]
|
558
|
+
# Required. The schedule to be created.
|
559
|
+
class CreateScheduleRequest
|
560
|
+
include ::Google::Protobuf::MessageExts
|
561
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
562
|
+
end
|
563
|
+
|
564
|
+
# Request for created scheduled notebooks
|
565
|
+
# @!attribute [rw] name
|
566
|
+
# @return [::String]
|
567
|
+
# Required. Format:
|
568
|
+
# `parent=projects/{project_id}/locations/{location}/schedules/{schedule_id}`
|
569
|
+
class TriggerScheduleRequest
|
570
|
+
include ::Google::Protobuf::MessageExts
|
571
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
572
|
+
end
|
573
|
+
|
574
|
+
# Request for listing scheduled notebook executions.
|
575
|
+
# @!attribute [rw] parent
|
576
|
+
# @return [::String]
|
577
|
+
# Required. Format:
|
578
|
+
# `parent=projects/{project_id}/locations/{location}`
|
579
|
+
# @!attribute [rw] page_size
|
580
|
+
# @return [::Integer]
|
581
|
+
# Maximum return size of the list call.
|
582
|
+
# @!attribute [rw] page_token
|
583
|
+
# @return [::String]
|
584
|
+
# A previous returned page token that can be used to continue listing
|
585
|
+
# from the last result.
|
586
|
+
# @!attribute [rw] filter
|
587
|
+
# @return [::String]
|
588
|
+
# Filter applied to resulting executions. Currently only supports filtering
|
589
|
+
# executions by a specified schedule_id.
|
590
|
+
# Format: `schedule_id=<Schedule_ID>`
|
591
|
+
# @!attribute [rw] order_by
|
592
|
+
# @return [::String]
|
593
|
+
# Sort by field.
|
594
|
+
class ListExecutionsRequest
|
595
|
+
include ::Google::Protobuf::MessageExts
|
596
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
597
|
+
end
|
598
|
+
|
599
|
+
# Response for listing scheduled notebook executions
|
600
|
+
# @!attribute [rw] executions
|
601
|
+
# @return [::Array<::Google::Cloud::Notebooks::V1::Execution>]
|
602
|
+
# A list of returned instances.
|
603
|
+
# @!attribute [rw] next_page_token
|
604
|
+
# @return [::String]
|
605
|
+
# Page token that can be used to continue listing from the last result in the
|
606
|
+
# next list call.
|
607
|
+
# @!attribute [rw] unreachable
|
608
|
+
# @return [::Array<::String>]
|
609
|
+
# Executions IDs that could not be reached. For example:
|
610
|
+
#
|
611
|
+
# ['projects/{project_id}/location/{location}/executions/imagenet_test1',
|
612
|
+
# 'projects/{project_id}/location/{location}/executions/classifier_train1']
|
613
|
+
class ListExecutionsResponse
|
614
|
+
include ::Google::Protobuf::MessageExts
|
615
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
616
|
+
end
|
617
|
+
|
618
|
+
# Request for getting scheduled notebook execution
|
619
|
+
# @!attribute [rw] name
|
620
|
+
# @return [::String]
|
621
|
+
# Required. Format:
|
622
|
+
# `projects/{project_id}/locations/{location}/executions/{execution_id}`
|
623
|
+
class GetExecutionRequest
|
624
|
+
include ::Google::Protobuf::MessageExts
|
625
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
626
|
+
end
|
627
|
+
|
628
|
+
# Request for deleting a scheduled notebook execution
|
629
|
+
# @!attribute [rw] name
|
630
|
+
# @return [::String]
|
631
|
+
# Required. Format:
|
632
|
+
# `projects/{project_id}/locations/{location}/executions/{execution_id}`
|
633
|
+
class DeleteExecutionRequest
|
634
|
+
include ::Google::Protobuf::MessageExts
|
635
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
636
|
+
end
|
637
|
+
|
638
|
+
# Request to create notebook execution
|
639
|
+
# @!attribute [rw] parent
|
640
|
+
# @return [::String]
|
641
|
+
# Required. Format:
|
642
|
+
# `parent=projects/{project_id}/locations/{location}`
|
643
|
+
# @!attribute [rw] execution_id
|
644
|
+
# @return [::String]
|
645
|
+
# Required. User-defined unique ID of this execution.
|
646
|
+
# @!attribute [rw] execution
|
647
|
+
# @return [::Google::Cloud::Notebooks::V1::Execution]
|
648
|
+
# Required. The execution to be created.
|
649
|
+
class CreateExecutionRequest
|
650
|
+
include ::Google::Protobuf::MessageExts
|
651
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
652
|
+
end
|
653
|
+
end
|
654
|
+
end
|
655
|
+
end
|
656
|
+
end
|