- 3.11.0 (latest)
- 3.10.0
- 3.9.0
- 3.8.0
- 3.7.0
- 3.6.0
- 3.5.0
- 3.4.0
- 3.3.0
- 3.2.0
- 3.1.0
- 3.0.0
- 2.28.0
- 2.27.0
- 2.26.0
- 2.25.0
- 2.24.0
- 2.23.0
- 2.22.0
- 2.21.0
- 2.20.0
- 2.19.0
- 2.18.0
- 2.17.0
- 2.16.0
- 2.15.0
- 2.14.0
- 2.13.0
- 2.12.0
- 2.11.0
- 2.10.0
- 2.9.0
- 2.8.0
- 2.7.0
- 2.6.0
- 2.5.0
- 2.4.0
- 2.3.0
- 2.2.0
- 2.1.0
- 2.0.0
- 1.8.0
- 1.7.0
- 1.6.0
- 1.5.0
- 1.4.0
- 1.3.0
- 1.2.0
- 1.1.0
- 1.0.0
public abstract class DatasetServiceClient
Reference documentation and code samples for the Cloud AI Platform v1 API class DatasetServiceClient.
DatasetService client wrapper, for convenient use.
Derived Types
Namespace
GoogleCloudGoogle.Cloud.AIPlatformV1Assembly
Google.Cloud.AIPlatform.V1.dll
Remarks
The service that handles the CRUD of Vertex AI Dataset and its child resources.
Properties
CreateDatasetOperationsClient
public virtual OperationsClient CreateDatasetOperationsClient { get; }
The long-running operations client for CreateDataset
.
Property Value | |
---|---|
Type | Description |
OperationsClient |
DefaultEndpoint
public static string DefaultEndpoint { get; }
The default endpoint for the DatasetService service, which is a host of "aiplatform.googleapis.com" and a port of 443.
Property Value | |
---|---|
Type | Description |
string |
DefaultScopes
public static IReadOnlyList<string> DefaultScopes { get; }
The default DatasetService scopes.
Property Value | |
---|---|
Type | Description |
IReadOnlyListstring |
The default DatasetService scopes are:
DeleteDatasetOperationsClient
public virtual OperationsClient DeleteDatasetOperationsClient { get; }
The long-running operations client for DeleteDataset
.
Property Value | |
---|---|
Type | Description |
OperationsClient |
ExportDataOperationsClient
public virtual OperationsClient ExportDataOperationsClient { get; }
The long-running operations client for ExportData
.
Property Value | |
---|---|
Type | Description |
OperationsClient |
GrpcClient
public virtual DatasetService.DatasetServiceClient GrpcClient { get; }
The underlying gRPC DatasetService client
Property Value | |
---|---|
Type | Description |
DatasetServiceDatasetServiceClient |
IAMPolicyClient
public virtual IAMPolicyClient IAMPolicyClient { get; }
The IAMPolicyClient associated with this client.
Property Value | |
---|---|
Type | Description |
IAMPolicyClient |
ImportDataOperationsClient
public virtual OperationsClient ImportDataOperationsClient { get; }
The long-running operations client for ImportData
.
Property Value | |
---|---|
Type | Description |
OperationsClient |
LocationsClient
public virtual LocationsClient LocationsClient { get; }
The LocationsClient associated with this client.
Property Value | |
---|---|
Type | Description |
LocationsClient |
ServiceMetadata
public static ServiceMetadata ServiceMetadata { get; }
The service metadata associated with this client type.
Property Value | |
---|---|
Type | Description |
ServiceMetadata |
Methods
Create()
public static DatasetServiceClient Create()
Synchronously creates a DatasetServiceClient using the default credentials, endpoint and settings. To specify custom credentials or other settings, use DatasetServiceClientBuilder.
Returns | |
---|---|
Type | Description |
DatasetServiceClient | The created DatasetServiceClient. |
CreateAsync(CancellationToken)
public static Task<DatasetServiceClient> CreateAsync(CancellationToken cancellationToken = default)
Asynchronously creates a DatasetServiceClient using the default credentials, endpoint and settings. To specify custom credentials or other settings, use DatasetServiceClientBuilder.
Parameter | |
---|---|
Name | Description |
cancellationToken | CancellationToken The CancellationToken to use while creating the client. |
Returns | |
---|---|
Type | Description |
TaskDatasetServiceClient | The task representing the created DatasetServiceClient. |
CreateDataset(LocationName, Dataset, CallSettings)
public virtual Operation<Dataset, CreateDatasetOperationMetadata> CreateDataset(LocationName parent, Dataset dataset, CallSettings callSettings = null)
Creates a Dataset.
Parameters | |
---|---|
Name | Description |
parent | LocationName Required. The resource name of the Location to create the Dataset in.
Format: |
dataset | Dataset Required. The Dataset to create. |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
OperationDatasetCreateDatasetOperationMetadata | The RPC response. |
// Create client
DatasetServiceClient datasetServiceClient = DatasetServiceClient.Create();
// Initialize request argument(s)
LocationName parent = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]");
Dataset dataset = new Dataset();
// Make the request
Operation<Dataset, CreateDatasetOperationMetadata> response = datasetServiceClient.CreateDataset(parent, dataset);
// Poll until the returned long-running operation is complete
Operation<Dataset, CreateDatasetOperationMetadata> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
Dataset 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<Dataset, CreateDatasetOperationMetadata> retrievedResponse = datasetServiceClient.PollOnceCreateDataset(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
// If it has completed, then access the result
Dataset retrievedResult = retrievedResponse.Result;
}
CreateDataset(CreateDatasetRequest, CallSettings)
public virtual Operation<Dataset, CreateDatasetOperationMetadata> CreateDataset(CreateDatasetRequest request, CallSettings callSettings = null)
Creates a Dataset.
Parameters | |
---|---|
Name | Description |
request | CreateDatasetRequest 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 |
OperationDatasetCreateDatasetOperationMetadata | The RPC response. |
// Create client
DatasetServiceClient datasetServiceClient = DatasetServiceClient.Create();
// Initialize request argument(s)
CreateDatasetRequest request = new CreateDatasetRequest
{
ParentAsLocationName = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]"),
Dataset = new Dataset(),
};
// Make the request
Operation<Dataset, CreateDatasetOperationMetadata> response = datasetServiceClient.CreateDataset(request);
// Poll until the returned long-running operation is complete
Operation<Dataset, CreateDatasetOperationMetadata> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
Dataset 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<Dataset, CreateDatasetOperationMetadata> retrievedResponse = datasetServiceClient.PollOnceCreateDataset(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
// If it has completed, then access the result
Dataset retrievedResult = retrievedResponse.Result;
}
CreateDataset(string, Dataset, CallSettings)
public virtual Operation<Dataset, CreateDatasetOperationMetadata> CreateDataset(string parent, Dataset dataset, CallSettings callSettings = null)
Creates a Dataset.
Parameters | |
---|---|
Name | Description |
parent | string Required. The resource name of the Location to create the Dataset in.
Format: |
dataset | Dataset Required. The Dataset to create. |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
OperationDatasetCreateDatasetOperationMetadata | The RPC response. |
// Create client
DatasetServiceClient datasetServiceClient = DatasetServiceClient.Create();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]";
Dataset dataset = new Dataset();
// Make the request
Operation<Dataset, CreateDatasetOperationMetadata> response = datasetServiceClient.CreateDataset(parent, dataset);
// Poll until the returned long-running operation is complete
Operation<Dataset, CreateDatasetOperationMetadata> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
Dataset 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<Dataset, CreateDatasetOperationMetadata> retrievedResponse = datasetServiceClient.PollOnceCreateDataset(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
// If it has completed, then access the result
Dataset retrievedResult = retrievedResponse.Result;
}
CreateDatasetAsync(LocationName, Dataset, CallSettings)
public virtual Task<Operation<Dataset, CreateDatasetOperationMetadata>> CreateDatasetAsync(LocationName parent, Dataset dataset, CallSettings callSettings = null)
Creates a Dataset.
Parameters | |
---|---|
Name | Description |
parent | LocationName Required. The resource name of the Location to create the Dataset in.
Format: |
dataset | Dataset Required. The Dataset to create. |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
TaskOperationDatasetCreateDatasetOperationMetadata | A Task containing the RPC response. |
// Create client
DatasetServiceClient datasetServiceClient = await DatasetServiceClient.CreateAsync();
// Initialize request argument(s)
LocationName parent = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]");
Dataset dataset = new Dataset();
// Make the request
Operation<Dataset, CreateDatasetOperationMetadata> response = await datasetServiceClient.CreateDatasetAsync(parent, dataset);
// Poll until the returned long-running operation is complete
Operation<Dataset, CreateDatasetOperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Dataset 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<Dataset, CreateDatasetOperationMetadata> retrievedResponse = await datasetServiceClient.PollOnceCreateDatasetAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
// If it has completed, then access the result
Dataset retrievedResult = retrievedResponse.Result;
}
CreateDatasetAsync(LocationName, Dataset, CancellationToken)
public virtual Task<Operation<Dataset, CreateDatasetOperationMetadata>> CreateDatasetAsync(LocationName parent, Dataset dataset, CancellationToken cancellationToken)
Creates a Dataset.
Parameters | |
---|---|
Name | Description |
parent | LocationName Required. The resource name of the Location to create the Dataset in.
Format: |
dataset | Dataset Required. The Dataset to create. |
cancellationToken | CancellationToken A CancellationToken to use for this RPC. |
Returns | |
---|---|
Type | Description |
TaskOperationDatasetCreateDatasetOperationMetadata | A Task containing the RPC response. |
// Create client
DatasetServiceClient datasetServiceClient = await DatasetServiceClient.CreateAsync();
// Initialize request argument(s)
LocationName parent = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]");
Dataset dataset = new Dataset();
// Make the request
Operation<Dataset, CreateDatasetOperationMetadata> response = await datasetServiceClient.CreateDatasetAsync(parent, dataset);
// Poll until the returned long-running operation is complete
Operation<Dataset, CreateDatasetOperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Dataset 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<Dataset, CreateDatasetOperationMetadata> retrievedResponse = await datasetServiceClient.PollOnceCreateDatasetAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
// If it has completed, then access the result
Dataset retrievedResult = retrievedResponse.Result;
}
CreateDatasetAsync(CreateDatasetRequest, CallSettings)
public virtual Task<Operation<Dataset, CreateDatasetOperationMetadata>> CreateDatasetAsync(CreateDatasetRequest request, CallSettings callSettings = null)
Creates a Dataset.
Parameters | |
---|---|
Name | Description |
request | CreateDatasetRequest 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 |
TaskOperationDatasetCreateDatasetOperationMetadata | A Task containing the RPC response. |
// Create client
DatasetServiceClient datasetServiceClient = await DatasetServiceClient.CreateAsync();
// Initialize request argument(s)
CreateDatasetRequest request = new CreateDatasetRequest
{
ParentAsLocationName = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]"),
Dataset = new Dataset(),
};
// Make the request
Operation<Dataset, CreateDatasetOperationMetadata> response = await datasetServiceClient.CreateDatasetAsync(request);
// Poll until the returned long-running operation is complete
Operation<Dataset, CreateDatasetOperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Dataset 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<Dataset, CreateDatasetOperationMetadata> retrievedResponse = await datasetServiceClient.PollOnceCreateDatasetAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
// If it has completed, then access the result
Dataset retrievedResult = retrievedResponse.Result;
}
CreateDatasetAsync(CreateDatasetRequest, CancellationToken)
public virtual Task<Operation<Dataset, CreateDatasetOperationMetadata>> CreateDatasetAsync(CreateDatasetRequest request, CancellationToken cancellationToken)
Creates a Dataset.
Parameters | |
---|---|
Name | Description |
request | CreateDatasetRequest The request object containing all of the parameters for the API call. |
cancellationToken | CancellationToken A CancellationToken to use for this RPC. |
Returns | |
---|---|
Type | Description |
TaskOperationDatasetCreateDatasetOperationMetadata | A Task containing the RPC response. |
// Create client
DatasetServiceClient datasetServiceClient = await DatasetServiceClient.CreateAsync();
// Initialize request argument(s)
CreateDatasetRequest request = new CreateDatasetRequest
{
ParentAsLocationName = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]"),
Dataset = new Dataset(),
};
// Make the request
Operation<Dataset, CreateDatasetOperationMetadata> response = await datasetServiceClient.CreateDatasetAsync(request);
// Poll until the returned long-running operation is complete
Operation<Dataset, CreateDatasetOperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Dataset 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<Dataset, CreateDatasetOperationMetadata> retrievedResponse = await datasetServiceClient.PollOnceCreateDatasetAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
// If it has completed, then access the result
Dataset retrievedResult = retrievedResponse.Result;
}
CreateDatasetAsync(string, Dataset, CallSettings)
public virtual Task<Operation<Dataset, CreateDatasetOperationMetadata>> CreateDatasetAsync(string parent, Dataset dataset, CallSettings callSettings = null)
Creates a Dataset.
Parameters | |
---|---|
Name | Description |
parent | string Required. The resource name of the Location to create the Dataset in.
Format: |
dataset | Dataset Required. The Dataset to create. |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
TaskOperationDatasetCreateDatasetOperationMetadata | A Task containing the RPC response. |
// Create client
DatasetServiceClient datasetServiceClient = await DatasetServiceClient.CreateAsync();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]";
Dataset dataset = new Dataset();
// Make the request
Operation<Dataset, CreateDatasetOperationMetadata> response = await datasetServiceClient.CreateDatasetAsync(parent, dataset);
// Poll until the returned long-running operation is complete
Operation<Dataset, CreateDatasetOperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Dataset 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<Dataset, CreateDatasetOperationMetadata> retrievedResponse = await datasetServiceClient.PollOnceCreateDatasetAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
// If it has completed, then access the result
Dataset retrievedResult = retrievedResponse.Result;
}
CreateDatasetAsync(string, Dataset, CancellationToken)
public virtual Task<Operation<Dataset, CreateDatasetOperationMetadata>> CreateDatasetAsync(string parent, Dataset dataset, CancellationToken cancellationToken)
Creates a Dataset.
Parameters | |
---|---|
Name | Description |
parent | string Required. The resource name of the Location to create the Dataset in.
Format: |
dataset | Dataset Required. The Dataset to create. |
cancellationToken | CancellationToken |