Google Cloud Spanner Instance Administration v1 API - Class InstanceAdminClientImpl (5.0.0-beta01)

Version 5.0.0-beta01

• 5.0.0-beta03 (latest)
• 5.0.0-beta02
• 4.6.0
• 4.5.0
• 4.4.0
• 4.3.0
• 4.2.0
• 4.1.0
• 4.0.0
• 3.15.1
• 3.14.0
• 3.13.0
• 3.12.0
• 3.11.0
• 3.10.0
• 3.9.0
• 3.8.0
• 3.7.0
• 3.6.0
• 3.5.0

public sealed class InstanceAdminClientImpl : InstanceAdminClient

Reference documentation and code samples for the Google Cloud Spanner Instance Administration v1 API class InstanceAdminClientImpl.

InstanceAdmin client wrapper implementation, for convenient use.

Inheritance

object > InstanceAdminClient > InstanceAdminClientImpl

Inherited Members

InstanceAdminClient.DefaultEndpoint

InstanceAdminClient.DefaultScopes

InstanceAdminClient.ServiceMetadata

InstanceAdminClient.CreateAsync(CancellationToken)

InstanceAdminClient.Create()

InstanceAdminClient.ShutdownDefaultChannelsAsync()

InstanceAdminClient.ListInstanceConfigs(string, string, int?, CallSettings)

InstanceAdminClient.ListInstanceConfigsAsync(string, string, int?, CallSettings)

InstanceAdminClient.ListInstanceConfigs(ProjectName, string, int?, CallSettings)

InstanceAdminClient.ListInstanceConfigsAsync(ProjectName, string, int?, CallSettings)

InstanceAdminClient.GetInstanceConfigAsync(GetInstanceConfigRequest, CancellationToken)

InstanceAdminClient.GetInstanceConfig(string, CallSettings)

InstanceAdminClient.GetInstanceConfigAsync(string, CallSettings)

InstanceAdminClient.GetInstanceConfigAsync(string, CancellationToken)

InstanceAdminClient.GetInstanceConfig(InstanceConfigName, CallSettings)

InstanceAdminClient.GetInstanceConfigAsync(InstanceConfigName, CallSettings)

InstanceAdminClient.GetInstanceConfigAsync(InstanceConfigName, CancellationToken)

InstanceAdminClient.CreateInstanceConfigAsync(CreateInstanceConfigRequest, CancellationToken)

InstanceAdminClient.PollOnceCreateInstanceConfig(string, CallSettings)

InstanceAdminClient.PollOnceCreateInstanceConfigAsync(string, CallSettings)

InstanceAdminClient.CreateInstanceConfig(string, InstanceConfig, string, CallSettings)

InstanceAdminClient.CreateInstanceConfigAsync(string, InstanceConfig, string, CallSettings)

InstanceAdminClient.CreateInstanceConfigAsync(string, InstanceConfig, string, CancellationToken)

InstanceAdminClient.CreateInstanceConfig(ProjectName, InstanceConfig, string, CallSettings)

InstanceAdminClient.CreateInstanceConfigAsync(ProjectName, InstanceConfig, string, CallSettings)

InstanceAdminClient.CreateInstanceConfigAsync(ProjectName, InstanceConfig, string, CancellationToken)

InstanceAdminClient.UpdateInstanceConfigAsync(UpdateInstanceConfigRequest, CancellationToken)

InstanceAdminClient.PollOnceUpdateInstanceConfig(string, CallSettings)

InstanceAdminClient.PollOnceUpdateInstanceConfigAsync(string, CallSettings)

InstanceAdminClient.UpdateInstanceConfig(InstanceConfig, FieldMask, CallSettings)

InstanceAdminClient.UpdateInstanceConfigAsync(InstanceConfig, FieldMask, CallSettings)

InstanceAdminClient.UpdateInstanceConfigAsync(InstanceConfig, FieldMask, CancellationToken)

InstanceAdminClient.DeleteInstanceConfigAsync(DeleteInstanceConfigRequest, CancellationToken)

InstanceAdminClient.DeleteInstanceConfig(string, CallSettings)

InstanceAdminClient.DeleteInstanceConfigAsync(string, CallSettings)

InstanceAdminClient.DeleteInstanceConfigAsync(string, CancellationToken)

InstanceAdminClient.DeleteInstanceConfig(InstanceConfigName, CallSettings)

InstanceAdminClient.DeleteInstanceConfigAsync(InstanceConfigName, CallSettings)

InstanceAdminClient.DeleteInstanceConfigAsync(InstanceConfigName, CancellationToken)

InstanceAdminClient.ListInstanceConfigOperations(string, string, int?, CallSettings)

InstanceAdminClient.ListInstanceConfigOperationsAsync(string, string, int?, CallSettings)

InstanceAdminClient.ListInstanceConfigOperations(ProjectName, string, int?, CallSettings)

InstanceAdminClient.ListInstanceConfigOperationsAsync(ProjectName, string, int?, CallSettings)

InstanceAdminClient.ListInstances(string, string, int?, CallSettings)

InstanceAdminClient.ListInstancesAsync(string, string, int?, CallSettings)

InstanceAdminClient.ListInstances(ProjectName, string, int?, CallSettings)

InstanceAdminClient.ListInstancesAsync(ProjectName, string, int?, CallSettings)

InstanceAdminClient.GetInstanceAsync(GetInstanceRequest, CancellationToken)

InstanceAdminClient.GetInstance(string, CallSettings)

InstanceAdminClient.GetInstanceAsync(string, CallSettings)

InstanceAdminClient.GetInstanceAsync(string, CancellationToken)

InstanceAdminClient.GetInstance(InstanceName, CallSettings)

InstanceAdminClient.GetInstanceAsync(InstanceName, CallSettings)

InstanceAdminClient.GetInstanceAsync(InstanceName, CancellationToken)

InstanceAdminClient.CreateInstanceAsync(CreateInstanceRequest, CancellationToken)

InstanceAdminClient.PollOnceCreateInstance(string, CallSettings)

InstanceAdminClient.PollOnceCreateInstanceAsync(string, CallSettings)

InstanceAdminClient.CreateInstance(string, string, Instance, CallSettings)

InstanceAdminClient.CreateInstanceAsync(string, string, Instance, CallSettings)

InstanceAdminClient.CreateInstanceAsync(string, string, Instance, CancellationToken)

InstanceAdminClient.CreateInstance(ProjectName, string, Instance, CallSettings)

InstanceAdminClient.CreateInstanceAsync(ProjectName, string, Instance, CallSettings)

InstanceAdminClient.CreateInstanceAsync(ProjectName, string, Instance, CancellationToken)

InstanceAdminClient.UpdateInstanceAsync(UpdateInstanceRequest, CancellationToken)

InstanceAdminClient.PollOnceUpdateInstance(string, CallSettings)

InstanceAdminClient.PollOnceUpdateInstanceAsync(string, CallSettings)

InstanceAdminClient.UpdateInstance(Instance, FieldMask, CallSettings)

InstanceAdminClient.UpdateInstanceAsync(Instance, FieldMask, CallSettings)

InstanceAdminClient.UpdateInstanceAsync(Instance, FieldMask, CancellationToken)

InstanceAdminClient.DeleteInstanceAsync(DeleteInstanceRequest, CancellationToken)

InstanceAdminClient.DeleteInstance(string, CallSettings)

InstanceAdminClient.DeleteInstanceAsync(string, CallSettings)

InstanceAdminClient.DeleteInstanceAsync(string, CancellationToken)

InstanceAdminClient.DeleteInstance(InstanceName, CallSettings)

InstanceAdminClient.DeleteInstanceAsync(InstanceName, CallSettings)

InstanceAdminClient.DeleteInstanceAsync(InstanceName, CancellationToken)

InstanceAdminClient.SetIamPolicyAsync(SetIamPolicyRequest, CancellationToken)

InstanceAdminClient.SetIamPolicy(string, Policy, CallSettings)

InstanceAdminClient.SetIamPolicyAsync(string, Policy, CallSettings)

InstanceAdminClient.SetIamPolicyAsync(string, Policy, CancellationToken)

InstanceAdminClient.SetIamPolicy(IResourceName, Policy, CallSettings)

InstanceAdminClient.SetIamPolicyAsync(IResourceName, Policy, CallSettings)

InstanceAdminClient.SetIamPolicyAsync(IResourceName, Policy, CancellationToken)

InstanceAdminClient.GetIamPolicyAsync(GetIamPolicyRequest, CancellationToken)

InstanceAdminClient.GetIamPolicy(string, CallSettings)

InstanceAdminClient.GetIamPolicyAsync(string, CallSettings)

InstanceAdminClient.GetIamPolicyAsync(string, CancellationToken)

InstanceAdminClient.GetIamPolicy(IResourceName, CallSettings)

InstanceAdminClient.GetIamPolicyAsync(IResourceName, CallSettings)

InstanceAdminClient.GetIamPolicyAsync(IResourceName, CancellationToken)

InstanceAdminClient.TestIamPermissionsAsync(TestIamPermissionsRequest, CancellationToken)

InstanceAdminClient.TestIamPermissions(string, IEnumerable<string>, CallSettings)

InstanceAdminClient.TestIamPermissionsAsync(string, IEnumerable<string>, CallSettings)

InstanceAdminClient.TestIamPermissionsAsync(string, IEnumerable<string>, CancellationToken)

InstanceAdminClient.TestIamPermissions(IResourceName, IEnumerable<string>, CallSettings)

InstanceAdminClient.TestIamPermissionsAsync(IResourceName, IEnumerable<string>, CallSettings)

InstanceAdminClient.TestIamPermissionsAsync(IResourceName, IEnumerable<string>, CancellationToken)

object.GetHashCode()

object.GetType()

object.ToString()

Namespace

Google.Cloud.Spanner.Admin.Instance.V1

Assembly

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(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	InstanceAdminInstanceAdminClient The underlying gRPC client.
settings	InstanceAdminSettings The base InstanceAdminSettings used within this client.
logger	ILogger Optional 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

Remarks

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

Overrides

InstanceAdminClient.CreateInstanceConfigOperationsClient

CreateInstanceOperationsClient

public override OperationsClient CreateInstanceOperationsClient { get; }

The long-running operations client for CreateInstance.

Property Value
Type	Description
OperationsClient

Overrides

InstanceAdminClient.CreateInstanceOperationsClient

GrpcClient

public override InstanceAdmin.InstanceAdminClient GrpcClient { get; }

The underlying gRPC InstanceAdmin client

Property Value
Type	Description
InstanceAdminInstanceAdminClient

Overrides

InstanceAdminClient.GrpcClient

UpdateInstanceConfigOperationsClient

public override OperationsClient UpdateInstanceConfigOperationsClient { get; }

The long-running operations client for UpdateInstanceConfig.

Property Value
Type	Description
OperationsClient

Overrides

InstanceAdminClient.UpdateInstanceConfigOperationsClient

UpdateInstanceOperationsClient

public override OperationsClient UpdateInstanceOperationsClient { get; }

The long-running operations client for UpdateInstance.

Property Value
Type	Description
OperationsClient

Overrides

InstanceAdminClient.UpdateInstanceOperationsClient

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	CreateInstanceRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
OperationInstanceCreateInstanceMetadata	The RPC response.

Overrides

InstanceAdminClient.CreateInstance(CreateInstanceRequest, CallSettings)

CreateInstanceAsync(CreateInstanceRequest, CallSettings)

public override 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	CreateInstanceRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
TaskOperationInstanceCreateInstanceMetadata	A Task containing the RPC response.

Overrides

InstanceAdminClient.CreateInstanceAsync(CreateInstanceRequest, CallSettings)

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	CreateInstanceConfigRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
OperationInstanceConfigCreateInstanceConfigMetadata	The RPC response.

Overrides

InstanceAdminClient.CreateInstanceConfig(CreateInstanceConfigRequest, CallSettings)

CreateInstanceConfigAsync(CreateInstanceConfigRequest, CallSettings)

public override 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	CreateInstanceConfigRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
TaskOperationInstanceConfigCreateInstanceConfigMetadata	A Task containing the RPC response.

Overrides

InstanceAdminClient.CreateInstanceConfigAsync(CreateInstanceConfigRequest, CallSettings)

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	DeleteInstanceRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Overrides

InstanceAdminClient.DeleteInstance(DeleteInstanceRequest, CallSettings)

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	DeleteInstanceRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
Task	A Task containing the RPC response.

Overrides

InstanceAdminClient.DeleteInstanceAsync(DeleteInstanceRequest, CallSettings)

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	DeleteInstanceConfigRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Overrides

InstanceAdminClient.DeleteInstanceConfig(DeleteInstanceConfigRequest, CallSettings)

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	DeleteInstanceConfigRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
Task	A Task containing the RPC response.

Overrides

InstanceAdminClient.DeleteInstanceConfigAsync(DeleteInstanceConfigRequest, CallSettings)

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	GetIamPolicyRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
Policy	The RPC response.

Overrides

InstanceAdminClient.GetIamPolicy(GetIamPolicyRequest, CallSettings)

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	GetIamPolicyRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
TaskPolicy	A Task containing the RPC response.

Overrides

InstanceAdminClient.GetIamPolicyAsync(GetIamPolicyRequest, CallSettings)

GetInstance(GetInstanceRequest, CallSettings)

public override Instance GetInstance(GetInstanceRequest request, CallSettings callSettings = null)

Gets information about a particular instance.

Parameters
Name	Description
request	GetInstanceRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
Instance	The RPC response.

Overrides

InstanceAdminClient.GetInstance(GetInstanceRequest, CallSettings)

GetInstanceAsync(GetInstanceRequest, CallSettings)

public override Task<Instance> GetInstanceAsync(GetInstanceRequest request, CallSettings callSettings = null)

Gets information about a particular instance.

Parameters
Name	Description
request	GetInstanceRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
TaskInstance	A Task containing the RPC response.

Overrides

InstanceAdminClient.GetInstanceAsync(GetInstanceRequest, CallSettings)

GetInstanceConfig(GetInstanceConfigRequest, CallSettings)

public override InstanceConfig GetInstanceConfig(GetInstanceConfigRequest request, CallSettings callSettings = null)

Gets information about a particular instance configuration.

Parameters
Name	Description
request	GetInstanceConfigRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
InstanceConfig	The RPC response.

Overrides

InstanceAdminClient.GetInstanceConfig(GetInstanceConfigRequest, CallSettings)

GetInstanceConfigAsync(GetInstanceConfigRequest, CallSettings)

public override Task<InstanceConfig> GetInstanceConfigAsync(GetInstanceConfigRequest request, CallSettings callSettings = null)

Gets information about a particular instance configuration.

Parameters
Name	Description
request	GetInstanceConfigRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
TaskInstanceConfig	A Task containing the RPC response.

Overrides

InstanceAdminClient.GetInstanceConfigAsync(GetInstanceConfigRequest, CallSettings)

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	ListInstanceConfigOperationsRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
PagedEnumerableListInstanceConfigOperationsResponseOperation	A pageable sequence of Operation resources.

Overrides

InstanceAdminClient.ListInstanceConfigOperations(ListInstanceConfigOperationsRequest, CallSettings)

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	ListInstanceConfigOperationsRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
PagedAsyncEnumerableListInstanceConfigOperationsResponseOperation	A pageable asynchronous sequence of Operation resources.

Overrides

InstanceAdminClient.ListInstanceConfigOperationsAsync(ListInstanceConfigOperationsRequest, CallSettings)

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	ListInstanceConfigsRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
PagedEnumerableListInstanceConfigsResponseInstanceConfig	A pageable sequence of InstanceConfig resources.

Overrides

InstanceAdminClient.ListInstanceConfigs(ListInstanceConfigsRequest, CallSettings)

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	ListInstanceConfigsRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
PagedAsyncEnumerableListInstanceConfigsResponseInstanceConfig	A pageable asynchronous sequence of InstanceConfig resources.

Overrides

InstanceAdminClient.ListInstanceConfigsAsync(ListInstanceConfigsRequest, CallSettings)

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	ListInstancesRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
PagedEnumerableListInstancesResponseInstance	A pageable sequence of Instance resources.

Overrides

InstanceAdminClient.ListInstances(ListInstancesRequest, CallSettings)

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	ListInstancesRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
PagedAsyncEnumerableListInstancesResponseInstance	A pageable asynchronous sequence of Instance resources.

Overrides

InstanceAdminClient.ListInstancesAsync(ListInstancesRequest, CallSettings)

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	SetIamPolicyRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
Policy	The RPC response.

Overrides

InstanceAdminClient.SetIamPolicy(SetIamPolicyRequest, CallSettings)

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	SetIamPolicyRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
TaskPolicy	A Task containing the RPC response.

Overrides

InstanceAdminClient.SetIamPolicyAsync(SetIamPolicyRequest, CallSettings)

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	TestIamPermissionsRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
TestIamPermissionsResponse	The RPC response.

Overrides

InstanceAdminClient.TestIamPermissions(TestIamPermissionsRequest, CallSettings)

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	TestIamPermissionsRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
TaskTestIamPermissionsResponse	A Task containing the RPC response.

Overrides

InstanceAdminClient.TestIamPermissionsAsync(TestIamPermissionsRequest, CallSettings)

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 CANCELLED status.
• 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	UpdateInstanceRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
OperationInstanceUpdateInstanceMetadata	The RPC response.

Overrides

InstanceAdminClient.UpdateInstance(UpdateInstanceRequest, CallSettings)

UpdateInstanceAsync(UpdateInstanceRequest, CallSettings)

public override 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 CANCELLED status.
• 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	UpdateInstanceRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
TaskOperationInstanceUpdateInstanceMetadata	A Task containing the RPC response.

Overrides

InstanceAdminClient.UpdateInstanceAsync(UpdateInstanceRequest, CallSettings)

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 CANCELLED status.
• 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	UpdateInstanceConfigRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
OperationInstanceConfigUpdateInstanceConfigMetadata	The RPC response.

Overrides

InstanceAdminClient.UpdateInstanceConfig(UpdateInstanceConfigRequest, CallSettings)

UpdateInstanceConfigAsync(UpdateInstanceConfigRequest, CallSettings)

public override 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 CANCELLED status.
• 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	UpdateInstanceConfigRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
TaskOperationInstanceConfigUpdateInstanceConfigMetadata	A Task containing the RPC response.

Overrides

InstanceAdminClient.UpdateInstanceConfigAsync(UpdateInstanceConfigRequest, CallSettings)