InstanceAdminGrpcClient
class InstanceAdminGrpcClient extends BaseStub
Cloud Spanner Instance Admin API
The Cloud Spanner Instance Admin API can be used to create, delete, modify and list instances. Instances are dedicated Cloud Spanner serving and storage resources to be used by Cloud Spanner databases.
Each instance has a "configuration", which dictates where the serving resources for the Cloud Spanner instance are located (e.g., US-central, Europe). Configurations are created by Google based on resource availability.
Cloud Spanner billing is based on the instances that exist and their sizes. After an instance exists, there are no additional per-database or per-operation charges for use of the instance (though there may be additional network bandwidth charges). Instances offer isolation: problems with databases in one instance will not affect other instances. However, within an instance databases can affect each other. For example, if one database in an instance receives a lot of requests and consumes most of the instance resources, fewer resources are available for other databases in that instance, and their performance may suffer.
Methods
No description
Lists the supported instance configurations for a given project.
Gets information about a particular instance configuration.
Lists all instances in the given project.
Gets information about a particular instance.
Creates an instance and begins preparing it to begin serving. The
returned [long-running operation][google.longrunning.Operation]
can be used to track the progress of preparing the new
instance. The instance name is assigned by the caller. If the
named instance already exists, CreateInstance returns
ALREADY_EXISTS.
Updates an instance, and begins allocating or releasing resources
as requested. The returned [long-running
operation][google.longrunning.Operation] can be used to track the
progress of updating the instance. If the named instance does not
exist, returns NOT_FOUND.
Deletes an instance.
Sets the access control policy on an instance resource. Replaces any existing policy.
Gets the access control policy for an instance resource. Returns an empty policy if an instance exists but does not have a policy set.
Returns permissions that the caller has on the specified instance resource.
Details
at line 51
__construct(string $hostname, array $opts, Channel $channel = null)
at line 61
ListInstanceConfigs(ListInstanceConfigsRequest $argument, array $metadata = [], array $options = [])
Lists the supported instance configurations for a given project.
at line 75
GetInstanceConfig(GetInstanceConfigRequest $argument, array $metadata = [], array $options = [])
Gets information about a particular instance configuration.
at line 89
ListInstances(ListInstancesRequest $argument, array $metadata = [], array $options = [])
Lists all instances in the given project.
at line 103
GetInstance(GetInstanceRequest $argument, array $metadata = [], array $options = [])
Gets information about a particular instance.
at line 150
CreateInstance(CreateInstanceRequest $argument, array $metadata = [], array $options = [])
Creates an instance and begins preparing it to begin serving. The
returned [long-running operation][google.longrunning.Operation]
can be used to track the progress of preparing the new
instance. The instance name is assigned by the caller. If the
named instance already exists, CreateInstance returns
ALREADY_EXISTS.
Immediately upon completion of this request:
- The instance is readable via the API, with all requested attributes
but no allocated resources. Its state is
CREATING.
Until completion of the returned operation:
- Cancelling the operation renders the instance immediately unreadable via the API.
- The instance can be deleted.
- All other attempts to modify the instance are rejected.
Upon completion of the returned operation:
- Billing for all successfully-allocated resources begins (some types may have lower than the requested levels).
- Databases can be created in the instance.
- The instance's allocated resource levels are readable via the API.
- The instance's state becomes
READY.
The returned [long-running operation][google.longrunning.Operation] will
have a name of the format <instance_name>/operations/<operation_id> and
can be used to track creation of the instance. The
[metadata][google.longrunning.Operation.metadata] field type is
[CreateInstanceMetadata][google.spanner.admin.instance.v1.CreateInstanceMetadata].
The [response][google.longrunning.Operation.response] field type is
[Instance][google.spanner.admin.instance.v1.Instance], if successful.
at line 203
UpdateInstance(UpdateInstanceRequest $argument, array $metadata = [], array $options = [])
Updates an instance, and begins allocating or releasing resources
as requested. The returned [long-running
operation][google.longrunning.Operation] can be used to track the
progress of updating the instance. If the named instance does not
exist, returns NOT_FOUND.
Immediately upon completion of this request:
- For resource types for which a decrease in the instance's allocation has been requested, billing is based on the newly-requested level.
Until completion of the returned operation:
- Cancelling the operation sets its metadata's
[cancel_time][google.spanner.admin.instance.v1.UpdateInstanceMetadata.cancel_time], and begins
restoring resources to their pre-request values. The operation
is guaranteed to succeed at undoing all resource changes,
after which point it terminates with a
CANCELLEDstatus. - All other attempts to modify the instance are rejected.
- Reading the instance via the API continues to give the pre-request resource levels.
Upon completion of the returned operation:
- Billing begins for all successfully-allocated resources (some types may have lower than the requested levels).
- All newly-reserved resources are available for serving the instance's tables.
- The instance's new resource levels are readable via the API.
The returned [long-running operation][google.longrunning.Operation] will
have a name of the format <instance_name>/operations/<operation_id> and
can be used to track the instance modification. The
[metadata][google.longrunning.Operation.metadata] field type is
[UpdateInstanceMetadata][google.spanner.admin.instance.v1.UpdateInstanceMetadata].
The [response][google.longrunning.Operation.response] field type is
[Instance][google.spanner.admin.instance.v1.Instance], if successful.
Authorization requires spanner.instances.update permission on
resource [name][google.spanner.admin.instance.v1.Instance.name].
at line 227
DeleteInstance(DeleteInstanceRequest $argument, array $metadata = [], array $options = [])
Deletes an instance.
Immediately upon completion of the request:
- Billing ceases for all of the instance's reserved resources.
Soon afterward:
- The instance and all of its databases immediately and irrevocably disappear from the API. All data in the databases is permanently deleted.
at line 245
SetIamPolicy(SetIamPolicyRequest $argument, array $metadata = [], array $options = [])
Sets the access control policy on an instance resource. Replaces any existing policy.
Authorization requires spanner.instances.setIamPolicy on
[resource][google.iam.v1.SetIamPolicyRequest.resource].
at line 263
GetIamPolicy(GetIamPolicyRequest $argument, array $metadata = [], array $options = [])
Gets the access control policy for an instance resource. Returns an empty policy if an instance exists but does not have a policy set.
Authorization requires spanner.instances.getIamPolicy on
[resource][google.iam.v1.GetIamPolicyRequest.resource].
at line 282
TestIamPermissions(TestIamPermissionsRequest $argument, array $metadata = [], array $options = [])
Returns permissions that the caller has on the specified instance resource.
Attempting this RPC on a non-existent Cloud Spanner instance resource will
result in a NOT_FOUND error if the user has spanner.instances.list
permission on the containing Google Cloud Project. Otherwise returns an
empty set of permissions.