- 0.63.0 (latest)
- 0.62.0
- 0.60.0
- 0.59.0
- 0.58.0
- 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
public class IntentsClient implements BackgroundResource
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:
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().
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 IntentsSettings to create(). For example:
To customize credentials:
IntentsSettings intentsSettings =
IntentsSettings.newBuilder()
.setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
.build();
IntentsClient intentsClient = IntentsClient.create(intentsSettings);
To customize the endpoint:
IntentsSettings intentsSettings = IntentsSettings.newBuilder().setEndpoint(myEndpoint).build();
IntentsClient intentsClient = IntentsClient.create(intentsSettings);
Please refer to the GitHub repository's samples for more quickstart code snippets.
Implements
BackgroundResourceStatic Methods
create()
public static final IntentsClient create()
Constructs an instance of IntentsClient with default settings.
Type | Description |
IntentsClient |
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.
Name | Description |
settings | IntentsSettings |
Type | Description |
IntentsClient |
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).
Name | Description |
stub | IntentsStub |
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.
Name | Description |
settings | IntentsSettings |
IntentsClient(IntentsStub stub)
protected IntentsClient(IntentsStub stub)
Name | Description |
stub | IntentsStub |
Methods
awaitTermination(long duration, TimeUnit unit)
public boolean awaitTermination(long duration, TimeUnit unit)
Name | Description |
duration | long |
unit | TimeUnit |
Type | Description |
boolean |
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:
try (IntentsClient intentsClient = IntentsClient.create()) {
AgentName parent = AgentName.of("[PROJECT]", "[LOCATION]", "[AGENT]");
Intent intent = Intent.newBuilder().build();
Intent response = intentsClient.createIntent(parent, intent);
}
Name | Description |
parent | AgentName Required. The agent to create an intent for. Format: |
intent | Intent Required. The intent to create. |
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:
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);
}
Name | Description |
request | CreateIntentRequest The request object containing all of the parameters for the API call. |
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:
try (IntentsClient intentsClient = IntentsClient.create()) {
String parent = AgentName.of("[PROJECT]", "[LOCATION]", "[AGENT]").toString();
Intent intent = Intent.newBuilder().build();
Intent response = intentsClient.createIntent(parent, intent);
}
Name | Description |
parent | String Required. The agent to create an intent for. Format: |
intent | Intent Required. The intent to create. |
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:
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();
}
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:
try (IntentsClient intentsClient = IntentsClient.create()) {
DeleteIntentRequest request =
DeleteIntentRequest.newBuilder()
.setName(IntentName.of("[PROJECT]", "[LOCATION]", "[AGENT]", "[INTENT]").toString())
.build();
intentsClient.deleteIntent(request);
}
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:
try (IntentsClient intentsClient = IntentsClient.create()) {
IntentName name = IntentName.of("[PROJECT]", "[LOCATION]", "[AGENT]", "[INTENT]");
intentsClient.deleteIntent(name);
}
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:
try (IntentsClient intentsClient = IntentsClient.create()) {
String name = IntentName.of("[PROJECT]", "[LOCATION]", "[AGENT]", "[INTENT]").toString();
intentsClient.deleteIntent(name);
}
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:
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();
}
Type | Description |
UnaryCallable<DeleteIntentRequest,Empty> |
getIntent(GetIntentRequest request)
public final Intent getIntent(GetIntentRequest request)
Retrieves the specified intent.
Sample code:
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);
}
Name | Description |
request | GetIntentRequest The request object containing all of the parameters for the API call. |
Type | Description |
Intent |
getIntent(IntentName name)
public final Intent getIntent(IntentName name)
Retrieves the specified intent.
Sample code:
try (IntentsClient intentsClient = IntentsClient.create()) {
IntentName name = IntentName.of("[PROJECT]", "[LOCATION]", "[AGENT]", "[INTENT]");
Intent response = intentsClient.getIntent(name);
}
Name | Description |
name | IntentName Required. The name of the intent. Format: |
Type | Description |
Intent |
getIntent(String name)
public final Intent getIntent(String name)
Retrieves the specified intent.
Sample code:
try (IntentsClient intentsClient = IntentsClient.create()) {
String name = IntentName.of("[PROJECT]", "[LOCATION]", "[AGENT]", "[INTENT]").toString();
Intent response = intentsClient.getIntent(name);
}
Name | Description |
name | String Required. The name of the intent. Format: |
Type | Description |
Intent |
getIntentCallable()
public final UnaryCallable<GetIntentRequest,Intent> getIntentCallable()
Retrieves the specified intent.
Sample code:
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();
}
Type | Description |
UnaryCallable<GetIntentRequest,Intent> |
getSettings()
public final IntentsSettings getSettings()
Type | Description |
IntentsSettings |
getStub()
public IntentsStub getStub()
Type | Description |
IntentsStub |
isShutdown()
public boolean isShutdown()
Type | Description |
boolean |
isTerminated()
public boolean isTerminated()
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:
try (IntentsClient intentsClient = IntentsClient.create()) {
AgentName parent = AgentName.of("[PROJECT]", "[LOCATION]", "[AGENT]");
for (Intent element : intentsClient.listIntents(parent).iterateAll()) {
// doThingsWith(element);
}
}
Name | Description |
parent | AgentName Required. The agent to list all intents for. Format: |
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:
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);
}
}
Name | Description |
request | ListIntentsRequest The request object containing all of the parameters for the API call. |
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:
try (IntentsClient intentsClient = IntentsClient.create()) {
String parent = AgentName.of("[PROJECT]", "[LOCATION]", "[AGENT]").toString();
for (Intent element : intentsClient.listIntents(parent).iterateAll()) {
// doThingsWith(element);
}
}
Name | Description |
parent | String Required. The agent to list all intents for. Format: |
Type | Description |
IntentsClient.ListIntentsPagedResponse |
listIntentsCallable()
public final UnaryCallable<ListIntentsRequest,ListIntentsResponse> listIntentsCallable()
Returns the list of all intents in the specified agent.
Sample code:
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.getResponsesList()) {
// doThingsWith(element);
}
String nextPageToken = response.getNextPageToken();
if (!Strings.isNullOrEmpty(nextPageToken)) {
request = request.toBuilder().setPageToken(nextPageToken).build();
} else {
break;
}
}
}
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:
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);
}
}
Type | Description |
UnaryCallable<ListIntentsRequest,ListIntentsPagedResponse> |
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:
try (IntentsClient intentsClient = IntentsClient.create()) {
Intent intent = Intent.newBuilder().build();
FieldMask updateMask = FieldMask.newBuilder().build();
Intent response = intentsClient.updateIntent(intent, updateMask);
}
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. |
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:
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);
}
Name | Description |
request | UpdateIntentRequest The request object containing all of the parameters for the API call. |
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:
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();
}
Type | Description |
UnaryCallable<UpdateIntentRequest,Intent> |