google-cloud-notebooks-v2 0.a → 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 +4 -4
- data/.yardopts +12 -0
- data/AUTHENTICATION.md +149 -0
- data/README.md +144 -8
- data/lib/google/cloud/notebooks/v2/bindings_override.rb +135 -0
- data/lib/google/cloud/notebooks/v2/diagnostic_config_pb.rb +44 -0
- data/lib/google/cloud/notebooks/v2/event_pb.rb +47 -0
- data/lib/google/cloud/notebooks/v2/gce_setup_pb.rb +57 -0
- data/lib/google/cloud/notebooks/v2/instance_pb.rb +54 -0
- data/lib/google/cloud/notebooks/v2/notebook_service/client.rb +1582 -0
- data/lib/google/cloud/notebooks/v2/notebook_service/credentials.rb +47 -0
- data/lib/google/cloud/notebooks/v2/notebook_service/operations.rb +770 -0
- data/lib/google/cloud/notebooks/v2/notebook_service/paths.rb +69 -0
- data/lib/google/cloud/notebooks/v2/notebook_service/rest/client.rb +1227 -0
- data/lib/google/cloud/notebooks/v2/notebook_service/rest/operations.rb +795 -0
- data/lib/google/cloud/notebooks/v2/notebook_service/rest/service_stub.rb +764 -0
- data/lib/google/cloud/notebooks/v2/notebook_service/rest.rb +54 -0
- data/lib/google/cloud/notebooks/v2/notebook_service.rb +56 -0
- data/lib/google/cloud/notebooks/v2/rest.rb +38 -0
- data/lib/google/cloud/notebooks/v2/service_pb.rb +71 -0
- data/lib/google/cloud/notebooks/v2/service_services_pb.rb +67 -0
- data/lib/google/cloud/notebooks/v2/version.rb +7 -2
- data/lib/google/cloud/notebooks/v2.rb +45 -0
- data/lib/google-cloud-notebooks-v2.rb +21 -0
- data/proto_docs/README.md +4 -0
- data/proto_docs/google/api/client.rb +381 -0
- data/proto_docs/google/api/field_behavior.rb +85 -0
- data/proto_docs/google/api/launch_stage.rb +71 -0
- data/proto_docs/google/api/resource.rb +222 -0
- data/proto_docs/google/cloud/notebooks/v2/diagnostic_config.rb +63 -0
- data/proto_docs/google/cloud/notebooks/v2/event.rb +79 -0
- data/proto_docs/google/cloud/notebooks/v2/gce_setup.rb +352 -0
- data/proto_docs/google/cloud/notebooks/v2/instance.rb +233 -0
- data/proto_docs/google/cloud/notebooks/v2/service.rb +263 -0
- data/proto_docs/google/longrunning/operations.rb +164 -0
- data/proto_docs/google/protobuf/any.rb +144 -0
- data/proto_docs/google/protobuf/duration.rb +98 -0
- data/proto_docs/google/protobuf/empty.rb +34 -0
- data/proto_docs/google/protobuf/field_mask.rb +229 -0
- data/proto_docs/google/protobuf/timestamp.rb +127 -0
- data/proto_docs/google/rpc/status.rb +48 -0
- data/proto_docs/google/type/expr.rb +75 -0
- metadata +237 -13
@@ -0,0 +1,263 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
# Copyright 2023 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 V2
|
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
|
46
|
+
# `Code.CANCELLED`.
|
47
|
+
# @!attribute [rw] api_version
|
48
|
+
# @return [::String]
|
49
|
+
# API version used to start the operation.
|
50
|
+
# @!attribute [rw] endpoint
|
51
|
+
# @return [::String]
|
52
|
+
# API endpoint name of this operation.
|
53
|
+
class OperationMetadata
|
54
|
+
include ::Google::Protobuf::MessageExts
|
55
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
56
|
+
end
|
57
|
+
|
58
|
+
# Request for listing notebook instances.
|
59
|
+
# @!attribute [rw] parent
|
60
|
+
# @return [::String]
|
61
|
+
# Required. Format:
|
62
|
+
# `parent=projects/{project_id}/locations/{location}`
|
63
|
+
# @!attribute [rw] page_size
|
64
|
+
# @return [::Integer]
|
65
|
+
# Optional. Maximum return size of the list call.
|
66
|
+
# @!attribute [rw] page_token
|
67
|
+
# @return [::String]
|
68
|
+
# Optional. A previous returned page token that can be used to continue
|
69
|
+
# listing from the last result.
|
70
|
+
# @!attribute [rw] order_by
|
71
|
+
# @return [::String]
|
72
|
+
# Optional. Sort results. Supported values are "name", "name desc" or ""
|
73
|
+
# (unsorted).
|
74
|
+
# @!attribute [rw] filter
|
75
|
+
# @return [::String]
|
76
|
+
# Optional. List filter.
|
77
|
+
class ListInstancesRequest
|
78
|
+
include ::Google::Protobuf::MessageExts
|
79
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
80
|
+
end
|
81
|
+
|
82
|
+
# Response for listing notebook instances.
|
83
|
+
# @!attribute [rw] instances
|
84
|
+
# @return [::Array<::Google::Cloud::Notebooks::V2::Instance>]
|
85
|
+
# A list of returned instances.
|
86
|
+
# @!attribute [rw] next_page_token
|
87
|
+
# @return [::String]
|
88
|
+
# Page token that can be used to continue listing from the last result in the
|
89
|
+
# next list call.
|
90
|
+
# @!attribute [rw] unreachable
|
91
|
+
# @return [::Array<::String>]
|
92
|
+
# Locations that could not be reached. For example,
|
93
|
+
# ['us-west1-a', 'us-central1-b'].
|
94
|
+
# A ListInstancesResponse will only contain either instances or unreachables,
|
95
|
+
class ListInstancesResponse
|
96
|
+
include ::Google::Protobuf::MessageExts
|
97
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
98
|
+
end
|
99
|
+
|
100
|
+
# Request for getting a notebook instance.
|
101
|
+
# @!attribute [rw] name
|
102
|
+
# @return [::String]
|
103
|
+
# Required. Format:
|
104
|
+
# `projects/{project_id}/locations/{location}/instances/{instance_id}`
|
105
|
+
class GetInstanceRequest
|
106
|
+
include ::Google::Protobuf::MessageExts
|
107
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
108
|
+
end
|
109
|
+
|
110
|
+
# Request for creating a notebook instance.
|
111
|
+
# @!attribute [rw] parent
|
112
|
+
# @return [::String]
|
113
|
+
# Required. Format:
|
114
|
+
# `parent=projects/{project_id}/locations/{location}`
|
115
|
+
# @!attribute [rw] instance_id
|
116
|
+
# @return [::String]
|
117
|
+
# Required. User-defined unique ID of this instance.
|
118
|
+
# @!attribute [rw] instance
|
119
|
+
# @return [::Google::Cloud::Notebooks::V2::Instance]
|
120
|
+
# Required. The instance to be created.
|
121
|
+
# @!attribute [rw] request_id
|
122
|
+
# @return [::String]
|
123
|
+
# Optional. Idempotent request UUID.
|
124
|
+
class CreateInstanceRequest
|
125
|
+
include ::Google::Protobuf::MessageExts
|
126
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
127
|
+
end
|
128
|
+
|
129
|
+
# Request for updating a notebook instance.
|
130
|
+
# @!attribute [rw] instance
|
131
|
+
# @return [::Google::Cloud::Notebooks::V2::Instance]
|
132
|
+
# Required. A representation of an instance.
|
133
|
+
# @!attribute [rw] update_mask
|
134
|
+
# @return [::Google::Protobuf::FieldMask]
|
135
|
+
# Required. Mask used to update an instance
|
136
|
+
# @!attribute [rw] request_id
|
137
|
+
# @return [::String]
|
138
|
+
# Optional. Idempotent request UUID.
|
139
|
+
class UpdateInstanceRequest
|
140
|
+
include ::Google::Protobuf::MessageExts
|
141
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
142
|
+
end
|
143
|
+
|
144
|
+
# Request for deleting a notebook instance.
|
145
|
+
# @!attribute [rw] name
|
146
|
+
# @return [::String]
|
147
|
+
# Required. Format:
|
148
|
+
# `projects/{project_id}/locations/{location}/instances/{instance_id}`
|
149
|
+
# @!attribute [rw] request_id
|
150
|
+
# @return [::String]
|
151
|
+
# Optional. Idempotent request UUID.
|
152
|
+
class DeleteInstanceRequest
|
153
|
+
include ::Google::Protobuf::MessageExts
|
154
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
155
|
+
end
|
156
|
+
|
157
|
+
# Request for starting a notebook instance
|
158
|
+
# @!attribute [rw] name
|
159
|
+
# @return [::String]
|
160
|
+
# Required. Format:
|
161
|
+
# `projects/{project_id}/locations/{location}/instances/{instance_id}`
|
162
|
+
class StartInstanceRequest
|
163
|
+
include ::Google::Protobuf::MessageExts
|
164
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
165
|
+
end
|
166
|
+
|
167
|
+
# Request for stopping a notebook instance
|
168
|
+
# @!attribute [rw] name
|
169
|
+
# @return [::String]
|
170
|
+
# Required. Format:
|
171
|
+
# `projects/{project_id}/locations/{location}/instances/{instance_id}`
|
172
|
+
class StopInstanceRequest
|
173
|
+
include ::Google::Protobuf::MessageExts
|
174
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
175
|
+
end
|
176
|
+
|
177
|
+
# Request for resetting a notebook instance
|
178
|
+
# @!attribute [rw] name
|
179
|
+
# @return [::String]
|
180
|
+
# Required. Format:
|
181
|
+
# `projects/{project_id}/locations/{location}/instances/{instance_id}`
|
182
|
+
class ResetInstanceRequest
|
183
|
+
include ::Google::Protobuf::MessageExts
|
184
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
185
|
+
end
|
186
|
+
|
187
|
+
# Request for checking if a notebook instance is upgradeable.
|
188
|
+
# @!attribute [rw] notebook_instance
|
189
|
+
# @return [::String]
|
190
|
+
# Required. Format:
|
191
|
+
# `projects/{project_id}/locations/{location}/instances/{instance_id}`
|
192
|
+
class CheckInstanceUpgradabilityRequest
|
193
|
+
include ::Google::Protobuf::MessageExts
|
194
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
195
|
+
end
|
196
|
+
|
197
|
+
# Response for checking if a notebook instance is upgradeable.
|
198
|
+
# @!attribute [rw] upgradeable
|
199
|
+
# @return [::Boolean]
|
200
|
+
# If an instance is upgradeable.
|
201
|
+
# @!attribute [rw] upgrade_version
|
202
|
+
# @return [::String]
|
203
|
+
# The version this instance will be upgraded to if calling the upgrade
|
204
|
+
# endpoint. This field will only be populated if field upgradeable is true.
|
205
|
+
# @!attribute [rw] upgrade_info
|
206
|
+
# @return [::String]
|
207
|
+
# Additional information about upgrade.
|
208
|
+
# @!attribute [rw] upgrade_image
|
209
|
+
# @return [::String]
|
210
|
+
# The new image self link this instance will be upgraded to if calling the
|
211
|
+
# upgrade endpoint. This field will only be populated if field upgradeable
|
212
|
+
# is true.
|
213
|
+
class CheckInstanceUpgradabilityResponse
|
214
|
+
include ::Google::Protobuf::MessageExts
|
215
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
216
|
+
end
|
217
|
+
|
218
|
+
# Request for upgrading a notebook instance
|
219
|
+
# @!attribute [rw] name
|
220
|
+
# @return [::String]
|
221
|
+
# Required. Format:
|
222
|
+
# `projects/{project_id}/locations/{location}/instances/{instance_id}`
|
223
|
+
class UpgradeInstanceRequest
|
224
|
+
include ::Google::Protobuf::MessageExts
|
225
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
226
|
+
end
|
227
|
+
|
228
|
+
# Request for rollbacking a notebook instance
|
229
|
+
# @!attribute [rw] name
|
230
|
+
# @return [::String]
|
231
|
+
# Required. Format:
|
232
|
+
# `projects/{project_id}/locations/{location}/instances/{instance_id}`
|
233
|
+
# @!attribute [rw] target_snapshot
|
234
|
+
# @return [::String]
|
235
|
+
# Required. The snapshot for rollback.
|
236
|
+
# Example: "projects/test-project/global/snapshots/krwlzipynril".
|
237
|
+
# @!attribute [r] revision_id
|
238
|
+
# @return [::String]
|
239
|
+
# Required. Output only. Revision Id
|
240
|
+
class RollbackInstanceRequest
|
241
|
+
include ::Google::Protobuf::MessageExts
|
242
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
243
|
+
end
|
244
|
+
|
245
|
+
# Request for creating a notebook instance diagnostic file.
|
246
|
+
# @!attribute [rw] name
|
247
|
+
# @return [::String]
|
248
|
+
# Required. Format:
|
249
|
+
# `projects/{project_id}/locations/{location}/instances/{instance_id}`
|
250
|
+
# @!attribute [rw] diagnostic_config
|
251
|
+
# @return [::Google::Cloud::Notebooks::V2::DiagnosticConfig]
|
252
|
+
# Required. Defines flags that are used to run the diagnostic tool
|
253
|
+
# @!attribute [rw] timeout_minutes
|
254
|
+
# @return [::Integer]
|
255
|
+
# Optional. Maxmium amount of time in minutes before the operation times out.
|
256
|
+
class DiagnoseInstanceRequest
|
257
|
+
include ::Google::Protobuf::MessageExts
|
258
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
259
|
+
end
|
260
|
+
end
|
261
|
+
end
|
262
|
+
end
|
263
|
+
end
|
@@ -0,0 +1,164 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
# Copyright 2023 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 Longrunning
|
22
|
+
# This resource represents a long-running operation that is the result of a
|
23
|
+
# network API call.
|
24
|
+
# @!attribute [rw] name
|
25
|
+
# @return [::String]
|
26
|
+
# The server-assigned name, which is only unique within the same service that
|
27
|
+
# originally returns it. If you use the default HTTP mapping, the
|
28
|
+
# `name` should be a resource name ending with `operations/{unique_id}`.
|
29
|
+
# @!attribute [rw] metadata
|
30
|
+
# @return [::Google::Protobuf::Any]
|
31
|
+
# Service-specific metadata associated with the operation. It typically
|
32
|
+
# contains progress information and common metadata such as create time.
|
33
|
+
# Some services might not provide such metadata. Any method that returns a
|
34
|
+
# long-running operation should document the metadata type, if any.
|
35
|
+
# @!attribute [rw] done
|
36
|
+
# @return [::Boolean]
|
37
|
+
# If the value is `false`, it means the operation is still in progress.
|
38
|
+
# If `true`, the operation is completed, and either `error` or `response` is
|
39
|
+
# available.
|
40
|
+
# @!attribute [rw] error
|
41
|
+
# @return [::Google::Rpc::Status]
|
42
|
+
# The error result of the operation in case of failure or cancellation.
|
43
|
+
# @!attribute [rw] response
|
44
|
+
# @return [::Google::Protobuf::Any]
|
45
|
+
# The normal response of the operation in case of success. If the original
|
46
|
+
# method returns no data on success, such as `Delete`, the response is
|
47
|
+
# `google.protobuf.Empty`. If the original method is standard
|
48
|
+
# `Get`/`Create`/`Update`, the response should be the resource. For other
|
49
|
+
# methods, the response should have the type `XxxResponse`, where `Xxx`
|
50
|
+
# is the original method name. For example, if the original method name
|
51
|
+
# is `TakeSnapshot()`, the inferred response type is
|
52
|
+
# `TakeSnapshotResponse`.
|
53
|
+
class Operation
|
54
|
+
include ::Google::Protobuf::MessageExts
|
55
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
56
|
+
end
|
57
|
+
|
58
|
+
# The request message for Operations.GetOperation.
|
59
|
+
# @!attribute [rw] name
|
60
|
+
# @return [::String]
|
61
|
+
# The name of the operation resource.
|
62
|
+
class GetOperationRequest
|
63
|
+
include ::Google::Protobuf::MessageExts
|
64
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
65
|
+
end
|
66
|
+
|
67
|
+
# The request message for Operations.ListOperations.
|
68
|
+
# @!attribute [rw] name
|
69
|
+
# @return [::String]
|
70
|
+
# The name of the operation's parent resource.
|
71
|
+
# @!attribute [rw] filter
|
72
|
+
# @return [::String]
|
73
|
+
# The standard list filter.
|
74
|
+
# @!attribute [rw] page_size
|
75
|
+
# @return [::Integer]
|
76
|
+
# The standard list page size.
|
77
|
+
# @!attribute [rw] page_token
|
78
|
+
# @return [::String]
|
79
|
+
# The standard list page token.
|
80
|
+
class ListOperationsRequest
|
81
|
+
include ::Google::Protobuf::MessageExts
|
82
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
83
|
+
end
|
84
|
+
|
85
|
+
# The response message for Operations.ListOperations.
|
86
|
+
# @!attribute [rw] operations
|
87
|
+
# @return [::Array<::Google::Longrunning::Operation>]
|
88
|
+
# A list of operations that matches the specified filter in the request.
|
89
|
+
# @!attribute [rw] next_page_token
|
90
|
+
# @return [::String]
|
91
|
+
# The standard List next-page token.
|
92
|
+
class ListOperationsResponse
|
93
|
+
include ::Google::Protobuf::MessageExts
|
94
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
95
|
+
end
|
96
|
+
|
97
|
+
# The request message for Operations.CancelOperation.
|
98
|
+
# @!attribute [rw] name
|
99
|
+
# @return [::String]
|
100
|
+
# The name of the operation resource to be cancelled.
|
101
|
+
class CancelOperationRequest
|
102
|
+
include ::Google::Protobuf::MessageExts
|
103
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
104
|
+
end
|
105
|
+
|
106
|
+
# The request message for Operations.DeleteOperation.
|
107
|
+
# @!attribute [rw] name
|
108
|
+
# @return [::String]
|
109
|
+
# The name of the operation resource to be deleted.
|
110
|
+
class DeleteOperationRequest
|
111
|
+
include ::Google::Protobuf::MessageExts
|
112
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
113
|
+
end
|
114
|
+
|
115
|
+
# The request message for Operations.WaitOperation.
|
116
|
+
# @!attribute [rw] name
|
117
|
+
# @return [::String]
|
118
|
+
# The name of the operation resource to wait on.
|
119
|
+
# @!attribute [rw] timeout
|
120
|
+
# @return [::Google::Protobuf::Duration]
|
121
|
+
# The maximum duration to wait before timing out. If left blank, the wait
|
122
|
+
# will be at most the time permitted by the underlying HTTP/RPC protocol.
|
123
|
+
# If RPC context deadline is also specified, the shorter one will be used.
|
124
|
+
class WaitOperationRequest
|
125
|
+
include ::Google::Protobuf::MessageExts
|
126
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
127
|
+
end
|
128
|
+
|
129
|
+
# A message representing the message types used by a long-running operation.
|
130
|
+
#
|
131
|
+
# Example:
|
132
|
+
#
|
133
|
+
# rpc LongRunningRecognize(LongRunningRecognizeRequest)
|
134
|
+
# returns (google.longrunning.Operation) {
|
135
|
+
# option (google.longrunning.operation_info) = {
|
136
|
+
# response_type: "LongRunningRecognizeResponse"
|
137
|
+
# metadata_type: "LongRunningRecognizeMetadata"
|
138
|
+
# };
|
139
|
+
# }
|
140
|
+
# @!attribute [rw] response_type
|
141
|
+
# @return [::String]
|
142
|
+
# Required. The message name of the primary return type for this
|
143
|
+
# long-running operation.
|
144
|
+
# This type will be used to deserialize the LRO's response.
|
145
|
+
#
|
146
|
+
# If the response is in a different package from the rpc, a fully-qualified
|
147
|
+
# message name must be used (e.g. `google.protobuf.Struct`).
|
148
|
+
#
|
149
|
+
# Note: Altering this value constitutes a breaking change.
|
150
|
+
# @!attribute [rw] metadata_type
|
151
|
+
# @return [::String]
|
152
|
+
# Required. The message name of the metadata type for this long-running
|
153
|
+
# operation.
|
154
|
+
#
|
155
|
+
# If the response is in a different package from the rpc, a fully-qualified
|
156
|
+
# message name must be used (e.g. `google.protobuf.Struct`).
|
157
|
+
#
|
158
|
+
# Note: Altering this value constitutes a breaking change.
|
159
|
+
class OperationInfo
|
160
|
+
include ::Google::Protobuf::MessageExts
|
161
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
162
|
+
end
|
163
|
+
end
|
164
|
+
end
|
@@ -0,0 +1,144 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
# Copyright 2023 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 Protobuf
|
22
|
+
# `Any` contains an arbitrary serialized protocol buffer message along with a
|
23
|
+
# URL that describes the type of the serialized message.
|
24
|
+
#
|
25
|
+
# Protobuf library provides support to pack/unpack Any values in the form
|
26
|
+
# of utility functions or additional generated methods of the Any type.
|
27
|
+
#
|
28
|
+
# Example 1: Pack and unpack a message in C++.
|
29
|
+
#
|
30
|
+
# Foo foo = ...;
|
31
|
+
# Any any;
|
32
|
+
# any.PackFrom(foo);
|
33
|
+
# ...
|
34
|
+
# if (any.UnpackTo(&foo)) {
|
35
|
+
# ...
|
36
|
+
# }
|
37
|
+
#
|
38
|
+
# Example 2: Pack and unpack a message in Java.
|
39
|
+
#
|
40
|
+
# Foo foo = ...;
|
41
|
+
# Any any = Any.pack(foo);
|
42
|
+
# ...
|
43
|
+
# if (any.is(Foo.class)) {
|
44
|
+
# foo = any.unpack(Foo.class);
|
45
|
+
# }
|
46
|
+
# // or ...
|
47
|
+
# if (any.isSameTypeAs(Foo.getDefaultInstance())) {
|
48
|
+
# foo = any.unpack(Foo.getDefaultInstance());
|
49
|
+
# }
|
50
|
+
#
|
51
|
+
# Example 3: Pack and unpack a message in Python.
|
52
|
+
#
|
53
|
+
# foo = Foo(...)
|
54
|
+
# any = Any()
|
55
|
+
# any.Pack(foo)
|
56
|
+
# ...
|
57
|
+
# if any.Is(Foo.DESCRIPTOR):
|
58
|
+
# any.Unpack(foo)
|
59
|
+
# ...
|
60
|
+
#
|
61
|
+
# Example 4: Pack and unpack a message in Go
|
62
|
+
#
|
63
|
+
# foo := &pb.Foo{...}
|
64
|
+
# any, err := anypb.New(foo)
|
65
|
+
# if err != nil {
|
66
|
+
# ...
|
67
|
+
# }
|
68
|
+
# ...
|
69
|
+
# foo := &pb.Foo{}
|
70
|
+
# if err := any.UnmarshalTo(foo); err != nil {
|
71
|
+
# ...
|
72
|
+
# }
|
73
|
+
#
|
74
|
+
# The pack methods provided by protobuf library will by default use
|
75
|
+
# 'type.googleapis.com/full.type.name' as the type URL and the unpack
|
76
|
+
# methods only use the fully qualified type name after the last '/'
|
77
|
+
# in the type URL, for example "foo.bar.com/x/y.z" will yield type
|
78
|
+
# name "y.z".
|
79
|
+
#
|
80
|
+
# JSON
|
81
|
+
# ====
|
82
|
+
# The JSON representation of an `Any` value uses the regular
|
83
|
+
# representation of the deserialized, embedded message, with an
|
84
|
+
# additional field `@type` which contains the type URL. Example:
|
85
|
+
#
|
86
|
+
# package google.profile;
|
87
|
+
# message Person {
|
88
|
+
# string first_name = 1;
|
89
|
+
# string last_name = 2;
|
90
|
+
# }
|
91
|
+
#
|
92
|
+
# {
|
93
|
+
# "@type": "type.googleapis.com/google.profile.Person",
|
94
|
+
# "firstName": <string>,
|
95
|
+
# "lastName": <string>
|
96
|
+
# }
|
97
|
+
#
|
98
|
+
# If the embedded message type is well-known and has a custom JSON
|
99
|
+
# representation, that representation will be embedded adding a field
|
100
|
+
# `value` which holds the custom JSON in addition to the `@type`
|
101
|
+
# field. Example (for message [google.protobuf.Duration][]):
|
102
|
+
#
|
103
|
+
# {
|
104
|
+
# "@type": "type.googleapis.com/google.protobuf.Duration",
|
105
|
+
# "value": "1.212s"
|
106
|
+
# }
|
107
|
+
# @!attribute [rw] type_url
|
108
|
+
# @return [::String]
|
109
|
+
# A URL/resource name that uniquely identifies the type of the serialized
|
110
|
+
# protocol buffer message. This string must contain at least
|
111
|
+
# one "/" character. The last segment of the URL's path must represent
|
112
|
+
# the fully qualified name of the type (as in
|
113
|
+
# `path/google.protobuf.Duration`). The name should be in a canonical form
|
114
|
+
# (e.g., leading "." is not accepted).
|
115
|
+
#
|
116
|
+
# In practice, teams usually precompile into the binary all types that they
|
117
|
+
# expect it to use in the context of Any. However, for URLs which use the
|
118
|
+
# scheme `http`, `https`, or no scheme, one can optionally set up a type
|
119
|
+
# server that maps type URLs to message definitions as follows:
|
120
|
+
#
|
121
|
+
# * If no scheme is provided, `https` is assumed.
|
122
|
+
# * An HTTP GET on the URL must yield a [google.protobuf.Type][]
|
123
|
+
# value in binary format, or produce an error.
|
124
|
+
# * Applications are allowed to cache lookup results based on the
|
125
|
+
# URL, or have them precompiled into a binary to avoid any
|
126
|
+
# lookup. Therefore, binary compatibility needs to be preserved
|
127
|
+
# on changes to types. (Use versioned type names to manage
|
128
|
+
# breaking changes.)
|
129
|
+
#
|
130
|
+
# Note: this functionality is not currently available in the official
|
131
|
+
# protobuf release, and it is not used for type URLs beginning with
|
132
|
+
# type.googleapis.com.
|
133
|
+
#
|
134
|
+
# Schemes other than `http`, `https` (or the empty scheme) might be
|
135
|
+
# used with implementation specific semantics.
|
136
|
+
# @!attribute [rw] value
|
137
|
+
# @return [::String]
|
138
|
+
# Must be a valid serialized protocol buffer of the above specified type.
|
139
|
+
class Any
|
140
|
+
include ::Google::Protobuf::MessageExts
|
141
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
142
|
+
end
|
143
|
+
end
|
144
|
+
end
|
@@ -0,0 +1,98 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
# Copyright 2023 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 Protobuf
|
22
|
+
# A Duration represents a signed, fixed-length span of time represented
|
23
|
+
# as a count of seconds and fractions of seconds at nanosecond
|
24
|
+
# resolution. It is independent of any calendar and concepts like "day"
|
25
|
+
# or "month". It is related to Timestamp in that the difference between
|
26
|
+
# two Timestamp values is a Duration and it can be added or subtracted
|
27
|
+
# from a Timestamp. Range is approximately +-10,000 years.
|
28
|
+
#
|
29
|
+
# # Examples
|
30
|
+
#
|
31
|
+
# Example 1: Compute Duration from two Timestamps in pseudo code.
|
32
|
+
#
|
33
|
+
# Timestamp start = ...;
|
34
|
+
# Timestamp end = ...;
|
35
|
+
# Duration duration = ...;
|
36
|
+
#
|
37
|
+
# duration.seconds = end.seconds - start.seconds;
|
38
|
+
# duration.nanos = end.nanos - start.nanos;
|
39
|
+
#
|
40
|
+
# if (duration.seconds < 0 && duration.nanos > 0) {
|
41
|
+
# duration.seconds += 1;
|
42
|
+
# duration.nanos -= 1000000000;
|
43
|
+
# } else if (duration.seconds > 0 && duration.nanos < 0) {
|
44
|
+
# duration.seconds -= 1;
|
45
|
+
# duration.nanos += 1000000000;
|
46
|
+
# }
|
47
|
+
#
|
48
|
+
# Example 2: Compute Timestamp from Timestamp + Duration in pseudo code.
|
49
|
+
#
|
50
|
+
# Timestamp start = ...;
|
51
|
+
# Duration duration = ...;
|
52
|
+
# Timestamp end = ...;
|
53
|
+
#
|
54
|
+
# end.seconds = start.seconds + duration.seconds;
|
55
|
+
# end.nanos = start.nanos + duration.nanos;
|
56
|
+
#
|
57
|
+
# if (end.nanos < 0) {
|
58
|
+
# end.seconds -= 1;
|
59
|
+
# end.nanos += 1000000000;
|
60
|
+
# } else if (end.nanos >= 1000000000) {
|
61
|
+
# end.seconds += 1;
|
62
|
+
# end.nanos -= 1000000000;
|
63
|
+
# }
|
64
|
+
#
|
65
|
+
# Example 3: Compute Duration from datetime.timedelta in Python.
|
66
|
+
#
|
67
|
+
# td = datetime.timedelta(days=3, minutes=10)
|
68
|
+
# duration = Duration()
|
69
|
+
# duration.FromTimedelta(td)
|
70
|
+
#
|
71
|
+
# # JSON Mapping
|
72
|
+
#
|
73
|
+
# In JSON format, the Duration type is encoded as a string rather than an
|
74
|
+
# object, where the string ends in the suffix "s" (indicating seconds) and
|
75
|
+
# is preceded by the number of seconds, with nanoseconds expressed as
|
76
|
+
# fractional seconds. For example, 3 seconds with 0 nanoseconds should be
|
77
|
+
# encoded in JSON format as "3s", while 3 seconds and 1 nanosecond should
|
78
|
+
# be expressed in JSON format as "3.000000001s", and 3 seconds and 1
|
79
|
+
# microsecond should be expressed in JSON format as "3.000001s".
|
80
|
+
# @!attribute [rw] seconds
|
81
|
+
# @return [::Integer]
|
82
|
+
# Signed seconds of the span of time. Must be from -315,576,000,000
|
83
|
+
# to +315,576,000,000 inclusive. Note: these bounds are computed from:
|
84
|
+
# 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
|
85
|
+
# @!attribute [rw] nanos
|
86
|
+
# @return [::Integer]
|
87
|
+
# Signed fractions of a second at nanosecond resolution of the span
|
88
|
+
# of time. Durations less than one second are represented with a 0
|
89
|
+
# `seconds` field and a positive or negative `nanos` field. For durations
|
90
|
+
# of one second or more, a non-zero value for the `nanos` field must be
|
91
|
+
# of the same sign as the `seconds` field. Must be from -999,999,999
|
92
|
+
# to +999,999,999 inclusive.
|
93
|
+
class Duration
|
94
|
+
include ::Google::Protobuf::MessageExts
|
95
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
96
|
+
end
|
97
|
+
end
|
98
|
+
end
|