Google Cloud Bigtable Administration v2 API - Class BigtableInstanceAdminClient (3.13.0)

public abstract class BigtableInstanceAdminClient

Reference documentation and code samples for the Google Cloud Bigtable Administration v2 API class BigtableInstanceAdminClient.

BigtableInstanceAdmin client wrapper, for convenient use.

Inheritance

object > BigtableInstanceAdminClient

Namespace

Google.Cloud.Bigtable.Admin.V2

Assembly

Google.Cloud.Bigtable.Admin.V2.dll

Remarks

Service for creating, configuring, and deleting Cloud Bigtable Instances and Clusters. Provides access to the Instance and Cluster schemas only, not the tables' metadata or data stored in those tables.

Properties

CreateClusterOperationsClient

public virtual OperationsClient CreateClusterOperationsClient { get; }

The long-running operations client for CreateCluster.

Property Value
TypeDescription
OperationsClient

CreateInstanceOperationsClient

public virtual OperationsClient CreateInstanceOperationsClient { get; }

The long-running operations client for CreateInstance.

Property Value
TypeDescription
OperationsClient

DefaultEndpoint

public static string DefaultEndpoint { get; }

The default endpoint for the BigtableInstanceAdmin service, which is a host of "bigtableadmin.googleapis.com" and a port of 443.

Property Value
TypeDescription
string

DefaultScopes

public static IReadOnlyList<string> DefaultScopes { get; }

The default BigtableInstanceAdmin scopes.

Property Value
TypeDescription
IReadOnlyListstring
Remarks

GrpcClient

public virtual BigtableInstanceAdmin.BigtableInstanceAdminClient GrpcClient { get; }

The underlying gRPC BigtableInstanceAdmin client

Property Value
TypeDescription
BigtableInstanceAdminBigtableInstanceAdminClient

PartialUpdateClusterOperationsClient

public virtual OperationsClient PartialUpdateClusterOperationsClient { get; }

The long-running operations client for PartialUpdateCluster.

Property Value
TypeDescription
OperationsClient

PartialUpdateInstanceOperationsClient

public virtual OperationsClient PartialUpdateInstanceOperationsClient { get; }

The long-running operations client for PartialUpdateInstance.

Property Value
TypeDescription
OperationsClient

ServiceMetadata

public static ServiceMetadata ServiceMetadata { get; }

The service metadata associated with this client type.

Property Value
TypeDescription
ServiceMetadata

UpdateAppProfileOperationsClient

public virtual OperationsClient UpdateAppProfileOperationsClient { get; }

The long-running operations client for UpdateAppProfile.

Property Value
TypeDescription
OperationsClient

UpdateClusterOperationsClient

public virtual OperationsClient UpdateClusterOperationsClient { get; }

The long-running operations client for UpdateCluster.

Property Value
TypeDescription
OperationsClient

Methods

Create()

public static BigtableInstanceAdminClient Create()

Synchronously creates a BigtableInstanceAdminClient using the default credentials, endpoint and settings. To specify custom credentials or other settings, use BigtableInstanceAdminClientBuilder.

Returns
TypeDescription
BigtableInstanceAdminClient

The created BigtableInstanceAdminClient.

CreateAppProfile(CreateAppProfileRequest, CallSettings)

public virtual AppProfile CreateAppProfile(CreateAppProfileRequest request, CallSettings callSettings = null)

Creates an app profile within an instance.

Parameters
NameDescription
requestCreateAppProfileRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
AppProfile

The RPC response.

Example
// Create client
BigtableInstanceAdminClient bigtableInstanceAdminClient = BigtableInstanceAdminClient.Create();
// Initialize request argument(s)
CreateAppProfileRequest request = new CreateAppProfileRequest
{
    ParentAsInstanceName = InstanceName.FromProjectInstance("[PROJECT]", "[INSTANCE]"),
    AppProfileId = "",
    AppProfile = new AppProfile(),
    IgnoreWarnings = false,
};
// Make the request
AppProfile response = bigtableInstanceAdminClient.CreateAppProfile(request);

CreateAppProfile(InstanceName, string, AppProfile, CallSettings)

public virtual AppProfile CreateAppProfile(InstanceName parent, string appProfileId, AppProfile appProfile, CallSettings callSettings = null)

Creates an app profile within an instance.

Parameters
NameDescription
parentInstanceName

Required. The unique name of the instance in which to create the new app profile. Values are of the form projects/{project}/instances/{instance}.

appProfileIdstring

Required. The ID to be used when referring to the new app profile within its instance, e.g., just myprofile rather than projects/myproject/instances/myinstance/appProfiles/myprofile.

appProfileAppProfile

Required. The app profile to be created. Fields marked OutputOnly will be ignored.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
AppProfile

The RPC response.

Example
// Create client
BigtableInstanceAdminClient bigtableInstanceAdminClient = BigtableInstanceAdminClient.Create();
// Initialize request argument(s)
InstanceName parent = InstanceName.FromProjectInstance("[PROJECT]", "[INSTANCE]");
string appProfileId = "";
AppProfile appProfile = new AppProfile();
// Make the request
AppProfile response = bigtableInstanceAdminClient.CreateAppProfile(parent, appProfileId, appProfile);

CreateAppProfile(string, string, AppProfile, CallSettings)

public virtual AppProfile CreateAppProfile(string parent, string appProfileId, AppProfile appProfile, CallSettings callSettings = null)

Creates an app profile within an instance.

Parameters
NameDescription
parentstring

Required. The unique name of the instance in which to create the new app profile. Values are of the form projects/{project}/instances/{instance}.

appProfileIdstring

Required. The ID to be used when referring to the new app profile within its instance, e.g., just myprofile rather than projects/myproject/instances/myinstance/appProfiles/myprofile.

appProfileAppProfile

Required. The app profile to be created. Fields marked OutputOnly will be ignored.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
AppProfile

The RPC response.

Example
// Create client
BigtableInstanceAdminClient bigtableInstanceAdminClient = BigtableInstanceAdminClient.Create();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/instances/[INSTANCE]";
string appProfileId = "";
AppProfile appProfile = new AppProfile();
// Make the request
AppProfile response = bigtableInstanceAdminClient.CreateAppProfile(parent, appProfileId, appProfile);

CreateAppProfileAsync(CreateAppProfileRequest, CallSettings)

public virtual Task<AppProfile> CreateAppProfileAsync(CreateAppProfileRequest request, CallSettings callSettings = null)

Creates an app profile within an instance.

Parameters
NameDescription
requestCreateAppProfileRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TaskAppProfile

A Task containing the RPC response.

Example
// Create client
BigtableInstanceAdminClient bigtableInstanceAdminClient = await BigtableInstanceAdminClient.CreateAsync();
// Initialize request argument(s)
CreateAppProfileRequest request = new CreateAppProfileRequest
{
    ParentAsInstanceName = InstanceName.FromProjectInstance("[PROJECT]", "[INSTANCE]"),
    AppProfileId = "",
    AppProfile = new AppProfile(),
    IgnoreWarnings = false,
};
// Make the request
AppProfile response = await bigtableInstanceAdminClient.CreateAppProfileAsync(request);

CreateAppProfileAsync(CreateAppProfileRequest, CancellationToken)

public virtual Task<AppProfile> CreateAppProfileAsync(CreateAppProfileRequest request, CancellationToken cancellationToken)

Creates an app profile within an instance.

Parameters
NameDescription
requestCreateAppProfileRequest

The request object containing all of the parameters for the API call.

cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
TaskAppProfile

A Task containing the RPC response.

Example
// Create client
BigtableInstanceAdminClient bigtableInstanceAdminClient = await BigtableInstanceAdminClient.CreateAsync();
// Initialize request argument(s)
CreateAppProfileRequest request = new CreateAppProfileRequest
{
    ParentAsInstanceName = InstanceName.FromProjectInstance("[PROJECT]", "[INSTANCE]"),
    AppProfileId = "",
    AppProfile = new AppProfile(),
    IgnoreWarnings = false,
};
// Make the request
AppProfile response = await bigtableInstanceAdminClient.CreateAppProfileAsync(request);

CreateAppProfileAsync(InstanceName, string, AppProfile, CallSettings)

public virtual Task<AppProfile> CreateAppProfileAsync(InstanceName parent, string appProfileId, AppProfile appProfile, CallSettings callSettings = null)

Creates an app profile within an instance.

Parameters
NameDescription
parentInstanceName

Required. The unique name of the instance in which to create the new app profile. Values are of the form projects/{project}/instances/{instance}.

appProfileIdstring

Required. The ID to be used when referring to the new app profile within its instance, e.g., just myprofile rather than projects/myproject/instances/myinstance/appProfiles/myprofile.

appProfileAppProfile

Required. The app profile to be created. Fields marked OutputOnly will be ignored.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TaskAppProfile

A Task containing the RPC response.

Example
// Create client
BigtableInstanceAdminClient bigtableInstanceAdminClient = await BigtableInstanceAdminClient.CreateAsync();
// Initialize request argument(s)
InstanceName parent = InstanceName.FromProjectInstance("[PROJECT]", "[INSTANCE]");
string appProfileId = "";
AppProfile appProfile = new AppProfile();
// Make the request
AppProfile response = await bigtableInstanceAdminClient.CreateAppProfileAsync(parent, appProfileId, appProfile);

CreateAppProfileAsync(InstanceName, string, AppProfile, CancellationToken)

public virtual Task<AppProfile> CreateAppProfileAsync(InstanceName parent, string appProfileId, AppProfile appProfile, CancellationToken cancellationToken)

Creates an app profile within an instance.

Parameters
NameDescription
parentInstanceName

Required. The unique name of the instance in which to create the new app profile. Values are of the form projects/{project}/instances/{instance}.

appProfileIdstring

Required. The ID to be used when referring to the new app profile within its instance, e.g., just myprofile rather than projects/myproject/instances/myinstance/appProfiles/myprofile.

appProfileAppProfile

Required. The app profile to be created. Fields marked OutputOnly will be ignored.

cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
TaskAppProfile

A Task containing the RPC response.

Example
// Create client
BigtableInstanceAdminClient bigtableInstanceAdminClient = await BigtableInstanceAdminClient.CreateAsync();
// Initialize request argument(s)
InstanceName parent = InstanceName.FromProjectInstance("[PROJECT]", "[INSTANCE]");
string appProfileId = "";
AppProfile appProfile = new AppProfile();
// Make the request
AppProfile response = await bigtableInstanceAdminClient.CreateAppProfileAsync(parent, appProfileId, appProfile);

CreateAppProfileAsync(string, string, AppProfile, CallSettings)

public virtual Task<AppProfile> CreateAppProfileAsync(string parent, string appProfileId, AppProfile appProfile, CallSettings callSettings = null)

Creates an app profile within an instance.

Parameters
NameDescription
parentstring

Required. The unique name of the instance in which to create the new app profile. Values are of the form projects/{project}/instances/{instance}.

appProfileIdstring

Required. The ID to be used when referring to the new app profile within its instance, e.g., just myprofile rather than projects/myproject/instances/myinstance/appProfiles/myprofile.

appProfileAppProfile

Required. The app profile to be created. Fields marked OutputOnly will be ignored.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TaskAppProfile

A Task containing the RPC response.

Example
// Create client
BigtableInstanceAdminClient bigtableInstanceAdminClient = await BigtableInstanceAdminClient.CreateAsync();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/instances/[INSTANCE]";
string appProfileId = "";
AppProfile appProfile = new AppProfile();
// Make the request
AppProfile response = await bigtableInstanceAdminClient.CreateAppProfileAsync(parent, appProfileId, appProfile);

CreateAppProfileAsync(string, string, AppProfile, CancellationToken)

public virtual Task<AppProfile> CreateAppProfileAsync(string parent, string appProfileId, AppProfile appProfile, CancellationToken cancellationToken)

Creates an app profile within an instance.

Parameters
NameDescription
parentstring

Required. The unique name of the instance in which to create the new app profile. Values are of the form projects/{project}/instances/{instance}.

appProfileIdstring

Required. The ID to be used when referring to the new app profile within its instance, e.g., just myprofile rather than projects/myproject/instances/myinstance/appProfiles/myprofile.

appProfileAppProfile

Required. The app profile to be created. Fields marked OutputOnly will be ignored.

cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
TaskAppProfile

A Task containing the RPC response.

Example
// Create client
BigtableInstanceAdminClient bigtableInstanceAdminClient = await BigtableInstanceAdminClient.CreateAsync();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/instances/[INSTANCE]";
string appProfileId = "";
AppProfile appProfile = new AppProfile();
// Make the request
AppProfile response = await bigtableInstanceAdminClient.CreateAppProfileAsync(parent, appProfileId, appProfile);

CreateAsync(CancellationToken)

public static Task<BigtableInstanceAdminClient> CreateAsync(CancellationToken cancellationToken = default)

Asynchronously creates a BigtableInstanceAdminClient using the default credentials, endpoint and settings. To specify custom credentials or other settings, use BigtableInstanceAdminClientBuilder.

Parameter
NameDescription
cancellationTokenCancellationToken

The CancellationToken to use while creating the client.

Returns
TypeDescription
TaskBigtableInstanceAdminClient

The task representing the created BigtableInstanceAdminClient.

CreateCluster(CreateClusterRequest, CallSettings)

public virtual Operation<Cluster, CreateClusterMetadata> CreateCluster(CreateClusterRequest request, CallSettings callSettings = null)

Creates a cluster within an instance.

Note that exactly one of Cluster.serve_nodes and Cluster.cluster_config.cluster_autoscaling_config can be set. If serve_nodes is set to non-zero, then the cluster is manually scaled. If cluster_config.cluster_autoscaling_config is non-empty, then autoscaling is enabled.

Parameters
NameDescription
requestCreateClusterRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
OperationClusterCreateClusterMetadata

The RPC response.

Example
// Create client
BigtableInstanceAdminClient bigtableInstanceAdminClient = BigtableInstanceAdminClient.Create();
// Initialize request argument(s)
CreateClusterRequest request = new CreateClusterRequest
{
    ParentAsInstanceName = InstanceName.FromProjectInstance("[PROJECT]", "[INSTANCE]"),
    ClusterId = "",
    Cluster = new Cluster(),
};
// Make the request
Operation<Cluster, CreateClusterMetadata> response = bigtableInstanceAdminClient.CreateCluster(request);

// Poll until the returned long-running operation is complete
Operation<Cluster, CreateClusterMetadata> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
Cluster result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Cluster, CreateClusterMetadata> retrievedResponse = bigtableInstanceAdminClient.PollOnceCreateCluster(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Cluster retrievedResult = retrievedResponse.Result;
}

CreateCluster(InstanceName, string, Cluster, CallSettings)

public virtual Operation<Cluster, CreateClusterMetadata> CreateCluster(InstanceName parent, string clusterId, Cluster cluster, CallSettings callSettings = null)

Creates a cluster within an instance.

Note that exactly one of Cluster.serve_nodes and Cluster.cluster_config.cluster_autoscaling_config can be set. If serve_nodes is set to non-zero, then the cluster is manually scaled. If cluster_config.cluster_autoscaling_config is non-empty, then autoscaling is enabled.

Parameters
NameDescription
parentInstanceName

Required. The unique name of the instance in which to create the new cluster. Values are of the form projects/{project}/instances/{instance}.

clusterIdstring

Required. The ID to be used when referring to the new cluster within its instance, e.g., just mycluster rather than projects/myproject/instances/myinstance/clusters/mycluster.

clusterCluster

Required. The cluster to be created. Fields marked OutputOnly must be left blank.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
OperationClusterCreateClusterMetadata

The RPC response.

Example
// Create client
BigtableInstanceAdminClient bigtableInstanceAdminClient = BigtableInstanceAdminClient.Create();
// Initialize request argument(s)
InstanceName parent = InstanceName.FromProjectInstance("[PROJECT]", "[INSTANCE]");
string clusterId = "";
Cluster cluster = new Cluster();
// Make the request
Operation<Cluster, CreateClusterMetadata> response = bigtableInstanceAdminClient.CreateCluster(parent, clusterId, cluster);

// Poll until the returned long-running operation is complete
Operation<Cluster, CreateClusterMetadata> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
Cluster result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Cluster, CreateClusterMetadata> retrievedResponse = bigtableInstanceAdminClient.PollOnceCreateCluster(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Cluster retrievedResult = retrievedResponse.Result;
}

CreateCluster(string, string, Cluster, CallSettings)

public virtual Operation<Cluster, CreateClusterMetadata> CreateCluster(string parent, string clusterId, Cluster cluster, CallSettings callSettings = null)

Creates a cluster within an instance.

Note that exactly one of Cluster.serve_nodes and Cluster.cluster_config.cluster_autoscaling_config can be set. If serve_nodes is set to non-zero, then the cluster is manually scaled. If cluster_config.cluster_autoscaling_config is non-empty, then autoscaling is enabled.

Parameters
NameDescription
parentstring

Required. The unique name of the instance in which to create the new cluster. Values are of the form projects/{project}/instances/{instance}.

clusterIdstring

Required. The ID to be used when referring to the new cluster within its instance, e.g., just mycluster rather than projects/myproject/instances/myinstance/clusters/mycluster.

clusterCluster

Required. The cluster to be created. Fields marked OutputOnly must be left blank.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
OperationClusterCreateClusterMetadata

The RPC response.

Example
// Create client
BigtableInstanceAdminClient bigtableInstanceAdminClient = BigtableInstanceAdminClient.Create();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/instances/[INSTANCE]";
string clusterId = "";
Cluster cluster = new Cluster();
// Make the request
Operation<Cluster, CreateClusterMetadata> response = bigtableInstanceAdminClient.CreateCluster(parent, clusterId, cluster);

// Poll until the returned long-running operation is complete
Operation<Cluster, CreateClusterMetadata> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
Cluster result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Cluster, CreateClusterMetadata> retrievedResponse = bigtableInstanceAdminClient.PollOnceCreateCluster(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Cluster retrievedResult = retrievedResponse.Result;
}

CreateClusterAsync(CreateClusterRequest, CallSettings)

public virtual Task<Operation<Cluster, CreateClusterMetadata>> CreateClusterAsync(CreateClusterRequest request, CallSettings callSettings = null)

Creates a cluster within an instance.

Note that exactly one of Cluster.serve_nodes and Cluster.cluster_config.cluster_autoscaling_config can be set. If serve_nodes is set to non-zero, then the cluster is manually scaled. If cluster_config.cluster_autoscaling_config is non-empty, then autoscaling is enabled.

Parameters
NameDescription
requestCreateClusterRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TaskOperationClusterCreateClusterMetadata

A Task containing the RPC response.

Example
// Create client
BigtableInstanceAdminClient bigtableInstanceAdminClient = await BigtableInstanceAdminClient.CreateAsync();
// Initialize request argument(s)
CreateClusterRequest request = new CreateClusterRequest
{
    ParentAsInstanceName = InstanceName.FromProjectInstance("[PROJECT]", "[INSTANCE]"),
    ClusterId = "",
    Cluster = new Cluster(),
};
// Make the request
Operation<Cluster, CreateClusterMetadata> response = await bigtableInstanceAdminClient.CreateClusterAsync(request);

// Poll until the returned long-running operation is complete
Operation<Cluster, CreateClusterMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Cluster result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Cluster, CreateClusterMetadata> retrievedResponse = await bigtableInstanceAdminClient.PollOnceCreateClusterAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Cluster retrievedResult = retrievedResponse.Result;
}

CreateClusterAsync(CreateClusterRequest, CancellationToken)

public virtual Task<Operation<Cluster, CreateClusterMetadata>> CreateClusterAsync(CreateClusterRequest request, CancellationToken cancellationToken)

Creates a cluster within an instance.

Note that exactly one of Cluster.serve_nodes and Cluster.cluster_config.cluster_autoscaling_config can be set. If serve_nodes is set to non-zero, then the cluster is manually scaled. If cluster_config.cluster_autoscaling_config is non-empty, then autoscaling is enabled.

Parameters
NameDescription
requestCreateClusterRequest

The request object containing all of the parameters for the API call.

cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
TaskOperationClusterCreateClusterMetadata

A Task containing the RPC response.

Example
// Create client
BigtableInstanceAdminClient bigtableInstanceAdminClient = await BigtableInstanceAdminClient.CreateAsync();
// Initialize request argument(s)
CreateClusterRequest request = new CreateClusterRequest
{
    ParentAsInstanceName = InstanceName.FromProjectInstance("[PROJECT]", "[INSTANCE]"),
    ClusterId = "",
    Cluster = new Cluster(),
};
// Make the request
Operation<Cluster, CreateClusterMetadata> response = await bigtableInstanceAdminClient.CreateClusterAsync(request);

// Poll until the returned long-running operation is complete
Operation<Cluster, CreateClusterMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Cluster result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Cluster, CreateClusterMetadata> retrievedResponse = await bigtableInstanceAdminClient.PollOnceCreateClusterAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Cluster retrievedResult = retrievedResponse.Result;
}

CreateClusterAsync(InstanceName, string, Cluster, CallSettings)

public virtual Task<Operation<Cluster, CreateClusterMetadata>> CreateClusterAsync(InstanceName parent, string clusterId, Cluster cluster, CallSettings callSettings = null)

Creates a cluster within an instance.

Note that exactly one of Cluster.serve_nodes and Cluster.cluster_config.cluster_autoscaling_config can be set. If serve_nodes is set to non-zero, then the cluster is manually scaled. If cluster_config.cluster_autoscaling_config is non-empty, then autoscaling is enabled.

Parameters
NameDescription
parentInstanceName

Required. The unique name of the instance in which to create the new cluster. Values are of the form projects/{project}/instances/{instance}.

clusterIdstring

Required. The ID to be used when referring to the new cluster within its instance, e.g., just mycluster rather than projects/myproject/instances/myinstance/clusters/mycluster.

clusterCluster

Required. The cluster to be created. Fields marked OutputOnly must be left blank.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TaskOperationClusterCreateClusterMetadata

A Task containing the RPC response.

Example
// Create client
BigtableInstanceAdminClient bigtableInstanceAdminClient = await BigtableInstanceAdminClient.CreateAsync();
// Initialize request argument(s)
InstanceName parent = InstanceName.FromProjectInstance("[PROJECT]", "[INSTANCE]");
string clusterId = "";
Cluster cluster = new Cluster();
// Make the request
Operation<Cluster, CreateClusterMetadata> response = await bigtableInstanceAdminClient.CreateClusterAsync(parent, clusterId, cluster);

// Poll until the returned long-running operation is complete
Operation<Cluster, CreateClusterMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Cluster result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Cluster, CreateClusterMetadata> retrievedResponse = await bigtableInstanceAdminClient.PollOnceCreateClusterAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Cluster retrievedResult = retrievedResponse.Result;
}

CreateClusterAsync(InstanceName, string, Cluster, CancellationToken)

public virtual Task<Operation<Cluster, CreateClusterMetadata>> CreateClusterAsync(InstanceName parent, string clusterId, Cluster cluster, CancellationToken cancellationToken)

Creates a cluster within an instance.

Note that exactly one of Cluster.serve_nodes and Cluster.cluster_config.cluster_autoscaling_config can be set. If serve_nodes is set to non-zero, then the cluster is manually scaled. If cluster_config.cluster_autoscaling_config is non-empty, then autoscaling is enabled.

Parameters
NameDescription
parentInstanceName

Required. The unique name of the instance in which to create the new cluster. Values are of the form projects/{project}/instances/{instance}.

clusterIdstring

Required. The ID to be used when referring to the new cluster within its instance, e.g., just mycluster rather than projects/myproject/instances/myinstance/clusters/mycluster.

clusterCluster

Required. The cluster to be created. Fields marked OutputOnly must be left blank.

cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
TaskOperationClusterCreateClusterMetadata

A Task containing the RPC response.

Example
// Create client
BigtableInstanceAdminClient bigtableInstanceAdminClient = await BigtableInstanceAdminClient.CreateAsync();
// Initialize request argument(s)
InstanceName parent = InstanceName.FromProjectInstance("[PROJECT]", "[INSTANCE]");
string clusterId = "";
Cluster cluster = new Cluster();
// Make the request
Operation<Cluster, CreateClusterMetadata> response = await bigtableInstanceAdminClient.CreateClusterAsync(parent, clusterId, cluster);

// Poll until the returned long-running operation is complete
Operation<Cluster, CreateClusterMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Cluster result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Cluster, CreateClusterMetadata> retrievedResponse = await bigtableInstanceAdminClient.PollOnceCreateClusterAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Cluster retrievedResult = retrievedResponse.Result;
}

CreateClusterAsync(string, string, Cluster, CallSettings)

public virtual Task<Operation<Cluster, CreateClusterMetadata>> CreateClusterAsync(string parent, string clusterId, Cluster cluster, CallSettings callSettings = null)

Creates a cluster within an instance.

Note that exactly one of Cluster.serve_nodes and Cluster.cluster_config.cluster_autoscaling_config can be set. If serve_nodes is set to non-zero, then the cluster is manually scaled. If cluster_config.cluster_autoscaling_config is non-empty, then autoscaling is enabled.

Parameters
NameDescription
parentstring

Required. The unique name of the instance in which to create the new cluster. Values are of the form projects/{project}/instances/{instance}.

clusterIdstring

Required. The ID to be used when referring to the new cluster within its instance, e.g., just mycluster rather than projects/myproject/instances/myinstance/clusters/mycluster.

clusterCluster

Required. The cluster to be created. Fields marked OutputOnly must be left blank.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TaskOperationClusterCreateClusterMetadata

A Task containing the RPC response.

Example
// Create client
BigtableInstanceAdminClient bigtableInstanceAdminClient = await BigtableInstanceAdminClient.CreateAsync();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/instances/[INSTANCE]";
string clusterId = "";
Cluster cluster = new Cluster();
// Make the request
Operation<Cluster, CreateClusterMetadata> response = await bigtableInstanceAdminClient.CreateClusterAsync(parent, clusterId, cluster);

// Poll until the returned long-running operation is complete
Operation<Cluster, CreateClusterMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Cluster result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Cluster, CreateClusterMetadata> retrievedResponse = await bigtableInstanceAdminClient.PollOnceCreateClusterAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Cluster retrievedResult = retrievedResponse.Result;
}

CreateClusterAsync(string, string, Cluster, CancellationToken)

public virtual Task<Operation<Cluster, CreateClusterMetadata>> CreateClusterAsync(string parent, string clusterId, Cluster cluster, CancellationToken cancellationToken)

Creates a cluster within an instance.

Note that exactly one of Cluster.serve_nodes and Cluster.cluster_config.cluster_autoscaling_config can be set. If serve_nodes is set to non-zero, then the cluster is manually scaled. If cluster_config.cluster_autoscaling_config is non-empty, then autoscaling is enabled.

Parameters
NameDescription
parentstring

Required. The unique name of the instance in which to create the new cluster. Values are of the form projects/{project}/instances/{instance}.

clusterIdstring

Required. The ID to be used when referring to the new cluster within its instance, e.g., just mycluster rather than projects/myproject/instances/myinstance/clusters/mycluster.

clusterCluster

Required. The cluster to be created. Fields marked OutputOnly must be left blank.

cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
TaskOperationClusterCreateClusterMetadata

A Task containing the RPC response.

Example
// Create client
BigtableInstanceAdminClient bigtableInstanceAdminClient = await BigtableInstanceAdminClient.CreateAsync();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/instances/[INSTANCE]";
string clusterId = "";
Cluster cluster = new Cluster();
// Make the request
Operation<Cluster, CreateClusterMetadata> response = await bigtableInstanceAdminClient.CreateClusterAsync(parent, clusterId, cluster);

// Poll until the returned long-running operation is complete
Operation<Cluster, CreateClusterMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Cluster result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Cluster, CreateClusterMetadata> retrievedResponse = await bigtableInstanceAdminClient.PollOnceCreateClusterAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Cluster retrievedResult = retrievedResponse.Result;
}

CreateInstance(ProjectName, string, Instance, IDictionary<string, Cluster>, CallSettings)

public virtual Operation<Instance, CreateInstanceMetadata> CreateInstance(ProjectName parent, string instanceId, Instance instance, IDictionary<string, Cluster> clusters, CallSettings callSettings = null)

Create an instance within a project.

Note that exactly one of Cluster.serve_nodes and Cluster.cluster_config.cluster_autoscaling_config can be set. If serve_nodes is set to non-zero, then the cluster is manually scaled. If cluster_config.cluster_autoscaling_config is non-empty, then autoscaling is enabled.

Parameters
NameDescription
parentProjectName

Required. The unique name of the project in which to create the new instance. Values are of the form projects/{project}.

instanceIdstring

Required. The ID to be used when referring to the new instance within its project, e.g., just myinstance rather than projects/myproject/instances/myinstance.

instanceInstance

Required. The instance to create. Fields marked OutputOnly must be left blank.

clustersIDictionarystringCluster

Required. The clusters to be created within the instance, mapped by desired cluster ID, e.g., just mycluster rather than projects/myproject/instances/myinstance/clusters/mycluster. Fields marked OutputOnly must be left blank. Currently, at most four clusters can be specified.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
OperationInstanceCreateInstanceMetadata

The RPC response.

Example
// Create client
BigtableInstanceAdminClient bigtableInstanceAdminClient = BigtableInstanceAdminClient.Create();
// Initialize request argument(s)
ProjectName parent = ProjectName.FromProject("[PROJECT]");
string instanceId = "";
Instance instance = new Instance();
IDictionary<string, Cluster> clusters = new Dictionary<string, Cluster> { { "", new Cluster() }, };
// Make the request
Operation<Instance, CreateInstanceMetadata> response = bigtableInstanceAdminClient.CreateInstance(parent, instanceId, instance, clusters);

// Poll until the returned long-running operation is complete
Operation<Instance, CreateInstanceMetadata> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
Instance result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Instance, CreateInstanceMetadata> retrievedResponse = bigtableInstanceAdminClient.PollOnceCreateInstance(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Instance retrievedResult = retrievedResponse.Result;
}

CreateInstance(CreateInstanceRequest, CallSettings)

public virtual Operation<Instance, CreateInstanceMetadata> CreateInstance(CreateInstanceRequest request, CallSettings callSettings = null)

Create an instance within a project.

Note that exactly one of Cluster.serve_nodes and Cluster.cluster_config.cluster_autoscaling_config can be set. If serve_nodes is set to non-zero, then the cluster is manually scaled. If cluster_config.cluster_autoscaling_config is non-empty, then autoscaling is enabled.

Parameters
NameDescription
requestCreateInstanceRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
OperationInstanceCreateInstanceMetadata

The RPC response.

Example
// Create client
BigtableInstanceAdminClient bigtableInstanceAdminClient = BigtableInstanceAdminClient.Create();
// Initialize request argument(s)
CreateInstanceRequest request = new CreateInstanceRequest
{
    ParentAsProjectName = ProjectName.FromProject("[PROJECT]"),
    InstanceId = "",
    Instance = new Instance(),
    Clusters = { { "", new Cluster() }, },
};
// Make the request
Operation<Instance, CreateInstanceMetadata> response = bigtableInstanceAdminClient.CreateInstance(request);

// Poll until the returned long-running operation is complete
Operation<Instance, CreateInstanceMetadata> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
Instance result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Instance, CreateInstanceMetadata> retrievedResponse = bigtableInstanceAdminClient.PollOnceCreateInstance(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Instance retrievedResult = retrievedResponse.Result;
}

CreateInstance(string, string, Instance, IDictionary<string, Cluster>, CallSettings)

public virtual Operation<Instance, CreateInstanceMetadata> CreateInstance(string parent, string instanceId, Instance instance, IDictionary<string, Cluster> clusters, CallSettings callSettings = null)

Create an instance within a project.

Note that exactly one of Cluster.serve_nodes and Cluster.cluster_config.cluster_autoscaling_config can be set. If serve_nodes is set to non-zero, then the cluster is manually scaled. If cluster_config.cluster_autoscaling_config is non-empty, then autoscaling is enabled.

Parameters
NameDescription
parentstring

Required. The unique name of the project in which to create the new instance. Values are of the form projects/{project}.

instanceIdstring

Required. The ID to be used when referring to the new instance within its project, e.g., just myinstance rather than projects/myproject/instances/myinstance.

instanceInstance

Required. The instance to create. Fields marked OutputOnly must be left blank.

clustersIDictionarystringCluster

Required. The clusters to be created within the instance, mapped by desired cluster ID, e.g., just mycluster rather than projects/myproject/instances/myinstance/clusters/mycluster. Fields marked OutputOnly must be left blank. Currently, at most four clusters can be specified.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
OperationInstanceCreateInstanceMetadata

The RPC response.

Example
// Create client
BigtableInstanceAdminClient bigtableInstanceAdminClient = BigtableInstanceAdminClient.Create();
// Initialize request argument(s)
string parent = "projects/[PROJECT]";
string instanceId = "";
Instance instance = new Instance();
IDictionary<string, Cluster> clusters = new Dictionary<string, Cluster> { { "", new Cluster() }, };
// Make the request
Operation<Instance, CreateInstanceMetadata> response = bigtableInstanceAdminClient.CreateInstance(parent, instanceId, instance, clusters);

// Poll until the returned long-running operation is complete
Operation<Instance, CreateInstanceMetadata> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
Instance result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Instance, CreateInstanceMetadata> retrievedResponse = bigtableInstanceAdminClient.PollOnceCreateInstance(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Instance retrievedResult = retrievedResponse.Result;
}

CreateInstanceAsync(ProjectName, string, Instance, IDictionary<string, Cluster>, CallSettings)

public virtual Task<Operation<Instance, CreateInstanceMetadata>> CreateInstanceAsync(ProjectName parent, string instanceId, Instance instance, IDictionary<string, Cluster> clusters, CallSettings callSettings = null)

Create an instance within a project.

Note that exactly one of Cluster.serve_nodes and Cluster.cluster_config.cluster_autoscaling_config can be set. If serve_nodes is set to non-zero, then the cluster is manually scaled. If cluster_config.cluster_autoscaling_config is non-empty, then autoscaling is enabled.

Parameters
NameDescription
parentProjectName

Required. The unique name of the project in which to create the new instance. Values are of the form projects/{project}.

instanceIdstring

Required. The ID to be used when referring to the new instance within its project, e.g., just myinstance rather than projects/myproject/instances/myinstance.

instanceInstance

Required. The instance to create. Fields marked OutputOnly must be left blank.

clustersIDictionarystringCluster

Required. The clusters to be created within the instance, mapped by desired cluster ID, e.g., just mycluster rather than projects/myproject/instances/myinstance/clusters/mycluster. Fields marked OutputOnly must be left blank. Currently, at most four clusters can be specified.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TaskOperationInstanceCreateInstanceMetadata

A Task containing the RPC response.

Example
// Create client
BigtableInstanceAdminClient bigtableInstanceAdminClient = await BigtableInstanceAdminClient.CreateAsync();
// Initialize request argument(s)
ProjectName parent = ProjectName.FromProject("[PROJECT]");
string instanceId = "";
Instance instance = new Instance();
IDictionary<string, Cluster> clusters = new Dictionary<string, Cluster> { { "", new Cluster() }, };
// Make the request
Operation<Instance, CreateInstanceMetadata> response = await bigtableInstanceAdminClient.CreateInstanceAsync(parent, instanceId, instance, clusters);

// Poll until the returned long-running operation is complete
Operation<Instance, CreateInstanceMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Instance result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Instance, CreateInstanceMetadata> retrievedResponse = await bigtableInstanceAdminClient.PollOnceCreateInstanceAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Instance retrievedResult = retrievedResponse.Result;
}

CreateInstanceAsync(ProjectName, string, Instance, IDictionary<string, Cluster>, CancellationToken)

public virtual Task<Operation<Instance, CreateInstanceMetadata>> CreateInstanceAsync(ProjectName parent, string instanceId, Instance instance, IDictionary<string, Cluster> clusters, CancellationToken cancellationToken)

Create an instance within a project.

Note that exactly one of Cluster.serve_nodes and Cluster.cluster_config.cluster_autoscaling_config can be set. If serve_nodes is set to non-zero, then the cluster is manually scaled. If cluster_config.cluster_autoscaling_config is non-empty, then autoscaling is enabled.

Parameters
NameDescription
parentProjectName

Required. The unique name of the project in which to create the new instance. Values are of the form projects/{project}.

instanceIdstring

Required. The ID to be used when referring to the new instance within its project, e.g., just myinstance rather than projects/myproject/instances/myinstance.

instanceInstance

Required. The instance to create. Fields marked OutputOnly must be left blank.

clustersIDictionarystringCluster

Required. The clusters to be created within the instance, mapped by desired cluster ID, e.g., just mycluster rather than projects/myproject/instances/myinstance/clusters/mycluster. Fields marked OutputOnly must be left blank. Currently, at most four clusters can be specified.

cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
TaskOperationInstanceCreateInstanceMetadata

A Task containing the RPC response.

Example
// Create client
BigtableInstanceAdminClient bigtableInstanceAdminClient = await BigtableInstanceAdminClient.CreateAsync();
// Initialize request argument(s)
ProjectName parent = ProjectName.FromProject("[PROJECT]");
string instanceId = "";
Instance instance = new Instance();
IDictionary<string, Cluster> clusters = new Dictionary<string, Cluster> { { "", new Cluster() }, };
// Make the request
Operation<Instance, CreateInstanceMetadata> response = await bigtableInstanceAdminClient.CreateInstanceAsync(parent, instanceId, instance, clusters);

// Poll until the returned long-running operation is complete
Operation<Instance, CreateInstanceMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Instance result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Instance, CreateInstanceMetadata> retrievedResponse = await bigtableInstanceAdminClient.PollOnceCreateInstanceAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Instance retrievedResult = retrievedResponse.Result;
}

CreateInstanceAsync(CreateInstanceRequest, CallSettings)

public virtual Task<Operation<Instance, CreateInstanceMetadata>> CreateInstanceAsync(CreateInstanceRequest request, CallSettings callSettings = null)

Create an instance within a project.

Note that exactly one of Cluster.serve_nodes and Cluster.cluster_config.cluster_autoscaling_config can be set. If serve_nodes is set to non-zero, then the cluster is manually scaled. If cluster_config.cluster_autoscaling_config is non-empty, then autoscaling is enabled.

Parameters
NameDescription
requestCreateInstanceRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TaskOperationInstanceCreateInstanceMetadata

A Task containing the RPC response.

Example
// Create client
BigtableInstanceAdminClient bigtableInstanceAdminClient = await BigtableInstanceAdminClient.CreateAsync();
// Initialize request argument(s)
CreateInstanceRequest request = new CreateInstanceRequest
{
    ParentAsProjectName = ProjectName.FromProject("[PROJECT]"),
    InstanceId = "",
    Instance = new Instance(),
    Clusters = { { "", new Cluster() }, },
};
// Make the request
Operation<Instance, CreateInstanceMetadata> response = await bigtableInstanceAdminClient.CreateInstanceAsync(request);

// Poll until the returned long-running operation is complete
Operation<Instance, CreateInstanceMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Instance result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Instance, CreateInstanceMetadata> retrievedResponse = await bigtableInstanceAdminClient.PollOnceCreateInstanceAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Instance retrievedResult = retrievedResponse.Result;
}

CreateInstanceAsync(CreateInstanceRequest, CancellationToken)

public virtual Task<Operation<Instance, CreateInstanceMetadata>> CreateInstanceAsync(CreateInstanceRequest request, CancellationToken cancellationToken)

Create an instance within a project.

Note that exactly one of Cluster.serve_nodes and Cluster.cluster_config.cluster_autoscaling_config can be set. If serve_nodes is set to non-zero, then the cluster is manually scaled. If cluster_config.cluster_autoscaling_config is non-empty, then autoscaling is enabled.

Parameters
NameDescription
requestCreateInstanceRequest

The request object containing all of the parameters for the API call.

cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
TaskOperationInstanceCreateInstanceMetadata

A Task containing the RPC response.

Example
// Create client
BigtableInstanceAdminClient bigtableInstanceAdminClient = await BigtableInstanceAdminClient.CreateAsync();
// Initialize request argument(s)
CreateInstanceRequest request = new CreateInstanceRequest
{
    ParentAsProjectName = ProjectName.FromProject("[PROJECT]"),
    InstanceId = "",
    Instance = new Instance(),
    Clusters = { { "", new Cluster() }, },
};
// Make the request
Operation<Instance, CreateInstanceMetadata> response = await bigtableInstanceAdminClient.CreateInstanceAsync(request);

// Poll until the returned long-running operation is complete
Operation<Instance, CreateInstanceMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Instance result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Instance, CreateInstanceMetadata> retrievedResponse = await bigtableInstanceAdminClient.PollOnceCreateInstanceAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Instance retrievedResult = retrievedResponse.Result;
}

CreateInstanceAsync(string, string, Instance, IDictionary<string, Cluster>, CallSettings)

public virtual Task<Operation<Instance, CreateInstanceMetadata>> CreateInstanceAsync(string parent, string instanceId, Instance instance, IDictionary<string, Cluster> clusters, CallSettings callSettings = null)

Create an instance within a project.

Note that exactly one of Cluster.serve_nodes and Cluster.cluster_config.cluster_autoscaling_config can be set. If serve_nodes is set to non-zero, then the cluster is manually scaled. If cluster_config.cluster_autoscaling_config is non-empty, then autoscaling is enabled.

Parameters
NameDescription
parentstring

Required. The unique name of the project in which to create the new instance. Values are of the form projects/{project}.

instanceIdstring

Required. The ID to be used when referring to the new instance within its project, e.g., just myinstance rather than projects/myproject/instances/myinstance.

instanceInstance

Required. The instance to create. Fields marked OutputOnly must be left blank.

clustersIDictionarystringCluster

Required. The clusters to be created within the instance, mapped by desired cluster ID, e.g., just mycluster rather than projects/myproject/instances/myinstance/clusters/mycluster. Fields marked OutputOnly must be left blank. Currently, at most four clusters can be specified.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TaskOperationInstanceCreateInstanceMetadata

A Task containing the RPC response.

Example
// Create client
BigtableInstanceAdminClient bigtableInstanceAdminClient = await BigtableInstanceAdminClient.CreateAsync();
// Initialize request argument(s)
string parent = "projects/[PROJECT]";
string instanceId = "";
Instance instance = new Instance();
IDictionary<string, Cluster> clusters = new Dictionary<string, Cluster> { { "", new Cluster() }, };
// Make the request
Operation<Instance, CreateInstanceMetadata> response = await bigtableInstanceAdminClient.CreateInstanceAsync(parent, instanceId, instance, clusters);

// Poll until the returned long-running operation is complete
Operation<Instance, CreateInstanceMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Instance result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Instance, CreateInstanceMetadata> retrievedResponse = await bigtableInstanceAdminClient.PollOnceCreateInstanceAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Instance retrievedResult = retrievedResponse.Result;
}

CreateInstanceAsync(string, string, Instance, IDictionary<string, Cluster>, CancellationToken)

public virtual Task<Operation<Instance, CreateInstanceMetadata>> CreateInstanceAsync(string parent, string instanceId, Instance instance, IDictionary<string, Cluster> clusters, CancellationToken cancellationToken)

Create an instance within a project.

Note that exactly one of Cluster.serve_nodes and Cluster.cluster_config.cluster_autoscaling_config can be set. If serve_nodes is set to non-zero, then the cluster is manually scaled. If cluster_config.cluster_autoscaling_config is non-empty, then autoscaling is enabled.

Parameters
NameDescription
parentstring

Required. The unique name of the project in which to create the new instance. Values are of the form projects/{project}.

instanceIdstring

Required. The ID to be used when referring to the new instance within its project, e.g., just myinstance rather than projects/myproject/instances/myinstance.

instanceInstance

Required. The instance to create. Fields marked OutputOnly must be left blank.

clustersIDictionarystringCluster

Required. The clusters to be created within the instance, mapped by desired cluster ID, e.g., just mycluster rather than projects/myproject/instances/myinstance/clusters/mycluster. Fields marked OutputOnly must be left blank. Currently, at most four clusters can be specified.

cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
TaskOperationInstanceCreateInstanceMetadata

A Task containing the RPC response.

Example
// Create client
BigtableInstanceAdminClient bigtableInstanceAdminClient = await BigtableInstanceAdminClient.CreateAsync();
// Initialize request argument(s)
string parent = "projects/[PROJECT]";
string instanceId = "";
Instance instance = new Instance();
IDictionary<string, Cluster> clusters = new Dictionary<string, Cluster> { { "", new Cluster() }, };
// Make the request
Operation<Instance, CreateInstanceMetadata> response = await bigtableInstanceAdminClient.CreateInstanceAsync(parent, instanceId, instance, clusters);

// Poll until the returned long-running operation is complete
Operation<Instance, CreateInstanceMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Instance result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Instance, CreateInstanceMetadata> retrievedResponse = await bigtableInstanceAdminClient.PollOnceCreateInstanceAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Instance retrievedResult = retrievedResponse.Result;
}

DeleteAppProfile(AppProfileName, CallSettings)

public virtual void DeleteAppProfile(AppProfileName name, CallSettings callSettings = null)

Deletes an app profile from an instance.

Parameters
NameDescription
nameAppProfileName

Required. The unique name of the app profile to be deleted. Values are of the form projects/{project}/instances/{instance}/appProfiles/{app_profile}.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Example
// Create client
BigtableInstanceAdminClient bigtableInstanceAdminClient = BigtableInstanceAdminClient.Create();
// Initialize request argument(s)
AppProfileName name = AppProfileName.FromProjectInstanceAppProfile("[PROJECT]", "[INSTANCE]", "[APP_PROFILE]");
// Make the request
bigtableInstanceAdminClient.DeleteAppProfile(name);

DeleteAppProfile(DeleteAppProfileRequest, CallSettings)

public virtual void DeleteAppProfile(DeleteAppProfileRequest request, CallSettings callSettings = null)

Deletes an app profile from an instance.

Parameters
NameDescription
requestDeleteAppProfileRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Example
// Create client
BigtableInstanceAdminClient bigtableInstanceAdminClient = BigtableInstanceAdminClient.Create();
// Initialize request argument(s)
DeleteAppProfileRequest request = new DeleteAppProfileRequest
{
    AppProfileName = AppProfileName.FromProjectInstanceAppProfile("[PROJECT]", "[INSTANCE]", "[APP_PROFILE]"),
    IgnoreWarnings = false,
};
// Make the request
bigtableInstanceAdminClient.DeleteAppProfile(request);

DeleteAppProfile(string, CallSettings)

public virtual void DeleteAppProfile(string name, CallSettings callSettings = null)

Deletes an app profile from an instance.

Parameters
NameDescription
namestring

Required. The unique name of the app profile to be deleted. Values are of the form projects/{project}/instances/{instance}/appProfiles/{app_profile}.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Example
// Create client
BigtableInstanceAdminClient bigtableInstanceAdminClient = BigtableInstanceAdminClient.Create();
// Initialize request argument(s)
string name = "projects/[PROJECT]/instances/[INSTANCE]/appProfiles/[APP_PROFILE]";
// Make the request
bigtableInstanceAdminClient.DeleteAppProfile(name);

DeleteAppProfileAsync(AppProfileName, CallSettings)

public virtual Task DeleteAppProfileAsync(AppProfileName name, CallSettings callSettings = null)

Deletes an app profile from an instance.

Parameters
NameDescription
nameAppProfileName

Required. The unique name of the app profile to be deleted. Values are of the form projects/{project}/instances/{instance}/appProfiles/{app_profile}.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task

A Task containing the RPC response.

Example
// Create client
BigtableInstanceAdminClient bigtableInstanceAdminClient = await BigtableInstanceAdminClient.CreateAsync();
// Initialize request argument(s)
AppProfileName name = AppProfileName.FromProjectInstanceAppProfile("[PROJECT]", "[INSTANCE]", "[APP_PROFILE]");
// Make the request
await bigtableInstanceAdminClient.DeleteAppProfileAsync(name);

DeleteAppProfileAsync(AppProfileName, CancellationToken)

public virtual Task DeleteAppProfileAsync(AppProfileName name, CancellationToken cancellationToken)

Deletes an app profile from an instance.

Parameters
NameDescription
nameAppProfileName

Required. The unique name of the app profile to be deleted. Values are of the form projects/{project}/instances/{instance}/appProfiles/{app_profile}.

cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
Task

A Task containing the RPC response.

Example
// Create client
BigtableInstanceAdminClient bigtableInstanceAdminClient = await BigtableInstanceAdminClient.CreateAsync();
// Initialize request argument(s)
AppProfileName name = AppProfileName.FromProjectInstanceAppProfile("[PROJECT]", "[INSTANCE]", "[APP_PROFILE]");
// Make the request
await bigtableInstanceAdminClient.DeleteAppProfileAsync(name);

DeleteAppProfileAsync(DeleteAppProfileRequest, CallSettings)

public virtual Task DeleteAppProfileAsync(DeleteAppProfileRequest request, CallSettings callSettings = null)

Deletes an app profile from an instance.

Parameters
NameDescription
requestDeleteAppProfileRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task

A Task containing the RPC response.

Example
// Create client
BigtableInstanceAdminClient bigtableInstanceAdminClient = await BigtableInstanceAdminClient.CreateAsync();
// Initialize request argument(s)
DeleteAppProfileRequest request = new DeleteAppProfileRequest
{
    AppProfileName = AppProfileName.FromProjectInstanceAppProfile("[PROJECT]", "[INSTANCE]", "[APP_PROFILE]"),
    IgnoreWarnings = false,
};
// Make the request
await bigtableInstanceAdminClient.DeleteAppProfileAsync(request);

DeleteAppProfileAsync(DeleteAppProfileRequest, CancellationToken)

public virtual Task DeleteAppProfileAsync(DeleteAppProfileRequest request, CancellationToken cancellationToken)

Deletes an app profile from an instance.

Parameters
NameDescription
requestDeleteAppProfileRequest

The request object containing all of the parameters for the API call.

cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
Task

A Task containing the RPC response.

Example
// Create client
BigtableInstanceAdminClient bigtableInstanceAdminClient = await BigtableInstanceAdminClient.CreateAsync();
// Initialize request argument(s)
DeleteAppProfileRequest request = new DeleteAppProfileRequest
{
    AppProfileName = AppProfileName.FromProjectInstanceAppProfile("[PROJECT]", "[INSTANCE]", "[APP_PROFILE]"),
    IgnoreWarnings = false,
};
// Make the request
await bigtableInstanceAdminClient.DeleteAppProfileAsync(request);

DeleteAppProfileAsync(string, CallSettings)

public virtual Task DeleteAppProfileAsync(string name, CallSettings callSettings = null)

Deletes an app profile from an instance.

Parameters
NameDescription
namestring

Required. The unique name of the app profile to be deleted. Values are of the form projects/{project}/instances/{instance}/appProfiles/{app_profile}.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task

A Task containing the RPC response.

Example
// Create client
BigtableInstanceAdminClient bigtableInstanceAdminClient = await BigtableInstanceAdminClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/instances/[INSTANCE]/appProfiles/[APP_PROFILE]";
// Make the request
await bigtableInstanceAdminClient.DeleteAppProfileAsync(name);

DeleteAppProfileAsync(string, CancellationToken)

public virtual Task DeleteAppProfileAsync(string name, CancellationToken cancellationToken)

Deletes an app profile from an instance.

Parameters
NameDescription
namestring

Required. The unique name of the app profile to be deleted. Values are of the form projects/{project}/instances/{instance}/appProfiles/{app_profile}.

cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
Task

A Task containing the RPC response.

Example
// Create client
BigtableInstanceAdminClient bigtableInstanceAdminClient = await BigtableInstanceAdminClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/instances/[INSTANCE]/appProfiles/[APP_PROFILE]";
// Make the request
await bigtableInstanceAdminClient.DeleteAppProfileAsync(name);

DeleteCluster(ClusterName, CallSettings)

public virtual void DeleteCluster(ClusterName name, CallSettings callSettings = null)

Deletes a cluster from an instance.

Parameters
NameDescription
nameClusterName

Required. The unique name of the cluster to be deleted. Values are of the form projects/{project}/instances/{instance}/clusters/{cluster}.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Example
// Create client
BigtableInstanceAdminClient bigtableInstanceAdminClient = BigtableInstanceAdminClient.Create();
// Initialize request argument(s)
ClusterName name = ClusterName.FromProjectInstanceCluster("[PROJECT]", "[INSTANCE]", "[CLUSTER]");
// Make the request
bigtableInstanceAdminClient.DeleteCluster(name);

DeleteCluster(DeleteClusterRequest, CallSettings)

public virtual void DeleteCluster(DeleteClusterRequest request, CallSettings callSettings = null)

Deletes a cluster from an instance.

Parameters
NameDescription
requestDeleteClusterRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Example
// Create client
BigtableInstanceAdminClient bigtableInstanceAdminClient = BigtableInstanceAdminClient.Create();
// Initialize request argument(s)
DeleteClusterRequest request = new DeleteClusterRequest
{
    ClusterName = ClusterName.FromProjectInstanceCluster("[PROJECT]", "[INSTANCE]", "[CLUSTER]"),
};
// Make the request
bigtableInstanceAdminClient.DeleteCluster(request);

DeleteCluster(string, CallSettings)

public virtual void DeleteCluster(string name, CallSettings callSettings = null)

Deletes a cluster from an instance.

Parameters
NameDescription
namestring

Required. The unique name of the cluster to be deleted. Values are of the form projects/{project}/instances/{instance}/clusters/{cluster}.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Example
// Create client
BigtableInstanceAdminClient bigtableInstanceAdminClient = BigtableInstanceAdminClient.Create();
// Initialize request argument(s)
string name = "projects/[PROJECT]/instances/[INSTANCE]/clusters/[CLUSTER]";
// Make the request
bigtableInstanceAdminClient.DeleteCluster(name);

DeleteClusterAsync(ClusterName, CallSettings)

public virtual Task DeleteClusterAsync(ClusterName name, CallSettings callSettings = null)

Deletes a cluster from an instance.

Parameters
NameDescription
nameClusterName

Required. The unique name of the cluster to be deleted. Values are of the form projects/{project}/instances/{instance}/clusters/{cluster}.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task

A Task containing the RPC response.

Example
// Create client
BigtableInstanceAdminClient bigtableInstanceAdminClient = await BigtableInstanceAdminClient.CreateAsync();
// Initialize request argument(s)
ClusterName name = ClusterName.FromProjectInstanceCluster("[PROJECT]", "[INSTANCE]", "[CLUSTER]");
// Make the request
await bigtableInstanceAdminClient.DeleteClusterAsync(name);

DeleteClusterAsync(ClusterName, CancellationToken)

public virtual Task DeleteClusterAsync(ClusterName name, CancellationToken cancellationToken)

Deletes a cluster from an instance.

Parameters
NameDescription
nameClusterName

Required. The unique name of the cluster to be deleted. Values are of the form projects/{project}/instances/{instance}/clusters/{cluster}.

cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
Task

A Task containing the RPC response.

Example
// Create client
BigtableInstanceAdminClient bigtableInstanceAdminClient = await BigtableInstanceAdminClient.CreateAsync();
// Initialize request argument(s)
ClusterName name = ClusterName.FromProjectInstanceCluster("[PROJECT]", "[INSTANCE]", "[CLUSTER]");
// Make the request
await bigtableInstanceAdminClient.DeleteClusterAsync(name);

DeleteClusterAsync(DeleteClusterRequest, CallSettings)

public virtual Task DeleteClusterAsync(DeleteClusterRequest request, CallSettings callSettings = null)

Deletes a cluster from an instance.

Parameters
NameDescription
requestDeleteClusterRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task

A Task containing the RPC response.

Example
// Create client
BigtableInstanceAdminClient bigtableInstanceAdminClient = await BigtableInstanceAdminClient.CreateAsync();
// Initialize request argument(s)
DeleteClusterRequest request = new DeleteClusterRequest
{
    ClusterName = ClusterName.FromProjectInstanceCluster("[PROJECT]", "[INSTANCE]", "[CLUSTER]"),
};
// Make the request
await bigtableInstanceAdminClient.DeleteClusterAsync(request);

DeleteClusterAsync(DeleteClusterRequest, CancellationToken)

public virtual Task DeleteClusterAsync(DeleteClusterRequest request, CancellationToken cancellationToken)

Deletes a cluster from an instance.

Parameters
NameDescription
requestDeleteClusterRequest

The request object containing all of the parameters for the API call.

cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
Task

A Task containing the RPC response.

Example
// Create client
BigtableInstanceAdminClient bigtableInstanceAdminClient = await BigtableInstanceAdminClient.CreateAsync();
// Initialize request argument(s)
DeleteClusterRequest request = new DeleteClusterRequest
{
    ClusterName = ClusterName.FromProjectInstanceCluster("[PROJECT]", "[INSTANCE]", "[CLUSTER]"),
};
// Make the request
await bigtableInstanceAdminClient.DeleteClusterAsync(request);

DeleteClusterAsync(string, CallSettings)

public virtual Task DeleteClusterAsync(string name, CallSettings callSettings = null)

Deletes a cluster from an instance.

Parameters
NameDescription
namestring

Required. The unique name of the cluster to be deleted. Values are of the form projects/{project}/instances/{instance}/clusters/{cluster}.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task

A Task containing the RPC response.

Example
// Create client
BigtableInstanceAdminClient bigtableInstanceAdminClient = await BigtableInstanceAdminClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/instances/[INSTANCE]/clusters/[CLUSTER]";
// Make the request
await bigtableInstanceAdminClient.DeleteClusterAsync(name);

DeleteClusterAsync(string, CancellationToken)

public virtual Task DeleteClusterAsync(string name, CancellationToken cancellationToken)

Deletes a cluster from an instance.

Parameters
NameDescription
namestring

Required. The unique name of the cluster to be deleted. Values are of the form projects/{project}/instances/{instance}/clusters/{cluster}.

cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
Task

A Task containing the RPC response.

Example
// Create client
BigtableInstanceAdminClient bigtableInstanceAdminClient = await BigtableInstanceAdminClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/instances/[INSTANCE]/clusters/[CLUSTER]";
// Make the request
await bigtableInstanceAdminClient.DeleteClusterAsync(name);

DeleteInstance(DeleteInstanceRequest, CallSettings)

public virtual void DeleteInstance(DeleteInstanceRequest request, CallSettings callSettings = null)

Delete an instance from a project.

Parameters
NameDescription
requestDeleteInstanceRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Example
// Create client
BigtableInstanceAdminClient bigtableInstanceAdminClient = BigtableInstanceAdminClient.Create();
// Initialize request argument(s)
DeleteInstanceRequest request = new DeleteInstanceRequest
{
    InstanceName = InstanceName.FromProjectInstance("[PROJECT]", "[INSTANCE]"),
};
// Make the request
bigtableInstanceAdminClient.DeleteInstance(request);

DeleteInstance(InstanceName, CallSettings)

public virtual void DeleteInstance(InstanceName name, CallSettings callSettings = null)

Delete an instance from a project.

Parameters
NameDescription
nameInstanceName

Required. The unique name of the instance to be deleted. Values are of the form projects/{project}/instances/{instance}.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Example
// Create client
BigtableInstanceAdminClient bigtableInstanceAdminClient = BigtableInstanceAdminClient.Create();
// Initialize request argument(s)
InstanceName name = InstanceName.FromProjectInstance("[PROJECT]", "[INSTANCE]");
// Make the request
bigtableInstanceAdminClient.DeleteInstance(name);

DeleteInstance(string, CallSettings)

public virtual void DeleteInstance(string name, CallSettings callSettings = null)

Delete an instance from a project.

Parameters
NameDescription
namestring

Required. The unique name of the instance to be deleted. Values are of the form projects/{project}/instances/{instance}.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Example
// Create client
BigtableInstanceAdminClient bigtableInstanceAdminClient = BigtableInstanceAdminClient.Create();
// Initialize request argument(s)
string name = "projects/[PROJECT]/instances/[INSTANCE]";
// Make the request
bigtableInstanceAdminClient.DeleteInstance(name);

DeleteInstanceAsync(DeleteInstanceRequest, CallSettings)

public virtual Task DeleteInstanceAsync(DeleteInstanceRequest request, CallSettings callSettings = null)

Delete an instance from a project.

Parameters
NameDescription
requestDeleteInstanceRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task

A Task containing the RPC response.

Example
// Create client
BigtableInstanceAdminClient bigtableInstanceAdminClient = await BigtableInstanceAdminClient.CreateAsync();
// Initialize request argument(s)
DeleteInstanceRequest request = new DeleteInstanceRequest
{
    InstanceName = InstanceName.FromProjectInstance("[PROJECT]", "[INSTANCE]"),
};
// Make the request
await bigtableInstanceAdminClient.DeleteInstanceAsync(request);

DeleteInstanceAsync(DeleteInstanceRequest, CancellationToken)

public virtual Task DeleteInstanceAsync(DeleteInstanceRequest request, CancellationToken cancellationToken)

Delete an instance from a project.

Parameters
NameDescription
requestDeleteInstanceRequest

The request object containing all of the parameters for the API call.

cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
Task

A Task containing the RPC response.

Example
// Create client
BigtableInstanceAdminClient bigtableInstanceAdminClient = await BigtableInstanceAdminClient.CreateAsync();
// Initialize request argument(s)
DeleteInstanceRequest request = new DeleteInstanceRequest
{
    InstanceName = InstanceName.FromProjectInstance("[PROJECT]", "[INSTANCE]"),
};
// Make the request
await bigtableInstanceAdminClient.DeleteInstanceAsync(request);

DeleteInstanceAsync(InstanceName, CallSettings)

public virtual Task DeleteInstanceAsync(InstanceName name, CallSettings callSettings = null)

Delete an instance from a project.

Parameters
NameDescription
nameInstanceName

Required. The unique name of the instance to be deleted. Values are of the form projects/{project}/instances/{instance}.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task

A Task containing the RPC response.

Example
// Create client
BigtableInstanceAdminClient bigtableInstanceAdminClient = await BigtableInstanceAdminClient.CreateAsync();
// Initialize request argument(s)
InstanceName name = InstanceName.FromProjectInstance("[PROJECT]", "[INSTANCE]");
// Make the request
await bigtableInstanceAdminClient.DeleteInstanceAsync(name);

DeleteInstanceAsync(InstanceName, CancellationToken)

public virtual Task DeleteInstanceAsync(InstanceName name, CancellationToken cancellationToken)

Delete an instance from a project.

Parameters
NameDescription
nameInstanceName

Required. The unique name of the instance to be deleted. Values are of the form projects/{project}/instances/{instance}.

cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
Task

A Task containing the RPC response.

Example
// Create client
BigtableInstanceAdminClient bigtableInstanceAdminClient = await BigtableInstanceAdminClient.CreateAsync();
// Initialize request argument(s)
InstanceName name = InstanceName.FromProjectInstance("[PROJECT]", "[INSTANCE]");
// Make the request
await bigtableInstanceAdminClient.DeleteInstanceAsync(name);

DeleteInstanceAsync(string, CallSettings)

public virtual Task DeleteInstanceAsync(string name, CallSettings callSettings = null)

Delete an instance from a project.

Parameters
NameDescription
namestring

Required. The unique name of the instance to be deleted. Values are of the form projects/{project}/instances/{instance}.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task

A Task containing the RPC response.

Example
// Create client
BigtableInstanceAdminClient bigtableInstanceAdminClient = await BigtableInstanceAdminClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/instances/[INSTANCE]";
// Make the request
await bigtableInstanceAdminClient.DeleteInstanceAsync(name);

DeleteInstanceAsync(string, CancellationToken)

public virtual Task DeleteInstanceAsync(string name, CancellationToken cancellationToken)

Delete an instance from a project.

Parameters
NameDescription
namestring

Required. The unique name of the instance to be deleted. Values are of the form projects/{project}/instances/{instance}.

cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
Task

A Task containing the RPC response.

Example
// Create client
BigtableInstanceAdminClient bigtableInstanceAdminClient = await BigtableInstanceAdminClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/instances/[INSTANCE]";
// Make the request
await bigtableInstanceAdminClient.DeleteInstanceAsync(name);

GetAppProfile(AppProfileName, CallSettings)

public virtual AppProfile GetAppProfile(AppProfileName name, CallSettings callSettings = null)

Gets information about an app profile.

Parameters
NameDescription
nameAppProfileName

Required. The unique name of the requested app profile. Values are of the form projects/{project}/instances/{instance}/appProfiles/{app_profile}.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
AppProfile

The RPC response.

Example
// Create client
BigtableInstanceAdminClient bigtableInstanceAdminClient = BigtableInstanceAdminClient.Create();
// Initialize request argument(s)
AppProfileName name = AppProfileName.FromProjectInstanceAppProfile("[PROJECT]", "[INSTANCE]", "[APP_PROFILE]");
// Make the request
AppProfile response = bigtableInstanceAdminClient.GetAppProfile(name);

GetAppProfile(GetAppProfileRequest, CallSettings)

public virtual AppProfile GetAppProfile(GetAppProfileRequest request, CallSettings callSettings = null)

Gets information about an app profile.

Parameters
NameDescription
requestGetAppProfileRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
AppProfile

The RPC response.

Example
// Create client
BigtableInstanceAdminClient bigtableInstanceAdminClient = BigtableInstanceAdminClient.Create();
// Initialize request argument(s)
GetAppProfileRequest request = new GetAppProfileRequest
{
    AppProfileName = AppProfileName.FromProjectInstanceAppProfile("[PROJECT]", "[INSTANCE]", "[APP_PROFILE]"),
};
// Make the request
AppProfile response = bigtableInstanceAdminClient.GetAppProfile(request);

GetAppProfile(string, CallSettings)

public virtual AppProfile GetAppProfile(string name, CallSettings callSettings = null)

Gets information about an app profile.

Parameters
NameDescription
namestring

Required. The unique name of the requested app profile. Values are of the form projects/{project}/instances/{instance}/appProfiles/{app_profile}.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
AppProfile

The RPC response.

Example
// Create client
BigtableInstanceAdminClient bigtableInstanceAdminClient = BigtableInstanceAdminClient.Create();
// Initialize request argument(s)
string name = "projects/[PROJECT]/instances/[INSTANCE]/appProfiles/[APP_PROFILE]";
// Make the request
AppProfile response = bigtableInstanceAdminClient.GetAppProfile(name);

GetAppProfileAsync(AppProfileName, CallSettings)

public virtual Task<AppProfile> GetAppProfileAsync(AppProfileName name, CallSettings callSettings = null)

Gets information about an app profile.

Parameters
NameDescription
nameAppProfileName

Required. The unique name of the requested app profile. Values are of the form projects/{project}/instances/{instance}/appProfiles/{app_profile}.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TaskAppProfile

A Task containing the RPC response.

Example
// Create client
BigtableInstanceAdminClient bigtableInstanceAdminClient = await BigtableInstanceAdminClient.CreateAsync();
// Initialize request argument(s)
AppProfileName name = AppProfileName.FromProjectInstanceAppProfile("[PROJECT]", "[INSTANCE]", "[APP_PROFILE]");
// Make the request
AppProfile response = await bigtableInstanceAdminClient.GetAppProfileAsync(name);

GetAppProfileAsync(AppProfileName, CancellationToken)

public virtual Task<AppProfile> GetAppProfileAsync(AppProfileName name, CancellationToken cancellationToken)

Gets information about an app profile.

Parameters
NameDescription
nameAppProfileName

Required. The unique name of the requested app profile. Values are of the form projects/{project}/instances/{instance}/appProfiles/{app_profile}.

cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
TaskAppProfile

A Task containing the RPC response.

Example
// Create client
BigtableInstanceAdminClient bigtableInstanceAdminClient = await BigtableInstanceAdminClient.CreateAsync();
// Initialize request argument(s)
AppProfileName name = AppProfileName.FromProjectInstanceAppProfile("[PROJECT]", "[INSTANCE]", "[APP_PROFILE]");
// Make the request
AppProfile response = await bigtableInstanceAdminClient.GetAppProfileAsync(name);

GetAppProfileAsync(GetAppProfileRequest, CallSettings)

public virtual Task<AppProfile> GetAppProfileAsync(GetAppProfileRequest request, CallSettings callSettings = null)

Gets information about an app profile.

Parameters
NameDescription
requestGetAppProfileRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TaskAppProfile

A Task containing the RPC response.

Example
// Create client
BigtableInstanceAdminClient bigtableInstanceAdminClient = await BigtableInstanceAdminClient.CreateAsync();
// Initialize request argument(s)
GetAppProfileRequest request = new GetAppProfileRequest
{
    AppProfileName = AppProfileName.FromProjectInstanceAppProfile("[PROJECT]", "[INSTANCE]", "[APP_PROFILE]"),
};
// Make the request
AppProfile response = await bigtableInstanceAdminClient.GetAppProfileAsync(request);

GetAppProfileAsync(GetAppProfileRequest, CancellationToken)

public virtual Task<AppProfile> GetAppProfileAsync(GetAppProfileRequest request, CancellationToken cancellationToken)

Gets information about an app profile.

Parameters
NameDescription
requestGetAppProfileRequest

The request object containing all of the parameters for the API call.

cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
TaskAppProfile

A Task containing the RPC response.

Example
// Create client
BigtableInstanceAdminClient bigtableInstanceAdminClient = await BigtableInstanceAdminClient.CreateAsync();
// Initialize request argument(s)
GetAppProfileRequest request = new GetAppProfileRequest
{
    AppProfileName = AppProfileName.FromProjectInstanceAppProfile("[PROJECT]", "[INSTANCE]", "[APP_PROFILE]"),
};
// Make the request
AppProfile response = await bigtableInstanceAdminClient.GetAppProfileAsync(request);

GetAppProfileAsync(string, CallSettings)

public virtual Task<AppProfile> GetAppProfileAsync(string name, CallSettings callSettings = null)

Gets information about an app profile.

Parameters
NameDescription
namestring

Required. The unique name of the requested app profile. Values are of the form projects/{project}/instances/{instance}/appProfiles/{app_profile}.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TaskAppProfile

A Task containing the RPC response.

Example
// Create client
BigtableInstanceAdminClient bigtableInstanceAdminClient = await BigtableInstanceAdminClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/instances/[INSTANCE]/appProfiles/[APP_PROFILE]";
// Make the request
AppProfile response = await bigtableInstanceAdminClient.GetAppProfileAsync(name);

GetAppProfileAsync(string, CancellationToken)

public virtual Task<AppProfile> GetAppProfileAsync(string name, CancellationToken cancellationToken)

Gets information about an app profile.

Parameters
NameDescription
namestring

Required. The unique name of the requested app profile. Values are of the form projects/{project}/instances/{instance}/appProfiles/{app_profile}.

cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
TaskAppProfile

A Task containing the RPC response.

Example
// Create client
BigtableInstanceAdminClient bigtableInstanceAdminClient = await BigtableInstanceAdminClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/instances/[INSTANCE]/appProfiles/[APP_PROFILE]";
// Make the request
AppProfile response = await bigtableInstanceAdminClient.GetAppProfileAsync(name);

GetCluster(ClusterName, CallSettings)

public virtual Cluster GetCluster(ClusterName name, CallSettings callSettings = null)

Gets information about a cluster.

Parameters
NameDescription
nameClusterName

Required. The unique name of the requested cluster. Values are of the form projects/{project}/instances/{instance}/clusters/{cluster}.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Cluster

The RPC response.

Example
// Create client
BigtableInstanceAdminClient bigtableInstanceAdminClient = BigtableInstanceAdminClient.Create();
// Initialize request argument(s)
ClusterName name = ClusterName.FromProjectInstanceCluster("[PROJECT]", "[INSTANCE]", "[CLUSTER]");
// Make the request
Cluster response = bigtableInstanceAdminClient.GetCluster(name);

GetCluster(GetClusterRequest, CallSettings)

public virtual Cluster GetCluster(GetClusterRequest request, CallSettings callSettings = null)

Gets information about a cluster.

Parameters
NameDescription
requestGetClusterRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Cluster

The RPC response.

Example
// Create client
BigtableInstanceAdminClient bigtableInstanceAdminClient = BigtableInstanceAdminClient.Create();
// Initialize request argument(s)
GetClusterRequest request = new GetClusterRequest
{
    ClusterName = ClusterName.FromProjectInstanceCluster("[PROJECT]", "[INSTANCE]", "[CLUSTER]"),
};
// Make the request
Cluster response = bigtableInstanceAdminClient.GetCluster(request);

GetCluster(string, CallSettings)

public virtual Cluster GetCluster(string name, CallSettings callSettings = null)

Gets information about a cluster.

Parameters
NameDescription
namestring

Required. The unique name of the requested cluster. Values are of the form projects/{project}/instances/{instance}/clusters/{cluster}.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Cluster

The RPC response.

Example
// Create client
BigtableInstanceAdminClient bigtableInstanceAdminClient = BigtableInstanceAdminClient.Create();
// Initialize request argument(s)
string name = "projects/[PROJECT]/instances/[INSTANCE]/clusters/[CLUSTER]";
// Make the request
Cluster response = bigtableInstanceAdminClient.GetCluster(name);

GetClusterAsync(ClusterName, CallSettings)

public virtual Task<Cluster> GetClusterAsync(ClusterName name, CallSettings callSettings = null)

Gets information about a cluster.

Parameters
NameDescription
nameClusterName

Required. The unique name of the requested cluster. Values are of the form projects/{project}/instances/{instance}/clusters/{cluster}.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TaskCluster

A Task containing the RPC response.

Example
// Create client
BigtableInstanceAdminClient bigtableInstanceAdminClient = await BigtableInstanceAdminClient.CreateAsync();
// Initialize request argument(s)
ClusterName name = ClusterName.FromProjectInstanceCluster("[PROJECT]", "[INSTANCE]", "[CLUSTER]");
// Make the request
Cluster response = await bigtableInstanceAdminClient.GetClusterAsync(name);

GetClusterAsync(ClusterName, CancellationToken)

public virtual Task<Cluster> GetClusterAsync(ClusterName name, CancellationToken cancellationToken)

Gets information about a cluster.

Parameters
NameDescription
nameClusterName

Required. The unique name of the requested cluster. Values are of the form projects/{project}/instances/{instance}/clusters/{cluster}.

cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
TaskCluster

A Task containing the RPC response.

Example
// Create client
BigtableInstanceAdminClient bigtableInstanceAdminClient = await BigtableInstanceAdminClient.CreateAsync();
// Initialize request argument(s)
ClusterName name = ClusterName.FromProjectInstanceCluster("[PROJECT]", "[INSTANCE]", "[CLUSTER]");
// Make the request
Cluster response = await bigtableInstanceAdminClient.GetClusterAsync(name);

GetClusterAsync(GetClusterRequest, CallSettings)

public virtual Task<Cluster> GetClusterAsync(GetClusterRequest request, CallSettings callSettings = null)

Gets information about a cluster.

Parameters
NameDescription
requestGetClusterRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TaskCluster

A Task containing the RPC response.

Example
// Create client
BigtableInstanceAdminClient bigtableInstanceAdminClient = await BigtableInstanceAdminClient.CreateAsync();
// Initialize request argument(s)
GetClusterRequest request = new GetClusterRequest
{
    ClusterName = ClusterName.FromProjectInstanceCluster("[PROJECT]", "[INSTANCE]", "[CLUSTER]"),
};
// Make the request
Cluster response = await bigtableInstanceAdminClient.GetClusterAsync(request);

GetClusterAsync(GetClusterRequest, CancellationToken)

public virtual Task<Cluster> GetClusterAsync(GetClusterRequest request, CancellationToken cancellationToken)

Gets information about a cluster.

Parameters
NameDescription
requestGetClusterRequest

The request object containing all of the parameters for the API call.

cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
TaskCluster

A Task containing the RPC response.

Example
// Create client
BigtableInstanceAdminClient bigtableInstanceAdminClient = await BigtableInstanceAdminClient.CreateAsync();
// Initialize request argument(s)
GetClusterRequest request = new GetClusterRequest
{
    ClusterName = ClusterName.FromProjectInstanceCluster("[PROJECT]", "[INSTANCE]", "[CLUSTER]"),
};
// Make the request
Cluster response = await bigtableInstanceAdminClient.GetClusterAsync(request);

GetClusterAsync(string, CallSettings)

public virtual Task<Cluster> GetClusterAsync(string name, CallSettings callSettings = null)

Gets information about a cluster.

Parameters
NameDescription
namestring

Required. The unique name of the requested cluster. Values are of the form projects/{project}/instances/{instance}/clusters/{cluster}.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TaskCluster

A Task containing the RPC response.

Example
// Create client
BigtableInstanceAdminClient bigtableInstanceAdminClient = await BigtableInstanceAdminClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/instances/[INSTANCE]/clusters/[CLUSTER]";
// Make the request
Cluster response = await bigtableInstanceAdminClient.GetClusterAsync(name);

GetClusterAsync(string, CancellationToken)

public virtual Task<Cluster> GetClusterAsync(string name, CancellationToken cancellationToken)

Gets information about a cluster.

Parameters
NameDescription
namestring

Required. The unique name of the requested cluster. Values are of the form projects/{project}/instances/{instance}/clusters/{cluster}.

cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
TaskCluster

A Task containing the RPC response.

Example
// Create client
BigtableInstanceAdminClient bigtableInstanceAdminClient = await BigtableInstanceAdminClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/instances/[INSTANCE]/clusters/[CLUSTER]";
// Make the request
Cluster response = await bigtableInstanceAdminClient.GetClusterAsync(name);

GetIamPolicy(IResourceName, CallSettings)

public virtual Policy GetIamPolicy(IResourceName resource, 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.

Parameters
NameDescription
resourceIResourceName

REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Policy

The RPC response.

Example
// Create client
BigtableInstanceAdminClient bigtableInstanceAdminClient = BigtableInstanceAdminClient.Create();
// Initialize request argument(s)
IResourceName resource = new UnparsedResourceName("a/wildcard/resource");
// Make the request
Policy response = bigtableInstanceAdminClient.GetIamPolicy(resource);

GetIamPolicy(GetIamPolicyRequest, CallSettings)

public virtual 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.

Parameters
NameDescription
requestGetIamPolicyRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Policy

The RPC response.

Example
// Create client
BigtableInstanceAdminClient bigtableInstanceAdminClient = BigtableInstanceAdminClient.Create();
// Initialize request argument(s)
GetIamPolicyRequest request = new GetIamPolicyRequest
{
    ResourceAsResourceName = new UnparsedResourceName("a/wildcard/resource"),
    Options = new GetPolicyOptions(),
};
// Make the request
Policy response = bigtableInstanceAdminClient.GetIamPolicy(request);

GetIamPolicy(string, CallSettings)

public virtual Policy GetIamPolicy(string resource, 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.

Parameters
NameDescription
resourcestring

REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Policy

The RPC response.

Example
// Create client
BigtableInstanceAdminClient bigtableInstanceAdminClient = BigtableInstanceAdminClient.Create();
// Initialize request argument(s)
string resource = "a/wildcard/resource";
// Make the request
Policy response = bigtableInstanceAdminClient.GetIamPolicy(resource);

GetIamPolicyAsync(IResourceName, CallSettings)

public virtual Task<Policy> GetIamPolicyAsync(IResourceName resource, 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.

Parameters
NameDescription
resourceIResourceName

REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TaskPolicy

A Task containing the RPC response.

Example
// Create client
BigtableInstanceAdminClient bigtableInstanceAdminClient = await BigtableInstanceAdminClient.CreateAsync();
// Initialize request argument(s)
IResourceName resource = new UnparsedResourceName("a/wildcard/resource");
// Make the request
Policy response = await bigtableInstanceAdminClient.GetIamPolicyAsync(resource);

GetIamPolicyAsync(IResourceName, CancellationToken)

public virtual Task<Policy> GetIamPolicyAsync(IResourceName resource, CancellationToken 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.

Parameters
NameDescription
resourceIResourceName

REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field.

cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
TaskPolicy

A Task containing the RPC response.

Example
// Create client
BigtableInstanceAdminClient bigtableInstanceAdminClient = await BigtableInstanceAdminClient.CreateAsync();
// Initialize request argument(s)
IResourceName resource = new UnparsedResourceName("a/wildcard/resource");
// Make the request
Policy response = await bigtableInstanceAdminClient.GetIamPolicyAsync(resource);

GetIamPolicyAsync(GetIamPolicyRequest, CallSettings)

public virtual 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.

Parameters
NameDescription
requestGetIamPolicyRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TaskPolicy

A Task containing the RPC response.

Example
// Create client
BigtableInstanceAdminClient bigtableInstanceAdminClient = await BigtableInstanceAdminClient.CreateAsync();
// Initialize request argument(s)
GetIamPolicyRequest request = new GetIamPolicyRequest
{
    ResourceAsResourceName = new UnparsedResourceName("a/wildcard/resource"),
    Options = new GetPolicyOptions(),
};
// Make the request
Policy response = await bigtableInstanceAdminClient.GetIamPolicyAsync(request);

GetIamPolicyAsync(GetIamPolicyRequest, CancellationToken)

public virtual Task<Policy> GetIamPolicyAsync(GetIamPolicyRequest request, CancellationToken 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.

Parameters
NameDescription
requestGetIamPolicyRequest

The request object containing all of the parameters for the API call.

cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
TaskPolicy

A Task containing the RPC response.

Example
// Create client
BigtableInstanceAdminClient bigtableInstanceAdminClient = await BigtableInstanceAdminClient.CreateAsync();
// Initialize request argument(s)
GetIamPolicyRequest request = new GetIamPolicyRequest
{
    ResourceAsResourceName = new UnparsedResourceName("a/wildcard/resource"),
    Options = new GetPolicyOptions(),
};
// Make the request
Policy response = await bigtableInstanceAdminClient.GetIamPolicyAsync(request);

GetIamPolicyAsync(string, CallSettings)

public virtual Task<Policy> GetIamPolicyAsync(string resource, 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.

Parameters
NameDescription
resourcestring

REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TaskPolicy

A Task containing the RPC response.

Example
// Create client
BigtableInstanceAdminClient bigtableInstanceAdminClient = await BigtableInstanceAdminClient.CreateAsync();
// Initialize request argument(s)
string resource = "a/wildcard/resource";
// Make the request
Policy response = await bigtableInstanceAdminClient.GetIamPolicyAsync(resource);

GetIamPolicyAsync(string, CancellationToken)

public virtual Task<Policy> GetIamPolicyAsync(string resource, CancellationToken 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.

Parameters
NameDescription
resourcestring

REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field.

cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
TaskPolicy

A Task containing the RPC response.

Example
// Create client
BigtableInstanceAdminClient bigtableInstanceAdminClient = await BigtableInstanceAdminClient.CreateAsync();
// Initialize request argument(s)
string resource = "a/wildcard/resource";
// Make the request
Policy response = await bigtableInstanceAdminClient.GetIamPolicyAsync(resource);

GetInstance(GetInstanceRequest, CallSettings)

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

Gets information about an instance.

Parameters
NameDescription
requestGetInstanceRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Instance

The RPC response.

Example
// Create client
BigtableInstanceAdminClient bigtableInstanceAdminClient = BigtableInstanceAdminClient.Create();
// Initialize request argument(s)
GetInstanceRequest request = new GetInstanceRequest
{
    InstanceName = InstanceName.FromProjectInstance("[PROJECT]", "[INSTANCE]"),
};
// Make the request
Instance response = bigtableInstanceAdminClient.GetInstance(request);

GetInstance(InstanceName, CallSettings)

public virtual Instance GetInstance(InstanceName name, CallSettings callSettings = null)

Gets information about an instance.

Parameters
NameDescription
nameInstanceName

Required. The unique name of the requested instance. Values are of the form projects/{project}/instances/{instance}.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Instance

The RPC response.

Example
// Create client
BigtableInstanceAdminClient bigtableInstanceAdminClient = BigtableInstanceAdminClient.Create();
// Initialize request argument(s)
InstanceName name = InstanceName.FromProjectInstance("[PROJECT]", "[INSTANCE]");
// Make the request
Instance response = bigtableInstanceAdminClient.GetInstance(name);

GetInstance(string, CallSettings)

public virtual Instance GetInstance(string name, CallSettings callSettings = null)

Gets information about an instance.

Parameters
NameDescription
namestring

Required. The unique name of the requested instance. Values are of the form projects/{project}/instances/{instance}.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Instance

The RPC response.

Example
// Create client
BigtableInstanceAdminClient bigtableInstanceAdminClient = BigtableInstanceAdminClient.Create();
// Initialize request argument(s)
string name = "projects/[PROJECT]/instances/[INSTANCE]";
// Make the request
Instance response = bigtableInstanceAdminClient.GetInstance(name);

GetInstanceAsync(GetInstanceRequest, CallSettings)

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

Gets information about an instance.

Parameters
NameDescription
requestGetInstanceRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TaskInstance

A Task containing the RPC response.

Example
// Create client
BigtableInstanceAdminClient bigtableInstanceAdminClient = await BigtableInstanceAdminClient.CreateAsync();
// Initialize request argument(s)
GetInstanceRequest request = new GetInstanceRequest
{
    InstanceName = InstanceName.FromProjectInstance("[PROJECT]", "[INSTANCE]"),
};
// Make the request
Instance response = await bigtableInstanceAdminClient.GetInstanceAsync(request);

GetInstanceAsync(GetInstanceRequest, CancellationToken)

public virtual Task<Instance> GetInstanceAsync(GetInstanceRequest request, CancellationToken cancellationToken)

Gets information about an instance.

Parameters
NameDescription
requestGetInstanceRequest

The request object containing all of the parameters for the API call.

cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
TaskInstance

A Task containing the RPC response.

Example
// Create client
BigtableInstanceAdminClient bigtableInstanceAdminClient = await BigtableInstanceAdminClient.CreateAsync();
// Initialize request argument(s)
GetInstanceRequest request = new GetInstanceRequest
{
    InstanceName = InstanceName.FromProjectInstance("[PROJECT]", "[INSTANCE]"),
};
// Make the request
Instance response = await bigtableInstanceAdminClient.GetInstanceAsync(request);

GetInstanceAsync(InstanceName, CallSettings)

public virtual Task<Instance> GetInstanceAsync(InstanceName name, CallSettings callSettings = null)

Gets information about an instance.

Parameters
NameDescription
nameInstanceName

Required. The unique name of the requested instance. Values are of the form projects/{project}/instances/{instance}.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TaskInstance

A Task containing the RPC response.

Example
// Create client
BigtableInstanceAdminClient bigtableInstanceAdminClient = await BigtableInstanceAdminClient.CreateAsync();
// Initialize request argument(s)
InstanceName name = InstanceName.FromProjectInstance("[PROJECT]", "[INSTANCE]");
// Make the request
Instance response = await bigtableInstanceAdminClient.GetInstanceAsync(name);

GetInstanceAsync(InstanceName, CancellationToken)

public virtual Task<Instance> GetInstanceAsync(InstanceName name, CancellationToken cancellationToken)

Gets information about an instance.

Parameters
NameDescription
nameInstanceName

Required. The unique name of the requested instance. Values are of the form projects/{project}/instances/{instance}.

cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
TaskInstance

A Task containing the RPC response.

Example
// Create client
BigtableInstanceAdminClient bigtableInstanceAdminClient = await BigtableInstanceAdminClient.CreateAsync();
// Initialize request argument(s)
InstanceName name = InstanceName.FromProjectInstance("[PROJECT]", "[INSTANCE]");
// Make the request
Instance response = await bigtableInstanceAdminClient.GetInstanceAsync(name);

GetInstanceAsync(string, CallSettings)

public virtual Task<Instance> GetInstanceAsync(string name, CallSettings callSettings = null)

Gets information about an instance.

Parameters
NameDescription
namestring

Required. The unique name of the requested instance. Values are of the form projects/{project}/instances/{instance}.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TaskInstance

A Task containing the RPC response.

Example
// Create client
BigtableInstanceAdminClient bigtableInstanceAdminClient = await BigtableInstanceAdminClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/instances/[INSTANCE]";
// Make the request
Instance response = await bigtableInstanceAdminClient.GetInstanceAsync(name);

GetInstanceAsync(string, CancellationToken)

public virtual Task<Instance> GetInstanceAsync(string name, CancellationToken cancellationToken)

Gets information about an instance.

Parameters
NameDescription
namestring

Required. The unique name of the requested instance. Values are of the form projects/{project}/instances/{instance}.

cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
TaskInstance

A Task containing the RPC response.

Example
// Create client
BigtableInstanceAdminClient bigtableInstanceAdminClient = await BigtableInstanceAdminClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/instances/[INSTANCE]";
// Make the request
Instance response = await bigtableInstanceAdminClient.GetInstanceAsync(name);

ListAppProfiles(ListAppProfilesRequest, CallSettings)

public virtual PagedEnumerable<ListAppProfilesResponse, AppProfile> ListAppProfiles(ListAppProfilesRequest request, CallSettings callSettings = null)

Lists information about app profiles in an instance.

Parameters
NameDescription
requestListAppProfilesRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
PagedEnumerableListAppProfilesResponseAppProfile

A pageable sequence of AppProfile resources.

Example
// Create client
BigtableInstanceAdminClient bigtableInstanceAdminClient = BigtableInstanceAdminClient.Create();
// Initialize request argument(s)
ListAppProfilesRequest request = new ListAppProfilesRequest
{
    ParentAsInstanceName = InstanceName.FromProjectInstance("[PROJECT]", "[INSTANCE]"),
};
// Make the request
PagedEnumerable<ListAppProfilesResponse, AppProfile> response = bigtableInstanceAdminClient.ListAppProfiles(request);

// Iterate over all response items, lazily performing RPCs as required
foreach (AppProfile item in response)
{
    // Do something with each item
    Console.WriteLine(item);
}

// Or iterate over pages (of server-defined size), performing one RPC per page
foreach (ListAppProfilesResponse page in response.AsRawResponses())
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (AppProfile item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
}

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<AppProfile> singlePage = response.ReadPage(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (AppProfile item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListAppProfiles(InstanceName, string, int?, CallSettings)

public virtual PagedEnumerable<ListAppProfilesResponse, AppProfile> ListAppProfiles(InstanceName parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

Lists information about app profiles in an instance.

Parameters
NameDescription
parentInstanceName

Required. The unique name of the instance for which a list of app profiles is requested. Values are of the form projects/{project}/instances/{instance}. Use {instance} = '-' to list AppProfiles for all Instances in a project, e.g., projects/myproject/instances/-.

pageTokenstring

The token returned from the previous request. A value of null or an empty string retrieves the first page.

pageSizeint

The size of page to request. The response will not be larger than this, but may be smaller. A value of null or 0 uses a server-defined page size.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
PagedEnumerableListAppProfilesResponseAppProfile

A pageable sequence of AppProfile resources.

Example
// Create client
BigtableInstanceAdminClient bigtableInstanceAdminClient = BigtableInstanceAdminClient.Create();
// Initialize request argument(s)
InstanceName parent = InstanceName.FromProjectInstance("[PROJECT]", "[INSTANCE]");
// Make the request
PagedEnumerable<ListAppProfilesResponse, AppProfile> response = bigtableInstanceAdminClient.ListAppProfiles(parent);

// Iterate over all response items, lazily performing RPCs as required
foreach (AppProfile item in response)
{
    // Do something with each item
    Console.WriteLine(item);
}

// Or iterate over pages (of server-defined size), performing one RPC per page
foreach (ListAppProfilesResponse page in response.AsRawResponses())
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (AppProfile item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
}

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<AppProfile> singlePage = response.ReadPage(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (AppProfile item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListAppProfiles(string, string, int?, CallSettings)

public virtual PagedEnumerable<ListAppProfilesResponse, AppProfile> ListAppProfiles(string parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

Lists information about app profiles in an instance.

Parameters
NameDescription
parentstring

Required. The unique name of the instance for which a list of app profiles is requested. Values are of the form projects/{project}/instances/{instance}. Use {instance} = '-' to list AppProfiles for all Instances in a project, e.g., projects/myproject/instances/-.

pageTokenstring

The token returned from the previous request. A value of null or an empty string retrieves the first page.

pageSizeint

The size of page to request. The response will not be larger than this, but may be smaller. A value of null or 0 uses a server-defined page size.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
PagedEnumerableListAppProfilesResponseAppProfile

A pageable sequence of AppProfile resources.

Example
// Create client
BigtableInstanceAdminClient bigtableInstanceAdminClient = BigtableInstanceAdminClient.Create();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/instances/[INSTANCE]";
// Make the request
PagedEnumerable<ListAppProfilesResponse, AppProfile> response = bigtableInstanceAdminClient.ListAppProfiles(parent);

// Iterate over all response items, lazily performing RPCs as required
foreach (AppProfile item in response)
{
    // Do something with each item
    Console.WriteLine(item);
}

// Or iterate over pages (of server-defined size), performing one RPC per page
foreach (ListAppProfilesResponse page in response.AsRawResponses())
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (AppProfile item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
}

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<AppProfile> singlePage = response.ReadPage(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (AppProfile item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListAppProfilesAsync(ListAppProfilesRequest, CallSettings)

public virtual PagedAsyncEnumerable<ListAppProfilesResponse, AppProfile> ListAppProfilesAsync(ListAppProfilesRequest request, CallSettings callSettings = null)

Lists information about app profiles in an instance.

Parameters
NameDescription
requestListAppProfilesRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
PagedAsyncEnumerableListAppProfilesResponseAppProfile

A pageable asynchronous sequence of AppProfile resources.

Example
// Create client
BigtableInstanceAdminClient bigtableInstanceAdminClient = await BigtableInstanceAdminClient.CreateAsync();
// Initialize request argument(s)
ListAppProfilesRequest request = new ListAppProfilesRequest
{
    ParentAsInstanceName = InstanceName.FromProjectInstance("[PROJECT]", "[INSTANCE]"),
};
// Make the request
PagedAsyncEnumerable<ListAppProfilesResponse, AppProfile> response = bigtableInstanceAdminClient.ListAppProfilesAsync(request);

// Iterate over all response items, lazily performing RPCs as required
await response.ForEachAsync((AppProfile item) =>
{
    // Do something with each item
    Console.WriteLine(item);
});

// Or iterate over pages (of server-defined size), performing one RPC per page
await response.AsRawResponses().ForEachAsync((ListAppProfilesResponse page) =>
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (AppProfile item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
});

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<AppProfile> singlePage = await response.ReadPageAsync(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (AppProfile item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListAppProfilesAsync(InstanceName, string, int?, CallSettings)

public virtual PagedAsyncEnumerable<ListAppProfilesResponse, AppProfile> ListAppProfilesAsync(InstanceName parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

Lists information about app profiles in an instance.

Parameters
NameDescription
parentInstanceName

Required. The unique name of the instance for which a list of app profiles is requested. Values are of the form projects/{project}/instances/{instance}. Use {instance} = '-' to list AppProfiles for all Instances in a project, e.g., projects/myproject/instances/-.

pageTokenstring

The token returned from the previous request. A value of null or an empty string retrieves the first page.

pageSizeint

The size of page to request. The response will not be larger than this, but may be smaller. A value of null or 0 uses a server-defined page size.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
PagedAsyncEnumerableListAppProfilesResponseAppProfile

A pageable asynchronous sequence of AppProfile resources.

Example
// Create client
BigtableInstanceAdminClient bigtableInstanceAdminClient = await BigtableInstanceAdminClient.CreateAsync();
// Initialize request argument(s)
InstanceName parent = InstanceName.FromProjectInstance("[PROJECT]", "[INSTANCE]");
// Make the request
PagedAsyncEnumerable<ListAppProfilesResponse, AppProfile> response = bigtableInstanceAdminClient.ListAppProfilesAsync(parent);

// Iterate over all response items, lazily performing RPCs as required
await response.ForEachAsync((AppProfile item) =>
{
    // Do something with each item
    Console.WriteLine(item);
});

// Or iterate over pages (of server-defined size), performing one RPC per page
await response.AsRawResponses().ForEachAsync((ListAppProfilesResponse page) =>
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (AppProfile item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
});

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<AppProfile> singlePage = await response.ReadPageAsync(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (AppProfile item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListAppProfilesAsync(string, string, int?, CallSettings)

public virtual PagedAsyncEnumerable<ListAppProfilesResponse, AppProfile> ListAppProfilesAsync(string parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

Lists information about app profiles in an instance.

Parameters
NameDescription
parentstring

Required. The unique name of the instance for which a list of app profiles is requested. Values are of the form projects/{project}/instances/{instance}. Use {instance} = '-' to list AppProfiles for all Instances in a project, e.g., projects/myproject/instances/-.

pageTokenstring

The token returned from the previous request. A value of null or an empty string retrieves the first page.

pageSizeint

The size of page to request. The response will not be larger than this, but may be smaller. A value of null or 0 uses a server-defined page size.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
PagedAsyncEnumerableListAppProfilesResponseAppProfile

A pageable asynchronous sequence of AppProfile resources.

Example
// Create client
BigtableInstanceAdminClient bigtableInstanceAdminClient = await BigtableInstanceAdminClient.CreateAsync();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/instances/[INSTANCE]";
// Make the request
PagedAsyncEnumerable<ListAppProfilesResponse, AppProfile> response = bigtableInstanceAdminClient.ListAppProfilesAsync(parent);

// Iterate over all response items, lazily performing RPCs as required
await response.ForEachAsync((AppProfile item) =>
{
    // Do something with each item
    Console.WriteLine(item);
});

// Or iterate over pages (of server-defined size), performing one RPC per page
await response.AsRawResponses().ForEachAsync((ListAppProfilesResponse page) =>
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (AppProfile item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
});

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<AppProfile> singlePage = await response.ReadPageAsync(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (AppProfile item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListClusters(ListClustersRequest, CallSettings)

public virtual ListClustersResponse ListClusters(ListClustersRequest request, CallSettings callSettings = null)

Lists information about clusters in an instance.

Parameters
NameDescription
requestListClustersRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
ListClustersResponse

The RPC response.

Example
// Create client
BigtableInstanceAdminClient bigtableInstanceAdminClient = BigtableInstanceAdminClient.Create();
// Initialize request argument(s)
ListClustersRequest request = new ListClustersRequest
{
    ParentAsInstanceName = InstanceName.FromProjectInstance("[PROJECT]", "[INSTANCE]"),
    PageToken = "",
};
// Make the request
ListClustersResponse response = bigtableInstanceAdminClient.ListClusters(request);

ListClusters(InstanceName, CallSettings)

public virtual ListClustersResponse ListClusters(InstanceName parent, CallSettings callSettings = null)

Lists information about clusters in an instance.

Parameters
NameDescription
parentInstanceName

Required. The unique name of the instance for which a list of clusters is requested. Values are of the form projects/{project}/instances/{instance}. Use {instance} = '-' to list Clusters for all Instances in a project, e.g., projects/myproject/instances/-.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
ListClustersResponse

The RPC response.

Example
// Create client
BigtableInstanceAdminClient bigtableInstanceAdminClient = BigtableInstanceAdminClient.Create();
// Initialize request argument(s)
InstanceName parent = InstanceName.FromProjectInstance("[PROJECT]", "[INSTANCE]");
// Make the request
ListClustersResponse response = bigtableInstanceAdminClient.ListClusters(parent);

ListClusters(string, CallSettings)

public virtual ListClustersResponse ListClusters(string parent, CallSettings callSettings = null)

Lists information about clusters in an instance.

Parameters
NameDescription
parentstring

Required. The unique name of the instance for which a list of clusters is requested. Values are of the form projects/{project}/instances/{instance}. Use {instance} = '-' to list Clusters for all Instances in a project, e.g., projects/myproject/instances/-.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
ListClustersResponse

The RPC response.

Example
// Create client
BigtableInstanceAdminClient bigtableInstanceAdminClient = BigtableInstanceAdminClient.Create();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/instances/[INSTANCE]";
// Make the request
ListClustersResponse response = bigtableInstanceAdminClient.ListClusters(parent);

ListClustersAsync(ListClustersRequest, CallSettings)

public virtual Task<ListClustersResponse> ListClustersAsync(ListClustersRequest request, CallSettings callSettings = null)

Lists information about clusters in an instance.

Parameters
NameDescription
requestListClustersRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TaskListClustersResponse

A Task containing the RPC response.

Example
// Create client
BigtableInstanceAdminClient bigtableInstanceAdminClient = await BigtableInstanceAdminClient.CreateAsync();
// Initialize request argument(s)
ListClustersRequest request = new ListClustersRequest
{
    ParentAsInstanceName = InstanceName.FromProjectInstance("[PROJECT]", "[INSTANCE]"),
    PageToken = "",
};
// Make the request
ListClustersResponse response = await bigtableInstanceAdminClient.ListClustersAsync(request);

ListClustersAsync(ListClustersRequest, CancellationToken)

public virtual Task<ListClustersResponse> ListClustersAsync(ListClustersRequest request, CancellationToken cancellationToken)

Lists information about clusters in an instance.

Parameters
NameDescription
requestListClustersRequest

The request object containing all of the parameters for the API call.

cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
TaskListClustersResponse

A Task containing the RPC response.

Example
// Create client
BigtableInstanceAdminClient bigtableInstanceAdminClient = await BigtableInstanceAdminClient.CreateAsync();
// Initialize request argument(s)
ListClustersRequest request = new ListClustersRequest
{
    ParentAsInstanceName = InstanceName.FromProjectInstance("[PROJECT]", "[INSTANCE]"),
    PageToken = "",
};
// Make the request
ListClustersResponse response = await bigtableInstanceAdminClient.ListClustersAsync(request);

ListClustersAsync(InstanceName, CallSettings)

public virtual Task<ListClustersResponse> ListClustersAsync(InstanceName parent, CallSettings callSettings = null)

Lists information about clusters in an instance.

Parameters
NameDescription
parentInstanceName

Required. The unique name of the instance for which a list of clusters is requested. Values are of the form projects/{project}/instances/{instance}. Use {instance} = '-' to list Clusters for all Instances in a project, e.g., projects/myproject/instances/-.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TaskListClustersResponse

A Task containing the RPC response.

Example
// Create client
BigtableInstanceAdminClient bigtableInstanceAdminClient = await BigtableInstanceAdminClient.CreateAsync();
// Initialize request argument(s)
InstanceName parent = InstanceName.FromProjectInstance("[PROJECT]", "[INSTANCE]");
// Make the request
ListClustersResponse response = await bigtableInstanceAdminClient.ListClustersAsync(parent);

ListClustersAsync(InstanceName, CancellationToken)

public virtual Task<ListClustersResponse> ListClustersAsync(InstanceName parent, CancellationToken cancellationToken)

Lists information about clusters in an instance.

Parameters
NameDescription
parentInstanceName

Required. The unique name of the instance for which a list of clusters is requested. Values are of the form projects/{project}/instances/{instance}. Use {instance} = '-' to list Clusters for all Instances in a project, e.g., projects/myproject/instances/-.

cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
TaskListClustersResponse

A Task containing the RPC response.

Example
// Create client
BigtableInstanceAdminClient bigtableInstanceAdminClient = await BigtableInstanceAdminClient.CreateAsync();
// Initialize request argument(s)
InstanceName parent = InstanceName.FromProjectInstance("[PROJECT]", "[INSTANCE]");
// Make the request
ListClustersResponse response = await bigtableInstanceAdminClient.ListClustersAsync(parent);

ListClustersAsync(string, CallSettings)

public virtual Task<ListClustersResponse> ListClustersAsync(string parent, CallSettings callSettings = null)

Lists information about clusters in an instance.

Parameters
NameDescription
parentstring

Required. The unique name of the instance for which a list of clusters is requested. Values are of the form projects/{project}/instances/{instance}. Use {instance} = '-' to list Clusters for all Instances in a project, e.g., projects/myproject/instances/-.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TaskListClustersResponse

A Task containing the RPC response.

Example
// Create client
BigtableInstanceAdminClient bigtableInstanceAdminClient = await BigtableInstanceAdminClient.CreateAsync();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/instances/[INSTANCE]";
// Make the request
ListClustersResponse response = await bigtableInstanceAdminClient.ListClustersAsync(parent);

ListClustersAsync(string, CancellationToken)

public virtual Task<ListClustersResponse> ListClustersAsync(string parent, CancellationToken cancellationToken)

Lists information about clusters in an instance.

Parameters
NameDescription
parentstring

Required. The unique name of the instance for which a list of clusters is requested. Values are of the form projects/{project}/instances/{instance}. Use {instance} = '-' to list Clusters for all Instances in a project, e.g., projects/myproject/instances/-.

cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
TaskListClustersResponse

A Task containing the RPC response.

Example
// Create client
BigtableInstanceAdminClient bigtableInstanceAdminClient = await BigtableInstanceAdminClient.CreateAsync();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/instances/[INSTANCE]";
// Make the request
ListClustersResponse response = await bigtableInstanceAdminClient.ListClustersAsync(parent);

ListHotTablets(ClusterName, string, int?, CallSettings)

public virtual PagedEnumerable<ListHotTabletsResponse, HotTablet> ListHotTablets(ClusterName parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

Lists hot tablets in a cluster, within the time range provided. Hot tablets are ordered based on CPU usage.

Parameters
NameDescription
parentClusterName

Required. The cluster name to list hot tablets. Value is in the following form: projects/{project}/instances/{instance}/clusters/{cluster}.

pageTokenstring

The token returned from the previous request. A value of null or an empty string retrieves the first page.

pageSizeint

The size of page to request. The response will not be larger than this, but may be smaller. A value of null or 0 uses a server-defined page size.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
PagedEnumerableListHotTabletsResponseHotTablet

A pageable sequence of HotTablet resources.

Example
// Create client
BigtableInstanceAdminClient bigtableInstanceAdminClient = BigtableInstanceAdminClient.Create();
// Initialize request argument(s)
ClusterName parent = ClusterName.FromProjectInstanceCluster("[PROJECT]", "[INSTANCE]", "[CLUSTER]");
// Make the request
PagedEnumerable<ListHotTabletsResponse, HotTablet> response = bigtableInstanceAdminClient.ListHotTablets(parent);

// Iterate over all response items, lazily performing RPCs as required
foreach (HotTablet item in response)
{
    // Do something with each item
    Console.WriteLine(item);
}

// Or iterate over pages (of server-defined size), performing one RPC per page
foreach (ListHotTabletsResponse page in response.AsRawResponses())
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (HotTablet item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
}

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<HotTablet> singlePage = response.ReadPage(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (HotTablet item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListHotTablets(ListHotTabletsRequest, CallSettings)

public virtual PagedEnumerable<ListHotTabletsResponse, HotTablet> ListHotTablets(ListHotTabletsRequest request, CallSettings callSettings = null)

Lists hot tablets in a cluster, within the time range provided. Hot tablets are ordered based on CPU usage.

Parameters
NameDescription
requestListHotTabletsRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
PagedEnumerableListHotTabletsResponseHotTablet

A pageable sequence of HotTablet resources.

Example
// Create client
BigtableInstanceAdminClient bigtableInstanceAdminClient = BigtableInstanceAdminClient.Create();
// Initialize request argument(s)
ListHotTabletsRequest request = new ListHotTabletsRequest
{
    ParentAsClusterName = ClusterName.FromProjectInstanceCluster("[PROJECT]", "[INSTANCE]", "[CLUSTER]"),
    StartTime = new Timestamp(),
    EndTime = new Timestamp(),
};
// Make the request
PagedEnumerable<ListHotTabletsResponse, HotTablet> response = bigtableInstanceAdminClient.ListHotTablets(request);

// Iterate over all response items, lazily performing RPCs as required
foreach (HotTablet item in response)
{
    // Do something with each item
    Console.WriteLine(item);
}

// Or iterate over pages (of server-defined size), performing one RPC per page
foreach (ListHotTabletsResponse page in response.AsRawResponses())
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (HotTablet item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
}

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<HotTablet> singlePage = response.ReadPage(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (HotTablet item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListHotTablets(string, string, int?, CallSettings)

public virtual PagedEnumerable<ListHotTabletsResponse, HotTablet> ListHotTablets(string parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

Lists hot tablets in a cluster, within the time range provided. Hot tablets are ordered based on CPU usage.

Parameters
NameDescription
parentstring

Required. The cluster name to list hot tablets. Value is in the following form: projects/{project}/instances/{instance}/clusters/{cluster}.

pageTokenstring

The token returned from the previous request. A value of null or an empty string retrieves the first page.

pageSizeint

The size of page to request. The response will not be larger than this, but may be smaller. A value of null or 0 uses a server-defined page size.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
PagedEnumerableListHotTabletsResponseHotTablet

A pageable sequence of HotTablet resources.

Example
// Create client
BigtableInstanceAdminClient bigtableInstanceAdminClient = BigtableInstanceAdminClient.Create();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/instances/[INSTANCE]/clusters/[CLUSTER]";
// Make the request
PagedEnumerable<ListHotTabletsResponse, HotTablet> response = bigtableInstanceAdminClient.ListHotTablets(parent);

// Iterate over all response items, lazily performing RPCs as required
foreach (HotTablet item in response)
{
    // Do something with each item
    Console.WriteLine(item);
}

// Or iterate over pages (of server-defined size), performing one RPC per page
foreach (ListHotTabletsResponse page in response.AsRawResponses())
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (HotTablet item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
}

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<HotTablet> singlePage = response.ReadPage(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (HotTablet item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListHotTabletsAsync(ClusterName, string, int?, CallSettings)

public virtual PagedAsyncEnumerable<ListHotTabletsResponse, HotTablet> ListHotTabletsAsync(ClusterName parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

Lists hot tablets in a cluster, within the time range provided. Hot tablets are ordered based on CPU usage.

Parameters
NameDescription
parentClusterName

Required. The cluster name to list hot tablets. Value is in the following form: projects/{project}/instances/{instance}/clusters/{cluster}.

pageTokenstring

The token returned from the previous request. A value of null or an empty string retrieves the first page.

pageSizeint

The size of page to request. The response will not be larger than this, but may be smaller. A value of null or 0 uses a server-defined page size.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
PagedAsyncEnumerableListHotTabletsResponseHotTablet

A pageable asynchronous sequence of HotTablet resources.

Example
// Create client
BigtableInstanceAdminClient bigtableInstanceAdminClient = await BigtableInstanceAdminClient.CreateAsync();
// Initialize request argument(s)
ClusterName parent = ClusterName.FromProjectInstanceCluster("[PROJECT]", "[INSTANCE]", "[CLUSTER]");
// Make the request
PagedAsyncEnumerable<ListHotTabletsResponse, HotTablet> response = bigtableInstanceAdminClient.ListHotTabletsAsync(parent);

// Iterate over all response items, lazily performing RPCs as required
await response.ForEachAsync((HotTablet item) =>
{
    // Do something with each item
    Console.WriteLine(item);
});

// Or iterate over pages (of server-defined size), performing one RPC per page
await response.AsRawResponses().ForEachAsync((ListHotTabletsResponse page) =>
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (HotTablet item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
});

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<HotTablet> singlePage = await response.ReadPageAsync(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (HotTablet item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListHotTabletsAsync(ListHotTabletsRequest, CallSettings)

public virtual PagedAsyncEnumerable<ListHotTabletsResponse, HotTablet> ListHotTabletsAsync(ListHotTabletsRequest request, CallSettings callSettings = null)

Lists hot tablets in a cluster, within the time range provided. Hot tablets are ordered based on CPU usage.

Parameters
NameDescription
requestListHotTabletsRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
PagedAsyncEnumerableListHotTabletsResponseHotTablet

A pageable asynchronous sequence of HotTablet resources.

Example
// Create client
BigtableInstanceAdminClient bigtableInstanceAdminClient = await BigtableInstanceAdminClient.CreateAsync();
// Initialize request argument(s)
ListHotTabletsRequest request = new ListHotTabletsRequest
{
    ParentAsClusterName = ClusterName.FromProjectInstanceCluster("[PROJECT]", "[INSTANCE]", "[CLUSTER]"),
    StartTime = new Timestamp(),
    EndTime = new Timestamp(),
};
// Make the request
PagedAsyncEnumerable<ListHotTabletsResponse, HotTablet> response = bigtableInstanceAdminClient.ListHotTabletsAsync(request);

// Iterate over all response items, lazily performing RPCs as required
await response.ForEachAsync((HotTablet item) =>
{
    // Do something with each item
    Console.WriteLine(item);
});

// Or iterate over pages (of server-defined size), performing one RPC per page
await response.AsRawResponses().ForEachAsync((ListHotTabletsResponse page) =>
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (HotTablet item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
});

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<HotTablet> singlePage = await response.ReadPageAsync(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (HotTablet item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListHotTabletsAsync(string, string, int?, CallSettings)

public virtual PagedAsyncEnumerable<ListHotTabletsResponse, HotTablet> ListHotTabletsAsync(string parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

Lists hot tablets in a cluster, within the time range provided. Hot tablets are ordered based on CPU usage.

Parameters
NameDescription
parentstring

Required. The cluster name to list hot tablets. Value is in the following form: projects/{project}/instances/{instance}/clusters/{cluster}.

pageTokenstring

The token returned from the previous request. A value of null or an empty string retrieves the first page.

pageSizeint

The size of page to request. The response will not be larger than this, but may be smaller. A value of null or 0 uses a server-defined page size.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
PagedAsyncEnumerableListHotTabletsResponseHotTablet

A pageable asynchronous sequence of HotTablet resources.

Example
// Create client
BigtableInstanceAdminClient bigtableInstanceAdminClient = await BigtableInstanceAdminClient.CreateAsync();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/instances/[INSTANCE]/clusters/[CLUSTER]";
// Make the request
PagedAsyncEnumerable<ListHotTabletsResponse, HotTablet> response = bigtableInstanceAdminClient.ListHotTabletsAsync(parent);

// Iterate over all response items, lazily performing RPCs as required
await response.ForEachAsync((HotTablet item) =>
{
    // Do something with each item
    Console.WriteLine(item);
});

// Or iterate over pages (of server-defined size), performing one RPC per page
await response.AsRawResponses().ForEachAsync((ListHotTabletsResponse page) =>
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (HotTablet item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
});

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<HotTablet> singlePage = await response.ReadPageAsync(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (HotTablet item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListInstances(ProjectName, CallSettings)

public virtual ListInstancesResponse ListInstances(ProjectName parent, CallSettings callSettings = null)

Lists information about instances in a project.

Parameters
NameDescription
parentProjectName

Required. The unique name of the project for which a list of instances is requested. Values are of the form projects/{project}.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
ListInstancesResponse

The RPC response.

Example
// Create client
BigtableInstanceAdminClient bigtableInstanceAdminClient = BigtableInstanceAdminClient.Create();
// Initialize request argument(s)
ProjectName parent = ProjectName.FromProject("[PROJECT]");
// Make the request
ListInstancesResponse response = bigtableInstanceAdminClient.ListInstances(parent);

ListInstances(ListInstancesRequest, CallSettings)

public virtual ListInstancesResponse ListInstances(ListInstancesRequest request, CallSettings callSettings = null)

Lists information about instances in a project.

Parameters
NameDescription
requestListInstancesRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
ListInstancesResponse

The RPC response.

Example
// Create client
BigtableInstanceAdminClient bigtableInstanceAdminClient = BigtableInstanceAdminClient.Create();
// Initialize request argument(s)
ListInstancesRequest request = new ListInstancesRequest
{
    ParentAsProjectName = ProjectName.FromProject("[PROJECT]"),
    PageToken = "",
};
// Make the request
ListInstancesResponse response = bigtableInstanceAdminClient.ListInstances(request);

ListInstances(string, CallSettings)

public virtual ListInstancesResponse ListInstances(string parent, CallSettings callSettings = null)

Lists information about instances in a project.

Parameters
NameDescription
parentstring

Required. The unique name of the project for which a list of instances is requested. Values are of the form projects/{project}.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
ListInstancesResponse

The RPC response.

Example
// Create client
BigtableInstanceAdminClient bigtableInstanceAdminClient = BigtableInstanceAdminClient.Create();
// Initialize request argument(s)
string parent = "projects/[PROJECT]";
// Make the request
ListInstancesResponse response = bigtableInstanceAdminClient.ListInstances(parent);

ListInstancesAsync(ProjectName, CallSettings)

public virtual Task<ListInstancesResponse> ListInstancesAsync(ProjectName parent, CallSettings callSettings = null)

Lists information about instances in a project.

Parameters
NameDescription
parentProjectName

Required. The unique name of the project for which a list of instances is requested. Values are of the form projects/{project}.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TaskListInstancesResponse

A Task containing the RPC response.

Example
// Create client
BigtableInstanceAdminClient bigtableInstanceAdminClient = await BigtableInstanceAdminClient.CreateAsync();
// Initialize request argument(s)
ProjectName parent = ProjectName.FromProject("[PROJECT]");
// Make the request
ListInstancesResponse response = await bigtableInstanceAdminClient.ListInstancesAsync(parent);

ListInstancesAsync(ProjectName, CancellationToken)

public virtual Task<ListInstancesResponse> ListInstancesAsync(ProjectName parent, CancellationToken cancellationToken)

Lists information about instances in a project.

Parameters
NameDescription
parentProjectName

Required. The unique name of the project for which a list of instances is requested. Values are of the form projects/{project}.

cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
TaskListInstancesResponse

A Task containing the RPC response.

Example
// Create client
BigtableInstanceAdminClient bigtableInstanceAdminClient = await BigtableInstanceAdminClient.CreateAsync();
// Initialize request argument(s)
ProjectName parent = ProjectName.FromProject("[PROJECT]");
// Make the request
ListInstancesResponse response = await bigtableInstanceAdminClient.ListInstancesAsync(parent);

ListInstancesAsync(ListInstancesRequest, CallSettings)

public virtual Task<ListInstancesResponse> ListInstancesAsync(ListInstancesRequest request, CallSettings callSettings = null)

Lists information about instances in a project.

Parameters
NameDescription
requestListInstancesRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TaskListInstancesResponse

A Task containing the RPC response.

Example
// Create client
BigtableInstanceAdminClient bigtableInstanceAdminClient = await BigtableInstanceAdminClient.CreateAsync();
// Initialize request argument(s)
ListInstancesRequest request = new ListInstancesRequest
{
    ParentAsProjectName = ProjectName.FromProject("[PROJECT]"),
    PageToken = "",
};
// Make the request
ListInstancesResponse response = await bigtableInstanceAdminClient.ListInstancesAsync(request);

ListInstancesAsync(ListInstancesRequest, CancellationToken)

public virtual Task<ListInstancesResponse> ListInstancesAsync(ListInstancesRequest request, CancellationToken cancellationToken)

Lists information about instances in a project.

Parameters
NameDescription
requestListInstancesRequest

The request object containing all of the parameters for the API call.

cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
TaskListInstancesResponse

A Task containing the RPC response.

Example
// Create client
BigtableInstanceAdminClient bigtableInstanceAdminClient = await BigtableInstanceAdminClient.CreateAsync();
// Initialize request argument(s)
ListInstancesRequest request = new ListInstancesRequest
{
    ParentAsProjectName = ProjectName.FromProject("[PROJECT]"),
    PageToken = "",
};
// Make the request
ListInstancesResponse response = await bigtableInstanceAdminClient.ListInstancesAsync(request);

ListInstancesAsync(string, CallSettings)

public virtual Task<ListInstancesResponse> ListInstancesAsync(string parent, CallSettings callSettings = null)

Lists information about instances in a project.

Parameters
NameDescription
parentstring

Required. The unique name of the project for which a list of instances is requested. Values are of the form projects/{project}.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TaskListInstancesResponse

A Task containing the RPC response.

Example
// Create client
BigtableInstanceAdminClient bigtableInstanceAdminClient = await BigtableInstanceAdminClient.CreateAsync();
// Initialize request argument(s)
string parent = "projects/[PROJECT]";
// Make the request
ListInstancesResponse response = await bigtableInstanceAdminClient.ListInstancesAsync(parent);

ListInstancesAsync(string, CancellationToken)

public virtual Task<ListInstancesResponse> ListInstancesAsync(string parent, CancellationToken cancellationToken)

Lists information about instances in a project.

Parameters
NameDescription
parentstring

Required. The unique name of the project for which a list of instances is requested. Values are of the form projects/{project}.

cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
TaskListInstancesResponse

A Task containing the RPC response.

Example
// Create client
BigtableInstanceAdminClient bigtableInstanceAdminClient = await BigtableInstanceAdminClient.CreateAsync();
// Initialize request argument(s)
string parent = "projects/[PROJECT]";
// Make the request
ListInstancesResponse response = await bigtableInstanceAdminClient.ListInstancesAsync(parent);

PartialUpdateCluster(Cluster, FieldMask, CallSettings)

public virtual Operation<Cluster, PartialUpdateClusterMetadata> PartialUpdateCluster(Cluster cluster, FieldMask updateMask, CallSettings callSettings = null)

Partially updates a cluster within a project. This method is the preferred way to update a Cluster.

To enable and update autoscaling, set cluster_config.cluster_autoscaling_config. When autoscaling is enabled, serve_nodes is treated as an OUTPUT_ONLY field, meaning that updates to it are ignored. Note that an update cannot simultaneously set serve_nodes to non-zero and cluster_config.cluster_autoscaling_config to non-empty, and also specify both in the update_mask.

To disable autoscaling, clear cluster_config.cluster_autoscaling_config, and explicitly set a serve_node count via the update_mask.

Parameters
NameDescription
clusterCluster

Required. The Cluster which contains the partial updates to be applied, subject to the update_mask.

updateMaskFieldMask

Required. The subset of Cluster fields which should be replaced.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
OperationClusterPartialUpdateClusterMetadata

The RPC response.

Example
// Create client
BigtableInstanceAdminClient bigtableInstanceAdminClient = BigtableInstanceAdminClient.Create();
// Initialize request argument(s)
Cluster cluster = new Cluster();
FieldMask updateMask = new FieldMask();
// Make the request
Operation<Cluster, PartialUpdateClusterMetadata> response = bigtableInstanceAdminClient.PartialUpdateCluster(cluster, updateMask);

// Poll until the returned long-running operation is complete
Operation<Cluster, PartialUpdateClusterMetadata> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
Cluster result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Cluster, PartialUpdateClusterMetadata> retrievedResponse = bigtableInstanceAdminClient.PollOncePartialUpdateCluster(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Cluster retrievedResult = retrievedResponse.Result;
}

PartialUpdateCluster(PartialUpdateClusterRequest, CallSettings)

public virtual Operation<Cluster, PartialUpdateClusterMetadata> PartialUpdateCluster(PartialUpdateClusterRequest request, CallSettings callSettings = null)

Partially updates a cluster within a project. This method is the preferred way to update a Cluster.

To enable and update autoscaling, set cluster_config.cluster_autoscaling_config. When autoscaling is enabled, serve_nodes is treated as an OUTPUT_ONLY field, meaning that updates to it are ignored. Note that an update cannot simultaneously set serve_nodes to non-zero and cluster_config.cluster_autoscaling_config to non-empty, and also specify both in the update_mask.

To disable autoscaling, clear cluster_config.cluster_autoscaling_config, and explicitly set a serve_node count via the update_mask.

Parameters
NameDescription
requestPartialUpdateClusterRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
OperationClusterPartialUpdateClusterMetadata

The RPC response.

Example
// Create client
BigtableInstanceAdminClient bigtableInstanceAdminClient = BigtableInstanceAdminClient.Create();
// Initialize request argument(s)
PartialUpdateClusterRequest request = new PartialUpdateClusterRequest
{
    Cluster = new Cluster(),
    UpdateMask = new FieldMask(),
};
// Make the request
Operation<Cluster, PartialUpdateClusterMetadata> response = bigtableInstanceAdminClient.PartialUpdateCluster(request);

// Poll until the returned long-running operation is complete
Operation<Cluster, PartialUpdateClusterMetadata> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
Cluster result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Cluster, PartialUpdateClusterMetadata> retrievedResponse = bigtableInstanceAdminClient.PollOncePartialUpdateCluster(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Cluster retrievedResult = retrievedResponse.Result;
}

PartialUpdateClusterAsync(Cluster, FieldMask, CallSettings)

public virtual Task<Operation<Cluster, PartialUpdateClusterMetadata>> PartialUpdateClusterAsync(Cluster cluster, FieldMask updateMask, CallSettings callSettings = null)

Partially updates a cluster within a project. This method is the preferred way to update a Cluster.

To enable and update autoscaling, set cluster_config.cluster_autoscaling_config. When autoscaling is enabled, serve_nodes is treated as an OUTPUT_ONLY field, meaning that updates to it are ignored. Note that an update cannot simultaneously set serve_nodes to non-zero and cluster_config.cluster_autoscaling_config to non-empty, and also specify both in the update_mask.

To disable autoscaling, clear cluster_config.cluster_autoscaling_config, and explicitly set a serve_node count via the update_mask.

Parameters
NameDescription
clusterCluster

Required. The Cluster which contains the partial updates to be applied, subject to the update_mask.

updateMaskFieldMask

Required. The subset of Cluster fields which should be replaced.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TaskOperationClusterPartialUpdateClusterMetadata

A Task containing the RPC response.

Example
// Create client
BigtableInstanceAdminClient bigtableInstanceAdminClient = await BigtableInstanceAdminClient.CreateAsync();
// Initialize request argument(s)
Cluster cluster = new Cluster();
FieldMask updateMask = new FieldMask();
// Make the request
Operation<Cluster, PartialUpdateClusterMetadata> response = await bigtableInstanceAdminClient.PartialUpdateClusterAsync(cluster, updateMask);

// Poll until the returned long-running operation is complete
Operation<Cluster, PartialUpdateClusterMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Cluster result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Cluster, PartialUpdateClusterMetadata> retrievedResponse = await bigtableInstanceAdminClient.PollOncePartialUpdateClusterAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Cluster retrievedResult = retrievedResponse.Result;
}

PartialUpdateClusterAsync(Cluster, FieldMask, CancellationToken)

public virtual Task<Operation<Cluster, PartialUpdateClusterMetadata>> PartialUpdateClusterAsync(Cluster cluster, FieldMask updateMask, CancellationToken cancellationToken)

Partially updates a cluster within a project. This method is the preferred way to update a Cluster.

To enable and update autoscaling, set cluster_config.cluster_autoscaling_config. When autoscaling is enabled, serve_nodes is treated as an OUTPUT_ONLY field, meaning that updates to it are ignored. Note that an update cannot simultaneously set serve_nodes to non-zero and cluster_config.cluster_autoscaling_config to non-empty, and also specify both in the update_mask.

To disable autoscaling, clear cluster_config.cluster_autoscaling_config, and explicitly set a serve_node count via the update_mask.

Parameters
NameDescription
clusterCluster

Required. The Cluster which contains the partial updates to be applied, subject to the update_mask.

updateMaskFieldMask

Required. The subset of Cluster fields which should be replaced.

cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
TaskOperationClusterPartialUpdateClusterMetadata

A Task containing the RPC response.

Example
// Create client
BigtableInstanceAdminClient bigtableInstanceAdminClient = await BigtableInstanceAdminClient.CreateAsync();
// Initialize request argument(s)
Cluster cluster = new Cluster();
FieldMask updateMask = new FieldMask();
// Make the request
Operation<Cluster, PartialUpdateClusterMetadata> response = await bigtableInstanceAdminClient.PartialUpdateClusterAsync(cluster, updateMask);

// Poll until the returned long-running operation is complete
Operation<Cluster, PartialUpdateClusterMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Cluster result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Cluster, PartialUpdateClusterMetadata> retrievedResponse = await bigtableInstanceAdminClient.PollOncePartialUpdateClusterAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Cluster retrievedResult = retrievedResponse.Result;
}

PartialUpdateClusterAsync(PartialUpdateClusterRequest, CallSettings)

public virtual Task<Operation<Cluster, PartialUpdateClusterMetadata>> PartialUpdateClusterAsync(PartialUpdateClusterRequest request, CallSettings callSettings = null)

Partially updates a cluster within a project. This method is the preferred way to update a Cluster.

To enable and update autoscaling, set cluster_config.cluster_autoscaling_config. When autoscaling is enabled, serve_nodes is treated as an OUTPUT_ONLY field, meaning that updates to it are ignored. Note that an update cannot simultaneously set serve_nodes to non-zero and cluster_config.cluster_autoscaling_config to non-empty, and also specify both in the update_mask.

To disable autoscaling, clear cluster_config.cluster_autoscaling_config, and explicitly set a serve_node count via the update_mask.

Parameters
NameDescription
requestPartialUpdateClusterRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TaskOperationClusterPartialUpdateClusterMetadata

A Task containing the RPC response.

Example
// Create client
BigtableInstanceAdminClient bigtableInstanceAdminClient = await BigtableInstanceAdminClient.CreateAsync();
// Initialize request argument(s)
PartialUpdateClusterRequest request = new PartialUpdateClusterRequest
{
    Cluster = new Cluster(),
    UpdateMask = new FieldMask(),
};
// Make the request
Operation<Cluster, PartialUpdateClusterMetadata> response = await bigtableInstanceAdminClient.PartialUpdateClusterAsync(request);

// Poll until the returned long-running operation is complete
Operation<Cluster, PartialUpdateClusterMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Cluster result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Cluster, PartialUpdateClusterMetadata> retrievedResponse = await bigtableInstanceAdminClient.PollOncePartialUpdateClusterAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Cluster retrievedResult = retrievedResponse.Result;
}

PartialUpdateClusterAsync(PartialUpdateClusterRequest, CancellationToken)

public virtual Task<Operation<Cluster, PartialUpdateClusterMetadata>> PartialUpdateClusterAsync(PartialUpdateClusterRequest request, CancellationToken cancellationToken)

Partially updates a cluster within a project. This method is the preferred way to update a Cluster.

To enable and update autoscaling, set cluster_config.cluster_autoscaling_config. When autoscaling is enabled, serve_nodes is treated as an OUTPUT_ONLY field, meaning that updates to it are ignored. Note that an update cannot simultaneously set serve_nodes to non-zero and cluster_config.cluster_autoscaling_config to non-empty, and also specify both in the update_mask.

To disable autoscaling, clear cluster_config.cluster_autoscaling_config, and explicitly set a serve_node count via the update_mask.

Parameters
NameDescription
requestPartialUpdateClusterRequest

The request object containing all of the parameters for the API call.

cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
TaskOperationClusterPartialUpdateClusterMetadata

A Task containing the RPC response.

Example
// Create client
BigtableInstanceAdminClient bigtableInstanceAdminClient = await BigtableInstanceAdminClient.CreateAsync();
// Initialize request argument(s)
PartialUpdateClusterRequest request = new PartialUpdateClusterRequest
{
    Cluster = new Cluster(),
    UpdateMask = new FieldMask(),
};
// Make the request
Operation<Cluster, PartialUpdateClusterMetadata> response = await bigtableInstanceAdminClient.PartialUpdateClusterAsync(request);

// Poll until the returned long-running operation is complete
Operation<Cluster, PartialUpdateClusterMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Cluster result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Cluster, PartialUpdateClusterMetadata> retrievedResponse = await bigtableInstanceAdminClient.PollOncePartialUpdateClusterAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Cluster retrievedResult = retrievedResponse.Result;
}

PartialUpdateInstance(Instance, FieldMask, CallSettings)

public virtual Operation<Instance, UpdateInstanceMetadata> PartialUpdateInstance(Instance instance, FieldMask updateMask, CallSettings callSettings = null)

Partially updates an instance within a project. This method can modify all fields of an Instance and is the preferred way to update an Instance.

Parameters
NameDescription
instanceInstance

Required. The Instance which will (partially) replace the current value.

updateMaskFieldMask

Required. The subset of Instance fields which should be replaced. Must be explicitly set.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
OperationInstanceUpdateInstanceMetadata

The RPC response.

Example
// Create client
BigtableInstanceAdminClient bigtableInstanceAdminClient = BigtableInstanceAdminClient.Create();
// Initialize request argument(s)
Instance instance = new Instance();
FieldMask updateMask = new FieldMask();
// Make the request
Operation<Instance, UpdateInstanceMetadata> response = bigtableInstanceAdminClient.PartialUpdateInstance(instance, updateMask);

// Poll until the returned long-running operation is complete
Operation<Instance, UpdateInstanceMetadata> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
Instance result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Instance, UpdateInstanceMetadata> retrievedResponse = bigtableInstanceAdminClient.PollOncePartialUpdateInstance(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Instance retrievedResult = retrievedResponse.Result;
}

PartialUpdateInstance(PartialUpdateInstanceRequest, CallSettings)

public virtual Operation<Instance, UpdateInstanceMetadata> PartialUpdateInstance(PartialUpdateInstanceRequest request, CallSettings callSettings = null)

Partially updates an instance within a project. This method can modify all fields of an Instance and is the preferred way to update an Instance.

Parameters
NameDescription
requestPartialUpdateInstanceRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
OperationInstanceUpdateInstanceMetadata

The RPC response.

Example
// Create client
BigtableInstanceAdminClient bigtableInstanceAdminClient = BigtableInstanceAdminClient.Create();
// Initialize request argument(s)
PartialUpdateInstanceRequest request = new PartialUpdateInstanceRequest
{
    Instance = new Instance(),
    UpdateMask = new FieldMask(),
};
// Make the request
Operation<Instance, UpdateInstanceMetadata> response = bigtableInstanceAdminClient.PartialUpdateInstance(request);

// Poll until the returned long-running operation is complete
Operation<Instance, UpdateInstanceMetadata> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
Instance result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Instance, UpdateInstanceMetadata> retrievedResponse = bigtableInstanceAdminClient.PollOncePartialUpdateInstance(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Instance retrievedResult = retrievedResponse.Result;
}

PartialUpdateInstanceAsync(Instance, FieldMask, CallSettings)

public virtual Task<Operation<Instance, UpdateInstanceMetadata>> PartialUpdateInstanceAsync(Instance instance, FieldMask updateMask, CallSettings callSettings = null)

Partially updates an instance within a project. This method can modify all fields of an Instance and is the preferred way to update an Instance.

Parameters
NameDescription
instanceInstance

Required. The Instance which will (partially) replace the current value.

updateMaskFieldMask

Required. The subset of Instance fields which should be replaced. Must be explicitly set.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TaskOperationInstanceUpdateInstanceMetadata

A Task containing the RPC response.

Example
// Create client
BigtableInstanceAdminClient bigtableInstanceAdminClient = await BigtableInstanceAdminClient.CreateAsync();
// Initialize request argument(s)
Instance instance = new Instance();
FieldMask updateMask = new FieldMask();
// Make the request
Operation<Instance, UpdateInstanceMetadata> response = await bigtableInstanceAdminClient.PartialUpdateInstanceAsync(instance, updateMask);

// Poll until the returned long-running operation is complete
Operation<Instance, UpdateInstanceMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Instance result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Instance, UpdateInstanceMetadata> retrievedResponse = await bigtableInstanceAdminClient.PollOncePartialUpdateInstanceAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Instance retrievedResult = retrievedResponse.Result;
}

PartialUpdateInstanceAsync(Instance, FieldMask, CancellationToken)

public virtual Task<Operation<Instance, UpdateInstanceMetadata>> PartialUpdateInstanceAsync(Instance instance, FieldMask updateMask, CancellationToken cancellationToken)

Partially updates an instance within a project. This method can modify all fields of an Instance and is the preferred way to update an Instance.

Parameters
NameDescription
instanceInstance

Required. The Instance which will (partially) replace the current value.

updateMaskFieldMask

Required. The subset of Instance fields which should be replaced. Must be explicitly set.

cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
TaskOperationInstanceUpdateInstanceMetadata

A Task containing the RPC response.

Example
// Create client
BigtableInstanceAdminClient bigtableInstanceAdminClient = await BigtableInstanceAdminClient.CreateAsync();
// Initialize request argument(s)
Instance instance = new Instance();
FieldMask updateMask = new FieldMask();
// Make the request
Operation<Instance, UpdateInstanceMetadata> response = await bigtableInstanceAdminClient.PartialUpdateInstanceAsync(instance, updateMask);

// Poll until the returned long-running operation is complete
Operation<Instance, UpdateInstanceMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Instance result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Instance, UpdateInstanceMetadata> retrievedResponse = await bigtableInstanceAdminClient.PollOncePartialUpdateInstanceAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Instance retrievedResult = retrievedResponse.Result;
}

PartialUpdateInstanceAsync(PartialUpdateInstanceRequest, CallSettings)

public virtual Task<Operation<Instance, UpdateInstanceMetadata>> PartialUpdateInstanceAsync(PartialUpdateInstanceRequest request, CallSettings callSettings = null)

Partially updates an instance within a project. This method can modify all fields of an Instance and is the preferred way to update an Instance.

Parameters
NameDescription
requestPartialUpdateInstanceRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TaskOperationInstanceUpdateInstanceMetadata

A Task containing the RPC response.

Example
// Create client
BigtableInstanceAdminClient bigtableInstanceAdminClient = await BigtableInstanceAdminClient.CreateAsync();
// Initialize request argument(s)
PartialUpdateInstanceRequest request = new PartialUpdateInstanceRequest
{
    Instance = new Instance(),
    UpdateMask = new FieldMask(),
};
// Make the request
Operation<Instance, UpdateInstanceMetadata> response = await bigtableInstanceAdminClient.PartialUpdateInstanceAsync(request);

// Poll until the returned long-running operation is complete
Operation<Instance, UpdateInstanceMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Instance result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Instance, UpdateInstanceMetadata> retrievedResponse = await bigtableInstanceAdminClient.PollOncePartialUpdateInstanceAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Instance retrievedResult = retrievedResponse.Result;
}

PartialUpdateInstanceAsync(PartialUpdateInstanceRequest, CancellationToken)

public virtual Task<Operation<Instance, UpdateInstanceMetadata>> PartialUpdateInstanceAsync(PartialUpdateInstanceRequest request, CancellationToken cancellationToken)

Partially updates an instance within a project. This method can modify all fields of an Instance and is the preferred way to update an Instance.

Parameters
NameDescription
requestPartialUpdateInstanceRequest

The request object containing all of the parameters for the API call.

cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
TaskOperationInstanceUpdateInstanceMetadata

A Task containing the RPC response.

Example
// Create client
BigtableInstanceAdminClient bigtableInstanceAdminClient = await BigtableInstanceAdminClient.CreateAsync();
// Initialize request argument(s)
PartialUpdateInstanceRequest request = new PartialUpdateInstanceRequest
{
    Instance = new Instance(),
    UpdateMask = new FieldMask(),
};
// Make the request
Operation<Instance, UpdateInstanceMetadata> response = await bigtableInstanceAdminClient.PartialUpdateInstanceAsync(request);

// Poll until the returned long-running operation is complete
Operation<Instance, UpdateInstanceMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Instance result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Instance, UpdateInstanceMetadata> retrievedResponse = await bigtableInstanceAdminClient.PollOncePartialUpdateInstanceAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Instance retrievedResult = retrievedResponse.Result;
}

PollOnceCreateCluster(string, CallSettings)

public virtual Operation<Cluster, CreateClusterMetadata> PollOnceCreateCluster(string operationName, CallSettings callSettings = null)

Poll an operation once, using an operationName from a previous invocation of CreateCluster.

Parameters
NameDescription
operationNamestring

The name of a previously invoked operation. Must not be null or empty.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
OperationClusterCreateClusterMetadata

The result of polling the operation.

PollOnceCreateClusterAsync(string, CallSettings)

public virtual Task<Operation<Cluster, CreateClusterMetadata>> PollOnceCreateClusterAsync(string operationName, CallSettings callSettings = null)

Asynchronously poll an operation once, using an operationName from a previous invocation of CreateCluster.

Parameters
NameDescription
operationNamestring

The name of a previously invoked operation. Must not be null or empty.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TaskOperationClusterCreateClusterMetadata

A task representing the result of polling the operation.

PollOnceCreateInstance(string, CallSettings)

public virtual Operation<Instance, CreateInstanceMetadata> PollOnceCreateInstance(string operationName, CallSettings callSettings = null)

Poll an operation once, using an operationName from a previous invocation of CreateInstance.

Parameters
NameDescription
operationNamestring

The name of a previously invoked operation. Must not be null or empty.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
OperationInstanceCreateInstanceMetadata

The result of polling the operation.

PollOnceCreateInstanceAsync(string, CallSettings)

public virtual Task<Operation<Instance, CreateInstanceMetadata>> PollOnceCreateInstanceAsync(string operationName, CallSettings callSettings = null)

Asynchronously poll an operation once, using an operationName from a previous invocation of CreateInstance.

Parameters
NameDescription
operationNamestring

The name of a previously invoked operation. Must not be null or empty.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TaskOperationInstanceCreateInstanceMetadata

A task representing the result of polling the operation.

PollOncePartialUpdateCluster(string, CallSettings)

public virtual Operation<Cluster, PartialUpdateClusterMetadata> PollOncePartialUpdateCluster(string operationName, CallSettings callSettings = null)

Poll an operation once, using an operationName from a previous invocation of PartialUpdateCluster .

Parameters
NameDescription
operationNamestring

The name of a previously invoked operation. Must not be null or empty.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
OperationClusterPartialUpdateClusterMetadata

The result of polling the operation.

PollOncePartialUpdateClusterAsync(string, CallSettings)

public virtual Task<Operation<Cluster, PartialUpdateClusterMetadata>> PollOncePartialUpdateClusterAsync(string operationName, CallSettings callSettings = null)

Asynchronously poll an operation once, using an operationName from a previous invocation of PartialUpdateCluster.

Parameters
NameDescription
operationNamestring

The name of a previously invoked operation. Must not be null or empty.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TaskOperationClusterPartialUpdateClusterMetadata

A task representing the result of polling the operation.

PollOncePartialUpdateInstance(string, CallSettings)

public virtual Operation<Instance, UpdateInstanceMetadata> PollOncePartialUpdateInstance(string operationName, CallSettings callSettings = null)

Poll an operation once, using an operationName from a previous invocation of PartialUpdateInstance .

Parameters
NameDescription
operationNamestring

The name of a previously invoked operation. Must not be null or empty.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
OperationInstanceUpdateInstanceMetadata

The result of polling the operation.

PollOncePartialUpdateInstanceAsync(string, CallSettings)

public virtual Task<Operation<Instance, UpdateInstanceMetadata>> PollOncePartialUpdateInstanceAsync(string operationName, CallSettings callSettings = null)

Asynchronously poll an operation once, using an operationName from a previous invocation of PartialUpdateInstance.

Parameters
NameDescription
operationNamestring

The name of a previously invoked operation. Must not be null or empty.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TaskOperationInstanceUpdateInstanceMetadata

A task representing the result of polling the operation.

PollOnceUpdateAppProfile(string, CallSettings)

public virtual Operation<AppProfile, UpdateAppProfileMetadata> PollOnceUpdateAppProfile(string operationName, CallSettings callSettings = null)

Poll an operation once, using an operationName from a previous invocation of UpdateAppProfile.

Parameters
NameDescription
operationNamestring

The name of a previously invoked operation. Must not be null or empty.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
OperationAppProfileUpdateAppProfileMetadata

The result of polling the operation.

PollOnceUpdateAppProfileAsync(string, CallSettings)

public virtual Task<Operation<AppProfile, UpdateAppProfileMetadata>> PollOnceUpdateAppProfileAsync(string operationName, CallSettings callSettings = null)

Asynchronously poll an operation once, using an operationName from a previous invocation of UpdateAppProfile.

Parameters
NameDescription
operationNamestring

The name of a previously invoked operation. Must not be null or empty.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TaskOperationAppProfileUpdateAppProfileMetadata

A task representing the result of polling the operation.

PollOnceUpdateCluster(string, CallSettings)

public virtual Operation<Cluster, UpdateClusterMetadata> PollOnceUpdateCluster(string operationName, CallSettings callSettings = null)

Poll an operation once, using an operationName from a previous invocation of UpdateCluster.

Parameters
NameDescription
operationNamestring

The name of a previously invoked operation. Must not be null or empty.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
OperationClusterUpdateClusterMetadata

The result of polling the operation.

PollOnceUpdateClusterAsync(string, CallSettings)

public virtual Task<Operation<Cluster, UpdateClusterMetadata>> PollOnceUpdateClusterAsync(string operationName, CallSettings callSettings = null)

Asynchronously poll an operation once, using an operationName from a previous invocation of UpdateCluster.

Parameters
NameDescription
operationNamestring

The name of a previously invoked operation. Must not be null or empty.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TaskOperationClusterUpdateClusterMetadata

A task representing the result of polling the operation.

SetIamPolicy(IResourceName, Policy, CallSettings)

public virtual Policy SetIamPolicy(IResourceName resource, Policy policy, CallSettings callSettings = null)

Sets the access control policy on an instance resource. Replaces any existing policy.

Parameters
NameDescription
resourceIResourceName

REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field.

policyPolicy

REQUIRED: The complete policy to be applied to the resource. The size of the policy is limited to a few 10s of KB. An empty policy is a valid policy but certain Cloud Platform services (such as Projects) might reject them.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Policy

The RPC response.

Example
// Create client
BigtableInstanceAdminClient bigtableInstanceAdminClient = BigtableInstanceAdminClient.Create();
// Initialize request argument(s)
IResourceName resource = new UnparsedResourceName("a/wildcard/resource");
Policy policy = new Policy();
// Make the request
Policy response = bigtableInstanceAdminClient.SetIamPolicy(resource, policy);

SetIamPolicy(SetIamPolicyRequest, CallSettings)

public virtual Policy SetIamPolicy(SetIamPolicyRequest request, CallSettings callSettings = null)

Sets the access control policy on an instance resource. Replaces any existing policy.

Parameters
NameDescription
requestSetIamPolicyRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Policy

The RPC response.

Example
// Create client
BigtableInstanceAdminClient bigtableInstanceAdminClient = BigtableInstanceAdminClient.Create();
// Initialize request argument(s)
SetIamPolicyRequest request = new SetIamPolicyRequest
{
    ResourceAsResourceName = new UnparsedResourceName("a/wildcard/resource"),
    Policy = new Policy(),
    UpdateMask = new FieldMask(),
};
// Make the request
Policy response = bigtableInstanceAdminClient.SetIamPolicy(request);

SetIamPolicy(string, Policy, CallSettings)

public virtual Policy SetIamPolicy(string resource, Policy policy, CallSettings callSettings = null)

Sets the access control policy on an instance resource. Replaces any existing policy.

Parameters
NameDescription
resourcestring

REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field.

policyPolicy

REQUIRED: The complete policy to be applied to the resource. The size of the policy is limited to a few 10s of KB. An empty policy is a valid policy but certain Cloud Platform services (such as Projects) might reject them.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Policy

The RPC response.

Example
// Create client
BigtableInstanceAdminClient bigtableInstanceAdminClient = BigtableInstanceAdminClient.Create();
// Initialize request argument(s)
string resource = "a/wildcard/resource";
Policy policy = new Policy();
// Make the request
Policy response = bigtableInstanceAdminClient.SetIamPolicy(resource, policy);

SetIamPolicyAsync(IResourceName, Policy, CallSettings)

public virtual Task<Policy> SetIamPolicyAsync(IResourceName resource, Policy policy, CallSettings callSettings = null)

Sets the access control policy on an instance resource. Replaces any existing policy.

Parameters
NameDescription
resourceIResourceName

REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field.

policyPolicy

REQUIRED: The complete policy to be applied to the resource. The size of the policy is limited to a few 10s of KB. An empty policy is a valid policy but certain Cloud Platform services (such as Projects) might reject them.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TaskPolicy

A Task containing the RPC response.

Example
// Create client
BigtableInstanceAdminClient bigtableInstanceAdminClient = await BigtableInstanceAdminClient.CreateAsync();
// Initialize request argument(s)
IResourceName resource = new UnparsedResourceName("a/wildcard/resource");
Policy policy = new Policy();
// Make the request
Policy response = await bigtableInstanceAdminClient.SetIamPolicyAsync(resource, policy);

SetIamPolicyAsync(IResourceName, Policy, CancellationToken)

public virtual Task<Policy> SetIamPolicyAsync(IResourceName resource, Policy policy, CancellationToken cancellationToken)

Sets the access control policy on an instance resource. Replaces any existing policy.

Parameters
NameDescription
resourceIResourceName

REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field.

policyPolicy

REQUIRED: The complete policy to be applied to the resource. The size of the policy is limited to a few 10s of KB. An empty policy is a valid policy but certain Cloud Platform services (such as Projects) might reject them.

cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
TaskPolicy

A Task containing the RPC response.

Example
// Create client
BigtableInstanceAdminClient bigtableInstanceAdminClient = await BigtableInstanceAdminClient.CreateAsync();
// Initialize request argument(s)
IResourceName resource = new UnparsedResourceName("a/wildcard/resource");
Policy policy = new Policy();
// Make the request
Policy response = await bigtableInstanceAdminClient.SetIamPolicyAsync(resource, policy);

SetIamPolicyAsync(SetIamPolicyRequest, CallSettings)

public virtual Task<Policy> SetIamPolicyAsync(SetIamPolicyRequest request, CallSettings callSettings = null)

Sets the access control policy on an instance resource. Replaces any existing policy.

Parameters
NameDescription
requestSetIamPolicyRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TaskPolicy

A Task containing the RPC response.

Example
// Create client
BigtableInstanceAdminClient bigtableInstanceAdminClient = await BigtableInstanceAdminClient.CreateAsync();
// Initialize request argument(s)
SetIamPolicyRequest request = new SetIamPolicyRequest
{
    ResourceAsResourceName = new UnparsedResourceName("a/wildcard/resource"),
    Policy = new Policy(),
    UpdateMask = new FieldMask(),
};
// Make the request
Policy response = await bigtableInstanceAdminClient.SetIamPolicyAsync(request);

SetIamPolicyAsync(SetIamPolicyRequest, CancellationToken)

public virtual Task<Policy> SetIamPolicyAsync(SetIamPolicyRequest request, CancellationToken cancellationToken)

Sets the access control policy on an instance resource. Replaces any existing policy.

Parameters
NameDescription
requestSetIamPolicyRequest

The request object containing all of the parameters for the API call.

cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
TaskPolicy

A Task containing the RPC response.

Example
// Create client
BigtableInstanceAdminClient bigtableInstanceAdminClient = await BigtableInstanceAdminClient.CreateAsync();
// Initialize request argument(s)
SetIamPolicyRequest request = new SetIamPolicyRequest
{
    ResourceAsResourceName = new UnparsedResourceName("a/wildcard/resource"),
    Policy = new Policy(),
    UpdateMask = new FieldMask(),
};
// Make the request
Policy response = await bigtableInstanceAdminClient.SetIamPolicyAsync(request);

SetIamPolicyAsync(string, Policy, CallSettings)

public virtual Task<Policy> SetIamPolicyAsync(string resource, Policy policy, CallSettings callSettings = null)

Sets the access control policy on an instance resource. Replaces any existing policy.

Parameters
NameDescription
resourcestring

REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field.

policyPolicy

REQUIRED: The complete policy to be applied to the resource. The size of the policy is limited to a few 10s of KB. An empty policy is a valid policy but certain Cloud Platform services (such as Projects) might reject them.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TaskPolicy

A Task containing the RPC response.

Example
// Create client
BigtableInstanceAdminClient bigtableInstanceAdminClient = await BigtableInstanceAdminClient.CreateAsync();
// Initialize request argument(s)
string resource = "a/wildcard/resource";
Policy policy = new Policy();
// Make the request
Policy response = await bigtableInstanceAdminClient.SetIamPolicyAsync(resource, policy);

SetIamPolicyAsync(string, Policy, CancellationToken)

public virtual Task<Policy> SetIamPolicyAsync(string resource, Policy policy, CancellationToken cancellationToken)

Sets the access control policy on an instance resource. Replaces any existing policy.

Parameters
NameDescription
resourcestring

REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field.

policyPolicy

REQUIRED: The complete policy to be applied to the resource. The size of the policy is limited to a few 10s of KB. An empty policy is a valid policy but certain Cloud Platform services (such as Projects) might reject them.

cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
TaskPolicy

A Task containing the RPC response.

Example
// Create client
BigtableInstanceAdminClient bigtableInstanceAdminClient = await BigtableInstanceAdminClient.CreateAsync();
// Initialize request argument(s)
string resource = "a/wildcard/resource";
Policy policy = new Policy();
// Make the request
Policy response = await bigtableInstanceAdminClient.SetIamPolicyAsync(resource, policy);

ShutdownDefaultChannelsAsync()

public static Task ShutdownDefaultChannelsAsync()

Shuts down any channels automatically created by Create() and CreateAsync(CancellationToken). Channels which weren't automatically created are not affected.

Returns
TypeDescription
Task

A task representing the asynchronous shutdown operation.

Remarks

After calling this method, further calls to Create() and CreateAsync(CancellationToken) will create new channels, which could in turn be shut down by another call to this method.

TestIamPermissions(IResourceName, IEnumerable<string>, CallSettings)

public virtual TestIamPermissionsResponse TestIamPermissions(IResourceName resource, IEnumerable<string> permissions, CallSettings callSettings = null)

Returns permissions that the caller has on the specified instance resource.

Parameters
NameDescription
resourceIResourceName

REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field.

permissionsIEnumerablestring

The set of permissions to check for the resource. Permissions with wildcards (such as '' or 'storage.') are not allowed. For more information see IAM Overview.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TestIamPermissionsResponse

The RPC response.

Example
// Create client
BigtableInstanceAdminClient bigtableInstanceAdminClient = BigtableInstanceAdminClient.Create();
// Initialize request argument(s)
IResourceName resource = new UnparsedResourceName("a/wildcard/resource");
IEnumerable<string> permissions = new string[] { "", };
// Make the request
TestIamPermissionsResponse response = bigtableInstanceAdminClient.TestIamPermissions(resource, permissions);

TestIamPermissions(TestIamPermissionsRequest, CallSettings)

public virtual TestIamPermissionsResponse TestIamPermissions(TestIamPermissionsRequest request, CallSettings callSettings = null)

Returns permissions that the caller has on the specified instance resource.

Parameters
NameDescription
requestTestIamPermissionsRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TestIamPermissionsResponse

The RPC response.

Example
// Create client
BigtableInstanceAdminClient bigtableInstanceAdminClient = BigtableInstanceAdminClient.Create();
// Initialize request argument(s)
TestIamPermissionsRequest request = new TestIamPermissionsRequest
{
    ResourceAsResourceName = new UnparsedResourceName("a/wildcard/resource"),
    Permissions = { "", },
};
// Make the request
TestIamPermissionsResponse response = bigtableInstanceAdminClient.TestIamPermissions(request);

TestIamPermissions(string, IEnumerable<string>, CallSettings)

public virtual TestIamPermissionsResponse TestIamPermissions(string resource, IEnumerable<string> permissions, CallSettings callSettings = null)

Returns permissions that the caller has on the specified instance resource.

Parameters
NameDescription
resourcestring

REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field.

permissionsIEnumerablestring

The set of permissions to check for the resource. Permissions with wildcards (such as '' or 'storage.') are not allowed. For more information see IAM Overview.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TestIamPermissionsResponse

The RPC response.

Example
// Create client
BigtableInstanceAdminClient bigtableInstanceAdminClient = BigtableInstanceAdminClient.Create();
// Initialize request argument(s)
string resource = "a/wildcard/resource";
IEnumerable<string> permissions = new string[] { "", };
// Make the request
TestIamPermissionsResponse response = bigtableInstanceAdminClient.TestIamPermissions(resource, permissions);

TestIamPermissionsAsync(IResourceName, IEnumerable<string>, CallSettings)

public virtual Task<TestIamPermissionsResponse> TestIamPermissionsAsync(IResourceName resource, IEnumerable<string> permissions, CallSettings callSettings = null)

Returns permissions that the caller has on the specified instance resource.

Parameters
NameDescription
resourceIResourceName

REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field.

permissionsIEnumerablestring

The set of permissions to check for the resource. Permissions with wildcards (such as '' or 'storage.') are not allowed. For more information see IAM Overview.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TaskTestIamPermissionsResponse

A Task containing the RPC response.

Example
// Create client
BigtableInstanceAdminClient bigtableInstanceAdminClient = await BigtableInstanceAdminClient.CreateAsync();
// Initialize request argument(s)
IResourceName resource = new UnparsedResourceName("a/wildcard/resource");
IEnumerable<string> permissions = new string[] { "", };
// Make the request
TestIamPermissionsResponse response = await bigtableInstanceAdminClient.TestIamPermissionsAsync(resource, permissions);

TestIamPermissionsAsync(IResourceName, IEnumerable<string>, CancellationToken)

public virtual Task<TestIamPermissionsResponse> TestIamPermissionsAsync(IResourceName resource, IEnumerable<string> permissions, CancellationToken cancellationToken)

Returns permissions that the caller has on the specified instance resource.

Parameters
NameDescription
resourceIResourceName

REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field.

permissionsIEnumerablestring

The set of permissions to check for the resource. Permissions with wildcards (such as '' or 'storage.') are not allowed. For more information see IAM Overview.

cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
TaskTestIamPermissionsResponse

A Task containing the RPC response.

Example
// Create client
BigtableInstanceAdminClient bigtableInstanceAdminClient = await BigtableInstanceAdminClient.CreateAsync();
// Initialize request argument(s)
IResourceName resource = new UnparsedResourceName("a/wildcard/resource");
IEnumerable<string> permissions = new string[] { "", };
// Make the request
TestIamPermissionsResponse response = await bigtableInstanceAdminClient.TestIamPermissionsAsync(resource, permissions);

TestIamPermissionsAsync(TestIamPermissionsRequest, CallSettings)

public virtual Task<TestIamPermissionsResponse> TestIamPermissionsAsync(TestIamPermissionsRequest request, CallSettings callSettings = null)

Returns permissions that the caller has on the specified instance resource.

Parameters
NameDescription
requestTestIamPermissionsRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TaskTestIamPermissionsResponse

A Task containing the RPC response.

Example
// Create client
BigtableInstanceAdminClient bigtableInstanceAdminClient = await BigtableInstanceAdminClient.CreateAsync();
// Initialize request argument(s)
TestIamPermissionsRequest request = new TestIamPermissionsRequest
{
    ResourceAsResourceName = new UnparsedResourceName("a/wildcard/resource"),
    Permissions = { "", },
};
// Make the request
TestIamPermissionsResponse response = await bigtableInstanceAdminClient.TestIamPermissionsAsync(request);

TestIamPermissionsAsync(TestIamPermissionsRequest, CancellationToken)

public virtual Task<TestIamPermissionsResponse> TestIamPermissionsAsync(TestIamPermissionsRequest request, CancellationToken cancellationToken)

Returns permissions that the caller has on the specified instance resource.

Parameters
NameDescription
requestTestIamPermissionsRequest

The request object containing all of the parameters for the API call.

cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
TaskTestIamPermissionsResponse

A Task containing the RPC response.

Example
// Create client
BigtableInstanceAdminClient bigtableInstanceAdminClient = await BigtableInstanceAdminClient.CreateAsync();
// Initialize request argument(s)
TestIamPermissionsRequest request = new TestIamPermissionsRequest
{
    ResourceAsResourceName = new UnparsedResourceName("a/wildcard/resource"),
    Permissions = { "", },
};
// Make the request
TestIamPermissionsResponse response = await bigtableInstanceAdminClient.TestIamPermissionsAsync(request);

TestIamPermissionsAsync(string, IEnumerable<string>, CallSettings)

public virtual Task<TestIamPermissionsResponse> TestIamPermissionsAsync(string resource, IEnumerable<string> permissions, CallSettings callSettings = null)

Returns permissions that the caller has on the specified instance resource.

Parameters
NameDescription
resourcestring

REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field.

permissionsIEnumerablestring

The set of permissions to check for the resource. Permissions with wildcards (such as '' or 'storage.') are not allowed. For more information see IAM Overview.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TaskTestIamPermissionsResponse

A Task containing the RPC response.

Example
// Create client
BigtableInstanceAdminClient bigtableInstanceAdminClient = await BigtableInstanceAdminClient.CreateAsync();
// Initialize request argument(s)
string resource = "a/wildcard/resource";
IEnumerable<string> permissions = new string[] { "", };
// Make the request
TestIamPermissionsResponse response = await bigtableInstanceAdminClient.TestIamPermissionsAsync(resource, permissions);

TestIamPermissionsAsync(string, IEnumerable<string>, CancellationToken)

public virtual Task<TestIamPermissionsResponse> TestIamPermissionsAsync(string resource, IEnumerable<string> permissions, CancellationToken cancellationToken)

Returns permissions that the caller has on the specified instance resource.

Parameters
NameDescription
resourcestring

REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field.

permissionsIEnumerablestring

The set of permissions to check for the resource. Permissions with wildcards (such as '' or 'storage.') are not allowed. For more information see IAM Overview.

cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
TaskTestIamPermissionsResponse

A Task containing the RPC response.

Example
// Create client
BigtableInstanceAdminClient bigtableInstanceAdminClient = await BigtableInstanceAdminClient.CreateAsync();
// Initialize request argument(s)
string resource = "a/wildcard/resource";
IEnumerable<string> permissions = new string[] { "", };
// Make the request
TestIamPermissionsResponse response = await bigtableInstanceAdminClient.TestIamPermissionsAsync(resource, permissions);

UpdateAppProfile(AppProfile, FieldMask, CallSettings)

public virtual Operation<AppProfile, UpdateAppProfileMetadata> UpdateAppProfile(AppProfile appProfile, FieldMask updateMask, CallSettings callSettings = null)

Updates an app profile within an instance.

Parameters
NameDescription
appProfileAppProfile

Required. The app profile which will (partially) replace the current value.

updateMaskFieldMask

Required. The subset of app profile fields which should be replaced. If unset, all fields will be replaced.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
OperationAppProfileUpdateAppProfileMetadata

The RPC response.

Example
// Create client
BigtableInstanceAdminClient bigtableInstanceAdminClient = BigtableInstanceAdminClient.Create();
// Initialize request argument(s)
AppProfile appProfile = new AppProfile();
FieldMask updateMask = new FieldMask();
// Make the request
Operation<AppProfile, UpdateAppProfileMetadata> response = bigtableInstanceAdminClient.UpdateAppProfile(appProfile, updateMask);

// Poll until the returned long-running operation is complete
Operation<AppProfile, UpdateAppProfileMetadata> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
AppProfile result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<AppProfile, UpdateAppProfileMetadata> retrievedResponse = bigtableInstanceAdminClient.PollOnceUpdateAppProfile(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    AppProfile retrievedResult = retrievedResponse.Result;
}

UpdateAppProfile(UpdateAppProfileRequest, CallSettings)

public virtual Operation<AppProfile, UpdateAppProfileMetadata> UpdateAppProfile(UpdateAppProfileRequest request, CallSettings callSettings = null)

Updates an app profile within an instance.

Parameters
NameDescription
requestUpdateAppProfileRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
OperationAppProfileUpdateAppProfileMetadata

The RPC response.

Example
// Create client
BigtableInstanceAdminClient bigtableInstanceAdminClient = BigtableInstanceAdminClient.Create();
// Initialize request argument(s)
UpdateAppProfileRequest request = new UpdateAppProfileRequest
{
    AppProfile = new AppProfile(),
    UpdateMask = new FieldMask(),
    IgnoreWarnings = false,
};
// Make the request
Operation<AppProfile, UpdateAppProfileMetadata> response = bigtableInstanceAdminClient.UpdateAppProfile(request);

// Poll until the returned long-running operation is complete
Operation<AppProfile, UpdateAppProfileMetadata> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
AppProfile result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<AppProfile, UpdateAppProfileMetadata> retrievedResponse = bigtableInstanceAdminClient.PollOnceUpdateAppProfile(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    AppProfile retrievedResult = retrievedResponse.Result;
}

UpdateAppProfileAsync(AppProfile, FieldMask, CallSettings)

public virtual Task<Operation<AppProfile, UpdateAppProfileMetadata>> UpdateAppProfileAsync(AppProfile appProfile, FieldMask updateMask, CallSettings callSettings = null)

Updates an app profile within an instance.

Parameters
NameDescription
appProfileAppProfile

Required. The app profile which will (partially) replace the current value.

updateMaskFieldMask

Required. The subset of app profile fields which should be replaced. If unset, all fields will be replaced.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TaskOperationAppProfileUpdateAppProfileMetadata

A Task containing the RPC response.

Example
// Create client
BigtableInstanceAdminClient bigtableInstanceAdminClient = await BigtableInstanceAdminClient.CreateAsync();
// Initialize request argument(s)
AppProfile appProfile = new AppProfile();
FieldMask updateMask = new FieldMask();
// Make the request
Operation<AppProfile, UpdateAppProfileMetadata> response = await bigtableInstanceAdminClient.UpdateAppProfileAsync(appProfile, updateMask);

// Poll until the returned long-running operation is complete
Operation<AppProfile, UpdateAppProfileMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
AppProfile result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<AppProfile, UpdateAppProfileMetadata> retrievedResponse = await bigtableInstanceAdminClient.PollOnceUpdateAppProfileAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    AppProfile retrievedResult = retrievedResponse.Result;
}

UpdateAppProfileAsync(AppProfile, FieldMask, CancellationToken)

public virtual Task<Operation<AppProfile, UpdateAppProfileMetadata>> UpdateAppProfileAsync(AppProfile appProfile, FieldMask updateMask, CancellationToken cancellationToken)

Updates an app profile within an instance.

Parameters
NameDescription
appProfileAppProfile

Required. The app profile which will (partially) replace the current value.

updateMaskFieldMask

Required. The subset of app profile fields which should be replaced. If unset, all fields will be replaced.

cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
TaskOperationAppProfileUpdateAppProfileMetadata

A Task containing the RPC response.

Example
// Create client
BigtableInstanceAdminClient bigtableInstanceAdminClient = await BigtableInstanceAdminClient.CreateAsync();
// Initialize request argument(s)
AppProfile appProfile = new AppProfile();
FieldMask updateMask = new FieldMask();
// Make the request
Operation<AppProfile, UpdateAppProfileMetadata> response = await bigtableInstanceAdminClient.UpdateAppProfileAsync(appProfile, updateMask);

// Poll until the returned long-running operation is complete
Operation<AppProfile, UpdateAppProfileMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
AppProfile result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<AppProfile, UpdateAppProfileMetadata> retrievedResponse = await bigtableInstanceAdminClient.PollOnceUpdateAppProfileAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    AppProfile retrievedResult = retrievedResponse.Result;
}

UpdateAppProfileAsync(UpdateAppProfileRequest, CallSettings)

public virtual Task<Operation<AppProfile, UpdateAppProfileMetadata>> UpdateAppProfileAsync(UpdateAppProfileRequest request, CallSettings callSettings = null)

Updates an app profile within an instance.

Parameters
NameDescription
requestUpdateAppProfileRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TaskOperationAppProfileUpdateAppProfileMetadata

A Task containing the RPC response.

Example
// Create client
BigtableInstanceAdminClient bigtableInstanceAdminClient = await BigtableInstanceAdminClient.CreateAsync();
// Initialize request argument(s)
UpdateAppProfileRequest request = new UpdateAppProfileRequest
{
    AppProfile = new AppProfile(),
    UpdateMask = new FieldMask(),
    IgnoreWarnings = false,
};
// Make the request
Operation<AppProfile, UpdateAppProfileMetadata> response = await bigtableInstanceAdminClient.UpdateAppProfileAsync(request);

// Poll until the returned long-running operation is complete
Operation<AppProfile, UpdateAppProfileMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
AppProfile result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<AppProfile, UpdateAppProfileMetadata> retrievedResponse = await bigtableInstanceAdminClient.PollOnceUpdateAppProfileAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    AppProfile retrievedResult = retrievedResponse.Result;
}

UpdateAppProfileAsync(UpdateAppProfileRequest, CancellationToken)

public virtual Task<Operation<AppProfile, UpdateAppProfileMetadata>> UpdateAppProfileAsync(UpdateAppProfileRequest request, CancellationToken cancellationToken)

Updates an app profile within an instance.

Parameters
NameDescription
requestUpdateAppProfileRequest

The request object containing all of the parameters for the API call.

cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
TaskOperationAppProfileUpdateAppProfileMetadata

A Task containing the RPC response.

Example
// Create client
BigtableInstanceAdminClient bigtableInstanceAdminClient = await BigtableInstanceAdminClient.CreateAsync();
// Initialize request argument(s)
UpdateAppProfileRequest request = new UpdateAppProfileRequest
{
    AppProfile = new AppProfile(),
    UpdateMask = new FieldMask(),
    IgnoreWarnings = false,
};
// Make the request
Operation<AppProfile, UpdateAppProfileMetadata> response = await bigtableInstanceAdminClient.UpdateAppProfileAsync(request);

// Poll until the returned long-running operation is complete
Operation<AppProfile, UpdateAppProfileMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
AppProfile result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<AppProfile, UpdateAppProfileMetadata> retrievedResponse = await bigtableInstanceAdminClient.PollOnceUpdateAppProfileAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    AppProfile retrievedResult = retrievedResponse.Result;
}

UpdateCluster(Cluster, CallSettings)

public virtual Operation<Cluster, UpdateClusterMetadata> UpdateCluster(Cluster request, CallSettings callSettings = null)

Updates a cluster within an instance.

Note that UpdateCluster does not support updating cluster_config.cluster_autoscaling_config. In order to update it, you must use PartialUpdateCluster.

Parameters
NameDescription
requestCluster

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
OperationClusterUpdateClusterMetadata

The RPC response.

Example
// Create client
BigtableInstanceAdminClient bigtableInstanceAdminClient = BigtableInstanceAdminClient.Create();
// Initialize request argument(s)
Cluster request = new Cluster
{
    ClusterName = ClusterName.FromProjectInstanceCluster("[PROJECT]", "[INSTANCE]", "[CLUSTER]"),
    LocationAsLocationName = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]"),
    State = Cluster.Types.State.NotKnown,
    ServeNodes = 0,
    DefaultStorageType = StorageType.Unspecified,
    EncryptionConfig = new Cluster.Types.EncryptionConfig(),
    ClusterConfig = new Cluster.Types.ClusterConfig(),
};
// Make the request
Operation<Cluster, UpdateClusterMetadata> response = bigtableInstanceAdminClient.UpdateCluster(request);

// Poll until the returned long-running operation is complete
Operation<Cluster, UpdateClusterMetadata> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
Cluster result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Cluster, UpdateClusterMetadata> retrievedResponse = bigtableInstanceAdminClient.PollOnceUpdateCluster(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Cluster retrievedResult = retrievedResponse.Result;
}

UpdateClusterAsync(Cluster, CallSettings)

public virtual Task<Operation<Cluster, UpdateClusterMetadata>> UpdateClusterAsync(Cluster request, CallSettings callSettings = null)

Updates a cluster within an instance.

Note that UpdateCluster does not support updating cluster_config.cluster_autoscaling_config. In order to update it, you must use PartialUpdateCluster.

Parameters
NameDescription
requestCluster

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TaskOperationClusterUpdateClusterMetadata

A Task containing the RPC response.

Example
// Create client
BigtableInstanceAdminClient bigtableInstanceAdminClient = await BigtableInstanceAdminClient.CreateAsync();
// Initialize request argument(s)
Cluster request = new Cluster
{
    ClusterName = ClusterName.FromProjectInstanceCluster("[PROJECT]", "[INSTANCE]", "[CLUSTER]"),
    LocationAsLocationName = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]"),
    State = Cluster.Types.State.NotKnown,
    ServeNodes = 0,
    DefaultStorageType = StorageType.Unspecified,
    EncryptionConfig = new Cluster.Types.EncryptionConfig(),
    ClusterConfig = new Cluster.Types.ClusterConfig(),
};
// Make the request
Operation<Cluster, UpdateClusterMetadata> response = await bigtableInstanceAdminClient.UpdateClusterAsync(request);

// Poll until the returned long-running operation is complete
Operation<Cluster, UpdateClusterMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Cluster result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Cluster, UpdateClusterMetadata> retrievedResponse = await bigtableInstanceAdminClient.PollOnceUpdateClusterAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Cluster retrievedResult = retrievedResponse.Result;
}

UpdateClusterAsync(Cluster, CancellationToken)

public virtual Task<Operation<Cluster, UpdateClusterMetadata>> UpdateClusterAsync(Cluster request, CancellationToken cancellationToken)

Updates a cluster within an instance.

Note that UpdateCluster does not support updating cluster_config.cluster_autoscaling_config. In order to update it, you must use PartialUpdateCluster.

Parameters
NameDescription
requestCluster

The request object containing all of the parameters for the API call.

cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
TaskOperationClusterUpdateClusterMetadata

A Task containing the RPC response.

Example
// Create client
BigtableInstanceAdminClient bigtableInstanceAdminClient = await BigtableInstanceAdminClient.CreateAsync();
// Initialize request argument(s)
Cluster request = new Cluster
{
    ClusterName = ClusterName.FromProjectInstanceCluster("[PROJECT]", "[INSTANCE]", "[CLUSTER]"),
    LocationAsLocationName = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]"),
    State = Cluster.Types.State.NotKnown,
    ServeNodes = 0,
    DefaultStorageType = StorageType.Unspecified,
    EncryptionConfig = new Cluster.Types.EncryptionConfig(),
    ClusterConfig = new Cluster.Types.ClusterConfig(),
};
// Make the request
Operation<Cluster, UpdateClusterMetadata> response = await bigtableInstanceAdminClient.UpdateClusterAsync(request);

// Poll until the returned long-running operation is complete
Operation<Cluster, UpdateClusterMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Cluster result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Cluster, UpdateClusterMetadata> retrievedResponse = await bigtableInstanceAdminClient.PollOnceUpdateClusterAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Cluster retrievedResult = retrievedResponse.Result;
}

UpdateInstance(Instance, CallSettings)

public virtual Instance UpdateInstance(Instance request, CallSettings callSettings = null)

Updates an instance within a project. This method updates only the display name and type for an Instance. To update other Instance properties, such as labels, use PartialUpdateInstance.

Parameters
NameDescription
requestInstance

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Instance

The RPC response.

Example
// Create client
BigtableInstanceAdminClient bigtableInstanceAdminClient = BigtableInstanceAdminClient.Create();
// Initialize request argument(s)
Instance request = new Instance
{
    InstanceName = InstanceName.FromProjectInstance("[PROJECT]", "[INSTANCE]"),
    DisplayName = "",
    State = Instance.Types.State.NotKnown,
    Type = Instance.Types.Type.Unspecified,
    Labels = { { "", "" }, },
    CreateTime = new Timestamp(),
    SatisfiesPzs = false,
};
// Make the request
Instance response = bigtableInstanceAdminClient.UpdateInstance(request);

UpdateInstanceAsync(Instance, CallSettings)

public virtual Task<Instance> UpdateInstanceAsync(Instance request, CallSettings callSettings = null)

Updates an instance within a project. This method updates only the display name and type for an Instance. To update other Instance properties, such as labels, use PartialUpdateInstance.

Parameters
NameDescription
requestInstance

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TaskInstance

A Task containing the RPC response.

Example
// Create client
BigtableInstanceAdminClient bigtableInstanceAdminClient = await BigtableInstanceAdminClient.CreateAsync();
// Initialize request argument(s)
Instance request = new Instance
{
    InstanceName = InstanceName.FromProjectInstance("[PROJECT]", "[INSTANCE]"),
    DisplayName = "",
    State = Instance.Types.State.NotKnown,
    Type = Instance.Types.Type.Unspecified,
    Labels = { { "", "" }, },
    CreateTime = new Timestamp(),
    SatisfiesPzs = false,
};
// Make the request
Instance response = await bigtableInstanceAdminClient.UpdateInstanceAsync(request);

UpdateInstanceAsync(Instance, CancellationToken)

public virtual Task<Instance> UpdateInstanceAsync(Instance request, CancellationToken cancellationToken)

Updates an instance within a project. This method updates only the display name and type for an Instance. To update other Instance properties, such as labels, use PartialUpdateInstance.

Parameters
NameDescription
requestInstance

The request object containing all of the parameters for the API call.

cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
TaskInstance

A Task containing the RPC response.

Example
// Create client
BigtableInstanceAdminClient bigtableInstanceAdminClient = await BigtableInstanceAdminClient.CreateAsync();
// Initialize request argument(s)
Instance request = new Instance
{
    InstanceName = InstanceName.FromProjectInstance("[PROJECT]", "[INSTANCE]"),
    DisplayName = "",
    State = Instance.Types.State.NotKnown,
    Type = Instance.Types.Type.Unspecified,
    Labels = { { "", "" }, },
    CreateTime = new Timestamp(),
    SatisfiesPzs = false,
};
// Make the request
Instance response = await bigtableInstanceAdminClient.UpdateInstanceAsync(request);