google-cloud-spanner-admin-instance-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.
Files changed (30) hide show
  1. checksums.yaml +7 -0
  2. data/.yardopts +12 -0
  3. data/AUTHENTICATION.md +169 -0
  4. data/LICENSE.md +203 -0
  5. data/README.md +75 -0
  6. data/lib/google-cloud-spanner-admin-instance-v1.rb +21 -0
  7. data/lib/google/cloud/spanner/admin/instance/v1.rb +39 -0
  8. data/lib/google/cloud/spanner/admin/instance/v1/instance_admin.rb +74 -0
  9. data/lib/google/cloud/spanner/admin/instance/v1/instance_admin/client.rb +1291 -0
  10. data/lib/google/cloud/spanner/admin/instance/v1/instance_admin/credentials.rb +56 -0
  11. data/lib/google/cloud/spanner/admin/instance/v1/instance_admin/operations.rb +574 -0
  12. data/lib/google/cloud/spanner/admin/instance/v1/instance_admin/paths.rb +85 -0
  13. data/lib/google/cloud/spanner/admin/instance/v1/version.rb +32 -0
  14. data/lib/google/spanner/admin/instance/v1/spanner_instance_admin_pb.rb +128 -0
  15. data/lib/google/spanner/admin/instance/v1/spanner_instance_admin_services_pb.rb +182 -0
  16. data/proto_docs/README.md +4 -0
  17. data/proto_docs/google/api/field_behavior.rb +59 -0
  18. data/proto_docs/google/api/resource.rb +247 -0
  19. data/proto_docs/google/iam/v1/iam_policy.rb +80 -0
  20. data/proto_docs/google/iam/v1/options.rb +40 -0
  21. data/proto_docs/google/iam/v1/policy.rb +248 -0
  22. data/proto_docs/google/longrunning/operations.rb +150 -0
  23. data/proto_docs/google/protobuf/any.rb +138 -0
  24. data/proto_docs/google/protobuf/empty.rb +36 -0
  25. data/proto_docs/google/protobuf/field_mask.rb +229 -0
  26. data/proto_docs/google/protobuf/timestamp.rb +120 -0
  27. data/proto_docs/google/rpc/status.rb +46 -0
  28. data/proto_docs/google/spanner/admin/instance/v1/spanner_instance_admin.rb +391 -0
  29. data/proto_docs/google/type/expr.rb +52 -0
  30. metadata +231 -0
@@ -0,0 +1,120 @@
1
+ # frozen_string_literal: true
2
+
3
+ # Copyright 2020 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 Timestamp represents a point in time independent of any time zone or local
23
+ # calendar, encoded as a count of seconds and fractions of seconds at
24
+ # nanosecond resolution. The count is relative to an epoch at UTC midnight on
25
+ # January 1, 1970, in the proleptic Gregorian calendar which extends the
26
+ # Gregorian calendar backwards to year one.
27
+ #
28
+ # All minutes are 60 seconds long. Leap seconds are "smeared" so that no leap
29
+ # second table is needed for interpretation, using a [24-hour linear
30
+ # smear](https://developers.google.com/time/smear).
31
+ #
32
+ # The range is from 0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z. By
33
+ # restricting to that range, we ensure that we can convert to and from [RFC
34
+ # 3339](https://www.ietf.org/rfc/rfc3339.txt) date strings.
35
+ #
36
+ # # Examples
37
+ #
38
+ # Example 1: Compute Timestamp from POSIX `time()`.
39
+ #
40
+ # Timestamp timestamp;
41
+ # timestamp.set_seconds(time(NULL));
42
+ # timestamp.set_nanos(0);
43
+ #
44
+ # Example 2: Compute Timestamp from POSIX `gettimeofday()`.
45
+ #
46
+ # struct timeval tv;
47
+ # gettimeofday(&tv, NULL);
48
+ #
49
+ # Timestamp timestamp;
50
+ # timestamp.set_seconds(tv.tv_sec);
51
+ # timestamp.set_nanos(tv.tv_usec * 1000);
52
+ #
53
+ # Example 3: Compute Timestamp from Win32 `GetSystemTimeAsFileTime()`.
54
+ #
55
+ # FILETIME ft;
56
+ # GetSystemTimeAsFileTime(&ft);
57
+ # UINT64 ticks = (((UINT64)ft.dwHighDateTime) << 32) | ft.dwLowDateTime;
58
+ #
59
+ # // A Windows tick is 100 nanoseconds. Windows epoch 1601-01-01T00:00:00Z
60
+ # // is 11644473600 seconds before Unix epoch 1970-01-01T00:00:00Z.
61
+ # Timestamp timestamp;
62
+ # timestamp.set_seconds((INT64) ((ticks / 10000000) - 11644473600LL));
63
+ # timestamp.set_nanos((INT32) ((ticks % 10000000) * 100));
64
+ #
65
+ # Example 4: Compute Timestamp from Java `System.currentTimeMillis()`.
66
+ #
67
+ # long millis = System.currentTimeMillis();
68
+ #
69
+ # Timestamp timestamp = Timestamp.newBuilder().setSeconds(millis / 1000)
70
+ # .setNanos((int) ((millis % 1000) * 1000000)).build();
71
+ #
72
+ #
73
+ # Example 5: Compute Timestamp from current time in Python.
74
+ #
75
+ # timestamp = Timestamp()
76
+ # timestamp.GetCurrentTime()
77
+ #
78
+ # # JSON Mapping
79
+ #
80
+ # In JSON format, the Timestamp type is encoded as a string in the
81
+ # [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) format. That is, the
82
+ # format is "\\{year}-\\{month}-\\{day}T\\{hour}:\\{min}:\\{sec}[.\\{frac_sec}]Z"
83
+ # where \\{year} is always expressed using four digits while \\{month}, \\{day},
84
+ # \\{hour}, \\{min}, and \\{sec} are zero-padded to two digits each. The fractional
85
+ # seconds, which can go up to 9 digits (i.e. up to 1 nanosecond resolution),
86
+ # are optional. The "Z" suffix indicates the timezone ("UTC"); the timezone
87
+ # is required. A proto3 JSON serializer should always use UTC (as indicated by
88
+ # "Z") when printing the Timestamp type and a proto3 JSON parser should be
89
+ # able to accept both UTC and other timezones (as indicated by an offset).
90
+ #
91
+ # For example, "2017-01-15T01:30:15.01Z" encodes 15.01 seconds past
92
+ # 01:30 UTC on January 15, 2017.
93
+ #
94
+ # In JavaScript, one can convert a Date object to this format using the
95
+ # standard
96
+ # [toISOString()](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date/toISOString)
97
+ # method. In Python, a standard `datetime.datetime` object can be converted
98
+ # to this format using
99
+ # [`strftime`](https://docs.python.org/2/library/time.html#time.strftime) with
100
+ # the time format spec '%Y-%m-%dT%H:%M:%S.%fZ'. Likewise, in Java, one can use
101
+ # the Joda Time's [`ISODateTimeFormat.dateTime()`](
102
+ # http://www.joda.org/joda-time/apidocs/org/joda/time/format/ISODateTimeFormat.html#dateTime%2D%2D
103
+ # ) to obtain a formatter capable of generating timestamps in this format.
104
+ # @!attribute [rw] seconds
105
+ # @return [::Integer]
106
+ # Represents seconds of UTC time since Unix epoch
107
+ # 1970-01-01T00:00:00Z. Must be from 0001-01-01T00:00:00Z to
108
+ # 9999-12-31T23:59:59Z inclusive.
109
+ # @!attribute [rw] nanos
110
+ # @return [::Integer]
111
+ # Non-negative fractions of a second at nanosecond resolution. Negative
112
+ # second values with fractions must still have non-negative nanos values
113
+ # that count forward in time. Must be from 0 to 999,999,999
114
+ # inclusive.
115
+ class Timestamp
116
+ include ::Google::Protobuf::MessageExts
117
+ extend ::Google::Protobuf::MessageExts::ClassMethods
118
+ end
119
+ end
120
+ end
@@ -0,0 +1,46 @@
1
+ # frozen_string_literal: true
2
+
3
+ # Copyright 2020 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 Rpc
22
+ # The `Status` type defines a logical error model that is suitable for
23
+ # different programming environments, including REST APIs and RPC APIs. It is
24
+ # used by [gRPC](https://github.com/grpc). Each `Status` message contains
25
+ # three pieces of data: error code, error message, and error details.
26
+ #
27
+ # You can find out more about this error model and how to work with it in the
28
+ # [API Design Guide](https://cloud.google.com/apis/design/errors).
29
+ # @!attribute [rw] code
30
+ # @return [::Integer]
31
+ # The status code, which should be an enum value of [google.rpc.Code][google.rpc.Code].
32
+ # @!attribute [rw] message
33
+ # @return [::String]
34
+ # A developer-facing error message, which should be in English. Any
35
+ # user-facing error message should be localized and sent in the
36
+ # {::Google::Rpc::Status#details google.rpc.Status.details} field, or localized by the client.
37
+ # @!attribute [rw] details
38
+ # @return [::Array<::Google::Protobuf::Any>]
39
+ # A list of messages that carry the error details. There is a common set of
40
+ # message types for APIs to use.
41
+ class Status
42
+ include ::Google::Protobuf::MessageExts
43
+ extend ::Google::Protobuf::MessageExts::ClassMethods
44
+ end
45
+ end
46
+ end
@@ -0,0 +1,391 @@
1
+ # frozen_string_literal: true
2
+
3
+ # Copyright 2020 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 Spanner
23
+ module Admin
24
+ module Instance
25
+ module V1
26
+ # @!attribute [rw] location
27
+ # @return [::String]
28
+ # The location of the serving resources, e.g. "us-central1".
29
+ # @!attribute [rw] type
30
+ # @return [::Google::Cloud::Spanner::Admin::Instance::V1::ReplicaInfo::ReplicaType]
31
+ # The type of replica.
32
+ # @!attribute [rw] default_leader_location
33
+ # @return [::Boolean]
34
+ # If true, this location is designated as the default leader location where
35
+ # leader replicas are placed. See the [region types
36
+ # documentation](https://cloud.google.com/spanner/docs/instances#region_types)
37
+ # for more details.
38
+ class ReplicaInfo
39
+ include ::Google::Protobuf::MessageExts
40
+ extend ::Google::Protobuf::MessageExts::ClassMethods
41
+
42
+ # Indicates the type of replica. See the [replica types
43
+ # documentation](https://cloud.google.com/spanner/docs/replication#replica_types)
44
+ # for more details.
45
+ module ReplicaType
46
+ # Not specified.
47
+ TYPE_UNSPECIFIED = 0
48
+
49
+ # Read-write replicas support both reads and writes. These replicas:
50
+ #
51
+ # * Maintain a full copy of your data.
52
+ # * Serve reads.
53
+ # * Can vote whether to commit a write.
54
+ # * Participate in leadership election.
55
+ # * Are eligible to become a leader.
56
+ READ_WRITE = 1
57
+
58
+ # Read-only replicas only support reads (not writes). Read-only replicas:
59
+ #
60
+ # * Maintain a full copy of your data.
61
+ # * Serve reads.
62
+ # * Do not participate in voting to commit writes.
63
+ # * Are not eligible to become a leader.
64
+ READ_ONLY = 2
65
+
66
+ # Witness replicas don't support reads but do participate in voting to
67
+ # commit writes. Witness replicas:
68
+ #
69
+ # * Do not maintain a full copy of data.
70
+ # * Do not serve reads.
71
+ # * Vote whether to commit writes.
72
+ # * Participate in leader election but are not eligible to become leader.
73
+ WITNESS = 3
74
+ end
75
+ end
76
+
77
+ # A possible configuration for a Cloud Spanner instance. Configurations
78
+ # define the geographic placement of nodes and their replication.
79
+ # @!attribute [rw] name
80
+ # @return [::String]
81
+ # A unique identifier for the instance configuration. Values
82
+ # are of the form
83
+ # `projects/<project>/instanceConfigs/[a-z][-a-z0-9]*`
84
+ # @!attribute [rw] display_name
85
+ # @return [::String]
86
+ # The name of this instance configuration as it appears in UIs.
87
+ # @!attribute [rw] replicas
88
+ # @return [::Array<::Google::Cloud::Spanner::Admin::Instance::V1::ReplicaInfo>]
89
+ # The geographic placement of nodes in this instance configuration and their
90
+ # replication properties.
91
+ class InstanceConfig
92
+ include ::Google::Protobuf::MessageExts
93
+ extend ::Google::Protobuf::MessageExts::ClassMethods
94
+ end
95
+
96
+ # An isolated set of Cloud Spanner resources on which databases can be hosted.
97
+ # @!attribute [rw] name
98
+ # @return [::String]
99
+ # Required. A unique identifier for the instance, which cannot be changed
100
+ # after the instance is created. Values are of the form
101
+ # `projects/<project>/instances/[a-z][-a-z0-9]*[a-z0-9]`. The final
102
+ # segment of the name must be between 2 and 64 characters in length.
103
+ # @!attribute [rw] config
104
+ # @return [::String]
105
+ # Required. The name of the instance's configuration. Values are of the form
106
+ # `projects/<project>/instanceConfigs/<configuration>`. See
107
+ # also {::Google::Cloud::Spanner::Admin::Instance::V1::InstanceConfig InstanceConfig} and
108
+ # {::Google::Cloud::Spanner::Admin::Instance::V1::InstanceAdmin::Client#list_instance_configs ListInstanceConfigs}.
109
+ # @!attribute [rw] display_name
110
+ # @return [::String]
111
+ # Required. The descriptive name for this instance as it appears in UIs.
112
+ # Must be unique per project and between 4 and 30 characters in length.
113
+ # @!attribute [rw] node_count
114
+ # @return [::Integer]
115
+ # Required. The number of nodes allocated to this instance. This may be zero
116
+ # in API responses for instances that are not yet in state `READY`.
117
+ #
118
+ # See [the
119
+ # documentation](https://cloud.google.com/spanner/docs/instances#node_count)
120
+ # for more information about nodes.
121
+ # @!attribute [rw] state
122
+ # @return [::Google::Cloud::Spanner::Admin::Instance::V1::Instance::State]
123
+ # Output only. The current instance state. For
124
+ # {::Google::Cloud::Spanner::Admin::Instance::V1::InstanceAdmin::Client#create_instance CreateInstance}, the state must be
125
+ # either omitted or set to `CREATING`. For
126
+ # {::Google::Cloud::Spanner::Admin::Instance::V1::InstanceAdmin::Client#update_instance UpdateInstance}, the state must be
127
+ # either omitted or set to `READY`.
128
+ # @!attribute [rw] labels
129
+ # @return [::Google::Protobuf::Map{::String => ::String}]
130
+ # Cloud Labels are a flexible and lightweight mechanism for organizing cloud
131
+ # resources into groups that reflect a customer's organizational needs and
132
+ # deployment strategies. Cloud Labels can be used to filter collections of
133
+ # resources. They can be used to control how resource metrics are aggregated.
134
+ # And they can be used as arguments to policy management rules (e.g. route,
135
+ # firewall, load balancing, etc.).
136
+ #
137
+ # * Label keys must be between 1 and 63 characters long and must conform to
138
+ # the following regular expression: `[a-z]([-a-z0-9]*[a-z0-9])?`.
139
+ # * Label values must be between 0 and 63 characters long and must conform
140
+ # to the regular expression `([a-z]([-a-z0-9]*[a-z0-9])?)?`.
141
+ # * No more than 64 labels can be associated with a given resource.
142
+ #
143
+ # See https://goo.gl/xmQnxf for more information on and examples of labels.
144
+ #
145
+ # If you plan to use labels in your own code, please note that additional
146
+ # characters may be allowed in the future. And so you are advised to use an
147
+ # internal label representation, such as JSON, which doesn't rely upon
148
+ # specific characters being disallowed. For example, representing labels
149
+ # as the string: name + "_" + value would prove problematic if we were to
150
+ # allow "_" in a future release.
151
+ # @!attribute [rw] endpoint_uris
152
+ # @return [::Array<::String>]
153
+ # Deprecated. This field is not populated.
154
+ class Instance
155
+ include ::Google::Protobuf::MessageExts
156
+ extend ::Google::Protobuf::MessageExts::ClassMethods
157
+
158
+ # @!attribute [rw] key
159
+ # @return [::String]
160
+ # @!attribute [rw] value
161
+ # @return [::String]
162
+ class LabelsEntry
163
+ include ::Google::Protobuf::MessageExts
164
+ extend ::Google::Protobuf::MessageExts::ClassMethods
165
+ end
166
+
167
+ # Indicates the current state of the instance.
168
+ module State
169
+ # Not specified.
170
+ STATE_UNSPECIFIED = 0
171
+
172
+ # The instance is still being created. Resources may not be
173
+ # available yet, and operations such as database creation may not
174
+ # work.
175
+ CREATING = 1
176
+
177
+ # The instance is fully created and ready to do work such as
178
+ # creating databases.
179
+ READY = 2
180
+ end
181
+ end
182
+
183
+ # The request for {::Google::Cloud::Spanner::Admin::Instance::V1::InstanceAdmin::Client#list_instance_configs ListInstanceConfigs}.
184
+ # @!attribute [rw] parent
185
+ # @return [::String]
186
+ # Required. The name of the project for which a list of supported instance
187
+ # configurations is requested. Values are of the form
188
+ # `projects/<project>`.
189
+ # @!attribute [rw] page_size
190
+ # @return [::Integer]
191
+ # Number of instance configurations to be returned in the response. If 0 or
192
+ # less, defaults to the server's maximum allowed page size.
193
+ # @!attribute [rw] page_token
194
+ # @return [::String]
195
+ # If non-empty, `page_token` should contain a
196
+ # {::Google::Cloud::Spanner::Admin::Instance::V1::ListInstanceConfigsResponse#next_page_token next_page_token}
197
+ # from a previous {::Google::Cloud::Spanner::Admin::Instance::V1::ListInstanceConfigsResponse ListInstanceConfigsResponse}.
198
+ class ListInstanceConfigsRequest
199
+ include ::Google::Protobuf::MessageExts
200
+ extend ::Google::Protobuf::MessageExts::ClassMethods
201
+ end
202
+
203
+ # The response for {::Google::Cloud::Spanner::Admin::Instance::V1::InstanceAdmin::Client#list_instance_configs ListInstanceConfigs}.
204
+ # @!attribute [rw] instance_configs
205
+ # @return [::Array<::Google::Cloud::Spanner::Admin::Instance::V1::InstanceConfig>]
206
+ # The list of requested instance configurations.
207
+ # @!attribute [rw] next_page_token
208
+ # @return [::String]
209
+ # `next_page_token` can be sent in a subsequent
210
+ # {::Google::Cloud::Spanner::Admin::Instance::V1::InstanceAdmin::Client#list_instance_configs ListInstanceConfigs} call to
211
+ # fetch more of the matching instance configurations.
212
+ class ListInstanceConfigsResponse
213
+ include ::Google::Protobuf::MessageExts
214
+ extend ::Google::Protobuf::MessageExts::ClassMethods
215
+ end
216
+
217
+ # The request for
218
+ # {::Google::Cloud::Spanner::Admin::Instance::V1::InstanceAdmin::Client#get_instance_config GetInstanceConfigRequest}.
219
+ # @!attribute [rw] name
220
+ # @return [::String]
221
+ # Required. The name of the requested instance configuration. Values are of
222
+ # the form `projects/<project>/instanceConfigs/<config>`.
223
+ class GetInstanceConfigRequest
224
+ include ::Google::Protobuf::MessageExts
225
+ extend ::Google::Protobuf::MessageExts::ClassMethods
226
+ end
227
+
228
+ # The request for {::Google::Cloud::Spanner::Admin::Instance::V1::InstanceAdmin::Client#get_instance GetInstance}.
229
+ # @!attribute [rw] name
230
+ # @return [::String]
231
+ # Required. The name of the requested instance. Values are of the form
232
+ # `projects/<project>/instances/<instance>`.
233
+ # @!attribute [rw] field_mask
234
+ # @return [::Google::Protobuf::FieldMask]
235
+ # If field_mask is present, specifies the subset of {::Google::Cloud::Spanner::Admin::Instance::V1::Instance Instance} fields that
236
+ # should be returned.
237
+ # If absent, all {::Google::Cloud::Spanner::Admin::Instance::V1::Instance Instance} fields are returned.
238
+ class GetInstanceRequest
239
+ include ::Google::Protobuf::MessageExts
240
+ extend ::Google::Protobuf::MessageExts::ClassMethods
241
+ end
242
+
243
+ # The request for {::Google::Cloud::Spanner::Admin::Instance::V1::InstanceAdmin::Client#create_instance CreateInstance}.
244
+ # @!attribute [rw] parent
245
+ # @return [::String]
246
+ # Required. The name of the project in which to create the instance. Values
247
+ # are of the form `projects/<project>`.
248
+ # @!attribute [rw] instance_id
249
+ # @return [::String]
250
+ # Required. The ID of the instance to create. Valid identifiers are of the
251
+ # form `[a-z][-a-z0-9]*[a-z0-9]` and must be between 2 and 64 characters in
252
+ # length.
253
+ # @!attribute [rw] instance
254
+ # @return [::Google::Cloud::Spanner::Admin::Instance::V1::Instance]
255
+ # Required. The instance to create. The name may be omitted, but if
256
+ # specified must be `<parent>/instances/<instance_id>`.
257
+ class CreateInstanceRequest
258
+ include ::Google::Protobuf::MessageExts
259
+ extend ::Google::Protobuf::MessageExts::ClassMethods
260
+ end
261
+
262
+ # The request for {::Google::Cloud::Spanner::Admin::Instance::V1::InstanceAdmin::Client#list_instances ListInstances}.
263
+ # @!attribute [rw] parent
264
+ # @return [::String]
265
+ # Required. The name of the project for which a list of instances is
266
+ # requested. Values are of the form `projects/<project>`.
267
+ # @!attribute [rw] page_size
268
+ # @return [::Integer]
269
+ # Number of instances to be returned in the response. If 0 or less, defaults
270
+ # to the server's maximum allowed page size.
271
+ # @!attribute [rw] page_token
272
+ # @return [::String]
273
+ # If non-empty, `page_token` should contain a
274
+ # {::Google::Cloud::Spanner::Admin::Instance::V1::ListInstancesResponse#next_page_token next_page_token} from a
275
+ # previous {::Google::Cloud::Spanner::Admin::Instance::V1::ListInstancesResponse ListInstancesResponse}.
276
+ # @!attribute [rw] filter
277
+ # @return [::String]
278
+ # An expression for filtering the results of the request. Filter rules are
279
+ # case insensitive. The fields eligible for filtering are:
280
+ #
281
+ # * `name`
282
+ # * `display_name`
283
+ # * `labels.key` where key is the name of a label
284
+ #
285
+ # Some examples of using filters are:
286
+ #
287
+ # * `name:*` --> The instance has a name.
288
+ # * `name:Howl` --> The instance's name contains the string "howl".
289
+ # * `name:HOWL` --> Equivalent to above.
290
+ # * `NAME:howl` --> Equivalent to above.
291
+ # * `labels.env:*` --> The instance has the label "env".
292
+ # * `labels.env:dev` --> The instance has the label "env" and the value of
293
+ # the label contains the string "dev".
294
+ # * `name:howl labels.env:dev` --> The instance's name contains "howl" and
295
+ # it has the label "env" with its value
296
+ # containing "dev".
297
+ class ListInstancesRequest
298
+ include ::Google::Protobuf::MessageExts
299
+ extend ::Google::Protobuf::MessageExts::ClassMethods
300
+ end
301
+
302
+ # The response for {::Google::Cloud::Spanner::Admin::Instance::V1::InstanceAdmin::Client#list_instances ListInstances}.
303
+ # @!attribute [rw] instances
304
+ # @return [::Array<::Google::Cloud::Spanner::Admin::Instance::V1::Instance>]
305
+ # The list of requested instances.
306
+ # @!attribute [rw] next_page_token
307
+ # @return [::String]
308
+ # `next_page_token` can be sent in a subsequent
309
+ # {::Google::Cloud::Spanner::Admin::Instance::V1::InstanceAdmin::Client#list_instances ListInstances} call to fetch more
310
+ # of the matching instances.
311
+ class ListInstancesResponse
312
+ include ::Google::Protobuf::MessageExts
313
+ extend ::Google::Protobuf::MessageExts::ClassMethods
314
+ end
315
+
316
+ # The request for {::Google::Cloud::Spanner::Admin::Instance::V1::InstanceAdmin::Client#update_instance UpdateInstance}.
317
+ # @!attribute [rw] instance
318
+ # @return [::Google::Cloud::Spanner::Admin::Instance::V1::Instance]
319
+ # Required. The instance to update, which must always include the instance
320
+ # name. Otherwise, only fields mentioned in {::Google::Cloud::Spanner::Admin::Instance::V1::UpdateInstanceRequest#field_mask field_mask} need be included.
321
+ # @!attribute [rw] field_mask
322
+ # @return [::Google::Protobuf::FieldMask]
323
+ # Required. A mask specifying which fields in {::Google::Cloud::Spanner::Admin::Instance::V1::Instance Instance} should be updated.
324
+ # The field mask must always be specified; this prevents any future fields in
325
+ # {::Google::Cloud::Spanner::Admin::Instance::V1::Instance Instance} from being erased accidentally by clients that do not know
326
+ # about them.
327
+ class UpdateInstanceRequest
328
+ include ::Google::Protobuf::MessageExts
329
+ extend ::Google::Protobuf::MessageExts::ClassMethods
330
+ end
331
+
332
+ # The request for {::Google::Cloud::Spanner::Admin::Instance::V1::InstanceAdmin::Client#delete_instance DeleteInstance}.
333
+ # @!attribute [rw] name
334
+ # @return [::String]
335
+ # Required. The name of the instance to be deleted. Values are of the form
336
+ # `projects/<project>/instances/<instance>`
337
+ class DeleteInstanceRequest
338
+ include ::Google::Protobuf::MessageExts
339
+ extend ::Google::Protobuf::MessageExts::ClassMethods
340
+ end
341
+
342
+ # Metadata type for the operation returned by
343
+ # {::Google::Cloud::Spanner::Admin::Instance::V1::InstanceAdmin::Client#create_instance CreateInstance}.
344
+ # @!attribute [rw] instance
345
+ # @return [::Google::Cloud::Spanner::Admin::Instance::V1::Instance]
346
+ # The instance being created.
347
+ # @!attribute [rw] start_time
348
+ # @return [::Google::Protobuf::Timestamp]
349
+ # The time at which the
350
+ # {::Google::Cloud::Spanner::Admin::Instance::V1::InstanceAdmin::Client#create_instance CreateInstance} request was
351
+ # received.
352
+ # @!attribute [rw] cancel_time
353
+ # @return [::Google::Protobuf::Timestamp]
354
+ # The time at which this operation was cancelled. If set, this operation is
355
+ # in the process of undoing itself (which is guaranteed to succeed) and
356
+ # cannot be cancelled again.
357
+ # @!attribute [rw] end_time
358
+ # @return [::Google::Protobuf::Timestamp]
359
+ # The time at which this operation failed or was completed successfully.
360
+ class CreateInstanceMetadata
361
+ include ::Google::Protobuf::MessageExts
362
+ extend ::Google::Protobuf::MessageExts::ClassMethods
363
+ end
364
+
365
+ # Metadata type for the operation returned by
366
+ # {::Google::Cloud::Spanner::Admin::Instance::V1::InstanceAdmin::Client#update_instance UpdateInstance}.
367
+ # @!attribute [rw] instance
368
+ # @return [::Google::Cloud::Spanner::Admin::Instance::V1::Instance]
369
+ # The desired end state of the update.
370
+ # @!attribute [rw] start_time
371
+ # @return [::Google::Protobuf::Timestamp]
372
+ # The time at which {::Google::Cloud::Spanner::Admin::Instance::V1::InstanceAdmin::Client#update_instance UpdateInstance}
373
+ # request was received.
374
+ # @!attribute [rw] cancel_time
375
+ # @return [::Google::Protobuf::Timestamp]
376
+ # The time at which this operation was cancelled. If set, this operation is
377
+ # in the process of undoing itself (which is guaranteed to succeed) and
378
+ # cannot be cancelled again.
379
+ # @!attribute [rw] end_time
380
+ # @return [::Google::Protobuf::Timestamp]
381
+ # The time at which this operation failed or was completed successfully.
382
+ class UpdateInstanceMetadata
383
+ include ::Google::Protobuf::MessageExts
384
+ extend ::Google::Protobuf::MessageExts::ClassMethods
385
+ end
386
+ end
387
+ end
388
+ end
389
+ end
390
+ end
391
+ end