- 4.53.0 (latest)
- 4.52.0
- 4.51.0
- 4.50.0
- 4.49.0
- 4.48.0
- 4.47.0
- 4.46.0
- 4.45.0
- 4.43.0
- 4.42.0
- 4.41.0
- 4.40.0
- 4.39.0
- 4.38.0
- 4.37.0
- 4.36.0
- 4.35.0
- 4.34.0
- 4.33.0
- 4.30.0
- 4.29.0
- 4.28.0
- 4.27.0
- 4.26.0
- 4.25.0
- 4.24.0
- 4.23.0
- 4.22.0
- 4.21.0
- 4.20.0
- 4.19.0
- 4.18.0
- 4.17.0
- 4.15.0
- 4.14.0
- 4.13.0
- 4.12.0
- 4.11.0
- 4.10.0
- 4.9.1
- 4.8.6
- 4.7.5
- 4.6.0
- 4.5.11
- 4.4.0
- 4.3.1
public class ConversationDatasetsClient implements BackgroundResource
Service Description: Conversation datasets.
Conversation datasets contain raw conversation files and their customizable metadata that can be used for model training.
This class provides the ability to make remote calls to the backing service through method calls that map to API methods. Sample code to get started:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (ConversationDatasetsClient conversationDatasetsClient =
ConversationDatasetsClient.create()) {
ConversationDatasetName name =
ConversationDatasetName.of("[PROJECT]", "[LOCATION]", "[CONVERSATION_DATASET]");
ConversationDataset response = conversationDatasetsClient.getConversationDataset(name);
}
Note: close() needs to be called on the ConversationDatasetsClient object to clean up resources such as threads. In the example above, try-with-resources is used, which automatically calls close().
The surface of this class includes several types of Java methods for each of the API's methods:
- A "flattened" method. With this type of method, the fields of the request type have been converted into function parameters. It may be the case that not all fields are available as parameters, and not every API method will have a flattened method entry point.
- A "request object" method. This type of method only takes one parameter, a request object, which must be constructed before the call. Not every API method will have a request object method.
- A "callable" method. This type of method takes no parameters and returns an immutable API callable object, which can be used to initiate calls to the service.
See the individual methods for example code.
Many parameters require resource names to be formatted in a particular way. To assist with these names, this class includes a format method for each type of name, and additionally a parse method to extract the individual identifiers contained within names that are returned.
This class can be customized by passing in a custom instance of ConversationDatasetsSettings to create(). For example:
To customize credentials:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
ConversationDatasetsSettings conversationDatasetsSettings =
ConversationDatasetsSettings.newBuilder()
.setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
.build();
ConversationDatasetsClient conversationDatasetsClient =
ConversationDatasetsClient.create(conversationDatasetsSettings);
To customize the endpoint:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
ConversationDatasetsSettings conversationDatasetsSettings =
ConversationDatasetsSettings.newBuilder().setEndpoint(myEndpoint).build();
ConversationDatasetsClient conversationDatasetsClient =
ConversationDatasetsClient.create(conversationDatasetsSettings);
To use REST (HTTP1.1/JSON) transport (instead of gRPC) for sending and receiving requests over the wire:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
ConversationDatasetsSettings conversationDatasetsSettings =
ConversationDatasetsSettings.newHttpJsonBuilder().build();
ConversationDatasetsClient conversationDatasetsClient =
ConversationDatasetsClient.create(conversationDatasetsSettings);
Please refer to the GitHub repository's samples for more quickstart code snippets.
Implements
BackgroundResourceStatic Methods
create()
public static final ConversationDatasetsClient create()
Constructs an instance of ConversationDatasetsClient with default settings.
Returns | |
---|---|
Type | Description |
ConversationDatasetsClient |
Exceptions | |
---|---|
Type | Description |
IOException |
create(ConversationDatasetsSettings settings)
public static final ConversationDatasetsClient create(ConversationDatasetsSettings settings)
Constructs an instance of ConversationDatasetsClient, using the given settings. The channels are created based on the settings passed in, or defaults for any settings that are not set.
Parameter | |
---|---|
Name | Description |
settings |
ConversationDatasetsSettings |
Returns | |
---|---|
Type | Description |
ConversationDatasetsClient |
Exceptions | |
---|---|
Type | Description |
IOException |
create(ConversationDatasetsStub stub)
public static final ConversationDatasetsClient create(ConversationDatasetsStub stub)
Constructs an instance of ConversationDatasetsClient, using the given stub for making calls. This is for advanced usage - prefer using create(ConversationDatasetsSettings).
Parameter | |
---|---|
Name | Description |
stub |
ConversationDatasetsStub |
Returns | |
---|---|
Type | Description |
ConversationDatasetsClient |
Constructors
ConversationDatasetsClient(ConversationDatasetsSettings settings)
protected ConversationDatasetsClient(ConversationDatasetsSettings settings)
Constructs an instance of ConversationDatasetsClient, using the given settings. This is protected so that it is easy to make a subclass, but otherwise, the static factory methods should be preferred.
Parameter | |
---|---|
Name | Description |
settings |
ConversationDatasetsSettings |
ConversationDatasetsClient(ConversationDatasetsStub stub)
protected ConversationDatasetsClient(ConversationDatasetsStub stub)
Parameter | |
---|---|
Name | Description |
stub |
ConversationDatasetsStub |
Methods
awaitTermination(long duration, TimeUnit unit)
public boolean awaitTermination(long duration, TimeUnit unit)
Parameters | |
---|---|
Name | Description |
duration |
long |
unit |
TimeUnit |
Returns | |
---|---|
Type | Description |
boolean |
Exceptions | |
---|---|
Type | Description |
InterruptedException |
close()
public final void close()
createConversationDatasetAsync(CreateConversationDatasetRequest request)
public final OperationFuture<ConversationDataset,CreateConversationDatasetOperationMetadata> createConversationDatasetAsync(CreateConversationDatasetRequest request)
Creates a new conversation dataset.
This method is a long-running
operation. The
returned Operation
type has the following method-specific fields:
- metadata
:
CreateConversationDatasetOperationMetadata
response
: ConversationDatasetSample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (ConversationDatasetsClient conversationDatasetsClient = ConversationDatasetsClient.create()) { CreateConversationDatasetRequest request = CreateConversationDatasetRequest.newBuilder() .setParent("parent-995424086") .setConversationDataset(ConversationDataset.newBuilder().build()) .build(); ConversationDataset response = conversationDatasetsClient.createConversationDatasetAsync(request).get(); }
Parameter | |
---|---|
Name | Description |
request |
CreateConversationDatasetRequest The request object containing all of the parameters for the API call. |
Returns | |
---|---|
Type | Description |
OperationFuture<ConversationDataset,CreateConversationDatasetOperationMetadata> |
createConversationDatasetAsync(String parent, ConversationDataset conversationDataset)
public final OperationFuture<ConversationDataset,CreateConversationDatasetOperationMetadata> createConversationDatasetAsync(String parent, ConversationDataset conversationDataset)
Creates a new conversation dataset.
This method is a long-running
operation. The
returned Operation
type has the following method-specific fields:
- metadata
:
CreateConversationDatasetOperationMetadata
response
: ConversationDatasetSample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (ConversationDatasetsClient conversationDatasetsClient = ConversationDatasetsClient.create()) { String parent = "parent-995424086"; ConversationDataset conversationDataset = ConversationDataset.newBuilder().build(); ConversationDataset response = conversationDatasetsClient .createConversationDatasetAsync(parent, conversationDataset) .get(); }
Parameters | |
---|---|
Name | Description |
parent |
String Required. The project to create conversation dataset for. Format:
|
conversationDataset |
ConversationDataset Required. The conversation dataset to create. |
Returns | |
---|---|
Type | Description |
OperationFuture<ConversationDataset,CreateConversationDatasetOperationMetadata> |
createConversationDatasetCallable()
public final UnaryCallable<CreateConversationDatasetRequest,Operation> createConversationDatasetCallable()
Creates a new conversation dataset.
This method is a long-running
operation. The
returned Operation
type has the following method-specific fields:
- metadata
:
CreateConversationDatasetOperationMetadata
response
: ConversationDatasetSample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (ConversationDatasetsClient conversationDatasetsClient = ConversationDatasetsClient.create()) { CreateConversationDatasetRequest request = CreateConversationDatasetRequest.newBuilder() .setParent("parent-995424086") .setConversationDataset(ConversationDataset.newBuilder().build()) .build(); ApiFuture<Operation> future = conversationDatasetsClient.createConversationDatasetCallable().futureCall(request); // Do something. Operation response = future.get(); }
Returns | |
---|---|
Type | Description |
UnaryCallable<CreateConversationDatasetRequest,Operation> |
createConversationDatasetOperationCallable()
public final OperationCallable<CreateConversationDatasetRequest,ConversationDataset,CreateConversationDatasetOperationMetadata> createConversationDatasetOperationCallable()
Creates a new conversation dataset.
This method is a long-running
operation. The
returned Operation
type has the following method-specific fields:
- metadata
:
CreateConversationDatasetOperationMetadata
response
: ConversationDatasetSample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (ConversationDatasetsClient conversationDatasetsClient = ConversationDatasetsClient.create()) { CreateConversationDatasetRequest request = CreateConversationDatasetRequest.newBuilder() .setParent("parent-995424086") .setConversationDataset(ConversationDataset.newBuilder().build()) .build(); OperationFuture<ConversationDataset, CreateConversationDatasetOperationMetadata> future = conversationDatasetsClient .createConversationDatasetOperationCallable() .futureCall(request); // Do something. ConversationDataset response = future.get(); }
Returns | |
---|---|
Type | Description |
OperationCallable<CreateConversationDatasetRequest,ConversationDataset,CreateConversationDatasetOperationMetadata> |
deleteConversationDatasetAsync(ConversationDatasetName name)
public final OperationFuture<Empty,DeleteConversationDatasetOperationMetadata> deleteConversationDatasetAsync(ConversationDatasetName name)
Deletes the specified conversation dataset.
This method is a long-running
operation. The
returned Operation
type has the following method-specific fields:
- metadata
:
DeleteConversationDatasetOperationMetadata
response
: An Empty messageSample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (ConversationDatasetsClient conversationDatasetsClient = ConversationDatasetsClient.create()) { ConversationDatasetName name = ConversationDatasetName.of("[PROJECT]", "[LOCATION]", "[CONVERSATION_DATASET]"); conversationDatasetsClient.deleteConversationDatasetAsync(name).get(); }
Parameter | |
---|---|
Name | Description |
name |
ConversationDatasetName Required. The conversation dataset to delete. Format: |
Returns | |
---|---|
Type | Description |
OperationFuture<Empty,DeleteConversationDatasetOperationMetadata> |
deleteConversationDatasetAsync(DeleteConversationDatasetRequest request)
public final OperationFuture<Empty,DeleteConversationDatasetOperationMetadata> deleteConversationDatasetAsync(DeleteConversationDatasetRequest request)
Deletes the specified conversation dataset.
This method is a long-running
operation. The
returned Operation
type has the following method-specific fields:
- metadata
:
DeleteConversationDatasetOperationMetadata
response
: An Empty messageSample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (ConversationDatasetsClient conversationDatasetsClient = ConversationDatasetsClient.create()) { DeleteConversationDatasetRequest request = DeleteConversationDatasetRequest.newBuilder() .setName( ConversationDatasetName.of("[PROJECT]", "[LOCATION]", "[CONVERSATION_DATASET]") .toString()) .build(); conversationDatasetsClient.deleteConversationDatasetAsync(request).get(); }
Parameter | |
---|---|
Name | Description |
request |
DeleteConversationDatasetRequest The request object containing all of the parameters for the API call. |
Returns | |
---|---|
Type | Description |
OperationFuture<Empty,DeleteConversationDatasetOperationMetadata> |
deleteConversationDatasetAsync(String name)
public final OperationFuture<Empty,DeleteConversationDatasetOperationMetadata> deleteConversationDatasetAsync(String name)
Deletes the specified conversation dataset.
This method is a long-running
operation. The
returned Operation
type has the following method-specific fields:
- metadata
:
DeleteConversationDatasetOperationMetadata
response
: An Empty messageSample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (ConversationDatasetsClient conversationDatasetsClient = ConversationDatasetsClient.create()) { String name = ConversationDatasetName.of("[PROJECT]", "[LOCATION]", "[CONVERSATION_DATASET]") .toString(); conversationDatasetsClient.deleteConversationDatasetAsync(name).get(); }
Parameter | |
---|---|
Name | Description |
name |
String Required. The conversation dataset to delete. Format: |
Returns | |
---|---|
Type | Description |
OperationFuture<Empty,DeleteConversationDatasetOperationMetadata> |
deleteConversationDatasetCallable()
public final UnaryCallable<DeleteConversationDatasetRequest,Operation> deleteConversationDatasetCallable()
Deletes the specified conversation dataset.
This method is a long-running
operation. The
returned Operation
type has the following method-specific fields:
- metadata
:
DeleteConversationDatasetOperationMetadata
response
: An Empty messageSample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (ConversationDatasetsClient conversationDatasetsClient = ConversationDatasetsClient.create()) { DeleteConversationDatasetRequest request = DeleteConversationDatasetRequest.newBuilder() .setName( ConversationDatasetName.of("[PROJECT]", "[LOCATION]", "[CONVERSATION_DATASET]") .toString()) .build(); ApiFuture<Operation> future = conversationDatasetsClient.deleteConversationDatasetCallable().futureCall(request); // Do something. future.get(); }
Returns | |
---|---|
Type | Description |
UnaryCallable<DeleteConversationDatasetRequest,Operation> |
deleteConversationDatasetOperationCallable()
public final OperationCallable<DeleteConversationDatasetRequest,Empty,DeleteConversationDatasetOperationMetadata> deleteConversationDatasetOperationCallable()
Deletes the specified conversation dataset.
This method is a long-running
operation. The
returned Operation
type has the following method-specific fields:
- metadata
:
DeleteConversationDatasetOperationMetadata
response
: An Empty messageSample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (ConversationDatasetsClient conversationDatasetsClient = ConversationDatasetsClient.create()) { DeleteConversationDatasetRequest request = DeleteConversationDatasetRequest.newBuilder() .setName( ConversationDatasetName.of("[PROJECT]", "[LOCATION]", "[CONVERSATION_DATASET]") .toString()) .build(); OperationFuture<Empty, DeleteConversationDatasetOperationMetadata> future = conversationDatasetsClient .deleteConversationDatasetOperationCallable() .futureCall(request); // Do something. future.get(); }
Returns | |
---|---|
Type | Description |
OperationCallable<DeleteConversationDatasetRequest,Empty,DeleteConversationDatasetOperationMetadata> |
getConversationDataset(ConversationDatasetName name)
public final ConversationDataset getConversationDataset(ConversationDatasetName name)
Retrieves the specified conversation dataset.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (ConversationDatasetsClient conversationDatasetsClient =
ConversationDatasetsClient.create()) {
ConversationDatasetName name =
ConversationDatasetName.of("[PROJECT]", "[LOCATION]", "[CONVERSATION_DATASET]");
ConversationDataset response = conversationDatasetsClient.getConversationDataset(name);
}
Parameter | |
---|---|
Name | Description |
name |
ConversationDatasetName Required. The conversation dataset to retrieve. Format: |
Returns | |
---|---|
Type | Description |
ConversationDataset |
getConversationDataset(GetConversationDatasetRequest request)
public final ConversationDataset getConversationDataset(GetConversationDatasetRequest request)
Retrieves the specified conversation dataset.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (ConversationDatasetsClient conversationDatasetsClient =
ConversationDatasetsClient.create()) {
GetConversationDatasetRequest request =
GetConversationDatasetRequest.newBuilder()
.setName(
ConversationDatasetName.of("[PROJECT]", "[LOCATION]", "[CONVERSATION_DATASET]")
.toString())
.build();
ConversationDataset response = conversationDatasetsClient.getConversationDataset(request);
}
Parameter | |
---|---|
Name | Description |
request |
GetConversationDatasetRequest The request object containing all of the parameters for the API call. |
Returns | |
---|---|
Type | Description |
ConversationDataset |
getConversationDataset(String name)
public final ConversationDataset getConversationDataset(String name)
Retrieves the specified conversation dataset.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (ConversationDatasetsClient conversationDatasetsClient =
ConversationDatasetsClient.create()) {
String name =
ConversationDatasetName.of("[PROJECT]", "[LOCATION]", "[CONVERSATION_DATASET]")
.toString();
ConversationDataset response = conversationDatasetsClient.getConversationDataset(name);
}
Parameter | |
---|---|
Name | Description |
name |
String Required. The conversation dataset to retrieve. Format: |
Returns | |
---|---|
Type | Description |
ConversationDataset |
getConversationDatasetCallable()
public final UnaryCallable<GetConversationDatasetRequest,ConversationDataset> getConversationDatasetCallable()
Retrieves the specified conversation dataset.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (ConversationDatasetsClient conversationDatasetsClient =
ConversationDatasetsClient.create()) {
GetConversationDatasetRequest request =
GetConversationDatasetRequest.newBuilder()
.setName(
ConversationDatasetName.of("[PROJECT]", "[LOCATION]", "[CONVERSATION_DATASET]")
.toString())
.build();
ApiFuture<ConversationDataset> future =
conversationDatasetsClient.getConversationDatasetCallable().futureCall(request);
// Do something.
ConversationDataset response = future.get();
}
Returns | |
---|---|
Type | Description |
UnaryCallable<GetConversationDatasetRequest,ConversationDataset> |
getHttpJsonOperationsClient()
public final OperationsClient getHttpJsonOperationsClient()
Returns the OperationsClient that can be used to query the status of a long-running operation returned by another API method call.
Returns | |
---|---|
Type | Description |
OperationsClient |
getLocation(GetLocationRequest request)
public final Location getLocation(GetLocationRequest request)
Gets information about a location.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (ConversationDatasetsClient conversationDatasetsClient =
ConversationDatasetsClient.create()) {
GetLocationRequest request = GetLocationRequest.newBuilder().setName("name3373707").build();
Location response = conversationDatasetsClient.getLocation(request);
}
Parameter | |
---|---|
Name | Description |
request |
com.google.cloud.location.GetLocationRequest The request object containing all of the parameters for the API call. |
Returns | |
---|---|
Type | Description |
com.google.cloud.location.Location |
getLocationCallable()
public final UnaryCallable<GetLocationRequest,Location> getLocationCallable()
Gets information about a location.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (ConversationDatasetsClient conversationDatasetsClient =
ConversationDatasetsClient.create()) {
GetLocationRequest request = GetLocationRequest.newBuilder().setName("name3373707").build();
ApiFuture<Location> future =
conversationDatasetsClient.getLocationCallable().futureCall(request);
// Do something.
Location response = future.get();
}
Returns | |
---|---|
Type | Description |
UnaryCallable<com.google.cloud.location.GetLocationRequest,com.google.cloud.location.Location> |
getOperationsClient()
public final OperationsClient getOperationsClient()
Returns the OperationsClient that can be used to query the status of a long-running operation returned by another API method call.
Returns | |
---|---|
Type | Description |
OperationsClient |
getSettings()
public final ConversationDatasetsSettings getSettings()
Returns | |
---|---|
Type | Description |
ConversationDatasetsSettings |
getStub()
public ConversationDatasetsStub getStub()
Returns | |
---|---|
Type | Description |
ConversationDatasetsStub |
importConversationDataAsync(ImportConversationDataRequest request)
public final OperationFuture<ImportConversationDataOperationResponse,ImportConversationDataOperationMetadata> importConversationDataAsync(ImportConversationDataRequest request)
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
response
: ImportConversationDataOperationResponseSample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (ConversationDatasetsClient conversationDatasetsClient = ConversationDatasetsClient.create()) { ImportConversationDataRequest request = ImportConversationDataRequest.newBuilder() .setName( ConversationDatasetName.of("[PROJECT]", "[LOCATION]", "[CONVERSATION_DATASET]") .toString()) .setInputConfig(InputConfig.newBuilder().build()) .build(); ImportConversationDataOperationResponse response = conversationDatasetsClient.importConversationDataAsync(request).get(); }
Parameter | |
---|---|
Name | Description |
request |
ImportConversationDataRequest The request object containing all of the parameters for the API call. |
Returns | |
---|---|
Type | Description |
OperationFuture<ImportConversationDataOperationResponse,ImportConversationDataOperationMetadata> |
importConversationDataCallable()
public final UnaryCallable<ImportConversationDataRequest,Operation> importConversationDataCallable()
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
response
: ImportConversationDataOperationResponseSample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (ConversationDatasetsClient conversationDatasetsClient = ConversationDatasetsClient.create()) { ImportConversationDataRequest request = ImportConversationDataRequest.newBuilder() .setName( ConversationDatasetName.of("[PROJECT]", "[LOCATION]", "[CONVERSATION_DATASET]") .toString()) .setInputConfig(InputConfig.newBuilder().build()) .build(); ApiFuture<Operation> future = conversationDatasetsClient.importConversationDataCallable().futureCall(request); // Do something. Operation response = future.get(); }
Returns | |
---|---|
Type | Description |
UnaryCallable<ImportConversationDataRequest,Operation> |
importConversationDataOperationCallable()
public final OperationCallable<ImportConversationDataRequest,ImportConversationDataOperationResponse,ImportConversationDataOperationMetadata> importConversationDataOperationCallable()
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
response
: ImportConversationDataOperationResponseSample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (ConversationDatasetsClient conversationDatasetsClient = ConversationDatasetsClient.create()) { ImportConversationDataRequest request = ImportConversationDataRequest.newBuilder() .setName( ConversationDatasetName.of("[PROJECT]", "[LOCATION]", "[CONVERSATION_DATASET]") .toString()) .setInputConfig(InputConfig.newBuilder().build()) .build(); OperationFuture< importconversationdataoperationresponse,="" importconversationdataoperationmetadata=""> future = conversationDatasetsClient .importConversationDataOperationCallable() .futureCall(request); // Do something. ImportConversationDataOperationResponse response = future.get(); }
Returns | |
---|---|
Type | Description |
OperationCallable<ImportConversationDataRequest,ImportConversationDataOperationResponse,ImportConversationDataOperationMetadata> |
isShutdown()
public boolean isShutdown()
Returns | |
---|---|
Type | Description |
boolean |
isTerminated()
public boolean isTerminated()
Returns | |
---|---|
Type | Description |
boolean |
listConversationDatasets(ListConversationDatasetsRequest request)
public final ConversationDatasetsClient.ListConversationDatasetsPagedResponse listConversationDatasets(ListConversationDatasetsRequest request)
Returns the list of all conversation datasets in the specified project and location.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (ConversationDatasetsClient conversationDatasetsClient =
ConversationDatasetsClient.create()) {
ListConversationDatasetsRequest request =
ListConversationDatasetsRequest.newBuilder()
.setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
.setPageSize(883849137)
.setPageToken("pageToken873572522")
.build();
for (ConversationDataset element :
conversationDatasetsClient.listConversationDatasets(request).iterateAll()) {
// doThingsWith(element);
}
}
Parameter | |
---|---|
Name | Description |
request |
ListConversationDatasetsRequest The request object containing all of the parameters for the API call. |
Returns | |
---|---|
Type | Description |
ConversationDatasetsClient.ListConversationDatasetsPagedResponse |
listConversationDatasets(LocationName parent)
public final ConversationDatasetsClient.ListConversationDatasetsPagedResponse listConversationDatasets(LocationName parent)
Returns the list of all conversation datasets in the specified project and location.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (ConversationDatasetsClient conversationDatasetsClient =
ConversationDatasetsClient.create()) {
LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
for (ConversationDataset element :
conversationDatasetsClient.listConversationDatasets(parent).iterateAll()) {
// doThingsWith(element);
}
}
Parameter | |
---|---|
Name | Description |
parent |
LocationName Required. The project and location name to list all conversation datasets for.
Format: |
Returns | |
---|---|
Type | Description |
ConversationDatasetsClient.ListConversationDatasetsPagedResponse |
listConversationDatasets(String parent)
public final ConversationDatasetsClient.ListConversationDatasetsPagedResponse listConversationDatasets(String parent)
Returns the list of all conversation datasets in the specified project and location.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (ConversationDatasetsClient conversationDatasetsClient =
ConversationDatasetsClient.create()) {
String parent = LocationName.of("[PROJECT]", "[LOCATION]").toString();
for (ConversationDataset element :
conversationDatasetsClient.listConversationDatasets(parent).iterateAll()) {
// doThingsWith(element);
}
}
Parameter | |
---|---|
Name | Description |
parent |
String Required. The project and location name to list all conversation datasets for.
Format: |
Returns | |
---|---|
Type | Description |
ConversationDatasetsClient.ListConversationDatasetsPagedResponse |
listConversationDatasetsCallable()
public final UnaryCallable<ListConversationDatasetsRequest,ListConversationDatasetsResponse> listConversationDatasetsCallable()
Returns the list of all conversation datasets in the specified project and location.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (ConversationDatasetsClient conversationDatasetsClient =
ConversationDatasetsClient.create()) {
ListConversationDatasetsRequest request =
ListConversationDatasetsRequest.newBuilder()
.setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
.setPageSize(883849137)
.setPageToken("pageToken873572522")
.build();
while (true) {
ListConversationDatasetsResponse response =
conversationDatasetsClient.listConversationDatasetsCallable().call(request);
for (ConversationDataset element : response.getConversationDatasetsList()) {
// doThingsWith(element);
}
String nextPageToken = response.getNextPageToken();
if (!Strings.isNullOrEmpty(nextPageToken)) {
request = request.toBuilder().setPageToken(nextPageToken).build();
} else {
break;
}
}
}
Returns | |
---|---|
Type | Description |
UnaryCallable<ListConversationDatasetsRequest,ListConversationDatasetsResponse> |
listConversationDatasetsPagedCallable()
public final UnaryCallable<ListConversationDatasetsRequest,ConversationDatasetsClient.ListConversationDatasetsPagedResponse> listConversationDatasetsPagedCallable()
Returns the list of all conversation datasets in the specified project and location.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (ConversationDatasetsClient conversationDatasetsClient =
ConversationDatasetsClient.create()) {
ListConversationDatasetsRequest request =
ListConversationDatasetsRequest.newBuilder()
.setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
.setPageSize(883849137)
.setPageToken("pageToken873572522")
.build();
ApiFuture<ConversationDataset> future =
conversationDatasetsClient.listConversationDatasetsPagedCallable().futureCall(request);
// Do something.
for (ConversationDataset element : future.get().iterateAll()) {
// doThingsWith(element);
}
}
Returns | |
---|---|
Type | Description |
UnaryCallable<ListConversationDatasetsRequest,ListConversationDatasetsPagedResponse> |
listLocations(ListLocationsRequest request)
public final ConversationDatasetsClient.ListLocationsPagedResponse listLocations(ListLocationsRequest request)
Lists information about the supported locations for this service.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (ConversationDatasetsClient conversationDatasetsClient =
ConversationDatasetsClient.create()) {
ListLocationsRequest request =
ListLocationsRequest.newBuilder()
.setName("name3373707")
.setFilter("filter-1274492040")
.setPageSize(883849137)
.setPageToken("pageToken873572522")
.build();
for (Location element : conversationDatasetsClient.listLocations(request).iterateAll()) {
// doThingsWith(element);
}
}
Parameter | |
---|---|
Name | Description |
request |
com.google.cloud.location.ListLocationsRequest The request object containing all of the parameters for the API call. |
Returns | |
---|---|
Type | Description |
ConversationDatasetsClient.ListLocationsPagedResponse |
listLocationsCallable()
public final UnaryCallable<ListLocationsRequest,ListLocationsResponse> listLocationsCallable()
Lists information about the supported locations for this service.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (ConversationDatasetsClient conversationDatasetsClient =
ConversationDatasetsClient.create()) {
ListLocationsRequest request =
ListLocationsRequest.newBuilder()
.setName("name3373707")
.setFilter("filter-1274492040")
.setPageSize(883849137)
.setPageToken("pageToken873572522")
.build();
while (true) {
ListLocationsResponse response =
conversationDatasetsClient.listLocationsCallable().call(request);
for (Location element : response.getLocationsList()) {
// doThingsWith(element);
}
String nextPageToken = response.getNextPageToken();
if (!Strings.isNullOrEmpty(nextPageToken)) {
request = request.toBuilder().setPageToken(nextPageToken).build();
} else {
break;
}
}
}
Returns | |
---|---|
Type | Description |
UnaryCallable<com.google.cloud.location.ListLocationsRequest,com.google.cloud.location.ListLocationsResponse> |
listLocationsPagedCallable()
public final UnaryCallable<ListLocationsRequest,ConversationDatasetsClient.ListLocationsPagedResponse> listLocationsPagedCallable()
Lists information about the supported locations for this service.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (ConversationDatasetsClient conversationDatasetsClient =
ConversationDatasetsClient.create()) {
ListLocationsRequest request =
ListLocationsRequest.newBuilder()
.setName("name3373707")
.setFilter("filter-1274492040")
.setPageSize(883849137)
.setPageToken("pageToken873572522")
.build();
ApiFuture<Location> future =
conversationDatasetsClient.listLocationsPagedCallable().futureCall(request);
// Do something.
for (Location element : future.get().iterateAll()) {
// doThingsWith(element);
}
}
Returns | |
---|---|
Type | Description |
UnaryCallable<com.google.cloud.location.ListLocationsRequest,ListLocationsPagedResponse> |
shutdown()
public void shutdown()
shutdownNow()
public void shutdownNow()