google-cloud-notebooks-v1 0.1.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (48) hide show
  1. checksums.yaml +7 -0
  2. data/.yardopts +12 -0
  3. data/AUTHENTICATION.md +151 -0
  4. data/LICENSE.md +201 -0
  5. data/README.md +139 -0
  6. data/lib/google/cloud/notebooks/v1/environment_pb.rb +46 -0
  7. data/lib/google/cloud/notebooks/v1/event_pb.rb +29 -0
  8. data/lib/google/cloud/notebooks/v1/execution_pb.rb +99 -0
  9. data/lib/google/cloud/notebooks/v1/instance_config_pb.rb +23 -0
  10. data/lib/google/cloud/notebooks/v1/instance_pb.rb +177 -0
  11. data/lib/google/cloud/notebooks/v1/managed_notebook_service/client.rb +1256 -0
  12. data/lib/google/cloud/notebooks/v1/managed_notebook_service/credentials.rb +51 -0
  13. data/lib/google/cloud/notebooks/v1/managed_notebook_service/operations.rb +767 -0
  14. data/lib/google/cloud/notebooks/v1/managed_notebook_service/paths.rb +52 -0
  15. data/lib/google/cloud/notebooks/v1/managed_notebook_service.rb +50 -0
  16. data/lib/google/cloud/notebooks/v1/managed_service_pb.rb +75 -0
  17. data/lib/google/cloud/notebooks/v1/managed_service_services_pb.rb +70 -0
  18. data/lib/google/cloud/notebooks/v1/notebook_service/client.rb +3643 -0
  19. data/lib/google/cloud/notebooks/v1/notebook_service/credentials.rb +51 -0
  20. data/lib/google/cloud/notebooks/v1/notebook_service/operations.rb +767 -0
  21. data/lib/google/cloud/notebooks/v1/notebook_service/paths.rb +105 -0
  22. data/lib/google/cloud/notebooks/v1/notebook_service.rb +50 -0
  23. data/lib/google/cloud/notebooks/v1/runtime_pb.rb +173 -0
  24. data/lib/google/cloud/notebooks/v1/schedule_pb.rb +45 -0
  25. data/lib/google/cloud/notebooks/v1/service_pb.rb +243 -0
  26. data/lib/google/cloud/notebooks/v1/service_services_pb.rb +114 -0
  27. data/lib/google/cloud/notebooks/v1/version.rb +28 -0
  28. data/lib/google/cloud/notebooks/v1.rb +41 -0
  29. data/lib/google-cloud-notebooks-v1.rb +21 -0
  30. data/proto_docs/README.md +4 -0
  31. data/proto_docs/google/api/field_behavior.rb +71 -0
  32. data/proto_docs/google/api/resource.rb +222 -0
  33. data/proto_docs/google/cloud/notebooks/v1/environment.rb +91 -0
  34. data/proto_docs/google/cloud/notebooks/v1/event.rb +47 -0
  35. data/proto_docs/google/cloud/notebooks/v1/execution.rb +330 -0
  36. data/proto_docs/google/cloud/notebooks/v1/instance.rb +551 -0
  37. data/proto_docs/google/cloud/notebooks/v1/instance_config.rb +39 -0
  38. data/proto_docs/google/cloud/notebooks/v1/managed_service.rb +160 -0
  39. data/proto_docs/google/cloud/notebooks/v1/runtime.rb +607 -0
  40. data/proto_docs/google/cloud/notebooks/v1/schedule.rb +104 -0
  41. data/proto_docs/google/cloud/notebooks/v1/service.rb +656 -0
  42. data/proto_docs/google/longrunning/operations.rb +164 -0
  43. data/proto_docs/google/protobuf/any.rb +141 -0
  44. data/proto_docs/google/protobuf/duration.rb +98 -0
  45. data/proto_docs/google/protobuf/empty.rb +36 -0
  46. data/proto_docs/google/protobuf/timestamp.rb +129 -0
  47. data/proto_docs/google/rpc/status.rb +46 -0
  48. metadata +239 -0
@@ -0,0 +1,114 @@
1
+ # Generated by the protocol buffer compiler. DO NOT EDIT!
2
+ # Source: google/cloud/notebooks/v1/service.proto for package 'Google.Cloud.Notebooks.V1'
3
+ # Original file comments:
4
+ # Copyright 2021 Google LLC
5
+ #
6
+ # Licensed under the Apache License, Version 2.0 (the "License");
7
+ # you may not use this file except in compliance with the License.
8
+ # You may obtain a copy of the License at
9
+ #
10
+ # http://www.apache.org/licenses/LICENSE-2.0
11
+ #
12
+ # Unless required by applicable law or agreed to in writing, software
13
+ # distributed under the License is distributed on an "AS IS" BASIS,
14
+ # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15
+ # See the License for the specific language governing permissions and
16
+ # limitations under the License.
17
+ #
18
+
19
+ require 'grpc'
20
+ require 'google/cloud/notebooks/v1/service_pb'
21
+
22
+ module Google
23
+ module Cloud
24
+ module Notebooks
25
+ module V1
26
+ module NotebookService
27
+ # API v1 service for Cloud AI Platform Notebooks.
28
+ class Service
29
+
30
+ include ::GRPC::GenericService
31
+
32
+ self.marshal_class_method = :encode
33
+ self.unmarshal_class_method = :decode
34
+ self.service_name = 'google.cloud.notebooks.v1.NotebookService'
35
+
36
+ # Lists instances in a given project and location.
37
+ rpc :ListInstances, ::Google::Cloud::Notebooks::V1::ListInstancesRequest, ::Google::Cloud::Notebooks::V1::ListInstancesResponse
38
+ # Gets details of a single Instance.
39
+ rpc :GetInstance, ::Google::Cloud::Notebooks::V1::GetInstanceRequest, ::Google::Cloud::Notebooks::V1::Instance
40
+ # Creates a new Instance in a given project and location.
41
+ rpc :CreateInstance, ::Google::Cloud::Notebooks::V1::CreateInstanceRequest, ::Google::Longrunning::Operation
42
+ # Registers an existing legacy notebook instance to the Notebooks API server.
43
+ # Legacy instances are instances created with the legacy Compute Engine
44
+ # calls. They are not manageable by the Notebooks API out of the box. This
45
+ # call makes these instances manageable by the Notebooks API.
46
+ rpc :RegisterInstance, ::Google::Cloud::Notebooks::V1::RegisterInstanceRequest, ::Google::Longrunning::Operation
47
+ # Updates the guest accelerators of a single Instance.
48
+ rpc :SetInstanceAccelerator, ::Google::Cloud::Notebooks::V1::SetInstanceAcceleratorRequest, ::Google::Longrunning::Operation
49
+ # Updates the machine type of a single Instance.
50
+ rpc :SetInstanceMachineType, ::Google::Cloud::Notebooks::V1::SetInstanceMachineTypeRequest, ::Google::Longrunning::Operation
51
+ # Update Notebook Instance configurations.
52
+ rpc :UpdateInstanceConfig, ::Google::Cloud::Notebooks::V1::UpdateInstanceConfigRequest, ::Google::Longrunning::Operation
53
+ # Updates the Shielded instance configuration of a single Instance.
54
+ rpc :UpdateShieldedInstanceConfig, ::Google::Cloud::Notebooks::V1::UpdateShieldedInstanceConfigRequest, ::Google::Longrunning::Operation
55
+ # Replaces all the labels of an Instance.
56
+ rpc :SetInstanceLabels, ::Google::Cloud::Notebooks::V1::SetInstanceLabelsRequest, ::Google::Longrunning::Operation
57
+ # Deletes a single Instance.
58
+ rpc :DeleteInstance, ::Google::Cloud::Notebooks::V1::DeleteInstanceRequest, ::Google::Longrunning::Operation
59
+ # Starts a notebook instance.
60
+ rpc :StartInstance, ::Google::Cloud::Notebooks::V1::StartInstanceRequest, ::Google::Longrunning::Operation
61
+ # Stops a notebook instance.
62
+ rpc :StopInstance, ::Google::Cloud::Notebooks::V1::StopInstanceRequest, ::Google::Longrunning::Operation
63
+ # Resets a notebook instance.
64
+ rpc :ResetInstance, ::Google::Cloud::Notebooks::V1::ResetInstanceRequest, ::Google::Longrunning::Operation
65
+ # Allows notebook instances to
66
+ # report their latest instance information to the Notebooks
67
+ # API server. The server will merge the reported information to
68
+ # the instance metadata store. Do not use this method directly.
69
+ rpc :ReportInstanceInfo, ::Google::Cloud::Notebooks::V1::ReportInstanceInfoRequest, ::Google::Longrunning::Operation
70
+ # Check if a notebook instance is upgradable.
71
+ rpc :IsInstanceUpgradeable, ::Google::Cloud::Notebooks::V1::IsInstanceUpgradeableRequest, ::Google::Cloud::Notebooks::V1::IsInstanceUpgradeableResponse
72
+ # Check if a notebook instance is healthy.
73
+ rpc :GetInstanceHealth, ::Google::Cloud::Notebooks::V1::GetInstanceHealthRequest, ::Google::Cloud::Notebooks::V1::GetInstanceHealthResponse
74
+ # Upgrades a notebook instance to the latest version.
75
+ rpc :UpgradeInstance, ::Google::Cloud::Notebooks::V1::UpgradeInstanceRequest, ::Google::Longrunning::Operation
76
+ # Rollbacks a notebook instance to the previous version.
77
+ rpc :RollbackInstance, ::Google::Cloud::Notebooks::V1::RollbackInstanceRequest, ::Google::Longrunning::Operation
78
+ # Allows notebook instances to
79
+ # call this endpoint to upgrade themselves. Do not use this method directly.
80
+ rpc :UpgradeInstanceInternal, ::Google::Cloud::Notebooks::V1::UpgradeInstanceInternalRequest, ::Google::Longrunning::Operation
81
+ # Lists environments in a project.
82
+ rpc :ListEnvironments, ::Google::Cloud::Notebooks::V1::ListEnvironmentsRequest, ::Google::Cloud::Notebooks::V1::ListEnvironmentsResponse
83
+ # Gets details of a single Environment.
84
+ rpc :GetEnvironment, ::Google::Cloud::Notebooks::V1::GetEnvironmentRequest, ::Google::Cloud::Notebooks::V1::Environment
85
+ # Creates a new Environment.
86
+ rpc :CreateEnvironment, ::Google::Cloud::Notebooks::V1::CreateEnvironmentRequest, ::Google::Longrunning::Operation
87
+ # Deletes a single Environment.
88
+ rpc :DeleteEnvironment, ::Google::Cloud::Notebooks::V1::DeleteEnvironmentRequest, ::Google::Longrunning::Operation
89
+ # Lists schedules in a given project and location.
90
+ rpc :ListSchedules, ::Google::Cloud::Notebooks::V1::ListSchedulesRequest, ::Google::Cloud::Notebooks::V1::ListSchedulesResponse
91
+ # Gets details of schedule
92
+ rpc :GetSchedule, ::Google::Cloud::Notebooks::V1::GetScheduleRequest, ::Google::Cloud::Notebooks::V1::Schedule
93
+ # Deletes schedule and all underlying jobs
94
+ rpc :DeleteSchedule, ::Google::Cloud::Notebooks::V1::DeleteScheduleRequest, ::Google::Longrunning::Operation
95
+ # Creates a new Scheduled Notebook in a given project and location.
96
+ rpc :CreateSchedule, ::Google::Cloud::Notebooks::V1::CreateScheduleRequest, ::Google::Longrunning::Operation
97
+ # Triggers execution of an existing schedule.
98
+ rpc :TriggerSchedule, ::Google::Cloud::Notebooks::V1::TriggerScheduleRequest, ::Google::Longrunning::Operation
99
+ # Lists executions in a given project and location
100
+ rpc :ListExecutions, ::Google::Cloud::Notebooks::V1::ListExecutionsRequest, ::Google::Cloud::Notebooks::V1::ListExecutionsResponse
101
+ # Gets details of executions
102
+ rpc :GetExecution, ::Google::Cloud::Notebooks::V1::GetExecutionRequest, ::Google::Cloud::Notebooks::V1::Execution
103
+ # Deletes execution
104
+ rpc :DeleteExecution, ::Google::Cloud::Notebooks::V1::DeleteExecutionRequest, ::Google::Longrunning::Operation
105
+ # Creates a new Scheduled Notebook in a given project and location.
106
+ rpc :CreateExecution, ::Google::Cloud::Notebooks::V1::CreateExecutionRequest, ::Google::Longrunning::Operation
107
+ end
108
+
109
+ Stub = Service.rpc_stub_class
110
+ end
111
+ end
112
+ end
113
+ end
114
+ end
@@ -0,0 +1,28 @@
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
+ VERSION = "0.1.0"
25
+ end
26
+ end
27
+ end
28
+ end
@@ -0,0 +1,41 @@
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
+ require "google/cloud/notebooks/v1/managed_notebook_service"
20
+ require "google/cloud/notebooks/v1/notebook_service"
21
+ require "google/cloud/notebooks/v1/version"
22
+
23
+ module Google
24
+ module Cloud
25
+ module Notebooks
26
+ ##
27
+ # To load this package, including all its services, and instantiate a client:
28
+ #
29
+ # @example
30
+ #
31
+ # require "google/cloud/notebooks/v1"
32
+ # client = ::Google::Cloud::Notebooks::V1::ManagedNotebookService::Client.new
33
+ #
34
+ module V1
35
+ end
36
+ end
37
+ end
38
+ end
39
+
40
+ helper_path = ::File.join __dir__, "v1", "_helpers.rb"
41
+ require "google/cloud/notebooks/v1/_helpers" if ::File.file? helper_path
@@ -0,0 +1,21 @@
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
+ # This gem does not autoload during Bundler.require. To load this gem,
20
+ # issue explicit require statements for the packages desired, e.g.:
21
+ # require "google/cloud/notebooks/v1"
@@ -0,0 +1,4 @@
1
+ # AI Platform Notebooks V1 Protocol Buffer Documentation
2
+
3
+ These files are for the YARD documentation of the generated protobuf files.
4
+ They are not intended to be required or loaded at runtime.
@@ -0,0 +1,71 @@
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 Api
22
+ # An indicator of the behavior of a given field (for example, that a field
23
+ # is required in requests, or given as output but ignored as input).
24
+ # This **does not** change the behavior in protocol buffers itself; it only
25
+ # denotes the behavior and may affect how API tooling handles the field.
26
+ #
27
+ # Note: This enum **may** receive new values in the future.
28
+ module FieldBehavior
29
+ # Conventional default for enums. Do not use this.
30
+ FIELD_BEHAVIOR_UNSPECIFIED = 0
31
+
32
+ # Specifically denotes a field as optional.
33
+ # While all fields in protocol buffers are optional, this may be specified
34
+ # for emphasis if appropriate.
35
+ OPTIONAL = 1
36
+
37
+ # Denotes a field as required.
38
+ # This indicates that the field **must** be provided as part of the request,
39
+ # and failure to do so will cause an error (usually `INVALID_ARGUMENT`).
40
+ REQUIRED = 2
41
+
42
+ # Denotes a field as output only.
43
+ # This indicates that the field is provided in responses, but including the
44
+ # field in a request does nothing (the server *must* ignore it and
45
+ # *must not* throw an error as a result of the field's presence).
46
+ OUTPUT_ONLY = 3
47
+
48
+ # Denotes a field as input only.
49
+ # This indicates that the field is provided in requests, and the
50
+ # corresponding field is not included in output.
51
+ INPUT_ONLY = 4
52
+
53
+ # Denotes a field as immutable.
54
+ # This indicates that the field may be set once in a request to create a
55
+ # resource, but may not be changed thereafter.
56
+ IMMUTABLE = 5
57
+
58
+ # Denotes that a (repeated) field is an unordered list.
59
+ # This indicates that the service may provide the elements of the list
60
+ # in any arbitrary order, rather than the order the user originally
61
+ # provided. Additionally, the list's order may or may not be stable.
62
+ UNORDERED_LIST = 6
63
+
64
+ # Denotes that this field returns a non-empty default value if not set.
65
+ # This indicates that if the user provides the empty value in a request,
66
+ # a non-empty value will be returned. The user will not be aware of what
67
+ # non-empty value to expect.
68
+ NON_EMPTY_DEFAULT = 7
69
+ end
70
+ end
71
+ end
@@ -0,0 +1,222 @@
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 Api
22
+ # A simple descriptor of a resource type.
23
+ #
24
+ # ResourceDescriptor annotates a resource message (either by means of a
25
+ # protobuf annotation or use in the service config), and associates the
26
+ # resource's schema, the resource type, and the pattern of the resource name.
27
+ #
28
+ # Example:
29
+ #
30
+ # message Topic {
31
+ # // Indicates this message defines a resource schema.
32
+ # // Declares the resource type in the format of {service}/{kind}.
33
+ # // For Kubernetes resources, the format is {api group}/{kind}.
34
+ # option (google.api.resource) = {
35
+ # type: "pubsub.googleapis.com/Topic"
36
+ # pattern: "projects/{project}/topics/{topic}"
37
+ # };
38
+ # }
39
+ #
40
+ # The ResourceDescriptor Yaml config will look like:
41
+ #
42
+ # resources:
43
+ # - type: "pubsub.googleapis.com/Topic"
44
+ # pattern: "projects/{project}/topics/{topic}"
45
+ #
46
+ # Sometimes, resources have multiple patterns, typically because they can
47
+ # live under multiple parents.
48
+ #
49
+ # Example:
50
+ #
51
+ # message LogEntry {
52
+ # option (google.api.resource) = {
53
+ # type: "logging.googleapis.com/LogEntry"
54
+ # pattern: "projects/{project}/logs/{log}"
55
+ # pattern: "folders/{folder}/logs/{log}"
56
+ # pattern: "organizations/{organization}/logs/{log}"
57
+ # pattern: "billingAccounts/{billing_account}/logs/{log}"
58
+ # };
59
+ # }
60
+ #
61
+ # The ResourceDescriptor Yaml config will look like:
62
+ #
63
+ # resources:
64
+ # - type: 'logging.googleapis.com/LogEntry'
65
+ # pattern: "projects/{project}/logs/{log}"
66
+ # pattern: "folders/{folder}/logs/{log}"
67
+ # pattern: "organizations/{organization}/logs/{log}"
68
+ # pattern: "billingAccounts/{billing_account}/logs/{log}"
69
+ # @!attribute [rw] type
70
+ # @return [::String]
71
+ # The resource type. It must be in the format of
72
+ # \\{service_name}/\\{resource_type_kind}. The `resource_type_kind` must be
73
+ # singular and must not include version numbers.
74
+ #
75
+ # Example: `storage.googleapis.com/Bucket`
76
+ #
77
+ # The value of the resource_type_kind must follow the regular expression
78
+ # /[A-Za-z][a-zA-Z0-9]+/. It should start with an upper case character and
79
+ # should use PascalCase (UpperCamelCase). The maximum number of
80
+ # characters allowed for the `resource_type_kind` is 100.
81
+ # @!attribute [rw] pattern
82
+ # @return [::Array<::String>]
83
+ # Optional. The relative resource name pattern associated with this resource
84
+ # type. The DNS prefix of the full resource name shouldn't be specified here.
85
+ #
86
+ # The path pattern must follow the syntax, which aligns with HTTP binding
87
+ # syntax:
88
+ #
89
+ # Template = Segment { "/" Segment } ;
90
+ # Segment = LITERAL | Variable ;
91
+ # Variable = "{" LITERAL "}" ;
92
+ #
93
+ # Examples:
94
+ #
95
+ # - "projects/\\{project}/topics/\\{topic}"
96
+ # - "projects/\\{project}/knowledgeBases/\\{knowledge_base}"
97
+ #
98
+ # The components in braces correspond to the IDs for each resource in the
99
+ # hierarchy. It is expected that, if multiple patterns are provided,
100
+ # the same component name (e.g. "project") refers to IDs of the same
101
+ # type of resource.
102
+ # @!attribute [rw] name_field
103
+ # @return [::String]
104
+ # Optional. The field on the resource that designates the resource name
105
+ # field. If omitted, this is assumed to be "name".
106
+ # @!attribute [rw] history
107
+ # @return [::Google::Api::ResourceDescriptor::History]
108
+ # Optional. The historical or future-looking state of the resource pattern.
109
+ #
110
+ # Example:
111
+ #
112
+ # // The InspectTemplate message originally only supported resource
113
+ # // names with organization, and project was added later.
114
+ # message InspectTemplate {
115
+ # option (google.api.resource) = {
116
+ # type: "dlp.googleapis.com/InspectTemplate"
117
+ # pattern:
118
+ # "organizations/{organization}/inspectTemplates/{inspect_template}"
119
+ # pattern: "projects/{project}/inspectTemplates/{inspect_template}"
120
+ # history: ORIGINALLY_SINGLE_PATTERN
121
+ # };
122
+ # }
123
+ # @!attribute [rw] plural
124
+ # @return [::String]
125
+ # The plural name used in the resource name and permission names, such as
126
+ # 'projects' for the resource name of 'projects/\\{project}' and the permission
127
+ # name of 'cloudresourcemanager.googleapis.com/projects.get'. It is the same
128
+ # concept of the `plural` field in k8s CRD spec
129
+ # https://kubernetes.io/docs/tasks/access-kubernetes-api/custom-resources/custom-resource-definitions/
130
+ #
131
+ # Note: The plural form is required even for singleton resources. See
132
+ # https://aip.dev/156
133
+ # @!attribute [rw] singular
134
+ # @return [::String]
135
+ # The same concept of the `singular` field in k8s CRD spec
136
+ # https://kubernetes.io/docs/tasks/access-kubernetes-api/custom-resources/custom-resource-definitions/
137
+ # Such as "project" for the `resourcemanager.googleapis.com/Project` type.
138
+ # @!attribute [rw] style
139
+ # @return [::Array<::Google::Api::ResourceDescriptor::Style>]
140
+ # Style flag(s) for this resource.
141
+ # These indicate that a resource is expected to conform to a given
142
+ # style. See the specific style flags for additional information.
143
+ class ResourceDescriptor
144
+ include ::Google::Protobuf::MessageExts
145
+ extend ::Google::Protobuf::MessageExts::ClassMethods
146
+
147
+ # A description of the historical or future-looking state of the
148
+ # resource pattern.
149
+ module History
150
+ # The "unset" value.
151
+ HISTORY_UNSPECIFIED = 0
152
+
153
+ # The resource originally had one pattern and launched as such, and
154
+ # additional patterns were added later.
155
+ ORIGINALLY_SINGLE_PATTERN = 1
156
+
157
+ # The resource has one pattern, but the API owner expects to add more
158
+ # later. (This is the inverse of ORIGINALLY_SINGLE_PATTERN, and prevents
159
+ # that from being necessary once there are multiple patterns.)
160
+ FUTURE_MULTI_PATTERN = 2
161
+ end
162
+
163
+ # A flag representing a specific style that a resource claims to conform to.
164
+ module Style
165
+ # The unspecified value. Do not use.
166
+ STYLE_UNSPECIFIED = 0
167
+
168
+ # This resource is intended to be "declarative-friendly".
169
+ #
170
+ # Declarative-friendly resources must be more strictly consistent, and
171
+ # setting this to true communicates to tools that this resource should
172
+ # adhere to declarative-friendly expectations.
173
+ #
174
+ # Note: This is used by the API linter (linter.aip.dev) to enable
175
+ # additional checks.
176
+ DECLARATIVE_FRIENDLY = 1
177
+ end
178
+ end
179
+
180
+ # Defines a proto annotation that describes a string field that refers to
181
+ # an API resource.
182
+ # @!attribute [rw] type
183
+ # @return [::String]
184
+ # The resource type that the annotated field references.
185
+ #
186
+ # Example:
187
+ #
188
+ # message Subscription {
189
+ # string topic = 2 [(google.api.resource_reference) = {
190
+ # type: "pubsub.googleapis.com/Topic"
191
+ # }];
192
+ # }
193
+ #
194
+ # Occasionally, a field may reference an arbitrary resource. In this case,
195
+ # APIs use the special value * in their resource reference.
196
+ #
197
+ # Example:
198
+ #
199
+ # message GetIamPolicyRequest {
200
+ # string resource = 2 [(google.api.resource_reference) = {
201
+ # type: "*"
202
+ # }];
203
+ # }
204
+ # @!attribute [rw] child_type
205
+ # @return [::String]
206
+ # The resource type of a child collection that the annotated field
207
+ # references. This is useful for annotating the `parent` field that
208
+ # doesn't have a fixed resource type.
209
+ #
210
+ # Example:
211
+ #
212
+ # message ListLogEntriesRequest {
213
+ # string parent = 1 [(google.api.resource_reference) = {
214
+ # child_type: "logging.googleapis.com/LogEntry"
215
+ # };
216
+ # }
217
+ class ResourceReference
218
+ include ::Google::Protobuf::MessageExts
219
+ extend ::Google::Protobuf::MessageExts::ClassMethods
220
+ end
221
+ end
222
+ end
@@ -0,0 +1,91 @@
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
+ # Definition of a software environment that is used to start a notebook
25
+ # instance.
26
+ # @!attribute [r] name
27
+ # @return [::String]
28
+ # Output only. Name of this environment.
29
+ # Format:
30
+ # `projects/{project_id}/locations/{location}/environments/{environment_id}`
31
+ # @!attribute [rw] display_name
32
+ # @return [::String]
33
+ # Display name of this environment for the UI.
34
+ # @!attribute [rw] description
35
+ # @return [::String]
36
+ # A brief description of this environment.
37
+ # @!attribute [rw] vm_image
38
+ # @return [::Google::Cloud::Notebooks::V1::VmImage]
39
+ # Use a Compute Engine VM image to start the notebook instance.
40
+ # @!attribute [rw] container_image
41
+ # @return [::Google::Cloud::Notebooks::V1::ContainerImage]
42
+ # Use a container image to start the notebook instance.
43
+ # @!attribute [rw] post_startup_script
44
+ # @return [::String]
45
+ # Path to a Bash script that automatically runs after a notebook instance
46
+ # fully boots up. The path must be a URL or
47
+ # Cloud Storage path. Example: `"gs://path-to-file/file-name"`
48
+ # @!attribute [r] create_time
49
+ # @return [::Google::Protobuf::Timestamp]
50
+ # Output only. The time at which this environment was created.
51
+ class Environment
52
+ include ::Google::Protobuf::MessageExts
53
+ extend ::Google::Protobuf::MessageExts::ClassMethods
54
+ end
55
+
56
+ # Definition of a custom Compute Engine virtual machine image for starting a
57
+ # notebook instance with the environment installed directly on the VM.
58
+ # @!attribute [rw] project
59
+ # @return [::String]
60
+ # Required. The name of the Google Cloud project that this VM image belongs to.
61
+ # Format: `projects/{project_id}`
62
+ # @!attribute [rw] image_name
63
+ # @return [::String]
64
+ # Use VM image name to find the image.
65
+ # @!attribute [rw] image_family
66
+ # @return [::String]
67
+ # Use this VM image family to find the image; the newest image in this
68
+ # family will be used.
69
+ class VmImage
70
+ include ::Google::Protobuf::MessageExts
71
+ extend ::Google::Protobuf::MessageExts::ClassMethods
72
+ end
73
+
74
+ # Definition of a container image for starting a notebook instance with the
75
+ # environment installed in a container.
76
+ # @!attribute [rw] repository
77
+ # @return [::String]
78
+ # Required. The path to the container image repository. For example:
79
+ # `gcr.io/{project_id}/{image_name}`
80
+ # @!attribute [rw] tag
81
+ # @return [::String]
82
+ # The tag of the container image. If not specified, this defaults
83
+ # to the latest tag.
84
+ class ContainerImage
85
+ include ::Google::Protobuf::MessageExts
86
+ extend ::Google::Protobuf::MessageExts::ClassMethods
87
+ end
88
+ end
89
+ end
90
+ end
91
+ end
@@ -0,0 +1,47 @@
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
+ # The definition of an Event for a managed / semi-managed notebook instance.
25
+ # @!attribute [rw] report_time
26
+ # @return [::Google::Protobuf::Timestamp]
27
+ # Event report time.
28
+ # @!attribute [rw] type
29
+ # @return [::Google::Cloud::Notebooks::V1::Event::EventType]
30
+ # Event type.
31
+ class Event
32
+ include ::Google::Protobuf::MessageExts
33
+ extend ::Google::Protobuf::MessageExts::ClassMethods
34
+
35
+ # The definition of the even types.
36
+ module EventType
37
+ # Event is not specified.
38
+ EVENT_TYPE_UNSPECIFIED = 0
39
+
40
+ # The instance / runtime is idle
41
+ IDLE = 1
42
+ end
43
+ end
44
+ end
45
+ end
46
+ end
47
+ end