/
Instance.java
242 lines (208 loc) · 7.77 KB
/
Instance.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
/*
* Copyright 2017 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
*
* http://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.
*/
package com.google.cloud.spanner;
import com.google.api.gax.longrunning.OperationFuture;
import com.google.api.gax.paging.Page;
import com.google.cloud.Policy;
import com.google.cloud.Timestamp;
import com.google.cloud.spanner.Options.ListOption;
import com.google.longrunning.Operation;
import com.google.spanner.admin.database.v1.CreateDatabaseMetadata;
import com.google.spanner.admin.instance.v1.UpdateInstanceMetadata;
import java.util.Map;
/**
* Represents a Cloud Spanner Instance. {@code Instance} adds a layer of service related
* functionality over {@code InstanceInfo}.
*/
public class Instance extends InstanceInfo {
/** Builder of {@code Instance}. */
public static class Builder extends InstanceInfo.Builder {
private final InstanceAdminClient instanceClient;
private final DatabaseAdminClient dbClient;
private final InstanceInfo.BuilderImpl infoBuilder;
Builder(Instance instance) {
this.instanceClient = instance.instanceClient;
this.dbClient = instance.dbClient;
this.infoBuilder = new InstanceInfo.BuilderImpl(instance);
}
Builder(InstanceAdminClient instanceClient, DatabaseAdminClient dbClient, InstanceId id) {
this.instanceClient = instanceClient;
this.dbClient = dbClient;
this.infoBuilder = new InstanceInfo.BuilderImpl(id);
}
@Override
public Builder setInstanceConfigId(InstanceConfigId instanceConfigId) {
infoBuilder.setInstanceConfigId(instanceConfigId);
return this;
}
@Override
public Builder setDisplayName(String displayName) {
infoBuilder.setDisplayName(displayName);
return this;
}
@Override
Builder setUpdateTime(Timestamp updateTime) {
infoBuilder.setUpdateTime(updateTime);
return this;
}
@Override
Builder setCreateTime(Timestamp createTime) {
infoBuilder.setCreateTime(createTime);
return this;
}
@Override
public Builder setNodeCount(int nodeCount) {
infoBuilder.setNodeCount(nodeCount);
return this;
}
@Override
public Builder setProcessingUnits(int processingUnits) {
infoBuilder.setProcessingUnits(processingUnits);
return this;
}
@Override
public Builder setState(State state) {
infoBuilder.setState(state);
return this;
}
@Override
public Builder addLabel(String key, String value) {
infoBuilder.addLabel(key, value);
return this;
}
@Override
public Builder putAllLabels(Map<String, String> labels) {
infoBuilder.putAllLabels(labels);
return this;
}
@Override
public Instance build() {
return new Instance(this);
}
}
private final InstanceAdminClient instanceClient;
private final DatabaseAdminClient dbClient;
Instance(Builder builder) {
super(builder.infoBuilder);
this.instanceClient = builder.instanceClient;
this.dbClient = builder.dbClient;
}
public Instance reload() {
return instanceClient.getInstance(instanceId());
}
public void delete() {
instanceClient.deleteInstance(instanceId());
}
public OperationFuture<Instance, UpdateInstanceMetadata> update(
InstanceInfo.InstanceField... fieldsToUpdate) {
return instanceClient.updateInstance(this, fieldsToUpdate);
}
public Page<Database> listDatabases(ListOption... options) {
return dbClient.listDatabases(instanceId(), options);
}
public Database getDatabase(String databaseId) {
return dbClient.getDatabase(instanceId(), databaseId);
}
/**
* Creates a new database in this instance.
*
* @param databaseId the id of the database which will be created. It must conform to the regular
* expression [a-z][a-z0-9_\-]*[a-z0-9] and be between 2 and 30 characters in length
* @param statements DDL statements to run while creating the database, for example {@code CREATE
* TABLE MyTable ( ... )}. This should not include {@code CREATE DATABASE} statement.
*/
public OperationFuture<Database, CreateDatabaseMetadata> createDatabase(
String databaseId, Iterable<String> statements) throws SpannerException {
return dbClient.createDatabase(instanceId(), databaseId, statements);
}
/** Returns the backups belonging to this instance. */
public Page<Backup> listBackups(ListOption... options) {
return dbClient.listBackups(instanceId(), options);
}
/** Returns the backup with the given id on this instance. */
public Backup getBackup(String backupId) {
return dbClient.getBackup(instanceId(), backupId);
}
/** Returns the long-running database operations on this instance. */
public Page<Operation> listDatabaseOperations(ListOption... options) {
return dbClient.listDatabaseOperations(instanceId(), options);
}
/** Returns the long-running backup operations on this instance. */
public Page<Operation> listBackupOperations(ListOption... options) {
return dbClient.listBackupOperations(instanceId(), options);
}
/** Returns the IAM {@link Policy} for this instance. */
public Policy getIAMPolicy() {
return instanceClient.getInstanceIAMPolicy(instanceId());
}
/**
* Updates the IAM policy for this instance and returns the resulting policy. It is highly
* recommended to first get the current policy and base the updated policy on the returned policy.
* See {@link Policy.Builder#setEtag(String)} for information on the recommended read-modify-write
* cycle.
*/
public Policy setIAMPolicy(Policy policy) {
return instanceClient.setInstanceIAMPolicy(instanceId(), policy);
}
/**
* Tests for the given permissions on this instance for the caller.
*
* @param permissions the permissions to test for. Permissions with wildcards (such as '*',
* 'spanner.*', 'spanner.instances.*') are not allowed.
* @return the subset of the tested permissions that the caller is allowed.
*/
public Iterable<String> testIAMPermissions(Iterable<String> permissions) {
return instanceClient.testInstanceIAMPermissions(instanceId(), permissions);
}
private String instanceId() {
return getId().getInstance();
}
@Override
public Builder toBuilder() {
return new Builder(this);
}
static Instance fromProto(
com.google.spanner.admin.instance.v1.Instance proto,
InstanceAdminClient instanceClient,
DatabaseAdminClient dbClient) {
InstanceId id = InstanceId.of(proto.getName());
Builder builder =
new Builder(instanceClient, dbClient, id)
.setInstanceConfigId(InstanceConfigId.of(proto.getConfig()))
.setDisplayName(proto.getDisplayName())
.setNodeCount(proto.getNodeCount())
.setCreateTime(Timestamp.fromProto(proto.getCreateTime()))
.setUpdateTime(Timestamp.fromProto(proto.getUpdateTime()))
.setProcessingUnits(proto.getProcessingUnits());
State state;
switch (proto.getState()) {
case STATE_UNSPECIFIED:
state = State.UNSPECIFIED;
break;
case CREATING:
state = State.CREATING;
break;
case READY:
state = State.READY;
break;
default:
throw new IllegalArgumentException("Unknown state:" + proto.getState());
}
builder.setState(state);
builder.putAllLabels(proto.getLabelsMap());
return builder.build();
}
}