- 0.58.0 (latest)
- 0.57.0
- 0.56.0
- 0.55.0
- 0.54.0
- 0.53.0
- 0.52.0
- 0.51.0
- 0.50.0
- 0.48.0
- 0.47.0
- 0.46.0
- 0.45.0
- 0.44.0
- 0.43.0
- 0.42.0
- 0.41.0
- 0.40.0
- 0.39.0
- 0.38.0
- 0.35.0
- 0.34.0
- 0.33.0
- 0.32.0
- 0.31.0
- 0.30.0
- 0.29.0
- 0.28.0
- 0.27.0
- 0.26.0
- 0.25.0
- 0.24.0
- 0.23.0
- 0.22.0
- 0.20.0
- 0.19.0
- 0.18.0
- 0.17.0
- 0.16.0
- 0.15.0
- 0.14.7
- 0.13.1
- 0.12.1
- 0.11.5
GitHub Repository | Product Reference | REST Documentation | RPC Documentation |
Service Description: Service for managing Intents.
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 (IntentsClient intentsClient = IntentsClient.create()) {
IntentName name = IntentName.of("[PROJECT]", "[LOCATION]", "[AGENT]", "[INTENT]");
Intent response = intentsClient.getIntent(name);
}
Note: close() needs to be called on the IntentsClient object to clean up resources such as threads. In the example above, try-with-resources is used, which automatically calls close().
Method | Description | Method Variants |
---|---|---|
ListIntents |
Returns the list of all intents in the specified agent. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
GetIntent |
Retrieves the specified intent. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
CreateIntent |
Creates an intent in the specified agent. Note: You should always train a flow prior to sending it queries. See the training documentation. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
UpdateIntent |
Updates the specified intent. Note: You should always train a flow prior to sending it queries. See the training documentation. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
DeleteIntent |
Deletes the specified intent. Note: You should always train a flow prior to sending it queries. See the training documentation. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
ImportIntents |
Imports the specified intents into the agent. This method is a long-running operation. The returned - |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
ExportIntents |
Exports the selected intents. This method is a long-running operation. The returned - |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
ListLocations |
Lists information about the supported locations for this service. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
GetLocation |
Gets information about a location. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
Callable method variants take no parameters and return 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 IntentsSettings 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
IntentsSettings intentsSettings =
IntentsSettings.newBuilder()
.setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
.build();
IntentsClient intentsClient = IntentsClient.create(intentsSettings);
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
IntentsSettings intentsSettings = IntentsSettings.newBuilder().setEndpoint(myEndpoint).build();
IntentsClient intentsClient = IntentsClient.create(intentsSettings);
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
IntentsSettings intentsSettings = IntentsSettings.newHttpJsonBuilder().build();
IntentsClient intentsClient = IntentsClient.create(intentsSettings);
Please refer to the GitHub repository's samples for more quickstart code snippets.
Static Methods
create()
public static final IntentsClient create()
Constructs an instance of IntentsClient with default settings.
Returns | |
---|---|
Type | Description |
IntentsClient |
Exceptions | |
---|---|
Type | Description |
IOException |
create(IntentsSettings settings)
public static final IntentsClient create(IntentsSettings settings)
Constructs an instance of IntentsClient, 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 |
IntentsSettings |
Returns | |
---|---|
Type | Description |
IntentsClient |
Exceptions | |
---|---|
Type | Description |
IOException |
create(IntentsStub stub)
public static final IntentsClient create(IntentsStub stub)
Constructs an instance of IntentsClient, using the given stub for making calls. This is for advanced usage - prefer using create(IntentsSettings).
Parameter | |
---|---|
Name | Description |
stub |
IntentsStub |
Returns | |
---|---|
Type | Description |
IntentsClient |
Constructors
IntentsClient(IntentsSettings settings)
protected IntentsClient(IntentsSettings settings)
Constructs an instance of IntentsClient, 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 |
IntentsSettings |
IntentsClient(IntentsStub stub)
protected IntentsClient(IntentsStub stub)
Parameter | |
---|---|
Name | Description |
stub |
IntentsStub |
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()
createIntent(AgentName parent, Intent intent)
public final Intent createIntent(AgentName parent, Intent intent)
Creates an intent in the specified agent.
Note: You should always train a flow prior to sending it queries. See the training documentation.
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 (IntentsClient intentsClient = IntentsClient.create()) {
AgentName parent = AgentName.of("[PROJECT]", "[LOCATION]", "[AGENT]");
Intent intent = Intent.newBuilder().build();
Intent response = intentsClient.createIntent(parent, intent);
}
Parameters | |
---|---|
Name | Description |
parent |
AgentName Required. The agent to create an intent for. Format: |
intent |
Intent Required. The intent to create. |
Returns | |
---|---|
Type | Description |
Intent |
createIntent(CreateIntentRequest request)
public final Intent createIntent(CreateIntentRequest request)
Creates an intent in the specified agent.
Note: You should always train a flow prior to sending it queries. See the training documentation.
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 (IntentsClient intentsClient = IntentsClient.create()) {
CreateIntentRequest request =
CreateIntentRequest.newBuilder()
.setParent(AgentName.of("[PROJECT]", "[LOCATION]", "[AGENT]").toString())
.setIntent(Intent.newBuilder().build())
.setLanguageCode("languageCode-2092349083")
.build();
Intent response = intentsClient.createIntent(request);
}
Parameter | |
---|---|
Name | Description |
request |
CreateIntentRequest The request object containing all of the parameters for the API call. |
Returns | |
---|---|
Type | Description |
Intent |
createIntent(String parent, Intent intent)
public final Intent createIntent(String parent, Intent intent)
Creates an intent in the specified agent.
Note: You should always train a flow prior to sending it queries. See the training documentation.
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 (IntentsClient intentsClient = IntentsClient.create()) {
String parent = AgentName.of("[PROJECT]", "[LOCATION]", "[AGENT]").toString();
Intent intent = Intent.newBuilder().build();
Intent response = intentsClient.createIntent(parent, intent);
}
Parameters | |
---|---|
Name | Description |
parent |
String Required. The agent to create an intent for. Format: |
intent |
Intent Required. The intent to create. |
Returns | |
---|---|
Type | Description |
Intent |
createIntentCallable()
public final UnaryCallable<CreateIntentRequest,Intent> createIntentCallable()
Creates an intent in the specified agent.
Note: You should always train a flow prior to sending it queries. See the training documentation.
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 (IntentsClient intentsClient = IntentsClient.create()) {
CreateIntentRequest request =
CreateIntentRequest.newBuilder()
.setParent(AgentName.of("[PROJECT]", "[LOCATION]", "[AGENT]").toString())
.setIntent(Intent.newBuilder().build())
.setLanguageCode("languageCode-2092349083")
.build();
ApiFuture<Intent> future = intentsClient.createIntentCallable().futureCall(request);
// Do something.
Intent response = future.get();
}
Returns | |
---|---|
Type | Description |
UnaryCallable<CreateIntentRequest,Intent> |
deleteIntent(DeleteIntentRequest request)
public final void deleteIntent(DeleteIntentRequest request)
Deletes the specified intent.
Note: You should always train a flow prior to sending it queries. See the training documentation.
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 (IntentsClient intentsClient = IntentsClient.create()) {
DeleteIntentRequest request =
DeleteIntentRequest.newBuilder()
.setName(IntentName.of("[PROJECT]", "[LOCATION]", "[AGENT]", "[INTENT]").toString())
.build();
intentsClient.deleteIntent(request);
}
Parameter | |
---|---|
Name | Description |
request |
DeleteIntentRequest The request object containing all of the parameters for the API call. |
deleteIntent(IntentName name)
public final void deleteIntent(IntentName name)
Deletes the specified intent.
Note: You should always train a flow prior to sending it queries. See the training documentation.
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 (IntentsClient intentsClient = IntentsClient.create()) {
IntentName name = IntentName.of("[PROJECT]", "[LOCATION]", "[AGENT]", "[INTENT]");
intentsClient.deleteIntent(name);
}
Parameter | |
---|---|
Name | Description |
name |
IntentName Required. The name of the intent to delete. Format: |
deleteIntent(String name)
public final void deleteIntent(String name)
Deletes the specified intent.
Note: You should always train a flow prior to sending it queries. See the training documentation.
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 (IntentsClient intentsClient = IntentsClient.create()) {
String name = IntentName.of("[PROJECT]", "[LOCATION]", "[AGENT]", "[INTENT]").toString();
intentsClient.deleteIntent(name);
}
Parameter | |
---|---|
Name | Description |
name |
String Required. The name of the intent to delete. Format: |
deleteIntentCallable()
public final UnaryCallable<DeleteIntentRequest,Empty> deleteIntentCallable()
Deletes the specified intent.
Note: You should always train a flow prior to sending it queries. See the training documentation.
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 (IntentsClient intentsClient = IntentsClient.create()) {
DeleteIntentRequest request =
DeleteIntentRequest.newBuilder()
.setName(IntentName.of("[PROJECT]", "[LOCATION]", "[AGENT]", "[INTENT]").toString())
.build();
ApiFuture<Empty> future = intentsClient.deleteIntentCallable().futureCall(request);
// Do something.
future.get();
}
Returns | |
---|---|
Type | Description |
UnaryCallable<DeleteIntentRequest,Empty> |
exportIntentsAsync(ExportIntentsRequest request)
public final OperationFuture<ExportIntentsResponse,ExportIntentsMetadata> exportIntentsAsync(ExportIntentsRequest request)
Exports the selected intents.
This method is a long-running
operation. The
returned Operation
type has the following method-specific fields:
- metadata
: ExportIntentsMetadata -
response
: ExportIntentsResponse
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 (IntentsClient intentsClient = IntentsClient.create()) {
ExportIntentsRequest request =
ExportIntentsRequest.newBuilder()
.setParent(AgentName.of("[PROJECT]", "[LOCATION]", "[AGENT]").toString())
.addAllIntents(new ArrayList<String>())
.build();
ExportIntentsResponse response = intentsClient.exportIntentsAsync(request).get();
}
Parameter | |
---|---|
Name | Description |
request |
ExportIntentsRequest The request object containing all of the parameters for the API call. |
Returns | |
---|---|
Type | Description |
OperationFuture<ExportIntentsResponse,ExportIntentsMetadata> |
exportIntentsCallable()
public final UnaryCallable<ExportIntentsRequest,Operation> exportIntentsCallable()
Exports the selected intents.
This method is a long-running
operation. The
returned Operation
type has the following method-specific fields:
- metadata
: ExportIntentsMetadata -
response
: ExportIntentsResponse
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 (IntentsClient intentsClient = IntentsClient.create()) {
ExportIntentsRequest request =
ExportIntentsRequest.newBuilder()
.setParent(AgentName.of("[PROJECT]", "[LOCATION]", "[AGENT]").toString())
.addAllIntents(new ArrayList<String>())
.build();
ApiFuture<Operation> future = intentsClient.exportIntentsCallable().futureCall(request);
// Do something.
Operation response = future.get();
}
Returns | |
---|---|
Type | Description |
UnaryCallable<ExportIntentsRequest,Operation> |
exportIntentsOperationCallable()
public final OperationCallable<ExportIntentsRequest,ExportIntentsResponse,ExportIntentsMetadata> exportIntentsOperationCallable()
Exports the selected intents.
This method is a long-running
operation. The
returned Operation
type has the following method-specific fields:
- metadata
: ExportIntentsMetadata -
response
: ExportIntentsResponse
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 (IntentsClient intentsClient = IntentsClient.create()) {
ExportIntentsRequest request =
ExportIntentsRequest.newBuilder()
.setParent(AgentName.of("[PROJECT]", "[LOCATION]", "[AGENT]").toString())
.addAllIntents(new ArrayList<String>())
.build();
OperationFuture<ExportIntentsResponse, ExportIntentsMetadata> future =
intentsClient.exportIntentsOperationCallable().futureCall(request);
// Do something.
ExportIntentsResponse response = future.get();
}
Returns | |
---|---|
Type | Description |
OperationCallable<ExportIntentsRequest,ExportIntentsResponse,ExportIntentsMetadata> |
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 |
getIntent(GetIntentRequest request)
public final Intent getIntent(GetIntentRequest request)
Retrieves the specified intent.
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 (IntentsClient intentsClient = IntentsClient.create()) {
GetIntentRequest request =
GetIntentRequest.newBuilder()
.setName(IntentName.of("[PROJECT]", "[LOCATION]", "[AGENT]", "[INTENT]").toString())
.setLanguageCode("languageCode-2092349083")
.build();
Intent response = intentsClient.getIntent(request);
}
Parameter | |
---|---|
Name | Description |
request |
GetIntentRequest The request object containing all of the parameters for the API call. |
Returns | |
---|---|
Type | Description |
Intent |
getIntent(IntentName name)
public final Intent getIntent(IntentName name)
Retrieves the specified intent.
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 (IntentsClient intentsClient = IntentsClient.create()) {
IntentName name = IntentName.of("[PROJECT]", "[LOCATION]", "[AGENT]", "[INTENT]");
Intent response = intentsClient.getIntent(name);
}
Parameter | |
---|---|
Name | Description |
name |
IntentName Required. The name of the intent. Format: |
Returns | |
---|---|
Type | Description |
Intent |
getIntent(String name)
public final Intent getIntent(String name)
Retrieves the specified intent.
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 (IntentsClient intentsClient = IntentsClient.create()) {
String name = IntentName.of("[PROJECT]", "[LOCATION]", "[AGENT]", "[INTENT]").toString();
Intent response = intentsClient.getIntent(name);
}
Parameter | |
---|---|
Name | Description |
name |
String Required. The name of the intent. Format: |
Returns | |
---|---|
Type | Description |
Intent |
getIntentCallable()
public final UnaryCallable<GetIntentRequest,Intent> getIntentCallable()
Retrieves the specified intent.
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 (IntentsClient intentsClient = IntentsClient.create()) {
GetIntentRequest request =
GetIntentRequest.newBuilder()
.setName(IntentName.of("[PROJECT]", "[LOCATION]", "[AGENT]", "[INTENT]").toString())
.setLanguageCode("languageCode-2092349083")
.build();
ApiFuture<Intent> future = intentsClient.getIntentCallable().futureCall(request);
// Do something.
Intent response = future.get();
}
Returns | |
---|---|
Type | Description |
UnaryCallable<GetIntentRequest,Intent> |
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 (IntentsClient intentsClient = IntentsClient.create()) {
GetLocationRequest request = GetLocationRequest.newBuilder().setName("name3373707").build();
Location response = intentsClient.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 (IntentsClient intentsClient = IntentsClient.create()) {
GetLocationRequest request = GetLocationRequest.newBuilder().setName("name3373707").build();
ApiFuture<Location> future = intentsClient.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 IntentsSettings getSettings()
Returns | |
---|---|
Type | Description |
IntentsSettings |
getStub()
public IntentsStub getStub()
Returns | |
---|---|
Type | Description |
IntentsStub |
importIntentsAsync(ImportIntentsRequest request)
public final OperationFuture<ImportIntentsResponse,ImportIntentsMetadata> importIntentsAsync(ImportIntentsRequest request)
Imports the specified intents into the agent.
This method is a long-running
operation. The
returned Operation
type has the following method-specific fields:
- metadata
: ImportIntentsMetadata -
response
: ImportIntentsResponse
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 (IntentsClient intentsClient = IntentsClient.create()) {
ImportIntentsRequest request =
ImportIntentsRequest.newBuilder()
.setParent(AgentName.of("[PROJECT]", "[LOCATION]", "[AGENT]").toString())
.build();
ImportIntentsResponse response = intentsClient.importIntentsAsync(request).get();
}
Parameter | |
---|---|
Name | Description |
request |
ImportIntentsRequest The request object containing all of the parameters for the API call. |
Returns | |
---|---|
Type | Description |
OperationFuture<ImportIntentsResponse,ImportIntentsMetadata> |
importIntentsCallable()
public final UnaryCallable<ImportIntentsRequest,Operation> importIntentsCallable()
Imports the specified intents into the agent.
This method is a long-running
operation. The
returned Operation
type has the following method-specific fields:
- metadata
: ImportIntentsMetadata -
response
: ImportIntentsResponse
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 (IntentsClient intentsClient = IntentsClient.create()) {
ImportIntentsRequest request =
ImportIntentsRequest.newBuilder()
.setParent(AgentName.of("[PROJECT]", "[LOCATION]", "[AGENT]").toString())
.build();
ApiFuture<Operation> future = intentsClient.importIntentsCallable().futureCall(request);
// Do something.
Operation response = future.get();
}
Returns | |
---|---|
Type | Description |
UnaryCallable<ImportIntentsRequest,Operation> |
importIntentsOperationCallable()
public final OperationCallable<ImportIntentsRequest,ImportIntentsResponse,ImportIntentsMetadata> importIntentsOperationCallable()
Imports the specified intents into the agent.
This method is a long-running
operation. The
returned Operation
type has the following method-specific fields:
- metadata
: ImportIntentsMetadata -
response
: ImportIntentsResponse
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 (IntentsClient intentsClient = IntentsClient.create()) {
ImportIntentsRequest request =
ImportIntentsRequest.newBuilder()
.setParent(AgentName.of("[PROJECT]", "[LOCATION]", "[AGENT]").toString())
.build();
OperationFuture<ImportIntentsResponse, ImportIntentsMetadata> future =
intentsClient.importIntentsOperationCallable().futureCall(request);
// Do something.
ImportIntentsResponse response = future.get();
}
Returns | |
---|---|
Type | Description |
OperationCallable<ImportIntentsRequest,ImportIntentsResponse,ImportIntentsMetadata> |
isShutdown()
public boolean isShutdown()
Returns | |
---|---|
Type | Description |
boolean |
isTerminated()
public boolean isTerminated()
Returns | |
---|---|
Type | Description |
boolean |
listIntents(AgentName parent)
public final IntentsClient.ListIntentsPagedResponse listIntents(AgentName parent)
Returns the list of all intents in the specified agent.
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 (IntentsClient intentsClient = IntentsClient.create()) {
AgentName parent = AgentName.of("[PROJECT]", "[LOCATION]", "[AGENT]");
for (Intent element : intentsClient.listIntents(parent).iterateAll()) {
// doThingsWith(element);
}
}
Parameter | |
---|---|
Name | Description |
parent |
AgentName Required. The agent to list all intents for. Format: |
Returns | |
---|---|
Type | Description |
IntentsClient.ListIntentsPagedResponse |
listIntents(ListIntentsRequest request)
public final IntentsClient.ListIntentsPagedResponse listIntents(ListIntentsRequest request)
Returns the list of all intents in the specified agent.
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 (IntentsClient intentsClient = IntentsClient.create()) {
ListIntentsRequest request =
ListIntentsRequest.newBuilder()
.setParent(AgentName.of("[PROJECT]", "[LOCATION]", "[AGENT]").toString())
.setLanguageCode("languageCode-2092349083")
.setIntentView(IntentView.forNumber(0))
.setPageSize(883849137)
.setPageToken("pageToken873572522")
.build();
for (Intent element : intentsClient.listIntents(request).iterateAll()) {
// doThingsWith(element);
}
}
Parameter | |
---|---|
Name | Description |
request |
ListIntentsRequest The request object containing all of the parameters for the API call. |
Returns | |
---|---|
Type | Description |
IntentsClient.ListIntentsPagedResponse |
listIntents(String parent)
public final IntentsClient.ListIntentsPagedResponse listIntents(String parent)
Returns the list of all intents in the specified agent.
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 (IntentsClient intentsClient = IntentsClient.create()) {
String parent = AgentName.of("[PROJECT]", "[LOCATION]", "[AGENT]").toString();
for (Intent element : intentsClient.listIntents(parent).iterateAll()) {
// doThingsWith(element);
}
}
Parameter | |
---|---|
Name | Description |
parent |
String Required. The agent to list all intents for. Format: |
Returns | |
---|---|
Type | Description |
IntentsClient.ListIntentsPagedResponse |
listIntentsCallable()
public final UnaryCallable<ListIntentsRequest,ListIntentsResponse> listIntentsCallable()
Returns the list of all intents in the specified agent.
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 (IntentsClient intentsClient = IntentsClient.create()) {
ListIntentsRequest request =
ListIntentsRequest.newBuilder()
.setParent(AgentName.of("[PROJECT]", "[LOCATION]", "[AGENT]").toString())
.setLanguageCode("languageCode-2092349083")
.setIntentView(IntentView.forNumber(0))
.setPageSize(883849137)
.setPageToken("pageToken873572522")
.build();
while (true) {
ListIntentsResponse response = intentsClient.listIntentsCallable().call(request);
for (Intent element : response.getIntentsList()) {
// doThingsWith(element);
}
String nextPageToken = response.getNextPageToken();
if (!Strings.isNullOrEmpty(nextPageToken)) {
request = request.toBuilder().setPageToken(nextPageToken).build();
} else {
break;
}
}
}
Returns | |
---|---|
Type | Description |
UnaryCallable<ListIntentsRequest,ListIntentsResponse> |
listIntentsPagedCallable()
public final UnaryCallable<ListIntentsRequest,IntentsClient.ListIntentsPagedResponse> listIntentsPagedCallable()
Returns the list of all intents in the specified agent.
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 (IntentsClient intentsClient = IntentsClient.create()) {
ListIntentsRequest request =
ListIntentsRequest.newBuilder()
.setParent(AgentName.of("[PROJECT]", "[LOCATION]", "[AGENT]").toString())
.setLanguageCode("languageCode-2092349083")
.setIntentView(IntentView.forNumber(0))
.setPageSize(883849137)
.setPageToken("pageToken873572522")
.build();
ApiFuture<Intent> future = intentsClient.listIntentsPagedCallable().futureCall(request);
// Do something.
for (Intent element : future.get().iterateAll()) {
// doThingsWith(element);
}
}
Returns | |
---|---|
Type | Description |
UnaryCallable<ListIntentsRequest,ListIntentsPagedResponse> |
listLocations(ListLocationsRequest request)
public final IntentsClient.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 (IntentsClient intentsClient = IntentsClient.create()) {
ListLocationsRequest request =
ListLocationsRequest.newBuilder()
.setName("name3373707")
.setFilter("filter-1274492040")
.setPageSize(883849137)
.setPageToken("pageToken873572522")
.build();
for (Location element : intentsClient.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 |
IntentsClient.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 (IntentsClient intentsClient = IntentsClient.create()) {
ListLocationsRequest request =
ListLocationsRequest.newBuilder()
.setName("name3373707")
.setFilter("filter-1274492040")
.setPageSize(883849137)
.setPageToken("pageToken873572522")
.build();
while (true) {
ListLocationsResponse response = intentsClient.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,IntentsClient.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 (IntentsClient intentsClient = IntentsClient.create()) {
ListLocationsRequest request =
ListLocationsRequest.newBuilder()
.setName("name3373707")
.setFilter("filter-1274492040")
.setPageSize(883849137)
.setPageToken("pageToken873572522")
.build();
ApiFuture<Location> future = intentsClient.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()
updateIntent(Intent intent, FieldMask updateMask)
public final Intent updateIntent(Intent intent, FieldMask updateMask)
Updates the specified intent.
Note: You should always train a flow prior to sending it queries. See the training documentation.
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 (IntentsClient intentsClient = IntentsClient.create()) {
Intent intent = Intent.newBuilder().build();
FieldMask updateMask = FieldMask.newBuilder().build();
Intent response = intentsClient.updateIntent(intent, updateMask);
}
Parameters | |
---|---|
Name | Description |
intent |
Intent Required. The intent to update. |
updateMask |
FieldMask The mask to control which fields get updated. If the mask is not present, all fields will be updated. |
Returns | |
---|---|
Type | Description |
Intent |
updateIntent(UpdateIntentRequest request)
public final Intent updateIntent(UpdateIntentRequest request)
Updates the specified intent.
Note: You should always train a flow prior to sending it queries. See the training documentation.
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 (IntentsClient intentsClient = IntentsClient.create()) {
UpdateIntentRequest request =
UpdateIntentRequest.newBuilder()
.setIntent(Intent.newBuilder().build())
.setLanguageCode("languageCode-2092349083")
.setUpdateMask(FieldMask.newBuilder().build())
.build();
Intent response = intentsClient.updateIntent(request);
}
Parameter | |
---|---|
Name | Description |
request |
UpdateIntentRequest The request object containing all of the parameters for the API call. |
Returns | |
---|---|
Type | Description |
Intent |
updateIntentCallable()
public final UnaryCallable<UpdateIntentRequest,Intent> updateIntentCallable()
Updates the specified intent.
Note: You should always train a flow prior to sending it queries. See the training documentation.
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 (IntentsClient intentsClient = IntentsClient.create()) {
UpdateIntentRequest request =
UpdateIntentRequest.newBuilder()
.setIntent(Intent.newBuilder().build())
.setLanguageCode("languageCode-2092349083")
.setUpdateMask(FieldMask.newBuilder().build())
.build();
ApiFuture<Intent> future = intentsClient.updateIntentCallable().futureCall(request);
// Do something.
Intent response = future.get();
}
Returns | |
---|---|
Type | Description |
UnaryCallable<UpdateIntentRequest,Intent> |