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.
Derived Types
Namespace
Google.Cloud.Bigtable.Admin.V2Assembly
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 | |
---|---|
Type | Description |
OperationsClient |
CreateInstanceOperationsClient
public virtual OperationsClient CreateInstanceOperationsClient { get; }
The long-running operations client for CreateInstance
.
Property Value | |
---|---|
Type | Description |
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 | |
---|---|
Type | Description |
string |
DefaultScopes
public static IReadOnlyList<string> DefaultScopes { get; }
The default BigtableInstanceAdmin scopes.
Property Value | |
---|---|
Type | Description |
IReadOnlyListstring |
The default BigtableInstanceAdmin scopes are:
- https://www.googleapis.com/auth/bigtable.admin
- https://www.googleapis.com/auth/bigtable.admin.cluster
- https://www.googleapis.com/auth/bigtable.admin.instance
- https://www.googleapis.com/auth/cloud-bigtable.admin
- https://www.googleapis.com/auth/cloud-bigtable.admin.cluster
- https://www.googleapis.com/auth/cloud-platform
- https://www.googleapis.com/auth/cloud-platform.read-only
GrpcClient
public virtual BigtableInstanceAdmin.BigtableInstanceAdminClient GrpcClient { get; }
The underlying gRPC BigtableInstanceAdmin client
Property Value | |
---|---|
Type | Description |
BigtableInstanceAdminBigtableInstanceAdminClient |
PartialUpdateClusterOperationsClient
public virtual OperationsClient PartialUpdateClusterOperationsClient { get; }
The long-running operations client for PartialUpdateCluster
.
Property Value | |
---|---|
Type | Description |
OperationsClient |
PartialUpdateInstanceOperationsClient
public virtual OperationsClient PartialUpdateInstanceOperationsClient { get; }
The long-running operations client for PartialUpdateInstance
.
Property Value | |
---|---|
Type | Description |
OperationsClient |
ServiceMetadata
public static ServiceMetadata ServiceMetadata { get; }
The service metadata associated with this client type.
Property Value | |
---|---|
Type | Description |
ServiceMetadata |
UpdateAppProfileOperationsClient
public virtual OperationsClient UpdateAppProfileOperationsClient { get; }
The long-running operations client for UpdateAppProfile
.
Property Value | |
---|---|
Type | Description |
OperationsClient |
UpdateClusterOperationsClient
public virtual OperationsClient UpdateClusterOperationsClient { get; }
The long-running operations client for UpdateCluster
.
Property Value | |
---|---|
Type | Description |
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 | |
---|---|
Type | Description |
BigtableInstanceAdminClient | The created BigtableInstanceAdminClient. |
CreateAppProfile(CreateAppProfileRequest, CallSettings)
public virtual AppProfile CreateAppProfile(CreateAppProfileRequest request, CallSettings callSettings = null)
Creates an app profile within an instance.
Parameters | |
---|---|
Name | Description |
request | CreateAppProfileRequest The request object containing all of the parameters for the API call. |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
AppProfile | The RPC response. |
// 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 | |
---|---|
Name | Description |
parent | InstanceName Required. The unique name of the instance in which to create the new app
profile. Values are of the form |
appProfileId | string Required. The ID to be used when referring to the new app profile within
its instance, e.g., just |
appProfile | AppProfile Required. The app profile to be created.
Fields marked |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
AppProfile | The RPC response. |
// 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 | |
---|---|
Name | Description |
parent | string Required. The unique name of the instance in which to create the new app
profile. Values are of the form |
appProfileId | string Required. The ID to be used when referring to the new app profile within
its instance, e.g., just |
appProfile | AppProfile Required. The app profile to be created.
Fields marked |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
AppProfile | The RPC response. |
// 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 | |
---|---|
Name | Description |
request | CreateAppProfileRequest The request object containing all of the parameters for the API call. |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
TaskAppProfile | A Task containing the RPC response. |
// 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 | |
---|---|
Name | Description |
request | CreateAppProfileRequest The request object containing all of the parameters for the API call. |
cancellationToken | CancellationToken A CancellationToken to use for this RPC. |
Returns | |
---|---|
Type | Description |
TaskAppProfile | A Task containing the RPC response. |
// 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 | |
---|---|
Name | Description |
parent | InstanceName Required. The unique name of the instance in which to create the new app
profile. Values are of the form |
appProfileId | string Required. The ID to be used when referring to the new app profile within
its instance, e.g., just |
appProfile | AppProfile Required. The app profile to be created.
Fields marked |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
TaskAppProfile | A Task containing the RPC response. |
// 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 | |
---|---|
Name | Description |
parent | InstanceName Required. The unique name of the instance in which to create the new app
profile. Values are of the form |
appProfileId | string Required. The ID to be used when referring to the new app profile within
its instance, e.g., just |
appProfile | AppProfile Required. The app profile to be created.
Fields marked |
cancellationToken | CancellationToken A CancellationToken to use for this RPC. |
Returns | |
---|---|
Type | Description |
TaskAppProfile | A Task containing the RPC response. |
// 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 | |
---|---|
Name | Description |
parent | string Required. The unique name of the instance in which to create the new app
profile. Values are of the form |
appProfileId | string Required. The ID to be used when referring to the new app profile within
its instance, e.g., just |
appProfile | AppProfile Required. The app profile to be created.
Fields marked |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
TaskAppProfile | A Task containing the RPC response. |
// 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 | |
---|---|
Name | Description |
parent | string Required. The unique name of the instance in which to create the new app
profile. Values are of the form |
appProfileId | string Required. The ID to be used when referring to the new app profile within
its instance, e.g., just |
appProfile | AppProfile Required. The app profile to be created.
Fields marked |
cancellationToken | CancellationToken A CancellationToken to use for this RPC. |
Returns | |
---|---|
Type | Description |
TaskAppProfile | A Task containing the RPC response. |
// 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 | |
---|---|
Name | Description |
cancellationToken | CancellationToken The CancellationToken to use while creating the client. |
Returns | |
---|---|
Type | Description |
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 | |
---|---|
Name | Description |
request | CreateClusterRequest The request object containing all of the parameters for the API call. |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
OperationClusterCreateClusterMetadata | The RPC response. |
// 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 | |
---|---|
Name | Description |
parent | InstanceName Required. The unique name of the instance in which to create the new
cluster. Values are of the form |
clusterId | string Required. The ID to be used when referring to the new cluster within its
instance, e.g., just |
cluster | Cluster Required. The cluster to be created.
Fields marked |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
OperationClusterCreateClusterMetadata | The RPC response. |
// 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 | |
---|---|
Name | Description |
parent | string Required. The unique name of the instance in which to create the new
cluster. Values are of the form |
clusterId | string Required. The ID to be used when referring to the new cluster within its
instance, e.g., just |
cluster | Cluster Required. The cluster to be created.
Fields marked |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
OperationClusterCreateClusterMetadata | The RPC response. |
// 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 | |
---|---|
Name | Description |
request | CreateClusterRequest The request object containing all of the parameters for the API call. |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
TaskOperationClusterCreateClusterMetadata | A Task containing the RPC response. |
// 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 | |
---|---|
Name | Description |
request | CreateClusterRequest The request object containing all of the parameters for the API call. |
cancellationToken | CancellationToken A CancellationToken to use for this RPC. |
Returns | |
---|---|
Type | Description |
TaskOperationClusterCreateClusterMetadata | A Task containing the RPC response. |
// 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 | |
---|---|
Name | Description |
parent | InstanceName Required. The unique name of the instance in which to create the new
cluster. Values are of the form |
clusterId | string Required. The ID to be used when referring to the new cluster within its
instance, e.g., just |
cluster | Cluster Required. The cluster to be created.
Fields marked |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
TaskOperationClusterCreateClusterMetadata | A Task containing the RPC response. |
// 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 | |
---|---|
Name | Description |
parent | InstanceName Required. The unique name of the instance in which to create the new
cluster. Values are of the form |
clusterId | string Required. The ID to be used when referring to the new cluster within its
instance, e.g., just |
cluster | Cluster Required. The cluster to be created.
Fields marked |
cancellationToken | CancellationToken A CancellationToken to use for this RPC. |
Returns | |
---|---|
Type | Description |
TaskOperationClusterCreateClusterMetadata | A Task containing the RPC response. |
// 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 | |
---|---|
Name | Description |
parent | string Required. The unique name of the instance in which to create the new
cluster. Values are of the form |
clusterId | string Required. The ID to be used when referring to the new cluster within its
instance, e.g., just |
cluster | Cluster Required. The cluster to be created.
Fields marked |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
TaskOperationClusterCreateClusterMetadata | A Task containing the RPC response. |
// 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 | |
---|---|
Name | Description |
parent | string Required. The unique name of the instance in which to create the new
cluster. Values are of the form |
clusterId | string Required. The ID to be used when referring to the new cluster within its
instance, e.g., just |
cluster | Cluster Required. The cluster to be created.
Fields marked |
cancellationToken | CancellationToken A CancellationToken to use for this RPC. |
Returns | |
---|---|
Type | Description |
TaskOperationClusterCreateClusterMetadata | A Task containing the RPC response. |
// 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 | |
---|---|
Name | Description |
parent | ProjectName Required. The unique name of the project in which to create the new
instance. Values are of the form |
instanceId | string Required. The ID to be used when referring to the new instance within its
project, e.g., just |
instance | Instance Required. The instance to create.
Fields marked |
clusters | IDictionarystringCluster Required. The clusters to be created within the instance, mapped by desired
cluster ID, e.g., just |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
OperationInstanceCreateInstanceMetadata | The RPC response. |
// 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 | |
---|---|
Name | Description |
request | CreateInstanceRequest The request object containing all of the parameters for the API call. |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
OperationInstanceCreateInstanceMetadata | The RPC response. |
// 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 | |
---|---|
Name | Description |
parent | string Required. The unique name of the project in which to create the new
instance. Values are of the form |
instanceId | string Required. The ID to be used when referring to the new instance within its
project, e.g., just |
instance | Instance Required. The instance to create.
Fields marked |
clusters | IDictionarystringCluster Required. The clusters to be created within the instance, mapped by desired
cluster ID, e.g., just |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
OperationInstanceCreateInstanceMetadata | The RPC response. |
// 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 | |
---|---|
Name | Description |
parent | ProjectName Required. The unique name of the project in which to create the new
instance. Values are of the form |
instanceId | string Required. The ID to be used when referring to the new instance within its
project, e.g., just |
instance | Instance Required. The instance to create.
Fields marked |
clusters | IDictionarystringCluster Required. The clusters to be created within the instance, mapped by desired
cluster ID, e.g., just |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
TaskOperationInstanceCreateInstanceMetadata | A Task containing the RPC response. |
// 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 | |
---|---|
Name | Description |
parent | ProjectName Required. The unique name of the project in which to create the new
instance. Values are of the form |
instanceId | string Required. The ID to be used when referring to the new instance within its
project, e.g., just |
instance | Instance Required. The instance to create.
Fields marked |
clusters | IDictionarystringCluster Required. The clusters to be created within the instance, mapped by desired
cluster ID, e.g., just |
cancellationToken | CancellationToken A CancellationToken to use for this RPC. |
Returns | |
---|---|
Type | Description |
TaskOperationInstanceCreateInstanceMetadata | A Task containing the RPC response. |
// 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 | |
---|---|
Name | Description |
request | CreateInstanceRequest The request object containing all of the parameters for the API call. |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
TaskOperationInstanceCreateInstanceMetadata | A Task containing the RPC response. |
// 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 | |
---|---|
Name | Description |
request | CreateInstanceRequest The request object containing all of the parameters for the API call. |
cancellationToken | CancellationToken A CancellationToken to use for this RPC. |
Returns | |
---|---|
Type | Description |
TaskOperationInstanceCreateInstanceMetadata | A Task containing the RPC response. |
// 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 | |
---|---|
Name | Description |
parent | string Required. The unique name of the project in which to create the new
instance. Values are of the form |
instanceId | string Required. The ID to be used when referring to the new instance within its
project, e.g., just |
instance | Instance Required. The instance to create.
Fields marked |
clusters | IDictionarystringCluster Required. The clusters to be created within the instance, mapped by desired
cluster ID, e.g., just |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
TaskOperationInstanceCreateInstanceMetadata | A Task containing the RPC response. |
// 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 | |
---|---|
Name | Description |
parent | string Required. The unique name of the project in which to create the new
instance. Values are of the form |
instanceId | string Required. The ID to be used when referring to the new instance within its
project, e.g., just |
instance | Instance Required. The instance to create.
Fields marked |
clusters | IDictionarystringCluster Required. The clusters to be created within the instance, mapped by desired
cluster ID, e.g., just |
cancellationToken | CancellationToken A CancellationToken to use for this RPC. |
Returns | |
---|---|
Type | Description |
TaskOperationInstanceCreateInstanceMetadata | A Task containing the RPC response. |
// 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 | |
---|---|
Name | Description |
name | AppProfileName Required. The unique name of the app profile to be deleted. Values are of
the form
|
callSettings | CallSettings If not null, applies overrides to this RPC call. |
// 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 prof