Repository navigation
Expand file tree
/
Copy pathInstanceConfiguration.php
More file actions
213 lines (197 loc) · 5.46 KB
/
Copy pathInstanceConfiguration.php
File metadata and controls
213 lines (197 loc) · 5.46 KB
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
<?php
/**
* Copyright 2016 Google Inc.
*
* 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.
*/
namespace Google\Cloud\Spanner;
use Google\Cloud\Core\Exception\NotFoundException;
use Google\Cloud\Spanner\Admin\Instance\V1\InstanceAdminClient;
use Google\Cloud\Spanner\Connection\ConnectionInterface;
use Google\ApiCore\ValidationException;
/**
* Represents a Cloud Spanner Instance Configuration.
*
* Example:
* ```
* use Google\Cloud\Spanner\SpannerClient;
*
* $spanner = new SpannerClient();
*
* $configuration = $spanner->instanceConfiguration('regional-europe-west');
* ```
*
* @codingStandardsIgnoreStart
* @see https://cloud.google.com/spanner/docs/reference/rpc/google.spanner.admin.instance.v1#instanceconfig InstanceConfig
* @codingStandardsIgnoreEnd
*/
class InstanceConfiguration
{
/**
* @var ConnectionInterface
*/
private $connection;
/**
* @var string
*/
private $projectId;
/**
* @var string
*/
private $name;
/**
* @var array
*/
private $info;
/**
* Create an instance configuration object.
*
* @param ConnectionInterface $connection A service connection for the
* Spanner API.
* @param string $projectId The current project ID.
* @param string $name The configuration name or ID.
* @param array $info [optional] A service representation of the
* configuration.
*/
public function __construct(
ConnectionInterface $connection,
$projectId,
$name,
array $info = []
) {
$this->connection = $connection;
$this->projectId = $projectId;
$this->name = $this->fullyQualifiedConfigName($name, $projectId);
$this->info = $info;
}
/**
* Return the configuration name.
*
* Example:
* ```
* $name = $configuration->name();
* ```
*
* @return string
*/
public function name()
{
return $this->name;
}
/**
* Return the service representation of the configuration.
*
* This method may require a service call.
*
* **NOTE**: Requires `https://www.googleapis.com/auth/spanner.admin` scope.
*
* Example:
* ```
* $info = $configuration->info();
* ```
*
* @codingStandardsIgnoreStart
* @param array $options [optional] Configuration options.
* @return array [InstanceConfig](https://cloud.google.com/spanner/docs/reference/rpc/google.spanner.admin.instance.v1#instanceconfig)
* @codingStandardsIgnoreEnd
*/
public function info(array $options = [])
{
if (!$this->info) {
$this->reload($options);
}
return $this->info;
}
/**
* Check if the configuration exists.
*
* This method requires a service call.
*
* **NOTE**: Requires `https://www.googleapis.com/auth/spanner.admin` scope.
*
* Example:
* ```
* if ($configuration->exists()) {
* echo 'Configuration exists!';
* }
* ```
*
* @param array $options [optional] Configuration options.
* @return bool
*/
public function exists(array $options = [])
{
try {
$this->reload($options = []);
} catch (NotFoundException $e) {
return false;
}
return true;
}
/**
* Fetch a fresh representation of the configuration from the service.
*
* **NOTE**: Requires `https://www.googleapis.com/auth/spanner.admin` scope.
*
* Example:
* ```
* $info = $configuration->reload();
* ```
*
* @codingStandardsIgnoreStart
* @param array $options [optional] Configuration options.
* @return array [InstanceConfig](https://cloud.google.com/spanner/docs/reference/rpc/google.spanner.admin.instance.v1#instanceconfig)
* @codingStandardsIgnoreEnd
*/
public function reload(array $options = [])
{
$this->info = $this->connection->getInstanceConfig($options + [
'name' => $this->name,
'projectName' => InstanceAdminClient::projectName($this->projectId),
]);
return $this->info;
}
/**
* A more readable representation of the object.
*
* @codeCoverageIgnore
* @access private
*/
public function __debugInfo()
{
return [
'connection' => get_class($this->connection),
'projectId' => $this->projectId,
'name' => $this->name,
'info' => $this->info,
];
}
/**
* Get the fully qualified instance config name.
*
* @param string $name The configuration name.
* @param string $projectId The project ID.
* @return string
*/
private function fullyQualifiedConfigName($name, $projectId)
{
try {
return InstanceAdminClient::instanceConfigName(
$projectId,
$name
);
} catch (ValidationException $e) {
return $name;
}
}
}