/
InstanceOrBuilder.java
373 lines (363 loc) · 13.9 KB
/
InstanceOrBuilder.java
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
/*
* Copyright 2020 Google LLC
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* https://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
// Generated by the protocol buffer compiler. DO NOT EDIT!
// source: google/spanner/admin/instance/v1/spanner_instance_admin.proto
package com.google.spanner.admin.instance.v1;
public interface InstanceOrBuilder
extends
// @@protoc_insertion_point(interface_extends:google.spanner.admin.instance.v1.Instance)
com.google.protobuf.MessageOrBuilder {
/**
*
*
* <pre>
* Required. A unique identifier for the instance, which cannot be changed
* after the instance is created. Values are of the form
* `projects/<project>/instances/[a-z][-a-z0-9]*[a-z0-9]`. The final
* segment of the name must be between 2 and 64 characters in length.
* </pre>
*
* <code>string name = 1;</code>
*
* @return The name.
*/
java.lang.String getName();
/**
*
*
* <pre>
* Required. A unique identifier for the instance, which cannot be changed
* after the instance is created. Values are of the form
* `projects/<project>/instances/[a-z][-a-z0-9]*[a-z0-9]`. The final
* segment of the name must be between 2 and 64 characters in length.
* </pre>
*
* <code>string name = 1;</code>
*
* @return The bytes for name.
*/
com.google.protobuf.ByteString getNameBytes();
/**
*
*
* <pre>
* Required. The name of the instance's configuration. Values are of the form
* `projects/<project>/instanceConfigs/<configuration>`. See
* also [InstanceConfig][google.spanner.admin.instance.v1.InstanceConfig] and
* [ListInstanceConfigs][google.spanner.admin.instance.v1.InstanceAdmin.ListInstanceConfigs].
* </pre>
*
* <code>string config = 2 [(.google.api.resource_reference) = { ... }</code>
*
* @return The config.
*/
java.lang.String getConfig();
/**
*
*
* <pre>
* Required. The name of the instance's configuration. Values are of the form
* `projects/<project>/instanceConfigs/<configuration>`. See
* also [InstanceConfig][google.spanner.admin.instance.v1.InstanceConfig] and
* [ListInstanceConfigs][google.spanner.admin.instance.v1.InstanceAdmin.ListInstanceConfigs].
* </pre>
*
* <code>string config = 2 [(.google.api.resource_reference) = { ... }</code>
*
* @return The bytes for config.
*/
com.google.protobuf.ByteString getConfigBytes();
/**
*
*
* <pre>
* Required. The descriptive name for this instance as it appears in UIs.
* Must be unique per project and between 4 and 30 characters in length.
* </pre>
*
* <code>string display_name = 3;</code>
*
* @return The displayName.
*/
java.lang.String getDisplayName();
/**
*
*
* <pre>
* Required. The descriptive name for this instance as it appears in UIs.
* Must be unique per project and between 4 and 30 characters in length.
* </pre>
*
* <code>string display_name = 3;</code>
*
* @return The bytes for displayName.
*/
com.google.protobuf.ByteString getDisplayNameBytes();
/**
*
*
* <pre>
* Required. The number of nodes allocated to this instance. This may be zero
* in API responses for instances that are not yet in state `READY`.
* See [the
* documentation](https://cloud.google.com/spanner/docs/instances#node_count)
* for more information about nodes.
* </pre>
*
* <code>int32 node_count = 5;</code>
*
* @return The nodeCount.
*/
int getNodeCount();
/**
*
*
* <pre>
* The number of processing units allocated to this instance. At most one of
* processing_units or node_count should be present in the message. This may
* be zero in API responses for instances that are not yet in state `READY`.
* </pre>
*
* <code>int32 processing_units = 9;</code>
*
* @return The processingUnits.
*/
int getProcessingUnits();
/**
*
*
* <pre>
* Output only. The current instance state. For
* [CreateInstance][google.spanner.admin.instance.v1.InstanceAdmin.CreateInstance], the state must be
* either omitted or set to `CREATING`. For
* [UpdateInstance][google.spanner.admin.instance.v1.InstanceAdmin.UpdateInstance], the state must be
* either omitted or set to `READY`.
* </pre>
*
* <code>
* .google.spanner.admin.instance.v1.Instance.State state = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
* </code>
*
* @return The enum numeric value on the wire for state.
*/
int getStateValue();
/**
*
*
* <pre>
* Output only. The current instance state. For
* [CreateInstance][google.spanner.admin.instance.v1.InstanceAdmin.CreateInstance], the state must be
* either omitted or set to `CREATING`. For
* [UpdateInstance][google.spanner.admin.instance.v1.InstanceAdmin.UpdateInstance], the state must be
* either omitted or set to `READY`.
* </pre>
*
* <code>
* .google.spanner.admin.instance.v1.Instance.State state = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
* </code>
*
* @return The state.
*/
com.google.spanner.admin.instance.v1.Instance.State getState();
/**
*
*
* <pre>
* Cloud Labels are a flexible and lightweight mechanism for organizing cloud
* resources into groups that reflect a customer's organizational needs and
* deployment strategies. Cloud Labels can be used to filter collections of
* resources. They can be used to control how resource metrics are aggregated.
* And they can be used as arguments to policy management rules (e.g. route,
* firewall, load balancing, etc.).
* * Label keys must be between 1 and 63 characters long and must conform to
* the following regular expression: `[a-z]([-a-z0-9]*[a-z0-9])?`.
* * Label values must be between 0 and 63 characters long and must conform
* to the regular expression `([a-z]([-a-z0-9]*[a-z0-9])?)?`.
* * No more than 64 labels can be associated with a given resource.
* See https://goo.gl/xmQnxf for more information on and examples of labels.
* If you plan to use labels in your own code, please note that additional
* characters may be allowed in the future. And so you are advised to use an
* internal label representation, such as JSON, which doesn't rely upon
* specific characters being disallowed. For example, representing labels
* as the string: name + "_" + value would prove problematic if we were to
* allow "_" in a future release.
* </pre>
*
* <code>map<string, string> labels = 7;</code>
*/
int getLabelsCount();
/**
*
*
* <pre>
* Cloud Labels are a flexible and lightweight mechanism for organizing cloud
* resources into groups that reflect a customer's organizational needs and
* deployment strategies. Cloud Labels can be used to filter collections of
* resources. They can be used to control how resource metrics are aggregated.
* And they can be used as arguments to policy management rules (e.g. route,
* firewall, load balancing, etc.).
* * Label keys must be between 1 and 63 characters long and must conform to
* the following regular expression: `[a-z]([-a-z0-9]*[a-z0-9])?`.
* * Label values must be between 0 and 63 characters long and must conform
* to the regular expression `([a-z]([-a-z0-9]*[a-z0-9])?)?`.
* * No more than 64 labels can be associated with a given resource.
* See https://goo.gl/xmQnxf for more information on and examples of labels.
* If you plan to use labels in your own code, please note that additional
* characters may be allowed in the future. And so you are advised to use an
* internal label representation, such as JSON, which doesn't rely upon
* specific characters being disallowed. For example, representing labels
* as the string: name + "_" + value would prove problematic if we were to
* allow "_" in a future release.
* </pre>
*
* <code>map<string, string> labels = 7;</code>
*/
boolean containsLabels(java.lang.String key);
/** Use {@link #getLabelsMap()} instead. */
@java.lang.Deprecated
java.util.Map<java.lang.String, java.lang.String> getLabels();
/**
*
*
* <pre>
* Cloud Labels are a flexible and lightweight mechanism for organizing cloud
* resources into groups that reflect a customer's organizational needs and
* deployment strategies. Cloud Labels can be used to filter collections of
* resources. They can be used to control how resource metrics are aggregated.
* And they can be used as arguments to policy management rules (e.g. route,
* firewall, load balancing, etc.).
* * Label keys must be between 1 and 63 characters long and must conform to
* the following regular expression: `[a-z]([-a-z0-9]*[a-z0-9])?`.
* * Label values must be between 0 and 63 characters long and must conform
* to the regular expression `([a-z]([-a-z0-9]*[a-z0-9])?)?`.
* * No more than 64 labels can be associated with a given resource.
* See https://goo.gl/xmQnxf for more information on and examples of labels.
* If you plan to use labels in your own code, please note that additional
* characters may be allowed in the future. And so you are advised to use an
* internal label representation, such as JSON, which doesn't rely upon
* specific characters being disallowed. For example, representing labels
* as the string: name + "_" + value would prove problematic if we were to
* allow "_" in a future release.
* </pre>
*
* <code>map<string, string> labels = 7;</code>
*/
java.util.Map<java.lang.String, java.lang.String> getLabelsMap();
/**
*
*
* <pre>
* Cloud Labels are a flexible and lightweight mechanism for organizing cloud
* resources into groups that reflect a customer's organizational needs and
* deployment strategies. Cloud Labels can be used to filter collections of
* resources. They can be used to control how resource metrics are aggregated.
* And they can be used as arguments to policy management rules (e.g. route,
* firewall, load balancing, etc.).
* * Label keys must be between 1 and 63 characters long and must conform to
* the following regular expression: `[a-z]([-a-z0-9]*[a-z0-9])?`.
* * Label values must be between 0 and 63 characters long and must conform
* to the regular expression `([a-z]([-a-z0-9]*[a-z0-9])?)?`.
* * No more than 64 labels can be associated with a given resource.
* See https://goo.gl/xmQnxf for more information on and examples of labels.
* If you plan to use labels in your own code, please note that additional
* characters may be allowed in the future. And so you are advised to use an
* internal label representation, such as JSON, which doesn't rely upon
* specific characters being disallowed. For example, representing labels
* as the string: name + "_" + value would prove problematic if we were to
* allow "_" in a future release.
* </pre>
*
* <code>map<string, string> labels = 7;</code>
*/
java.lang.String getLabelsOrDefault(java.lang.String key, java.lang.String defaultValue);
/**
*
*
* <pre>
* Cloud Labels are a flexible and lightweight mechanism for organizing cloud
* resources into groups that reflect a customer's organizational needs and
* deployment strategies. Cloud Labels can be used to filter collections of
* resources. They can be used to control how resource metrics are aggregated.
* And they can be used as arguments to policy management rules (e.g. route,
* firewall, load balancing, etc.).
* * Label keys must be between 1 and 63 characters long and must conform to
* the following regular expression: `[a-z]([-a-z0-9]*[a-z0-9])?`.
* * Label values must be between 0 and 63 characters long and must conform
* to the regular expression `([a-z]([-a-z0-9]*[a-z0-9])?)?`.
* * No more than 64 labels can be associated with a given resource.
* See https://goo.gl/xmQnxf for more information on and examples of labels.
* If you plan to use labels in your own code, please note that additional
* characters may be allowed in the future. And so you are advised to use an
* internal label representation, such as JSON, which doesn't rely upon
* specific characters being disallowed. For example, representing labels
* as the string: name + "_" + value would prove problematic if we were to
* allow "_" in a future release.
* </pre>
*
* <code>map<string, string> labels = 7;</code>
*/
java.lang.String getLabelsOrThrow(java.lang.String key);
/**
*
*
* <pre>
* Deprecated. This field is not populated.
* </pre>
*
* <code>repeated string endpoint_uris = 8;</code>
*
* @return A list containing the endpointUris.
*/
java.util.List<java.lang.String> getEndpointUrisList();
/**
*
*
* <pre>
* Deprecated. This field is not populated.
* </pre>
*
* <code>repeated string endpoint_uris = 8;</code>
*
* @return The count of endpointUris.
*/
int getEndpointUrisCount();
/**
*
*
* <pre>
* Deprecated. This field is not populated.
* </pre>
*
* <code>repeated string endpoint_uris = 8;</code>
*
* @param index The index of the element to return.
* @return The endpointUris at the given index.
*/
java.lang.String getEndpointUris(int index);
/**
*
*
* <pre>
* Deprecated. This field is not populated.
* </pre>
*
* <code>repeated string endpoint_uris = 8;</code>
*
* @param index The index of the value to return.
* @return The bytes of the endpointUris at the given index.
*/
com.google.protobuf.ByteString getEndpointUrisBytes(int index);
}