Google Cloud Dialogflow v2 API - Class ConversationDatasetsClient (4.25.0)

public abstract class ConversationDatasetsClient

Reference documentation and code samples for the Google Cloud Dialogflow v2 API class ConversationDatasetsClient.

ConversationDatasets client wrapper, for convenient use.

Inheritance

object > ConversationDatasetsClient

Namespace

Google.Cloud.Dialogflow.V2

Assembly

Google.Cloud.Dialogflow.V2.dll

Remarks

Conversation datasets.

Conversation datasets contain raw conversation files and their customizable metadata that can be used for model training.

Properties

CreateConversationDatasetOperationsClient

public virtual OperationsClient CreateConversationDatasetOperationsClient { get; }

The long-running operations client for CreateConversationDataset.

Property Value
Type Description
OperationsClient

DefaultEndpoint

public static string DefaultEndpoint { get; }

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

Property Value
Type Description
string

DefaultScopes

public static IReadOnlyList<string> DefaultScopes { get; }

The default ConversationDatasets scopes.

Property Value
Type Description
IReadOnlyListstring
Remarks

DeleteConversationDatasetOperationsClient

public virtual OperationsClient DeleteConversationDatasetOperationsClient { get; }

The long-running operations client for DeleteConversationDataset.

Property Value
Type Description
OperationsClient

GrpcClient

public virtual ConversationDatasets.ConversationDatasetsClient GrpcClient { get; }

The underlying gRPC ConversationDatasets client

Property Value
Type Description
ConversationDatasetsConversationDatasetsClient

ImportConversationDataOperationsClient

public virtual OperationsClient ImportConversationDataOperationsClient { get; }

The long-running operations client for ImportConversationData.

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 ConversationDatasetsClient Create()

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

Returns
Type Description
ConversationDatasetsClient

The created ConversationDatasetsClient.

CreateAsync(CancellationToken)

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

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

Parameter
Name Description
cancellationToken CancellationToken

The CancellationToken to use while creating the client.

Returns
Type Description
TaskConversationDatasetsClient

The task representing the created ConversationDatasetsClient.

CreateConversationDataset(CreateConversationDatasetRequest, CallSettings)

public virtual Operation<ConversationDataset, CreateConversationDatasetOperationMetadata> CreateConversationDataset(CreateConversationDatasetRequest request, CallSettings callSettings = null)

Creates a new conversation dataset.

This method is a long-running operation. The returned Operation type has the following method-specific fields:

  • metadata: [CreateConversationDatasetOperationMetadata][google.cloud.dialogflow.v2.CreateConversationDatasetOperationMetadata]
  • response: [ConversationDataset][google.cloud.dialogflow.v2.ConversationDataset]
Parameters
Name Description
request CreateConversationDatasetRequest

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
OperationConversationDatasetCreateConversationDatasetOperationMetadata

The RPC response.

Example
// Create client
ConversationDatasetsClient conversationDatasetsClient = ConversationDatasetsClient.Create();
// Initialize request argument(s)
CreateConversationDatasetRequest request = new CreateConversationDatasetRequest
{
    Parent = "",
    ConversationDataset = new ConversationDataset(),
};
// Make the request
Operation<ConversationDataset, CreateConversationDatasetOperationMetadata> response = conversationDatasetsClient.CreateConversationDataset(request);

// Poll until the returned long-running operation is complete
Operation<ConversationDataset, CreateConversationDatasetOperationMetadata> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
ConversationDataset 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<ConversationDataset, CreateConversationDatasetOperationMetadata> retrievedResponse = conversationDatasetsClient.PollOnceCreateConversationDataset(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    ConversationDataset retrievedResult = retrievedResponse.Result;
}

CreateConversationDataset(string, ConversationDataset, CallSettings)

public virtual Operation<ConversationDataset, CreateConversationDatasetOperationMetadata> CreateConversationDataset(string parent, ConversationDataset conversationDataset, CallSettings callSettings = null)

Creates a new conversation dataset.

This method is a long-running operation. The returned Operation type has the following method-specific fields:

  • metadata: [CreateConversationDatasetOperationMetadata][google.cloud.dialogflow.v2.CreateConversationDatasetOperationMetadata]
  • response: [ConversationDataset][google.cloud.dialogflow.v2.ConversationDataset]
Parameters
Name Description
parent string

Required. The project to create conversation dataset for. Format: projects/<Project ID>/locations/<Location ID>

conversationDataset ConversationDataset

Required. The conversation dataset to create.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
OperationConversationDatasetCreateConversationDatasetOperationMetadata

The RPC response.

Example
// Create client
ConversationDatasetsClient conversationDatasetsClient = ConversationDatasetsClient.Create();
// Initialize request argument(s)
string parent = "";
ConversationDataset conversationDataset = new ConversationDataset();
// Make the request
Operation<ConversationDataset, CreateConversationDatasetOperationMetadata> response = conversationDatasetsClient.CreateConversationDataset(parent, conversationDataset);

// Poll until the returned long-running operation is complete
Operation<ConversationDataset, CreateConversationDatasetOperationMetadata> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
ConversationDataset 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<ConversationDataset, CreateConversationDatasetOperationMetadata> retrievedResponse = conversationDatasetsClient.PollOnceCreateConversationDataset(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    ConversationDataset retrievedResult = retrievedResponse.Result;
}

CreateConversationDatasetAsync(CreateConversationDatasetRequest, CallSettings)

public virtual Task<Operation<ConversationDataset, CreateConversationDatasetOperationMetadata>> CreateConversationDatasetAsync(CreateConversationDatasetRequest request, CallSettings callSettings = null)

Creates a new conversation dataset.

This method is a long-running operation. The returned Operation type has the following method-specific fields:

  • metadata: [CreateConversationDatasetOperationMetadata][google.cloud.dialogflow.v2.CreateConversationDatasetOperationMetadata]
  • response: [ConversationDataset][google.cloud.dialogflow.v2.ConversationDataset]
Parameters
Name Description
request CreateConversationDatasetRequest

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
TaskOperationConversationDatasetCreateConversationDatasetOperationMetadata

A Task containing the RPC response.

Example
// Create client
ConversationDatasetsClient conversationDatasetsClient = await ConversationDatasetsClient.CreateAsync();
// Initialize request argument(s)
CreateConversationDatasetRequest request = new CreateConversationDatasetRequest
{
    Parent = "",
    ConversationDataset = new ConversationDataset(),
};
// Make the request
Operation<ConversationDataset, CreateConversationDatasetOperationMetadata> response = await conversationDatasetsClient.CreateConversationDatasetAsync(request);

// Poll until the returned long-running operation is complete
Operation<ConversationDataset, CreateConversationDatasetOperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
ConversationDataset 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<ConversationDataset, CreateConversationDatasetOperationMetadata> retrievedResponse = await conversationDatasetsClient.PollOnceCreateConversationDatasetAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    ConversationDataset retrievedResult = retrievedResponse.Result;
}

CreateConversationDatasetAsync(CreateConversationDatasetRequest, CancellationToken)

public virtual Task<Operation<ConversationDataset, CreateConversationDatasetOperationMetadata>> CreateConversationDatasetAsync(CreateConversationDatasetRequest request, CancellationToken cancellationToken)

Creates a new conversation dataset.

This method is a long-running operation. The returned Operation type has the following method-specific fields:

  • metadata: [CreateConversationDatasetOperationMetadata][google.cloud.dialogflow.v2.CreateConversationDatasetOperationMetadata]
  • response: [ConversationDataset][google.cloud.dialogflow.v2.ConversationDataset]
Parameters
Name Description
request CreateConversationDatasetRequest

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

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskOperationConversationDatasetCreateConversationDatasetOperationMetadata

A Task containing the RPC response.

Example
// Create client
ConversationDatasetsClient conversationDatasetsClient = await ConversationDatasetsClient.CreateAsync();
// Initialize request argument(s)
CreateConversationDatasetRequest request = new CreateConversationDatasetRequest
{
    Parent = "",
    ConversationDataset = new ConversationDataset(),
};
// Make the request
Operation<ConversationDataset, CreateConversationDatasetOperationMetadata> response = await conversationDatasetsClient.CreateConversationDatasetAsync(request);

// Poll until the returned long-running operation is complete
Operation<ConversationDataset, CreateConversationDatasetOperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
ConversationDataset 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<ConversationDataset, CreateConversationDatasetOperationMetadata> retrievedResponse = await conversationDatasetsClient.PollOnceCreateConversationDatasetAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    ConversationDataset retrievedResult = retrievedResponse.Result;
}

CreateConversationDatasetAsync(string, ConversationDataset, CallSettings)

public virtual Task<Operation<ConversationDataset, CreateConversationDatasetOperationMetadata>> CreateConversationDatasetAsync(string parent, ConversationDataset conversationDataset, CallSettings callSettings = null)

Creates a new conversation dataset.

This method is a long-running operation. The returned Operation type has the following method-specific fields:

  • metadata: [CreateConversationDatasetOperationMetadata][google.cloud.dialogflow.v2.CreateConversationDatasetOperationMetadata]
  • response: [ConversationDataset][google.cloud.dialogflow.v2.ConversationDataset]
Parameters
Name Description
parent string

Required. The project to create conversation dataset for. Format: projects/<Project ID>/locations/<Location ID>

conversationDataset ConversationDataset

Required. The conversation dataset to create.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskOperationConversationDatasetCreateConversationDatasetOperationMetadata

A Task containing the RPC response.

Example
// Create client
ConversationDatasetsClient conversationDatasetsClient = await ConversationDatasetsClient.CreateAsync();
// Initialize request argument(s)
string parent = "";
ConversationDataset conversationDataset = new ConversationDataset();
// Make the request
Operation<ConversationDataset, CreateConversationDatasetOperationMetadata> response = await conversationDatasetsClient.CreateConversationDatasetAsync(parent, conversationDataset);

// Poll until the returned long-running operation is complete
Operation<ConversationDataset, CreateConversationDatasetOperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
ConversationDataset 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<ConversationDataset, CreateConversationDatasetOperationMetadata> retrievedResponse = await conversationDatasetsClient.PollOnceCreateConversationDatasetAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    ConversationDataset retrievedResult = retrievedResponse.Result;
}

CreateConversationDatasetAsync(string, ConversationDataset, CancellationToken)

public virtual Task<Operation<ConversationDataset, CreateConversationDatasetOperationMetadata>> CreateConversationDatasetAsync(string parent, ConversationDataset conversationDataset, CancellationToken cancellationToken)

Creates a new conversation dataset.

This method is a long-running operation. The returned Operation type has the following method-specific fields:

  • metadata: [CreateConversationDatasetOperationMetadata][google.cloud.dialogflow.v2.CreateConversationDatasetOperationMetadata]
  • response: [ConversationDataset][google.cloud.dialogflow.v2.ConversationDataset]
Parameters
Name Description
parent string

Required. The project to create conversation dataset for. Format: projects/<Project ID>/locations/<Location ID>

conversationDataset ConversationDataset

Required. The conversation dataset to create.

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskOperationConversationDatasetCreateConversationDatasetOperationMetadata

A Task containing the RPC response.

Example
// Create client
ConversationDatasetsClient conversationDatasetsClient = await ConversationDatasetsClient.CreateAsync();
// Initialize request argument(s)
string parent = "";
ConversationDataset conversationDataset = new ConversationDataset();
// Make the request
Operation<ConversationDataset, CreateConversationDatasetOperationMetadata> response = await conversationDatasetsClient.CreateConversationDatasetAsync(parent, conversationDataset);

// Poll until the returned long-running operation is complete
Operation<ConversationDataset, CreateConversationDatasetOperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
ConversationDataset 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<ConversationDataset, CreateConversationDatasetOperationMetadata> retrievedResponse = await conversationDatasetsClient.PollOnceCreateConversationDatasetAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    ConversationDataset retrievedResult = retrievedResponse.Result;
}

DeleteConversationDataset(ConversationDatasetName, CallSettings)

public virtual Operation<Empty, DeleteConversationDatasetOperationMetadata> DeleteConversationDataset(ConversationDatasetName name, CallSettings callSettings = null)

Deletes the specified conversation dataset.

This method is a long-running operation. The returned Operation type has the following method-specific fields:

  • metadata: [DeleteConversationDatasetOperationMetadata][google.cloud.dialogflow.v2.DeleteConversationDatasetOperationMetadata]
  • response: An Empty message
Parameters
Name Description
name ConversationDatasetName

Required. The conversation dataset to delete. Format: projects/<Project ID>/locations/<Location ID>/conversationDatasets/<Conversation Dataset ID>

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
OperationEmptyDeleteConversationDatasetOperationMetadata

The RPC response.

Example
// Create client
ConversationDatasetsClient conversationDatasetsClient = ConversationDatasetsClient.Create();
// Initialize request argument(s)
ConversationDatasetName name = ConversationDatasetName.FromProjectLocationConversationDataset("[PROJECT]", "[LOCATION]", "[CONVERSATION_DATASET]");
// Make the request
Operation<Empty, DeleteConversationDatasetOperationMetadata> response = conversationDatasetsClient.DeleteConversationDataset(name);

// Poll until the returned long-running operation is complete
Operation<Empty, DeleteConversationDatasetOperationMetadata> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
Empty 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<Empty, DeleteConversationDatasetOperationMetadata> retrievedResponse = conversationDatasetsClient.PollOnceDeleteConversationDataset(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Empty retrievedResult = retrievedResponse.Result;
}

DeleteConversationDataset(DeleteConversationDatasetRequest, CallSettings)

public virtual Operation<Empty, DeleteConversationDatasetOperationMetadata> DeleteConversationDataset(DeleteConversationDatasetRequest request, CallSettings callSettings = null)

Deletes the specified conversation dataset.

This method is a long-running operation. The returned Operation type has the following method-specific fields:

  • metadata: [DeleteConversationDatasetOperationMetadata][google.cloud.dialogflow.v2.DeleteConversationDatasetOperationMetadata]
  • response: An Empty message
Parameters
Name Description
request DeleteConversationDatasetRequest

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
OperationEmptyDeleteConversationDatasetOperationMetadata

The RPC response.

Example
// Create client
ConversationDatasetsClient conversationDatasetsClient = ConversationDatasetsClient.Create();
// Initialize request argument(s)
DeleteConversationDatasetRequest request = new DeleteConversationDatasetRequest
{
    ConversationDatasetName = ConversationDatasetName.FromProjectLocationConversationDataset("[PROJECT]", "[LOCATION]", "[CONVERSATION_DATASET]"),
};
// Make the request
Operation<Empty, DeleteConversationDatasetOperationMetadata> response = conversationDatasetsClient.DeleteConversationDataset(request);

// Poll until the returned long-running operation is complete
Operation<Empty, DeleteConversationDatasetOperationMetadata> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
Empty 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<Empty, DeleteConversationDatasetOperationMetadata> retrievedResponse = conversationDatasetsClient.PollOnceDeleteConversationDataset(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Empty retrievedResult = retrievedResponse.Result;
}

DeleteConversationDataset(string, CallSettings)

public virtual Operation<Empty, DeleteConversationDatasetOperationMetadata> DeleteConversationDataset(string name, CallSettings callSettings = null)

Deletes the specified conversation dataset.

This method is a long-running operation. The returned Operation type has the following method-specific fields:

  • metadata: [DeleteConversationDatasetOperationMetadata][google.cloud.dialogflow.v2.DeleteConversationDatasetOperationMetadata]
  • response: An Empty message
Parameters
Name Description
name string

Required. The conversation dataset to delete. Format: projects/<Project ID>/locations/<Location ID>/conversationDatasets/<Conversation Dataset ID>

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
OperationEmptyDeleteConversationDatasetOperationMetadata

The RPC response.

Example
// Create client
ConversationDatasetsClient conversationDatasetsClient = ConversationDatasetsClient.Create();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/conversationDatasets/[CONVERSATION_DATASET]";
// Make the request
Operation<Empty, DeleteConversationDatasetOperationMetadata> response = conversationDatasetsClient.DeleteConversationDataset(name);

// Poll until the returned long-running operation is complete
Operation<Empty, DeleteConversationDatasetOperationMetadata> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
Empty 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<Empty, DeleteConversationDatasetOperationMetadata> retrievedResponse = conversationDatasetsClient.PollOnceDeleteConversationDataset(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Empty retrievedResult = retrievedResponse.Result;
}

DeleteConversationDatasetAsync(ConversationDatasetName, CallSettings)

public virtual Task<Operation<Empty, DeleteConversationDatasetOperationMetadata>> DeleteConversationDatasetAsync(ConversationDatasetName name, CallSettings callSettings = null)

Deletes the specified conversation dataset.

This method is a long-running operation. The returned Operation type has the following method-specific fields:

  • metadata: [DeleteConversationDatasetOperationMetadata][google.cloud.dialogflow.v2.DeleteConversationDatasetOperationMetadata]
  • response: An Empty message
Parameters
Name Description
name ConversationDatasetName

Required. The conversation dataset to delete. Format: projects/<Project ID>/locations/<Location ID>/conversationDatasets/<Conversation Dataset ID>

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskOperationEmptyDeleteConversationDatasetOperationMetadata

A Task containing the RPC response.

Example
// Create client
ConversationDatasetsClient conversationDatasetsClient = await ConversationDatasetsClient.CreateAsync();
// Initialize request argument(s)
ConversationDatasetName name = ConversationDatasetName.FromProjectLocationConversationDataset("[PROJECT]", "[LOCATION]", "[CONVERSATION_DATASET]");
// Make the request
Operation<Empty, DeleteConversationDatasetOperationMetadata> response = await conversationDatasetsClient.DeleteConversationDatasetAsync(name);

// Poll until the returned long-running operation is complete
Operation<Empty, DeleteConversationDatasetOperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Empty 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<Empty, DeleteConversationDatasetOperationMetadata> retrievedResponse = await conversationDatasetsClient.PollOnceDeleteConversationDatasetAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Empty retrievedResult = retrievedResponse.Result;
}

DeleteConversationDatasetAsync(ConversationDatasetName, CancellationToken)

public virtual Task<Operation<Empty, DeleteConversationDatasetOperationMetadata>> DeleteConversationDatasetAsync(ConversationDatasetName name, CancellationToken cancellationToken)

Deletes the specified conversation dataset.

This method is a long-running operation. The returned Operation type has the following method-specific fields:

  • metadata: [DeleteConversationDatasetOperationMetadata][google.cloud.dialogflow.v2.DeleteConversationDatasetOperationMetadata]
  • response: An Empty message
Parameters
Name Description
name ConversationDatasetName

Required. The conversation dataset to delete. Format: projects/<Project ID>/locations/<Location ID>/conversationDatasets/<Conversation Dataset ID>

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskOperationEmptyDeleteConversationDatasetOperationMetadata

A Task containing the RPC response.

Example
// Create client
ConversationDatasetsClient conversationDatasetsClient = await ConversationDatasetsClient.CreateAsync();
// Initialize request argument(s)
ConversationDatasetName name = ConversationDatasetName.FromProjectLocationConversationDataset("[PROJECT]", "[LOCATION]", "[CONVERSATION_DATASET]");
// Make the request
Operation<Empty, DeleteConversationDatasetOperationMetadata> response = await conversationDatasetsClient.DeleteConversationDatasetAsync(name);

// Poll until the returned long-running operation is complete
Operation<Empty, DeleteConversationDatasetOperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Empty 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<Empty, DeleteConversationDatasetOperationMetadata> retrievedResponse = await conversationDatasetsClient.PollOnceDeleteConversationDatasetAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Empty retrievedResult = retrievedResponse.Result;
}

DeleteConversationDatasetAsync(DeleteConversationDatasetRequest, CallSettings)

public virtual Task<Operation<Empty, DeleteConversationDatasetOperationMetadata>> DeleteConversationDatasetAsync(DeleteConversationDatasetRequest request, CallSettings callSettings = null)

Deletes the specified conversation dataset.

This method is a long-running operation. The returned Operation type has the following method-specific fields:

  • metadata: [DeleteConversationDatasetOperationMetadata][google.cloud.dialogflow.v2.DeleteConversationDatasetOperationMetadata]
  • response: An Empty message
Parameters
Name Description
request DeleteConversationDatasetRequest

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
TaskOperationEmptyDeleteConversationDatasetOperationMetadata

A Task containing the RPC response.

Example
// Create client
ConversationDatasetsClient conversationDatasetsClient = await ConversationDatasetsClient.CreateAsync();
// Initialize request argument(s)
DeleteConversationDatasetRequest request = new DeleteConversationDatasetRequest
{
    ConversationDatasetName = ConversationDatasetName.FromProjectLocationConversationDataset("[PROJECT]", "[LOCATION]", "[CONVERSATION_DATASET]"),
};
// Make the request
Operation<Empty, DeleteConversationDatasetOperationMetadata> response = await conversationDatasetsClient.DeleteConversationDatasetAsync(request);

// Poll until the returned long-running operation is complete
Operation<Empty, DeleteConversationDatasetOperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Empty 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<Empty, DeleteConversationDatasetOperationMetadata> retrievedResponse = await conversationDatasetsClient.PollOnceDeleteConversationDatasetAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Empty retrievedResult = retrievedResponse.Result;
}

DeleteConversationDatasetAsync(DeleteConversationDatasetRequest, CancellationToken)

public virtual Task<Operation<Empty, DeleteConversationDatasetOperationMetadata>> DeleteConversationDatasetAsync(DeleteConversationDatasetRequest request, CancellationToken cancellationToken)

Deletes the specified conversation dataset.

This method is a long-running operation. The returned Operation type has the following method-specific fields:

  • metadata: [DeleteConversationDatasetOperationMetadata][google.cloud.dialogflow.v2.DeleteConversationDatasetOperationMetadata]
  • response: An Empty message
Parameters
Name Description
request DeleteConversationDatasetRequest

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

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskOperationEmptyDeleteConversationDatasetOperationMetadata

A Task containing the RPC response.

Example
// Create client
ConversationDatasetsClient conversationDatasetsClient = await ConversationDatasetsClient.CreateAsync();
// Initialize request argument(s)
DeleteConversationDatasetRequest request = new DeleteConversationDatasetRequest
{
    ConversationDatasetName = ConversationDatasetName.FromProjectLocationConversationDataset("[PROJECT]", "[LOCATION]", "[CONVERSATION_DATASET]"),
};
// Make the request
Operation<Empty, DeleteConversationDatasetOperationMetadata> response = await conversationDatasetsClient.DeleteConversationDatasetAsync(request);

// Poll until the returned long-running operation is complete
Operation<Empty, DeleteConversationDatasetOperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Empty 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<Empty, DeleteConversationDatasetOperationMetadata> retrievedResponse = await conversationDatasetsClient.PollOnceDeleteConversationDatasetAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Empty retrievedResult = retrievedResponse.Result;
}

DeleteConversationDatasetAsync(string, CallSettings)

public virtual Task<Operation<Empty, DeleteConversationDatasetOperationMetadata>> DeleteConversationDatasetAsync(string name, CallSettings callSettings = null)

Deletes the specified conversation dataset.

This method is a long-running operation. The returned Operation type has the following method-specific fields:

  • metadata: [DeleteConversationDatasetOperationMetadata][google.cloud.dialogflow.v2.DeleteConversationDatasetOperationMetadata]
  • response: An Empty message
Parameters
Name Description
name string

Required. The conversation dataset to delete. Format: projects/<Project ID>/locations/<Location ID>/conversationDatasets/<Conversation Dataset ID>

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskOperationEmptyDeleteConversationDatasetOperationMetadata

A Task containing the RPC response.

Example
// Create client
ConversationDatasetsClient conversationDatasetsClient = await ConversationDatasetsClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/conversationDatasets/[CONVERSATION_DATASET]";
// Make the request
Operation<Empty, DeleteConversationDatasetOperationMetadata> response = await conversationDatasetsClient.DeleteConversationDatasetAsync(name);

// Poll until the returned long-running operation is complete
Operation<Empty, DeleteConversationDatasetOperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Empty 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<Empty, DeleteConversationDatasetOperationMetadata> retrievedResponse = await conversationDatasetsClient.PollOnceDeleteConversationDatasetAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Empty retrievedResult = retrievedResponse.Result;
}

DeleteConversationDatasetAsync(string, CancellationToken)

public virtual Task<Operation<Empty, DeleteConversationDatasetOperationMetadata>> DeleteConversationDatasetAsync(string name, CancellationToken cancellationToken)

Deletes the specified conversation dataset.

This method is a long-running operation. The returned Operation type has the following method-specific fields:

  • metadata: [DeleteConversationDatasetOperationMetadata][google.cloud.dialogflow.v2.DeleteConversationDatasetOperationMetadata]
  • response: An Empty message
Parameters
Name Description
name string

Required. The conversation dataset to delete. Format: projects/<Project ID>/locations/<Location ID>/conversationDatasets/<Conversation Dataset ID>

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskOperationEmptyDeleteConversationDatasetOperationMetadata

A Task containing the RPC response.

Example
// Create client
ConversationDatasetsClient conversationDatasetsClient = await ConversationDatasetsClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/conversationDatasets/[CONVERSATION_DATASET]";
// Make the request
Operation<Empty, DeleteConversationDatasetOperationMetadata> response = await conversationDatasetsClient.DeleteConversationDatasetAsync(name);

// Poll until the returned long-running operation is complete
Operation<Empty, DeleteConversationDatasetOperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Empty 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<Empty, DeleteConversationDatasetOperationMetadata> retrievedResponse = await conversationDatasetsClient.PollOnceDeleteConversationDatasetAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Empty retrievedResult = retrievedResponse.Result;
}

GetConversationDataset(ConversationDatasetName, CallSettings)

public virtual ConversationDataset GetConversationDataset(ConversationDatasetName name, CallSettings callSettings = null)

Retrieves the specified conversation dataset.

Parameters
Name Description
name ConversationDatasetName

Required. The conversation dataset to retrieve. Format: projects/<Project ID>/locations/<Location ID>/conversationDatasets/<Conversation Dataset ID>

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
ConversationDataset

The RPC response.

Example
// Create client
ConversationDatasetsClient conversationDatasetsClient = ConversationDatasetsClient.Create();
// Initialize request argument(s)
ConversationDatasetName name = ConversationDatasetName.FromProjectLocationConversationDataset("[PROJECT]", "[LOCATION]", "[CONVERSATION_DATASET]");
// Make the request
ConversationDataset response = conversationDatasetsClient.GetConversationDataset(name);

GetConversationDataset(GetConversationDatasetRequest, CallSettings)

public virtual ConversationDataset GetConversationDataset(GetConversationDatasetRequest request, CallSettings callSettings = null)

Retrieves the specified conversation dataset.

Parameters
Name Description
request GetConversationDatasetRequest

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
ConversationDataset

The RPC response.

Example
// Create client
ConversationDatasetsClient conversationDatasetsClient = ConversationDatasetsClient.Create();
// Initialize request argument(s)
GetConversationDatasetRequest request = new GetConversationDatasetRequest
{
    ConversationDatasetName = ConversationDatasetName.FromProjectLocationConversationDataset("[PROJECT]", "[LOCATION]", "[CONVERSATION_DATASET]"),
};
// Make the request
ConversationDataset response = conversationDatasetsClient.GetConversationDataset(request);

GetConversationDataset(string, CallSettings)

public virtual ConversationDataset GetConversationDataset(string name, CallSettings callSettings = null)

Retrieves the specified conversation dataset.

Parameters
Name Description
name string

Required. The conversation dataset to retrieve. Format: projects/<Project ID>/locations/<Location ID>/conversationDatasets/<Conversation Dataset ID>

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
ConversationDataset

The RPC response.

Example
// Create client
ConversationDatasetsClient conversationDatasetsClient = ConversationDatasetsClient.Create();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/conversationDatasets/[CONVERSATION_DATASET]";
// Make the request
ConversationDataset response = conversationDatasetsClient.GetConversationDataset(name);

GetConversationDatasetAsync(ConversationDatasetName, CallSettings)

public virtual Task<ConversationDataset> GetConversationDatasetAsync(ConversationDatasetName name, CallSettings callSettings = null)

Retrieves the specified conversation dataset.

Parameters
Name Description
name ConversationDatasetName

Required. The conversation dataset to retrieve. Format: projects/<Project ID>/locations/<Location ID>/conversationDatasets/<Conversation Dataset ID>

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskConversationDataset

A Task containing the RPC response.

Example
// Create client
ConversationDatasetsClient conversationDatasetsClient = await ConversationDatasetsClient.CreateAsync();
// Initialize request argument(s)
ConversationDatasetName name = ConversationDatasetName.FromProjectLocationConversationDataset("[PROJECT]", "[LOCATION]", "[CONVERSATION_DATASET]");
// Make the request
ConversationDataset response = await conversationDatasetsClient.GetConversationDatasetAsync(name);

GetConversationDatasetAsync(ConversationDatasetName, CancellationToken)

public virtual Task<ConversationDataset> GetConversationDatasetAsync(ConversationDatasetName name, CancellationToken cancellationToken)

Retrieves the specified conversation dataset.

Parameters
Name Description
name ConversationDatasetName

Required. The conversation dataset to retrieve. Format: projects/<Project ID>/locations/<Location ID>/conversationDatasets/<Conversation Dataset ID>

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskConversationDataset

A Task containing the RPC response.

Example
// Create client
ConversationDatasetsClient conversationDatasetsClient = await ConversationDatasetsClient.CreateAsync();
// Initialize request argument(s)
ConversationDatasetName name = ConversationDatasetName.FromProjectLocationConversationDataset("[PROJECT]", "[LOCATION]", "[CONVERSATION_DATASET]");
// Make the request
ConversationDataset response = await conversationDatasetsClient.GetConversationDatasetAsync(name);

GetConversationDatasetAsync(GetConversationDatasetRequest, CallSettings)

public virtual Task<ConversationDataset> GetConversationDatasetAsync(GetConversationDatasetRequest request, CallSettings callSettings = null)

Retrieves the specified conversation dataset.

Parameters
Name Description
request GetConversationDatasetRequest

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
TaskConversationDataset

A Task containing the RPC response.

Example
// Create client
ConversationDatasetsClient conversationDatasetsClient = await ConversationDatasetsClient.CreateAsync();
// Initialize request argument(s)
GetConversationDatasetRequest request = new GetConversationDatasetRequest
{
    ConversationDatasetName = ConversationDatasetName.FromProjectLocationConversationDataset("[PROJECT]", "[LOCATION]", "[CONVERSATION_DATASET]"),
};
// Make the request
ConversationDataset response = await conversationDatasetsClient.GetConversationDatasetAsync(request);

GetConversationDatasetAsync(GetConversationDatasetRequest, CancellationToken)

public virtual Task<ConversationDataset> GetConversationDatasetAsync(GetConversationDatasetRequest request, CancellationToken cancellationToken)

Retrieves the specified conversation dataset.

Parameters
Name Description
request GetConversationDatasetRequest

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

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskConversationDataset

A Task containing the RPC response.

Example
// Create client
ConversationDatasetsClient conversationDatasetsClient = await ConversationDatasetsClient.CreateAsync();
// Initialize request argument(s)
GetConversationDatasetRequest request = new GetConversationDatasetRequest
{
    ConversationDatasetName = ConversationDatasetName.FromProjectLocationConversationDataset("[PROJECT]", "[LOCATION]", "[CONVERSATION_DATASET]"),
};
// Make the request
ConversationDataset response = await conversationDatasetsClient.GetConversationDatasetAsync(request);

GetConversationDatasetAsync(string, CallSettings)

public virtual Task<ConversationDataset> GetConversationDatasetAsync(string name, CallSettings callSettings = null)

Retrieves the specified conversation dataset.

Parameters
Name Description
name string

Required. The conversation dataset to retrieve. Format: projects/<Project ID>/locations/<Location ID>/conversationDatasets/<Conversation Dataset ID>

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskConversationDataset

A Task containing the RPC response.

Example
// Create client
ConversationDatasetsClient conversationDatasetsClient = await ConversationDatasetsClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/conversationDatasets/[CONVERSATION_DATASET]";
// Make the request
ConversationDataset response = await conversationDatasetsClient.GetConversationDatasetAsync(name);

GetConversationDatasetAsync(string, CancellationToken)

public virtual Task<ConversationDataset> GetConversationDatasetAsync(string name, CancellationToken cancellationToken)

Retrieves the specified conversation dataset.

Parameters
Name Description
name string

Required. The conversation dataset to retrieve. Format: projects/<Project ID>/locations/<Location ID>/conversationDatasets/<Conversation Dataset ID>

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskConversationDataset

A Task containing the RPC response.

Example
// Create client
ConversationDatasetsClient conversationDatasetsClient = await ConversationDatasetsClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/conversationDatasets/[CONVERSATION_DATASET]";
// Make the request
ConversationDataset response = await conversationDatasetsClient.GetConversationDatasetAsync(name);

ImportConversationData(ImportConversationDataRequest, CallSettings)

public virtual Operation<ImportConversationDataOperationResponse, ImportConversationDataOperationMetadata> ImportConversationData(ImportConversationDataRequest request, CallSettings callSettings = null)

Import data into the specified conversation dataset. Note that it is not allowed to import data to a conversation dataset that already has data in it.

This method is a long-running operation. The returned Operation type has the following method-specific fields:

  • metadata: [ImportConversationDataOperationMetadata][google.cloud.dialogflow.v2.ImportConversationDataOperationMetadata]
  • response: [ImportConversationDataOperationResponse][google.cloud.dialogflow.v2.ImportConversationDataOperationResponse]
Parameters
Name Description
request ImportConversationDataRequest

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
OperationImportConversationDataOperationResponseImportConversationDataOperationMetadata

The RPC response.

Example
// Create client
ConversationDatasetsClient conversationDatasetsClient = ConversationDatasetsClient.Create();
// Initialize request argument(s)
ImportConversationDataRequest request = new ImportConversationDataRequest
{
    ConversationDatasetName = ConversationDatasetName.FromProjectLocationConversationDataset("[PROJECT]", "[LOCATION]", "[CONVERSATION_DATASET]"),
    InputConfig = new InputConfig(),
};
// Make the request
Operation<ImportConversationDataOperationResponse, ImportConversationDataOperationMetadata> response = conversationDatasetsClient.ImportConversationData(request);

// Poll until the returned long-running operation is complete
Operation<ImportConversationDataOperationResponse, ImportConversationDataOperationMetadata> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
ImportConversationDataOperationResponse 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<ImportConversationDataOperationResponse, ImportConversationDataOperationMetadata> retrievedResponse = conversationDatasetsClient.PollOnceImportConversationData(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    ImportConversationDataOperationResponse retrievedResult = retrievedResponse.Result;
}

ImportConversationDataAsync(ImportConversationDataRequest, CallSettings)

public virtual Task<Operation<ImportConversationDataOperationResponse, ImportConversationDataOperationMetadata>> ImportConversationDataAsync(ImportConversationDataRequest request, CallSettings callSettings = null)

Import data into the specified conversation dataset. Note that it is not allowed to import data to a conversation dataset that already has data in it.

This method is a long-running operation. The returned Operation type has the following method-specific fields:

  • metadata: [ImportConversationDataOperationMetadata][google.cloud.dialogflow.v2.ImportConversationDataOperationMetadata]
  • response: [ImportConversationDataOperationResponse][google.cloud.dialogflow.v2.ImportConversationDataOperationResponse]
Parameters
Name Description
request ImportConversationDataRequest

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
TaskOperationImportConversationDataOperationResponseImportConversationDataOperationMetadata

A Task containing the RPC response.

Example
// Create client
ConversationDatasetsClient conversationDatasetsClient = await ConversationDatasetsClient.CreateAsync();
// Initialize request argument(s)
ImportConversationDataRequest request = new ImportConversationDataRequest
{
    ConversationDatasetName = ConversationDatasetName.FromProjectLocationConversationDataset("[PROJECT]", "[LOCATION]", "[CONVERSATION_DATASET]"),
    InputConfig = new InputConfig(),
};
// Make the request
Operation<ImportConversationDataOperationResponse, ImportConversationDataOperationMetadata> response = await conversationDatasetsClient.ImportConversationDataAsync(request);

// Poll until the returned long-running operation is complete
Operation<ImportConversationDataOperationResponse, ImportConversationDataOperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
ImportConversationDataOperationResponse 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<ImportConversationDataOperationResponse, ImportConversationDataOperationMetadata> retrievedResponse = await conversationDatasetsClient.PollOnceImportConversationDataAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    ImportConversationDataOperationResponse retrievedResult = retrievedResponse.Result;
}

ImportConversationDataAsync(ImportConversationDataRequest, CancellationToken)

public virtual Task<Operation<ImportConversationDataOperationResponse, ImportConversationDataOperationMetadata>> ImportConversationDataAsync(ImportConversationDataRequest request, CancellationToken cancellationToken)

Import data into the specified conversation dataset. Note that it is not allowed to import data to a conversation dataset that already has data in it.

This method is a long-running operation. The returned Operation type has the following method-specific fields:

  • metadata: [ImportConversationDataOperationMetadata][google.cloud.dialogflow.v2.ImportConversationDataOperationMetadata]
  • response: [ImportConversationDataOperationResponse][google.cloud.dialogflow.v2.ImportConversationDataOperationResponse]
Parameters
Name Description
request ImportConversationDataRequest

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

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskOperationImportConversationDataOperationResponseImportConversationDataOperationMetadata

A Task containing the RPC response.

Example
// Create client
ConversationDatasetsClient conversationDatasetsClient = await ConversationDatasetsClient.CreateAsync();
// Initialize request argument(s)
ImportConversationDataRequest request = new ImportConversationDataRequest
{
    ConversationDatasetName = ConversationDatasetName.FromProjectLocationConversationDataset("[PROJECT]", "[LOCATION]", "[CONVERSATION_DATASET]"),
    InputConfig = new InputConfig(),
};
// Make the request
Operation<ImportConversationDataOperationResponse, ImportConversationDataOperationMetadata> response = await conversationDatasetsClient.ImportConversationDataAsync(request);

// Poll until the returned long-running operation is complete
Operation<ImportConversationDataOperationResponse, ImportConversationDataOperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
ImportConversationDataOperationResponse 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<ImportConversationDataOperationResponse, ImportConversationDataOperationMetadata> retrievedResponse = await conversationDatasetsClient.PollOnceImportConversationDataAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    ImportConversationDataOperationResponse retrievedResult = retrievedResponse.Result;
}

ListConversationDatasets(LocationName, string, int?, CallSettings)

public virtual PagedEnumerable<ListConversationDatasetsResponse, ConversationDataset> ListConversationDatasets(LocationName parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

Returns the list of all conversation datasets in the specified project and location.

Parameters
Name Description
parent LocationName

Required. The project and location name to list all conversation datasets for. Format: projects/<Project ID>/locations/<Location ID>

pageToken string

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

pageSize int

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.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
PagedEnumerableListConversationDatasetsResponseConversationDataset

A pageable sequence of ConversationDataset resources.

Example
// Create client
ConversationDatasetsClient conversationDatasetsClient = ConversationDatasetsClient.Create();
// Initialize request argument(s)
LocationName parent = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]");
// Make the request
PagedEnumerable<ListConversationDatasetsResponse, ConversationDataset> response = conversationDatasetsClient.ListConversationDatasets(parent);

// Iterate over all response items, lazily performing RPCs as required
foreach (ConversationDataset 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 (ListConversationDatasetsResponse page in response.AsRawResponses())
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (ConversationDataset 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<ConversationDataset> 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 (ConversationDataset 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;

ListConversationDatasets(ListConversationDatasetsRequest, CallSettings)

public virtual PagedEnumerable<ListConversationDatasetsResponse, ConversationDataset> ListConversationDatasets(ListConversationDatasetsRequest request, CallSettings callSettings = null)

Returns the list of all conversation datasets in the specified project and location.

Parameters
Name Description
request ListConversationDatasetsRequest

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
PagedEnumerableListConversationDatasetsResponseConversationDataset

A pageable sequence of ConversationDataset resources.

Example
// Create client
ConversationDatasetsClient conversationDatasetsClient = ConversationDatasetsClient.Create();
// Initialize request argument(s)
ListConversationDatasetsRequest request = new ListConversationDatasetsRequest
{
    ParentAsLocationName = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]"),
};
// Make the request
PagedEnumerable<ListConversationDatasetsResponse, ConversationDataset> response = conversationDatasetsClient.ListConversationDatasets(request);

// Iterate over all response items, lazily performing RPCs as required
foreach (ConversationDataset 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 (ListConversationDatasetsResponse page in response.AsRawResponses())
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (ConversationDataset 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<ConversationDataset> 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 (ConversationDataset 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;

ListConversationDatasets(string, string, int?, CallSettings)

public virtual PagedEnumerable<ListConversationDatasetsResponse, ConversationDataset> ListConversationDatasets(string parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

Returns the list of all conversation datasets in the specified project and location.

Parameters
Name Description
parent string

Required. The project and location name to list all conversation datasets for. Format: projects/<Project ID>/locations/<Location ID>

pageToken string

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

pageSize int

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.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
PagedEnumerableListConversationDatasetsResponseConversationDataset

A pageable sequence of ConversationDataset resources.

Example
// Create client
ConversationDatasetsClient conversationDatasetsClient = ConversationDatasetsClient.Create();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]";
// Make the request
PagedEnumerable<ListConversationDatasetsResponse, ConversationDataset> response = conversationDatasetsClient.ListConversationDatasets(parent);

// Iterate over all response items, lazily performing RPCs as required
foreach (ConversationDataset 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 (ListConversationDatasetsResponse page in response.AsRawResponses())
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (ConversationDataset 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<ConversationDataset> 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 (ConversationDataset 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;

ListConversationDatasetsAsync(LocationName, string, int?, CallSettings)

public virtual PagedAsyncEnumerable<ListConversationDatasetsResponse, ConversationDataset> ListConversationDatasetsAsync(LocationName parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

Returns the list of all conversation datasets in the specified project and location.

Parameters
Name Description
parent LocationName

Required. The project and location name to list all conversation datasets for. Format: projects/<Project ID>/locations/<Location ID>

pageToken string

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

pageSize int

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.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
PagedAsyncEnumerableListConversationDatasetsResponseConversationDataset

A pageable asynchronous sequence of ConversationDataset resources.

Example
// Create client
ConversationDatasetsClient conversationDatasetsClient = await ConversationDatasetsClient.CreateAsync();
// Initialize request argument(s)
LocationName parent = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]");
// Make the request
PagedAsyncEnumerable<ListConversationDatasetsResponse, ConversationDataset> response = conversationDatasetsClient.ListConversationDatasetsAsync(parent);

// Iterate over all response items, lazily performing RPCs as required
await response.ForEachAsync((ConversationDataset 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((ListConversationDatasetsResponse page) =>
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (ConversationDataset 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<ConversationDataset> 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 (ConversationDataset 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;

ListConversationDatasetsAsync(ListConversationDatasetsRequest, CallSettings)

public virtual PagedAsyncEnumerable<ListConversationDatasetsResponse, ConversationDataset> ListConversationDatasetsAsync(ListConversationDatasetsRequest request, CallSettings callSettings = null)

Returns the list of all conversation datasets in the specified project and location.

Parameters
Name Description
request ListConversationDatasetsRequest

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
PagedAsyncEnumerableListConversationDatasetsResponseConversationDataset

A pageable asynchronous sequence of ConversationDataset resources.

Example
// Create client
ConversationDatasetsClient conversationDatasetsClient = await ConversationDatasetsClient.CreateAsync();
// Initialize request argument(s)
ListConversationDatasetsRequest request = new ListConversationDatasetsRequest
{
    ParentAsLocationName = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]"),
};
// Make the request
PagedAsyncEnumerable<ListConversationDatasetsResponse, ConversationDataset> response = conversationDatasetsClient.ListConversationDatasetsAsync(request);

// Iterate over all response items, lazily performing RPCs as required
await response.ForEachAsync((ConversationDataset 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((ListConversationDatasetsResponse page) =>
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (ConversationDataset 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<ConversationDataset> 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 (ConversationDataset 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;

ListConversationDatasetsAsync(string, string, int?, CallSettings)

public virtual PagedAsyncEnumerable<ListConversationDatasetsResponse, ConversationDataset> ListConversationDatasetsAsync(string parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

Returns the list of all conversation datasets in the specified project and location.

Parameters
Name Description
parent string

Required. The project and location name to list all conversation datasets for. Format: projects/<Project ID>/locations/<Location ID>

pageToken string

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

pageSize int

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.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
PagedAsyncEnumerableListConversationDatasetsResponseConversationDataset

A pageable asynchronous sequence of ConversationDataset resources.

Example
// Create client
ConversationDatasetsClient conversationDatasetsClient = await ConversationDatasetsClient.CreateAsync();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]";
// Make the request
PagedAsyncEnumerable<ListConversationDatasetsResponse, ConversationDataset> response = conversationDatasetsClient.ListConversationDatasetsAsync(parent);

// Iterate over all response items, lazily performing RPCs as required
await response.ForEachAsync((ConversationDataset 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((ListConversationDatasetsResponse page) =>
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (ConversationDataset 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<ConversationDataset> 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 (ConversationDataset 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;

PollOnceCreateConversationDataset(string, CallSettings)

public virtual Operation<ConversationDataset, CreateConversationDatasetOperationMetadata> PollOnceCreateConversationDataset(string operationName, CallSettings callSettings = null)

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

Parameters
Name Description
operationName string

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

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
OperationConversationDatasetCreateConversationDatasetOperationMetadata

The result of polling the operation.

PollOnceCreateConversationDatasetAsync(string, CallSettings)

public virtual Task<Operation<ConversationDataset, CreateConversationDatasetOperationMetadata>> PollOnceCreateConversationDatasetAsync(string operationName, CallSettings callSettings = null)

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

Parameters
Name Description
operationName string

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

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskOperationConversationDatasetCreateConversationDatasetOperationMetadata

A task representing the result of polling the operation.

PollOnceDeleteConversationDataset(string, CallSettings)

public virtual Operation<Empty, DeleteConversationDatasetOperationMetadata> PollOnceDeleteConversationDataset(string operationName, CallSettings callSettings = null)

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

Parameters
Name Description
operationName string

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

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
OperationEmptyDeleteConversationDatasetOperationMetadata

The result of polling the operation.

PollOnceDeleteConversationDatasetAsync(string, CallSettings)

public virtual Task<Operation<Empty, DeleteConversationDatasetOperationMetadata>> PollOnceDeleteConversationDatasetAsync(string operationName, CallSettings callSettings = null)

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

Parameters
Name Description
operationName string

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

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskOperationEmptyDeleteConversationDatasetOperationMetadata

A task representing the result of polling the operation.

PollOnceImportConversationData(string, CallSettings)

public virtual Operation<ImportConversationDataOperationResponse, ImportConversationDataOperationMetadata> PollOnceImportConversationData(string operationName, CallSettings callSettings = null)

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

Parameters
Name Description
operationName string

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

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
OperationImportConversationDataOperationResponseImportConversationDataOperationMetadata

The result of polling the operation.

PollOnceImportConversationDataAsync(string, CallSettings)

public virtual Task<Operation<ImportConversationDataOperationResponse, ImportConversationDataOperationMetadata>> PollOnceImportConversationDataAsync(string operationName, CallSettings callSettings = null)

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

Parameters
Name Description
operationName string

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

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskOperationImportConversationDataOperationResponseImportConversationDataOperationMetadata

A task representing the result of polling the operation.

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
Type Description
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.