public sealed class InstanceAdminClientImpl : InstanceAdminClientReference documentation and code samples for the Google Cloud Spanner Instance Administration v1 API class InstanceAdminClientImpl.
InstanceAdmin client wrapper implementation, for convenient use.
Namespace
Google.Cloud.Spanner.Admin.Instance.V1Assembly
Google.Cloud.Spanner.Admin.Instance.V1.dll
Remarks
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.
Constructors
InstanceAdminClientImpl(InstanceAdmin.InstanceAdminClient, InstanceAdminSettings, ILogger)
public InstanceAdminClientImpl(InstanceAdmin.InstanceAdminClient grpcClient, InstanceAdminSettings settings, ILogger logger)Constructs a client wrapper for the InstanceAdmin service, with the specified gRPC client and settings.
| Parameters | |
|---|---|
| Name | Description |
grpcClient | InstanceAdmin.InstanceAdminClientThe underlying gRPC client. |
settings | InstanceAdminSettingsThe base InstanceAdminSettings used within this client. |
logger | ILoggerOptional ILogger to use within this client. |
Fields
ResourcePrefixHeader
public const string ResourcePrefixHeader = "google-cloud-resource-prefix"The name of the header used for efficiently routing requests.
| Field Value | |
|---|---|
| Type | Description |
String | |
This should be set to the instance resource name ("projects/{projectId}/instances/{instanceId}") for some RPCs and to the project resource name for others ("projects/{projectId}"). For non-streaming calls, InstanceAdminClientImpl performs this automatically. This cannot be performed automatically for streaming calls due to the separation between initializing the stream and sending requests, so client code should set the value in a CallSettings. Typically this is performed with either the FromHeader(string, string) factory method or the WithHeader(CallSettings, string, string) extension method.
Properties
CreateInstanceConfigOperationsClient
public override OperationsClient CreateInstanceConfigOperationsClient { get; }The long-running operations client for CreateInstanceConfig.
| Property Value | |
|---|---|
| Type | Description |
OperationsClient | |
CreateInstanceOperationsClient
public override OperationsClient CreateInstanceOperationsClient { get; }The long-running operations client for CreateInstance.
| Property Value | |
|---|---|
| Type | Description |
OperationsClient | |
GrpcClient
public override InstanceAdmin.InstanceAdminClient GrpcClient { get; }The underlying gRPC InstanceAdmin client
| Property Value | |
|---|---|
| Type | Description |
InstanceAdmin.InstanceAdminClient | |
UpdateInstanceConfigOperationsClient
public override OperationsClient UpdateInstanceConfigOperationsClient { get; }The long-running operations client for UpdateInstanceConfig.
| Property Value | |
|---|---|
| Type | Description |
OperationsClient | |
UpdateInstanceOperationsClient
public override OperationsClient UpdateInstanceOperationsClient { get; }The long-running operations client for UpdateInstance.
| Property Value | |
|---|---|
| Type | Description |
OperationsClient | |
Methods
CreateInstance(CreateInstanceRequest, CallSettings)
public override Operation<Instance, CreateInstanceMetadata> CreateInstance(CreateInstanceRequest request, CallSettings callSettings = null)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.
| Parameters | |
|---|---|
| Name | Description |
request | CreateInstanceRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
Operation<Instance, CreateInstanceMetadata> | The RPC response. |
CreateInstanceAsync(CreateInstanceRequest, CallSettings)
public override async Task<Operation<Instance, CreateInstanceMetadata>> CreateInstanceAsync(CreateInstanceRequest request, CallSettings callSettings = null)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.
| Parameters | |
|---|---|
| Name | Description |
request | CreateInstanceRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
Task<Operation<Instance, CreateInstanceMetadata>> | A Task containing the RPC response. |
CreateInstanceConfig(CreateInstanceConfigRequest, CallSettings)
public override Operation<InstanceConfig, CreateInstanceConfigMetadata> CreateInstanceConfig(CreateInstanceConfigRequest request, CallSettings callSettings = null)Creates an instance config and begins preparing it to be used. The
returned [long-running operation][google.longrunning.Operation]
can be used to track the progress of preparing the new
instance config. The instance config name is assigned by the caller. If the
named instance config already exists, CreateInstanceConfig returns
ALREADY_EXISTS.
Immediately after the request returns:
- The instance config is readable via the API, with all requested
attributes. The instance config's
[reconciling][google.spanner.admin.instance.v1.InstanceConfig.reconciling]
field is set to true. Its state is
CREATING.
While the operation is pending:
- Cancelling the operation renders the instance config immediately unreadable via the API.
- Except for deleting the creating resource, all other attempts to modify the instance config are rejected.
Upon completion of the returned operation:
- Instances can be created using the instance configuration.
- The instance config's
[reconciling][google.spanner.admin.instance.v1.InstanceConfig.reconciling]
field becomes false. Its state becomes
READY.
The returned [long-running operation][google.longrunning.Operation] will
have a name of the format
<instance_config_name>/operations/<operation_id> and can be used to track
creation of the instance config. The
[metadata][google.longrunning.Operation.metadata] field type is
[CreateInstanceConfigMetadata][google.spanner.admin.instance.v1.CreateInstanceConfigMetadata].
The [response][google.longrunning.Operation.response] field type is
[InstanceConfig][google.spanner.admin.instance.v1.InstanceConfig], if
successful.
Authorization requires spanner.instanceConfigs.create permission on
the resource
[parent][google.spanner.admin.instance.v1.CreateInstanceConfigRequest.parent].
| Parameters | |
|---|---|
| Name | Description |
request | CreateInstanceConfigRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
Operation<InstanceConfig, CreateInstanceConfigMetadata> | The RPC response. |
CreateInstanceConfigAsync(CreateInstanceConfigRequest, CallSettings)
public override async Task<Operation<InstanceConfig, CreateInstanceConfigMetadata>> CreateInstanceConfigAsync(CreateInstanceConfigRequest request, CallSettings callSettings = null)Creates an instance config and begins preparing it to be used. The
returned [long-running operation][google.longrunning.Operation]
can be used to track the progress of preparing the new
instance config. The instance config name is assigned by the caller. If the
named instance config already exists, CreateInstanceConfig returns
ALREADY_EXISTS.
Immediately after the request returns:
- The instance config is readable via the API, with all requested
attributes. The instance config's
[reconciling][google.spanner.admin.instance.v1.InstanceConfig.reconciling]
field is set to true. Its state is
CREATING.
While the operation is pending:
- Cancelling the operation renders the instance config immediately unreadable via the API.
- Except for deleting the creating resource, all other attempts to modify the instance config are rejected.
Upon completion of the returned operation:
- Instances can be created using the instance configuration.
- The instance config's
[reconciling][google.spanner.admin.instance.v1.InstanceConfig.reconciling]
field becomes false. Its state becomes
READY.
The returned [long-running operation][google.longrunning.Operation] will
have a name of the format
<instance_config_name>/operations/<operation_id> and can be used to track
creation of the instance config. The
[metadata][google.longrunning.Operation.metadata] field type is
[CreateInstanceConfigMetadata][google.spanner.admin.instance.v1.CreateInstanceConfigMetadata].
The [response][google.longrunning.Operation.response] field type is
[InstanceConfig][google.spanner.admin.instance.v1.InstanceConfig], if
successful.
Authorization requires spanner.instanceConfigs.create permission on
the resource
[parent][google.spanner.admin.instance.v1.CreateInstanceConfigRequest.parent].
| Parameters | |
|---|---|
| Name | Description |
request | CreateInstanceConfigRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
Task<Operation<InstanceConfig, CreateInstanceConfigMetadata>> | A Task containing the RPC response. |
DeleteInstance(DeleteInstanceRequest, CallSettings)
public override void DeleteInstance(DeleteInstanceRequest request, CallSettings callSettings = null)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.
| Parameters | |
|---|---|
| Name | Description |
request | DeleteInstanceRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
DeleteInstanceAsync(DeleteInstanceRequest, CallSettings)
public override Task DeleteInstanceAsync(DeleteInstanceRequest request, CallSettings callSettings = null)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.
| Parameters | |
|---|---|
| Name | Description |
request | DeleteInstanceRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
System.Threading.Tasks.Task | A Task containing the RPC response. |
DeleteInstanceConfig(DeleteInstanceConfigRequest, CallSettings)
public override void DeleteInstanceConfig(DeleteInstanceConfigRequest request, CallSettings callSettings = null)Deletes the instance config. Deletion is only allowed when no
instances are using the configuration. If any instances are using
the config, returns FAILED_PRECONDITION.
Only user managed configurations can be deleted.
Authorization requires spanner.instanceConfigs.delete permission on
the resource [name][google.spanner.admin.instance.v1.InstanceConfig.name].
| Parameters | |
|---|---|
| Name | Description |
request | DeleteInstanceConfigRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
DeleteInstanceConfigAsync(DeleteInstanceConfigRequest, CallSettings)
public override Task DeleteInstanceConfigAsync(DeleteInstanceConfigRequest request, CallSettings callSettings = null)Deletes the instance config. Deletion is only allowed when no
instances are using the configuration. If any instances are using
the config, returns FAILED_PRECONDITION.
Only user managed configurations can be deleted.
Authorization requires spanner.instanceConfigs.delete permission on
the resource [name][google.spanner.admin.instance.v1.InstanceConfig.name].
| Parameters | |
|---|---|
| Name | Description |
request | DeleteInstanceConfigRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
System.Threading.Tasks.Task | A Task containing the RPC response. |
GetIamPolicy(GetIamPolicyRequest, CallSettings)
public override Policy GetIamPolicy(GetIamPolicyRequest request, CallSettings callSettings = null)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].
| Parameters | |
|---|---|
| Name | Description |
request | GetIamPolicyRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
Policy | The RPC response. |
GetIamPolicyAsync(GetIamPolicyRequest, CallSettings)
public override Task<Policy> GetIamPolicyAsync(GetIamPolicyRequest request, CallSettings callSettings = null)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].
| Parameters | |
|---|---|
| Name | Description |
request | GetIamPolicyRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
Task<Policy> | A Task containing the RPC response. |
GetInstance(GetInstanceRequest, CallSettings)
public override Instance GetInstance(GetInstanceRequest request, CallSettings callSettings = null)Gets information about a particular instance.
| Parameters | |
|---|---|
| Name | Description |
request | GetInstanceRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
Instance | The RPC response. |
GetInstanceAsync(GetInstanceRequest, CallSettings)
public override Task<Instance> GetInstanceAsync(GetInstanceRequest request, CallSettings callSettings = null)Gets information about a particular instance.
| Parameters | |
|---|---|
| Name | Description |
request | GetInstanceRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
Task<Instance> | A Task containing the RPC response. |
GetInstanceConfig(GetInstanceConfigRequest, CallSettings)
public override InstanceConfig GetInstanceConfig(GetInstanceConfigRequest request, CallSettings callSettings = null)Gets information about a particular instance configuration.
| Parameters | |
|---|---|
| Name | Description |
request | GetInstanceConfigRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
InstanceConfig | The RPC response. |
GetInstanceConfigAsync(GetInstanceConfigRequest, CallSettings)
public override Task<InstanceConfig> GetInstanceConfigAsync(GetInstanceConfigRequest request, CallSettings callSettings = null)Gets information about a particular instance configuration.
| Parameters | |
|---|---|
| Name | Description |
request | GetInstanceConfigRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
Task<InstanceConfig> | A Task containing the RPC response. |
ListInstanceConfigOperations(ListInstanceConfigOperationsRequest, CallSettings)
public override PagedEnumerable<ListInstanceConfigOperationsResponse, Operation> ListInstanceConfigOperations(ListInstanceConfigOperationsRequest request, CallSettings callSettings = null)Lists the user-managed instance config [long-running
operations][google.longrunning.Operation] in the given project. An instance
config operation has a name of the form
projects/<project>/instanceConfigs/<instance_config>/operations/<operation>.
The long-running operation
[metadata][google.longrunning.Operation.metadata] field type
metadata.type_url describes the type of the metadata. Operations returned
include those that have completed/failed/canceled within the last 7 days,
and pending operations. Operations returned are ordered by
operation.metadata.value.start_time in descending order starting
from the most recently started operation.
| Parameters | |
|---|---|
| Name | Description |
request | ListInstanceConfigOperationsRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
PagedEnumerable<ListInstanceConfigOperationsResponse, Operation> | A pageable sequence of Operation resources. |
ListInstanceConfigOperationsAsync(ListInstanceConfigOperationsRequest, CallSettings)
public override PagedAsyncEnumerable<ListInstanceConfigOperationsResponse, Operation> ListInstanceConfigOperationsAsync(ListInstanceConfigOperationsRequest request, CallSettings callSettings = null)Lists the user-managed instance config [long-running
operations][google.longrunning.Operation] in the given project. An instance
config operation has a name of the form
projects/<project>/instanceConfigs/<instance_config>/operations/<operation>.
The long-running operation
[metadata][google.longrunning.Operation.metadata] field type
metadata.type_url describes the type of the metadata. Operations returned
include those that have completed/failed/canceled within the last 7 days,
and pending operations. Operations returned are ordered by
operation.metadata.value.start_time in descending order starting
from the most recently started operation.
| Parameters | |
|---|---|
| Name | Description |
request | ListInstanceConfigOperationsRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
PagedAsyncEnumerable<ListInstanceConfigOperationsResponse, Operation> | A pageable asynchronous sequence of Operation resources. |
ListInstanceConfigs(ListInstanceConfigsRequest, CallSettings)
public override PagedEnumerable<ListInstanceConfigsResponse, InstanceConfig> ListInstanceConfigs(ListInstanceConfigsRequest request, CallSettings callSettings = null)Lists the supported instance configurations for a given project.
| Parameters | |
|---|---|
| Name | Description |
request | ListInstanceConfigsRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
PagedEnumerable<ListInstanceConfigsResponse, InstanceConfig> | A pageable sequence of InstanceConfig resources. |
ListInstanceConfigsAsync(ListInstanceConfigsRequest, CallSettings)
public override PagedAsyncEnumerable<ListInstanceConfigsResponse, InstanceConfig> ListInstanceConfigsAsync(ListInstanceConfigsRequest request, CallSettings callSettings = null)Lists the supported instance configurations for a given project.
| Parameters | |
|---|---|
| Name | Description |
request | ListInstanceConfigsRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
PagedAsyncEnumerable<ListInstanceConfigsResponse, InstanceConfig> | A pageable asynchronous sequence of InstanceConfig resources. |
ListInstances(ListInstancesRequest, CallSettings)
public override PagedEnumerable<ListInstancesResponse, Instance> ListInstances(ListInstancesRequest request, CallSettings callSettings = null)Lists all instances in the given project.
| Parameters | |
|---|---|
| Name | Description |
request | ListInstancesRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
PagedEnumerable<ListInstancesResponse, Instance> | A pageable sequence of Instance resources. |
ListInstancesAsync(ListInstancesRequest, CallSettings)
public override PagedAsyncEnumerable<ListInstancesResponse, Instance> ListInstancesAsync(ListInstancesRequest request, CallSettings callSettings = null)Lists all instances in the given project.
| Parameters | |
|---|---|
| Name | Description |
request | ListInstancesRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
PagedAsyncEnumerable<ListInstancesResponse, Instance> | A pageable asynchronous sequence of Instance resources. |
SetIamPolicy(SetIamPolicyRequest, CallSettings)
public override Policy SetIamPolicy(SetIamPolicyRequest request, CallSettings callSettings = null)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].
| Parameters | |
|---|---|
| Name | Description |
request | SetIamPolicyRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
Policy | The RPC response. |
SetIamPolicyAsync(SetIamPolicyRequest, CallSettings)
public override Task<Policy> SetIamPolicyAsync(SetIamPolicyRequest request, CallSettings callSettings = null)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].
| Parameters | |
|---|---|
| Name | Description |
request | SetIamPolicyRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
Task<Policy> | A Task containing the RPC response. |
TestIamPermissions(TestIamPermissionsRequest, CallSettings)
public override TestIamPermissionsResponse TestIamPermissions(TestIamPermissionsRequest request, CallSettings callSettings = null)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.
| Parameters | |
|---|---|
| Name | Description |
request | TestIamPermissionsRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TestIamPermissionsResponse | The RPC response. |
TestIamPermissionsAsync(TestIamPermissionsRequest, CallSettings)
public override Task<TestIamPermissionsResponse> TestIamPermissionsAsync(TestIamPermissionsRequest request, CallSettings callSettings = null)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.
| Parameters | |
|---|---|
| Name | Description |
request | TestIamPermissionsRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
Task<TestIamPermissionsResponse> | A Task containing the RPC response. |
UpdateInstance(UpdateInstanceRequest, CallSettings)
public override Operation<Instance, UpdateInstanceMetadata> UpdateInstance(UpdateInstanceRequest request, CallSettings callSettings = null)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
the resource [name][google.spanner.admin.instance.v1.Instance.name].
| Parameters | |
|---|---|
| Name | Description |
request | UpdateInstanceRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
Operation<Instance, UpdateInstanceMetadata> | The RPC response. |
UpdateInstanceAsync(UpdateInstanceRequest, CallSettings)
public override async Task<Operation<Instance, UpdateInstanceMetadata>> UpdateInstanceAsync(UpdateInstanceRequest request, CallSettings callSettings = null)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
the resource [name][google.spanner.admin.instance.v1.Instance.name].
| Parameters | |
|---|---|
| Name | Description |
request | UpdateInstanceRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
Task<Operation<Instance, UpdateInstanceMetadata>> | A Task containing the RPC response. |
UpdateInstanceConfig(UpdateInstanceConfigRequest, CallSettings)
public override Operation<InstanceConfig, UpdateInstanceConfigMetadata> UpdateInstanceConfig(UpdateInstanceConfigRequest request, CallSettings callSettings = null)Updates an instance config. The returned
[long-running operation][google.longrunning.Operation] can be used to track
the progress of updating the instance. If the named instance config does
not exist, returns NOT_FOUND.
Only user managed configurations can be updated.
Immediately after the request returns:
- The instance config's [reconciling][google.spanner.admin.instance.v1.InstanceConfig.reconciling] field is set to true.
While the operation is pending:
- Cancelling the operation sets its metadata's
[cancel_time][google.spanner.admin.instance.v1.UpdateInstanceConfigMetadata.cancel_time].
The operation is guaranteed to succeed at undoing all changes, after
which point it terminates with a
CANCELLEDstatus. - All other attempts to modify the instance config are rejected.
- Reading the instance config via the API continues to give the pre-request values.
Upon completion of the returned operation:
- Creating instances using the instance configuration uses the new values.
- The instance config's new values are readable via the API.
- The instance config's [reconciling][google.spanner.admin.instance.v1.InstanceConfig.reconciling] field becomes false.
The returned [long-running operation][google.longrunning.Operation] will
have a name of the format
<instance_config_name>/operations/<operation_id> and can be used to track
the instance config modification. The
[metadata][google.longrunning.Operation.metadata] field type is
[UpdateInstanceConfigMetadata][google.spanner.admin.instance.v1.UpdateInstanceConfigMetadata].
The [response][google.longrunning.Operation.response] field type is
[InstanceConfig][google.spanner.admin.instance.v1.InstanceConfig], if
successful.
Authorization requires spanner.instanceConfigs.update permission on
the resource [name][google.spanner.admin.instance.v1.InstanceConfig.name].
| Parameters | |
|---|---|
| Name | Description |
request | UpdateInstanceConfigRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
Operation<InstanceConfig, UpdateInstanceConfigMetadata> | The RPC response. |
UpdateInstanceConfigAsync(UpdateInstanceConfigRequest, CallSettings)
public override async Task<Operation<InstanceConfig, UpdateInstanceConfigMetadata>> UpdateInstanceConfigAsync(UpdateInstanceConfigRequest request, CallSettings callSettings = null)Updates an instance config. The returned
[long-running operation][google.longrunning.Operation] can be used to track
the progress of updating the instance. If the named instance config does
not exist, returns NOT_FOUND.
Only user managed configurations can be updated.
Immediately after the request returns:
- The instance config's [reconciling][google.spanner.admin.instance.v1.InstanceConfig.reconciling] field is set to true.
While the operation is pending:
- Cancelling the operation sets its metadata's
[cancel_time][google.spanner.admin.instance.v1.UpdateInstanceConfigMetadata.cancel_time].
The operation is guaranteed to succeed at undoing all changes, after
which point it terminates with a
CANCELLEDstatus. - All other attempts to modify the instance config are rejected.
- Reading the instance config via the API continues to give the pre-request values.
Upon completion of the returned operation:
- Creating instances using the instance configuration uses the new values.
- The instance config's new values are readable via the API.
- The instance config's [reconciling][google.spanner.admin.instance.v1.InstanceConfig.reconciling] field becomes false.
The returned [long-running operation][google.longrunning.Operation] will
have a name of the format
<instance_config_name>/operations/<operation_id> and can be used to track
the instance config modification. The
[metadata][google.longrunning.Operation.metadata] field type is
[UpdateInstanceConfigMetadata][google.spanner.admin.instance.v1.UpdateInstanceConfigMetadata].
The [response][google.longrunning.Operation.response] field type is
[InstanceConfig][google.spanner.admin.instance.v1.InstanceConfig], if
successful.
Authorization requires spanner.instanceConfigs.update permission on
the resource [name][google.spanner.admin.instance.v1.InstanceConfig.name].
| Parameters | |
|---|---|
| Name | Description |
request | UpdateInstanceConfigRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
Task<Operation<InstanceConfig, UpdateInstanceConfigMetadata>> | A Task containing the RPC response. |