public class InstanceAdminClient : ClientBase<InstanceAdmin.InstanceAdminClient>
Client for InstanceAdmin
Inheritance
Object > ClientBase > ClientBase<InstanceAdmin.InstanceAdminClient> > InstanceAdmin.InstanceAdminClientNamespace
Google.Cloud.Spanner.Admin.Instance.V1Assembly
Google.Cloud.Spanner.Admin.Instance.V1.dll
Constructors
InstanceAdminClient()
protected InstanceAdminClient()
Protected parameterless constructor to allow creation of test doubles.
InstanceAdminClient(CallInvoker)
public InstanceAdminClient(CallInvoker callInvoker)
Creates a new client for InstanceAdmin that uses a custom CallInvoker
.
Parameter | |
---|---|
Name | Description |
callInvoker | CallInvoker The callInvoker to use to make remote calls. |
InstanceAdminClient(Channel)
[Obsolete("This constructor overload is present for compatibility only, and will be removed in the next major version")]
public InstanceAdminClient(Channel channel)
Creates a new client using a channel.
Parameter | |
---|---|
Name | Description |
channel | Grpc.Core.Channel The channel to use to make remote calls. |
InstanceAdminClient(ChannelBase)
public InstanceAdminClient(ChannelBase channel)
Creates a new client for InstanceAdmin
Parameter | |
---|---|
Name | Description |
channel | ChannelBase The channel to use to make remote calls. |
InstanceAdminClient(ClientBase.ClientBaseConfiguration)
protected InstanceAdminClient(ClientBase.ClientBaseConfiguration configuration)
Protected constructor to allow creation of configured clients.
Parameter | |
---|---|
Name | Description |
configuration | ClientBase.ClientBaseConfiguration The client configuration. |
Methods
CreateInstance(CreateInstanceRequest, CallOptions)
public virtual Operation CreateInstance(CreateInstanceRequest request, CallOptions 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.
Parameters | |
---|---|
Name | Description |
request | CreateInstanceRequest The request to send to the server. |
options | CallOptions The options for the call. |
Returns | |
---|---|
Type | Description |
Google.LongRunning.Operation | The response received from the server. |
CreateInstance(CreateInstanceRequest, Metadata, Nullable<DateTime>, CancellationToken)
public virtual Operation CreateInstance(CreateInstanceRequest request, Metadata headers = null, DateTime? deadline = default(DateTime? ), CancellationToken cancellationToken = default(CancellationToken))
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 to send to the server. |
headers | Metadata The initial metadata to send with the call. This parameter is optional. |
deadline | Nullable<DateTime> An optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken | CancellationToken An optional token for canceling the call. |
Returns | |
---|---|
Type | Description |
Google.LongRunning.Operation | The response received from the server. |
CreateInstanceAsync(CreateInstanceRequest, CallOptions)
public virtual AsyncUnaryCall<Operation> CreateInstanceAsync(CreateInstanceRequest request, CallOptions 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.
Parameters | |
---|---|
Name | Description |
request | CreateInstanceRequest The request to send to the server. |
options | CallOptions The options for the call. |
Returns | |
---|---|
Type | Description |
AsyncUnaryCall<Google.LongRunning.Operation> | The call object. |
CreateInstanceAsync(CreateInstanceRequest, Metadata, Nullable<DateTime>, CancellationToken)
public virtual AsyncUnaryCall<Operation> CreateInstanceAsync(CreateInstanceRequest request, Metadata headers = null, DateTime? deadline = default(DateTime? ), CancellationToken cancellationToken = default(CancellationToken))
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 to send to the server. |
headers | Metadata The initial metadata to send with the call. This parameter is optional. |
deadline | Nullable<DateTime> An optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken | CancellationToken An optional token for canceling the call. |
Returns | |
---|---|
Type | Description |
AsyncUnaryCall<Google.LongRunning.Operation> | The call object. |
CreateOperationsClient()
public virtual Operations.OperationsClient CreateOperationsClient()
Creates a new instance of Google.LongRunning.Operations.OperationsClient using the same call invoker as this client.
Returns | |
---|---|
Type | Description |
Google.LongRunning.Operations.OperationsClient | A new Operations client for the same target as this client. |
DeleteInstance(DeleteInstanceRequest, CallOptions)
public virtual Empty DeleteInstance(DeleteInstanceRequest request, CallOptions 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.
Parameters | |
---|---|
Name | Description |
request | DeleteInstanceRequest The request to send to the server. |
options | CallOptions The options for the call. |
Returns | |
---|---|
Type | Description |
Empty | The response received from the server. |
DeleteInstance(DeleteInstanceRequest, Metadata, Nullable<DateTime>, CancellationToken)
public virtual Empty DeleteInstance(DeleteInstanceRequest request, Metadata headers = null, DateTime? deadline = default(DateTime? ), CancellationToken cancellationToken = default(CancellationToken))
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 to send to the server. |
headers | Metadata The initial metadata to send with the call. This parameter is optional. |
deadline | Nullable<DateTime> An optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken | CancellationToken An optional token for canceling the call. |
Returns | |
---|---|
Type | Description |
Empty | The response received from the server. |
DeleteInstanceAsync(DeleteInstanceRequest, CallOptions)
public virtual AsyncUnaryCall<Empty> DeleteInstanceAsync(DeleteInstanceRequest request, CallOptions 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.
Parameters | |
---|---|
Name | Description |
request | DeleteInstanceRequest The request to send to the server. |
options | CallOptions The options for the call. |
Returns | |
---|---|
Type | Description |
AsyncUnaryCall<Empty> | The call object. |
DeleteInstanceAsync(DeleteInstanceRequest, Metadata, Nullable<DateTime>, CancellationToken)
public virtual AsyncUnaryCall<Empty> DeleteInstanceAsync(DeleteInstanceRequest request, Metadata headers = null, DateTime? deadline = default(DateTime? ), CancellationToken cancellationToken = default(CancellationToken))
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 to send to the server. |
headers | Metadata The initial metadata to send with the call. This parameter is optional. |
deadline | Nullable<DateTime> An optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken | CancellationToken An optional token for canceling the call. |
Returns | |
---|---|
Type | Description |
AsyncUnaryCall<Empty> | The call object. |
GetIamPolicy(GetIamPolicyRequest, CallOptions)
public virtual Policy GetIamPolicy(GetIamPolicyRequest request, CallOptions 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].
Parameters | |
---|---|
Name | Description |
request | Google.Cloud.Iam.V1.GetIamPolicyRequest The request to send to the server. |
options | CallOptions The options for the call. |
Returns | |
---|---|
Type | Description |
Google.Cloud.Iam.V1.Policy | The response received from the server. |
GetIamPolicy(GetIamPolicyRequest, Metadata, Nullable<DateTime>, CancellationToken)
public virtual Policy GetIamPolicy(GetIamPolicyRequest request, Metadata headers = null, DateTime? deadline = default(DateTime? ), CancellationToken cancellationToken = default(CancellationToken))
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 | Google.Cloud.Iam.V1.GetIamPolicyRequest The request to send to the server. |
headers | Metadata The initial metadata to send with the call. This parameter is optional. |
deadline | Nullable<DateTime> An optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken | CancellationToken An optional token for canceling the call. |
Returns | |
---|---|
Type | Description |
Google.Cloud.Iam.V1.Policy | The response received from the server. |
GetIamPolicyAsync(GetIamPolicyRequest, CallOptions)
public virtual AsyncUnaryCall<Policy> GetIamPolicyAsync(GetIamPolicyRequest request, CallOptions 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].
Parameters | |
---|---|
Name | Description |
request | Google.Cloud.Iam.V1.GetIamPolicyRequest The request to send to the server. |
options | CallOptions The options for the call. |
Returns | |
---|---|
Type | Description |
AsyncUnaryCall<Google.Cloud.Iam.V1.Policy> | The call object. |
GetIamPolicyAsync(GetIamPolicyRequest, Metadata, Nullable<DateTime>, CancellationToken)
public virtual AsyncUnaryCall<Policy> GetIamPolicyAsync(GetIamPolicyRequest request, Metadata headers = null, DateTime? deadline = default(DateTime? ), CancellationToken cancellationToken = default(CancellationToken))
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 | Google.Cloud.Iam.V1.GetIamPolicyRequest The request to send to the server. |
headers | Metadata The initial metadata to send with the call. This parameter is optional. |
deadline | Nullable<DateTime> An optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken | CancellationToken An optional token for canceling the call. |
Returns | |
---|---|
Type | Description |
AsyncUnaryCall<Google.Cloud.Iam.V1.Policy> | The call object. |
GetInstance(GetInstanceRequest, CallOptions)
public virtual Instance GetInstance(GetInstanceRequest request, CallOptions options)
Gets information about a particular instance.
Parameters | |
---|---|
Name | Description |
request | GetInstanceRequest The request to send to the server. |
options | CallOptions The options for the call. |
Returns | |
---|---|
Type | Description |
Instance | The response received from the server. |
GetInstance(GetInstanceRequest, Metadata, Nullable<DateTime>, CancellationToken)
public virtual Instance GetInstance(GetInstanceRequest request, Metadata headers = null, DateTime? deadline = default(DateTime? ), CancellationToken cancellationToken = default(CancellationToken))
Gets information about a particular instance.
Parameters | |
---|---|
Name | Description |
request | GetInstanceRequest The request to send to the server. |
headers | Metadata The initial metadata to send with the call. This parameter is optional. |
deadline | Nullable<DateTime> An optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken | CancellationToken An optional token for canceling the call. |
Returns | |
---|---|
Type | Description |
Instance | The response received from the server. |
GetInstanceAsync(GetInstanceRequest, CallOptions)
public virtual AsyncUnaryCall<Instance> GetInstanceAsync(GetInstanceRequest request, CallOptions options)
Gets information about a particular instance.
Parameters | |
---|---|
Name | Description |
request | GetInstanceRequest The request to send to the server. |
options | CallOptions The options for the call. |
Returns | |
---|---|
Type | Description |
AsyncUnaryCall<Instance> | The call object. |
GetInstanceAsync(GetInstanceRequest, Metadata, Nullable<DateTime>, CancellationToken)
public virtual AsyncUnaryCall<Instance> GetInstanceAsync(GetInstanceRequest request, Metadata headers = null, DateTime? deadline = default(DateTime? ), CancellationToken cancellationToken = default(CancellationToken))
Gets information about a particular instance.
Parameters | |
---|---|
Name | Description |
request | GetInstanceRequest The request to send to the server. |
headers | Metadata The initial metadata to send with the call. This parameter is optional. |
deadline | Nullable<DateTime> An optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken | CancellationToken An optional token for canceling the call. |
Returns | |
---|---|
Type | Description |
AsyncUnaryCall<Instance> | The call object. |
GetInstanceConfig(GetInstanceConfigRequest, CallOptions)
public virtual InstanceConfig GetInstanceConfig(GetInstanceConfigRequest request, CallOptions options)
Gets information about a particular instance configuration.
Parameters | |
---|---|
Name | Description |
request | GetInstanceConfigRequest The request to send to the server. |
options | CallOptions The options for the call. |
Returns | |
---|---|
Type | Description |
InstanceConfig | The response received from the server. |
GetInstanceConfig(GetInstanceConfigRequest, Metadata, Nullable<DateTime>, CancellationToken)
public virtual InstanceConfig GetInstanceConfig(GetInstanceConfigRequest request, Metadata headers = null, DateTime? deadline = default(DateTime? ), CancellationToken cancellationToken = default(CancellationToken))
Gets information about a particular instance configuration.
Parameters | |
---|---|
Name | Description |
request | GetInstanceConfigRequest The request to send to the server. |
headers | Metadata The initial metadata to send with the call. This parameter is optional. |
deadline | Nullable<DateTime> An optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken | CancellationToken An optional token for canceling the call. |
Returns | |
---|---|
Type | Description |
InstanceConfig | The response received from the server. |
GetInstanceConfigAsync(GetInstanceConfigRequest, CallOptions)
public virtual AsyncUnaryCall<InstanceConfig> GetInstanceConfigAsync(GetInstanceConfigRequest request, CallOptions options)
Gets information about a particular instance configuration.
Parameters | |
---|---|
Name | Description |
request | GetInstanceConfigRequest The request to send to the server. |
options | CallOptions The options for the call. |
Returns | |
---|---|
Type | Description |
AsyncUnaryCall<InstanceConfig> | The call object. |
GetInstanceConfigAsync(GetInstanceConfigRequest, Metadata, Nullable<DateTime>, CancellationToken)
public virtual AsyncUnaryCall<InstanceConfig> GetInstanceConfigAsync(GetInstanceConfigRequest request, Metadata headers = null, DateTime? deadline = default(DateTime? ), CancellationToken cancellationToken = default(CancellationToken))
Gets information about a particular instance configuration.
Parameters | |
---|---|
Name | Description |
request | GetInstanceConfigRequest The request to send to the server. |
headers | Metadata The initial metadata to send with the call. This parameter is optional. |
deadline | Nullable<DateTime> An optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken | CancellationToken An optional token for canceling the call. |
Returns | |
---|---|
Type | Description |
AsyncUnaryCall<InstanceConfig> | The call object. |
ListInstanceConfigs(ListInstanceConfigsRequest, CallOptions)
public virtual ListInstanceConfigsResponse ListInstanceConfigs(ListInstanceConfigsRequest request, CallOptions options)
Lists the supported instance configurations for a given project.
Parameters | |
---|---|
Name | Description |
request | ListInstanceConfigsRequest The request to send to the server. |
options | CallOptions The options for the call. |
Returns | |
---|---|
Type | Description |
ListInstanceConfigsResponse | The response received from the server. |
ListInstanceConfigs(ListInstanceConfigsRequest, Metadata, Nullable<DateTime>, CancellationToken)
public virtual ListInstanceConfigsResponse ListInstanceConfigs(ListInstanceConfigsRequest request, Metadata headers = null, DateTime? deadline = default(DateTime? ), CancellationToken cancellationToken = default(CancellationToken))
Lists the supported instance configurations for a given project.
Parameters | |
---|---|
Name | Description |
request | ListInstanceConfigsRequest The request to send to the server. |
headers | Metadata The initial metadata to send with the call. This parameter is optional. |
deadline | Nullable<DateTime> An optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken | CancellationToken An optional token for canceling the call. |
Returns | |
---|---|
Type | Description |
ListInstanceConfigsResponse | The response received from the server. |
ListInstanceConfigsAsync(ListInstanceConfigsRequest, CallOptions)
public virtual AsyncUnaryCall<ListInstanceConfigsResponse> ListInstanceConfigsAsync(ListInstanceConfigsRequest request, CallOptions options)
Lists the supported instance configurations for a given project.
Parameters | |
---|---|
Name | Description |
request | ListInstanceConfigsRequest The request to send to the server. |
options | CallOptions The options for the call. |
Returns | |
---|---|
Type | Description |
AsyncUnaryCall<ListInstanceConfigsResponse> | The call object. |
ListInstanceConfigsAsync(ListInstanceConfigsRequest, Metadata, Nullable<DateTime>, CancellationToken)
public virtual AsyncUnaryCall<ListInstanceConfigsResponse> ListInstanceConfigsAsync(ListInstanceConfigsRequest request, Metadata headers = null, DateTime? deadline = default(DateTime? ), CancellationToken cancellationToken = default(CancellationToken))
Lists the supported instance configurations for a given project.
Parameters | |
---|---|
Name | Description |
request | ListInstanceConfigsRequest The request to send to the server. |
headers | Metadata The initial metadata to send with the call. This parameter is optional. |
deadline | Nullable<DateTime> An optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken | CancellationToken An optional token for canceling the call. |
Returns | |
---|---|
Type | Description |
AsyncUnaryCall<ListInstanceConfigsResponse> | The call object. |
ListInstances(ListInstancesRequest, CallOptions)
public virtual ListInstancesResponse ListInstances(ListInstancesRequest request, CallOptions options)
Lists all instances in the given project.
Parameters | |
---|---|
Name | Description |
request | ListInstancesRequest The request to send to the server. |
options | CallOptions The options for the call. |
Returns | |
---|---|
Type | Description |
ListInstancesResponse | The response received from the server. |
ListInstances(ListInstancesRequest, Metadata, Nullable<DateTime>, CancellationToken)
public virtual ListInstancesResponse ListInstances(ListInstancesRequest request, Metadata headers = null, DateTime? deadline = default(DateTime? ), CancellationToken cancellationToken = default(CancellationToken))
Lists all instances in the given project.
Parameters | |
---|---|
Name | Description |
request | ListInstancesRequest The request to send to the server. |
headers | Metadata The initial metadata to send with the call. This parameter is optional. |
deadline | Nullable<DateTime> An optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken | CancellationToken An optional token for canceling the call. |
Returns | |
---|---|
Type | Description |
ListInstancesResponse | The response received from the server. |
ListInstancesAsync(ListInstancesRequest, CallOptions)
public virtual AsyncUnaryCall<ListInstancesResponse> ListInstancesAsync(ListInstancesRequest request, CallOptions options)
Lists all instances in the given project.
Parameters | |
---|---|
Name | Description |
request | ListInstancesRequest The request to send to the server. |
options | CallOptions The options for the call. |
Returns | |
---|---|
Type | Description |
AsyncUnaryCall<ListInstancesResponse> | The call object. |
ListInstancesAsync(ListInstancesRequest, Metadata, Nullable<DateTime>, CancellationToken)
public virtual AsyncUnaryCall<ListInstancesResponse> ListInstancesAsync(ListInstancesRequest request, Metadata headers = null, DateTime? deadline = default(DateTime? ), CancellationToken cancellationToken = default(CancellationToken))
Lists all instances in the given project.
Parameters | |
---|---|
Name | Description |
request | ListInstancesRequest The request to send to the server. |
headers | Metadata The initial metadata to send with the call. This parameter is optional. |
deadline | Nullable<DateTime> An optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken | CancellationToken An optional token for canceling the call. |
Returns | |
---|---|
Type | Description |
AsyncUnaryCall<ListInstancesResponse> | The call object. |
NewInstance(ClientBase.ClientBaseConfiguration)
protected override InstanceAdmin.InstanceAdminClient NewInstance(ClientBase.ClientBaseConfiguration configuration)
Creates a new instance of client from given ClientBaseConfiguration
.
Parameter | |
---|---|
Name | Description |
configuration | ClientBase.ClientBaseConfiguration |
Returns | |
---|---|
Type | Description |
InstanceAdmin.InstanceAdminClient |
SetIamPolicy(SetIamPolicyRequest, CallOptions)
public virtual Policy SetIamPolicy(SetIamPolicyRequest request, CallOptions 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].
Parameters | |
---|---|
Name | Description |
request | Google.Cloud.Iam.V1.SetIamPolicyRequest The request to send to the server. |
options | CallOptions The options for the call. |
Returns | |
---|---|
Type | Description |
Google.Cloud.Iam.V1.Policy | The response received from the server. |
SetIamPolicy(SetIamPolicyRequest, Metadata, Nullable<DateTime>, CancellationToken)
public virtual Policy SetIamPolicy(SetIamPolicyRequest request, Metadata headers = null, DateTime? deadline = default(DateTime? ), CancellationToken cancellationToken = default(CancellationToken))
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 | Google.Cloud.Iam.V1.SetIamPolicyRequest The request to send to the server. |
headers | Metadata The initial metadata to send with the call. This parameter is optional. |
deadline | Nullable<DateTime> An optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken | CancellationToken An optional token for canceling the call. |
Returns | |
---|---|
Type | Description |
Google.Cloud.Iam.V1.Policy | The response received from the server. |
SetIamPolicyAsync(SetIamPolicyRequest, CallOptions)
public virtual AsyncUnaryCall<Policy> SetIamPolicyAsync(SetIamPolicyRequest request, CallOptions 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].
Parameters | |
---|---|
Name | Description |
request | Google.Cloud.Iam.V1.SetIamPolicyRequest The request to send to the server. |
options | CallOptions The options for the call. |
Returns | |
---|---|
Type | Description |
AsyncUnaryCall<Google.Cloud.Iam.V1.Policy> | The call object. |
SetIamPolicyAsync(SetIamPolicyRequest, Metadata, Nullable<DateTime>, CancellationToken)
public virtual AsyncUnaryCall<Policy> SetIamPolicyAsync(SetIamPolicyRequest request, Metadata headers = null, DateTime? deadline = default(DateTime? ), CancellationToken cancellationToken = default(CancellationToken))
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 | Google.Cloud.Iam.V1.SetIamPolicyRequest The request to send to the server. |
headers | Metadata The initial metadata to send with the call. This parameter is optional. |
deadline | Nullable<DateTime> An optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken | CancellationToken An optional token for canceling the call. |
Returns | |
---|---|
Type | Description |
AsyncUnaryCall<Google.Cloud.Iam.V1.Policy> | The call object. |
TestIamPermissions(TestIamPermissionsRequest, CallOptions)
public virtual TestIamPermissionsResponse TestIamPermissions(TestIamPermissionsRequest request, CallOptions 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.
Parameters | |
---|---|
Name | Description |
request | Google.Cloud.Iam.V1.TestIamPermissionsRequest The request to send to the server. |
options | CallOptions The options for the call. |
Returns | |
---|---|
Type | Description |
Google.Cloud.Iam.V1.TestIamPermissionsResponse | The response received from the server. |
TestIamPermissions(TestIamPermissionsRequest, Metadata, Nullable<DateTime>, CancellationToken)
public virtual TestIamPermissionsResponse TestIamPermissions(TestIamPermissionsRequest request, Metadata headers = null, DateTime? deadline = default(DateTime? ), CancellationToken cancellationToken = default(CancellationToken))
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 | Google.Cloud.Iam.V1.TestIamPermissionsRequest The request to send to the server. |
headers | Metadata The initial metadata to send with the call. This parameter is optional. |
deadline | Nullable<DateTime> An optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken | CancellationToken An optional token for canceling the call. |
Returns | |
---|---|
Type | Description |
Google.Cloud.Iam.V1.TestIamPermissionsResponse | The response received from the server. |
TestIamPermissionsAsync(TestIamPermissionsRequest, CallOptions)
public virtual AsyncUnaryCall<TestIamPermissionsResponse> TestIamPermissionsAsync(TestIamPermissionsRequest request, CallOptions 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.
Parameters | |
---|---|
Name | Description |
request | Google.Cloud.Iam.V1.TestIamPermissionsRequest The request to send to the server. |
options | CallOptions The options for the call. |
Returns | |
---|---|
Type | Description |
AsyncUnaryCall<Google.Cloud.Iam.V1.TestIamPermissionsResponse> | The call object. |
TestIamPermissionsAsync(TestIamPermissionsRequest, Metadata, Nullable<DateTime>, CancellationToken)
public virtual AsyncUnaryCall<TestIamPermissionsResponse> TestIamPermissionsAsync(TestIamPermissionsRequest request, Metadata headers = null, DateTime? deadline = default(DateTime? ), CancellationToken cancellationToken = default(CancellationToken))
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 | Google.Cloud.Iam.V1.TestIamPermissionsRequest The request to send to the server. |
headers | Metadata The initial metadata to send with the call. This parameter is optional. |
deadline | Nullable<DateTime> An optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken | CancellationToken An optional token for canceling the call. |
Returns | |
---|---|
Type | Description |
AsyncUnaryCall<Google.Cloud.Iam.V1.TestIamPermissionsResponse> | The call object. |
UpdateInstance(UpdateInstanceRequest, CallOptions)
public virtual Operation UpdateInstance(UpdateInstanceRequest request, CallOptions 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
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
resource [name][google.spanner.admin.instance.v1.Instance.name].
Parameters | |
---|---|
Name | Description |
request | UpdateInstanceRequest The request to send to the server. |
options | CallOptions The options for the call. |
Returns | |
---|---|
Type | Description |
Google.LongRunning.Operation | The response received from the server. |
UpdateInstance(UpdateInstanceRequest, Metadata, Nullable<DateTime>, CancellationToken)
public virtual Operation UpdateInstance(UpdateInstanceRequest request, Metadata headers = null, DateTime? deadline = default(DateTime? ), CancellationToken cancellationToken = default(CancellationToken))
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
resource [name][google.spanner.admin.instance.v1.Instance.name].
Parameters | |
---|---|
Name | Description |
request | UpdateInstanceRequest The request to send to the server. |
headers | Metadata The initial metadata to send with the call. This parameter is optional. |
deadline | Nullable<DateTime> An optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken | CancellationToken An optional token for canceling the call. |
Returns | |
---|---|
Type | Description |
Google.LongRunning.Operation | The response received from the server. |
UpdateInstanceAsync(UpdateInstanceRequest, CallOptions)
public virtual AsyncUnaryCall<Operation> UpdateInstanceAsync(UpdateInstanceRequest request, CallOptions 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
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
resource [name][google.spanner.admin.instance.v1.Instance.name].
Parameters | |
---|---|
Name | Description |
request | UpdateInstanceRequest The request to send to the server. |
options | CallOptions The options for the call. |
Returns | |
---|---|
Type | Description |
AsyncUnaryCall<Google.LongRunning.Operation> | The call object. |
UpdateInstanceAsync(UpdateInstanceRequest, Metadata, Nullable<DateTime>, CancellationToken)
public virtual AsyncUnaryCall<Operation> UpdateInstanceAsync(UpdateInstanceRequest request, Metadata headers = null, DateTime? deadline = default(DateTime? ), CancellationToken cancellationToken = default(CancellationToken))
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
resource [name][google.spanner.admin.instance.v1.Instance.name].
Parameters | |
---|---|
Name | Description |
request | UpdateInstanceRequest The request to send to the server. |
headers | Metadata The initial metadata to send with the call. This parameter is optional. |
deadline | Nullable<DateTime> An optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken | CancellationToken An optional token for canceling the call. |
Returns | |
---|---|
Type | Description |
AsyncUnaryCall<Google.LongRunning.Operation> | The call object. |