com.google.cloud.dialogflow.v2beta1

Class SessionEntityTypesClient

java.lang.Object

com.google.cloud.dialogflow.v2beta1.SessionEntityTypesClient

All Implemented Interfaces:

com.google.api.gax.core.BackgroundResource, AutoCloseable

@Generated(value="by GAPIC v0.0.5")
 @BetaApi
public class SessionEntityTypesClient
extends Object
implements com.google.api.gax.core.BackgroundResource

Service Description: Manages session entity types.

Session entity types can be redefined on a session level, allowing for specific concepts, like a user's playlists.

Standard methods.

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 (SessionEntityTypesClient sessionEntityTypesClient = SessionEntityTypesClient.create()) {
   SessionEntityTypeName name = SessionEntityTypeName.of("[PROJECT]", "[SESSION]", "[ENTITY_TYPE]");
   SessionEntityType response = sessionEntityTypesClient.getSessionEntityType(name);
 }
 
 

Note: close() needs to be called on the sessionEntityTypesClient 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:

1. 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.
2. 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.
3. 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 SessionEntityTypesSettings to create(). For example:

To customize credentials:

 
 SessionEntityTypesSettings sessionEntityTypesSettings =
     SessionEntityTypesSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 SessionEntityTypesClient sessionEntityTypesClient =
     SessionEntityTypesClient.create(sessionEntityTypesSettings);
 
 

To customize the endpoint:

 
 SessionEntityTypesSettings sessionEntityTypesSettings =
     SessionEntityTypesSettings.newBuilder().setEndpoint(myEndpoint).build();
 SessionEntityTypesClient sessionEntityTypesClient =
     SessionEntityTypesClient.create(sessionEntityTypesSettings);
 
 

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	SessionEntityTypesClient(SessionEntityTypesSettings settings) Constructs an instance of SessionEntityTypesClient, using the given settings.
protected	SessionEntityTypesClient(SessionEntityTypesStub stub)

Method Summary

Modifier and Type	Method and Description
boolean	awaitTermination(long duration, TimeUnit unit)
void	close()
static SessionEntityTypesClient	create() Constructs an instance of SessionEntityTypesClient with default settings.
static SessionEntityTypesClient	create(SessionEntityTypesSettings settings) Constructs an instance of SessionEntityTypesClient, using the given settings.
static SessionEntityTypesClient	create(SessionEntityTypesStub stub) Constructs an instance of SessionEntityTypesClient, using the given stub for making calls.
com.google.cloud.dialogflow.v2beta1.SessionEntityType	createSessionEntityType(com.google.cloud.dialogflow.v2beta1.CreateSessionEntityTypeRequest request) Creates a session entity type.
com.google.cloud.dialogflow.v2beta1.SessionEntityType	createSessionEntityType(com.google.cloud.dialogflow.v2beta1.SessionName parent, com.google.cloud.dialogflow.v2beta1.SessionEntityType sessionEntityType) Creates a session entity type.
com.google.api.gax.rpc.UnaryCallable<com.google.cloud.dialogflow.v2beta1.CreateSessionEntityTypeRequest,com.google.cloud.dialogflow.v2beta1.SessionEntityType>	createSessionEntityTypeCallable() Creates a session entity type.
void	deleteSessionEntityType(com.google.cloud.dialogflow.v2beta1.SessionEntityTypeName name) Deletes the specified session entity type.
com.google.api.gax.rpc.UnaryCallable<com.google.cloud.dialogflow.v2beta1.DeleteSessionEntityTypeRequest,com.google.protobuf.Empty>	deleteSessionEntityTypeCallable() Deletes the specified session entity type.
com.google.cloud.dialogflow.v2beta1.SessionEntityType	getSessionEntityType(com.google.cloud.dialogflow.v2beta1.SessionEntityTypeName name) Retrieves the specified session entity type.
com.google.api.gax.rpc.UnaryCallable<com.google.cloud.dialogflow.v2beta1.GetSessionEntityTypeRequest,com.google.cloud.dialogflow.v2beta1.SessionEntityType>	getSessionEntityTypeCallable() Retrieves the specified session entity type.
SessionEntityTypesSettings	getSettings()
SessionEntityTypesStub	getStub()
boolean	isShutdown()
boolean	isTerminated()
PagedResponseWrappers.ListSessionEntityTypesPagedResponse	listSessionEntityTypes(com.google.cloud.dialogflow.v2beta1.ListSessionEntityTypesRequest request) Returns the list of all session entity types in the specified session.
PagedResponseWrappers.ListSessionEntityTypesPagedResponse	listSessionEntityTypes(com.google.cloud.dialogflow.v2beta1.SessionName parent) Returns the list of all session entity types in the specified session.
com.google.api.gax.rpc.UnaryCallable<com.google.cloud.dialogflow.v2beta1.ListSessionEntityTypesRequest,com.google.cloud.dialogflow.v2beta1.ListSessionEntityTypesResponse>	listSessionEntityTypesCallable() Returns the list of all session entity types in the specified session.
com.google.api.gax.rpc.UnaryCallable<com.google.cloud.dialogflow.v2beta1.ListSessionEntityTypesRequest,PagedResponseWrappers.ListSessionEntityTypesPagedResponse>	listSessionEntityTypesPagedCallable() Returns the list of all session entity types in the specified session.
void	shutdown()
void	shutdownNow()
com.google.cloud.dialogflow.v2beta1.SessionEntityType	updateSessionEntityType(com.google.cloud.dialogflow.v2beta1.SessionEntityType sessionEntityType) Updates the specified session entity type.
com.google.cloud.dialogflow.v2beta1.SessionEntityType	updateSessionEntityType(com.google.cloud.dialogflow.v2beta1.UpdateSessionEntityTypeRequest request) Updates the specified session entity type.
com.google.api.gax.rpc.UnaryCallable<com.google.cloud.dialogflow.v2beta1.UpdateSessionEntityTypeRequest,com.google.cloud.dialogflow.v2beta1.SessionEntityType>	updateSessionEntityTypeCallable() Updates the specified session entity type.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SessionEntityTypesClient

protected SessionEntityTypesClient(SessionEntityTypesSettings settings)
                            throws IOException

Constructs an instance of SessionEntityTypesClient, 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.

Throws:

IOException

SessionEntityTypesClient

@BetaApi(value="A restructuring of stub classes is planned, so this may break in the future")
protected SessionEntityTypesClient(SessionEntityTypesStub stub)

Method Detail

create

public static final SessionEntityTypesClient create()
                                             throws IOException

Constructs an instance of SessionEntityTypesClient with default settings.

Throws:

IOException

create

public static final SessionEntityTypesClient create(SessionEntityTypesSettings settings)
                                             throws IOException

Constructs an instance of SessionEntityTypesClient, using the given settings. The channels are created based on the settings passed in, or defaults for any settings that are not set.

Throws:

IOException

create

@BetaApi(value="A restructuring of stub classes is planned, so this may break in the future")
public static final SessionEntityTypesClient create(SessionEntityTypesStub stub)

Constructs an instance of SessionEntityTypesClient, using the given stub for making calls. This is for advanced usage - prefer to use SessionEntityTypesSettings}.

getSettings

public final SessionEntityTypesSettings getSettings()

getStub

@BetaApi(value="A restructuring of stub classes is planned, so this may break in the future")
public SessionEntityTypesStub getStub()

listSessionEntityTypes

public final PagedResponseWrappers.ListSessionEntityTypesPagedResponse listSessionEntityTypes(com.google.cloud.dialogflow.v2beta1.SessionName parent)

Returns the list of all session entity types in the specified session.

Sample code:

 try (SessionEntityTypesClient sessionEntityTypesClient = SessionEntityTypesClient.create()) {
   SessionName parent = SessionName.of("[PROJECT]", "[SESSION]");
   for (SessionEntityType element : sessionEntityTypesClient.listSessionEntityTypes(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Parameters:

parent - Required. The session to list all session entity types from. Format: `projects/<Project ID>/agent/sessions/<Session ID>`.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

listSessionEntityTypes

public final PagedResponseWrappers.ListSessionEntityTypesPagedResponse listSessionEntityTypes(com.google.cloud.dialogflow.v2beta1.ListSessionEntityTypesRequest request)

Returns the list of all session entity types in the specified session.

Sample code:

 try (SessionEntityTypesClient sessionEntityTypesClient = SessionEntityTypesClient.create()) {
   SessionName parent = SessionName.of("[PROJECT]", "[SESSION]");
   ListSessionEntityTypesRequest request = ListSessionEntityTypesRequest.newBuilder()
     .setParentWithSessionName(parent)
     .build();
   for (SessionEntityType element : sessionEntityTypesClient.listSessionEntityTypes(request).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Parameters:

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

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

listSessionEntityTypesPagedCallable

public final com.google.api.gax.rpc.UnaryCallable<com.google.cloud.dialogflow.v2beta1.ListSessionEntityTypesRequest,PagedResponseWrappers.ListSessionEntityTypesPagedResponse> listSessionEntityTypesPagedCallable()

Returns the list of all session entity types in the specified session.

Sample code:

 try (SessionEntityTypesClient sessionEntityTypesClient = SessionEntityTypesClient.create()) {
   SessionName parent = SessionName.of("[PROJECT]", "[SESSION]");
   ListSessionEntityTypesRequest request = ListSessionEntityTypesRequest.newBuilder()
     .setParentWithSessionName(parent)
     .build();
   ApiFuture<ListSessionEntityTypesPagedResponse> future = sessionEntityTypesClient.listSessionEntityTypesPagedCallable().futureCall(request);
   // Do something
   for (SessionEntityType element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }
 

listSessionEntityTypesCallable

public final com.google.api.gax.rpc.UnaryCallable<com.google.cloud.dialogflow.v2beta1.ListSessionEntityTypesRequest,com.google.cloud.dialogflow.v2beta1.ListSessionEntityTypesResponse> listSessionEntityTypesCallable()

Returns the list of all session entity types in the specified session.

Sample code:

 try (SessionEntityTypesClient sessionEntityTypesClient = SessionEntityTypesClient.create()) {
   SessionName parent = SessionName.of("[PROJECT]", "[SESSION]");
   ListSessionEntityTypesRequest request = ListSessionEntityTypesRequest.newBuilder()
     .setParentWithSessionName(parent)
     .build();
   while (true) {
     ListSessionEntityTypesResponse response = sessionEntityTypesClient.listSessionEntityTypesCallable().call(request);
     for (SessionEntityType element : response.getSessionEntityTypesList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }
 

getSessionEntityType

public final com.google.cloud.dialogflow.v2beta1.SessionEntityType getSessionEntityType(com.google.cloud.dialogflow.v2beta1.SessionEntityTypeName name)

Retrieves the specified session entity type.

Sample code:

 try (SessionEntityTypesClient sessionEntityTypesClient = SessionEntityTypesClient.create()) {
   SessionEntityTypeName name = SessionEntityTypeName.of("[PROJECT]", "[SESSION]", "[ENTITY_TYPE]");
   SessionEntityType response = sessionEntityTypesClient.getSessionEntityType(name);
 }
 

Parameters:

name - Required. The name of the session entity type. Format: `projects/<Project ID>/agent/sessions/<Session ID>/entityTypes/<Entity Type Display Name>`.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

getSessionEntityTypeCallable

public final com.google.api.gax.rpc.UnaryCallable<com.google.cloud.dialogflow.v2beta1.GetSessionEntityTypeRequest,com.google.cloud.dialogflow.v2beta1.SessionEntityType> getSessionEntityTypeCallable()

Retrieves the specified session entity type.

Sample code:

 try (SessionEntityTypesClient sessionEntityTypesClient = SessionEntityTypesClient.create()) {
   SessionEntityTypeName name = SessionEntityTypeName.of("[PROJECT]", "[SESSION]", "[ENTITY_TYPE]");
   GetSessionEntityTypeRequest request = GetSessionEntityTypeRequest.newBuilder()
     .setNameWithSessionEntityTypeName(name)
     .build();
   ApiFuture<SessionEntityType> future = sessionEntityTypesClient.getSessionEntityTypeCallable().futureCall(request);
   // Do something
   SessionEntityType response = future.get();
 }
 

createSessionEntityType

public final com.google.cloud.dialogflow.v2beta1.SessionEntityType createSessionEntityType(com.google.cloud.dialogflow.v2beta1.SessionName parent,
                                                                                           com.google.cloud.dialogflow.v2beta1.SessionEntityType sessionEntityType)

Creates a session entity type.

Sample code:

 try (SessionEntityTypesClient sessionEntityTypesClient = SessionEntityTypesClient.create()) {
   SessionName parent = SessionName.of("[PROJECT]", "[SESSION]");
   SessionEntityType sessionEntityType = SessionEntityType.newBuilder().build();
   SessionEntityType response = sessionEntityTypesClient.createSessionEntityType(parent, sessionEntityType);
 }
 

Parameters:

parent - Required. The session to create a session entity type for. Format: `projects/<Project ID>/agent/sessions/<Session ID>`.

sessionEntityType - Required. The session entity type to create.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

createSessionEntityType

public final com.google.cloud.dialogflow.v2beta1.SessionEntityType createSessionEntityType(com.google.cloud.dialogflow.v2beta1.CreateSessionEntityTypeRequest request)

Creates a session entity type.

Sample code:

 try (SessionEntityTypesClient sessionEntityTypesClient = SessionEntityTypesClient.create()) {
   SessionName parent = SessionName.of("[PROJECT]", "[SESSION]");
   SessionEntityType sessionEntityType = SessionEntityType.newBuilder().build();
   CreateSessionEntityTypeRequest request = CreateSessionEntityTypeRequest.newBuilder()
     .setParentWithSessionName(parent)
     .setSessionEntityType(sessionEntityType)
     .build();
   SessionEntityType response = sessionEntityTypesClient.createSessionEntityType(request);
 }
 

Parameters:

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

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

createSessionEntityTypeCallable

public final com.google.api.gax.rpc.UnaryCallable<com.google.cloud.dialogflow.v2beta1.CreateSessionEntityTypeRequest,com.google.cloud.dialogflow.v2beta1.SessionEntityType> createSessionEntityTypeCallable()

Creates a session entity type.

Sample code:

 try (SessionEntityTypesClient sessionEntityTypesClient = SessionEntityTypesClient.create()) {
   SessionName parent = SessionName.of("[PROJECT]", "[SESSION]");
   SessionEntityType sessionEntityType = SessionEntityType.newBuilder().build();
   CreateSessionEntityTypeRequest request = CreateSessionEntityTypeRequest.newBuilder()
     .setParentWithSessionName(parent)
     .setSessionEntityType(sessionEntityType)
     .build();
   ApiFuture<SessionEntityType> future = sessionEntityTypesClient.createSessionEntityTypeCallable().futureCall(request);
   // Do something
   SessionEntityType response = future.get();
 }
 

updateSessionEntityType

public final com.google.cloud.dialogflow.v2beta1.SessionEntityType updateSessionEntityType(com.google.cloud.dialogflow.v2beta1.SessionEntityType sessionEntityType)

Updates the specified session entity type.

Sample code:

 try (SessionEntityTypesClient sessionEntityTypesClient = SessionEntityTypesClient.create()) {
   SessionEntityType sessionEntityType = SessionEntityType.newBuilder().build();
   SessionEntityType response = sessionEntityTypesClient.updateSessionEntityType(sessionEntityType);
 }
 

Parameters:

sessionEntityType - Required. The entity type to update. Format: `projects/<Project ID>/agent/sessions/<Session ID>/entityTypes/<Entity Type Display Name>`.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

updateSessionEntityType

public final com.google.cloud.dialogflow.v2beta1.SessionEntityType updateSessionEntityType(com.google.cloud.dialogflow.v2beta1.UpdateSessionEntityTypeRequest request)

Updates the specified session entity type.

Sample code:

 try (SessionEntityTypesClient sessionEntityTypesClient = SessionEntityTypesClient.create()) {
   SessionEntityType sessionEntityType = SessionEntityType.newBuilder().build();
   UpdateSessionEntityTypeRequest request = UpdateSessionEntityTypeRequest.newBuilder()
     .setSessionEntityType(sessionEntityType)
     .build();
   SessionEntityType response = sessionEntityTypesClient.updateSessionEntityType(request);
 }
 

Parameters:

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

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

updateSessionEntityTypeCallable

public final com.google.api.gax.rpc.UnaryCallable<com.google.cloud.dialogflow.v2beta1.UpdateSessionEntityTypeRequest,com.google.cloud.dialogflow.v2beta1.SessionEntityType> updateSessionEntityTypeCallable()

Updates the specified session entity type.

Sample code:

 try (SessionEntityTypesClient sessionEntityTypesClient = SessionEntityTypesClient.create()) {
   SessionEntityType sessionEntityType = SessionEntityType.newBuilder().build();
   UpdateSessionEntityTypeRequest request = UpdateSessionEntityTypeRequest.newBuilder()
     .setSessionEntityType(sessionEntityType)
     .build();
   ApiFuture<SessionEntityType> future = sessionEntityTypesClient.updateSessionEntityTypeCallable().futureCall(request);
   // Do something
   SessionEntityType response = future.get();
 }
 

deleteSessionEntityType

public final void deleteSessionEntityType(com.google.cloud.dialogflow.v2beta1.SessionEntityTypeName name)

Deletes the specified session entity type.

Sample code:

 try (SessionEntityTypesClient sessionEntityTypesClient = SessionEntityTypesClient.create()) {
   SessionEntityTypeName name = SessionEntityTypeName.of("[PROJECT]", "[SESSION]", "[ENTITY_TYPE]");
   sessionEntityTypesClient.deleteSessionEntityType(name);
 }
 

Parameters:

name - Required. The name of the entity type to delete. Format: `projects/<Project ID>/agent/sessions/<Session ID>/entityTypes/<Entity Type Display Name>`.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

deleteSessionEntityTypeCallable

public final com.google.api.gax.rpc.UnaryCallable<com.google.cloud.dialogflow.v2beta1.DeleteSessionEntityTypeRequest,com.google.protobuf.Empty> deleteSessionEntityTypeCallable()

Deletes the specified session entity type.

Sample code:

 try (SessionEntityTypesClient sessionEntityTypesClient = SessionEntityTypesClient.create()) {
   SessionEntityTypeName name = SessionEntityTypeName.of("[PROJECT]", "[SESSION]", "[ENTITY_TYPE]");
   DeleteSessionEntityTypeRequest request = DeleteSessionEntityTypeRequest.newBuilder()
     .setNameWithSessionEntityTypeName(name)
     .build();
   ApiFuture<Void> future = sessionEntityTypesClient.deleteSessionEntityTypeCallable().futureCall(request);
   // Do something
   future.get();
 }
 

close

public final void close()
                 throws Exception

Specified by:

close in interface AutoCloseable

Throws:

Exception

shutdown

public void shutdown()

Specified by:

shutdown in interface com.google.api.gax.core.BackgroundResource

isShutdown

public boolean isShutdown()

Specified by:

isShutdown in interface com.google.api.gax.core.BackgroundResource

isTerminated

public boolean isTerminated()

Specified by:

isTerminated in interface com.google.api.gax.core.BackgroundResource

shutdownNow

public void shutdownNow()

Specified by:

shutdownNow in interface com.google.api.gax.core.BackgroundResource

awaitTermination

public boolean awaitTermination(long duration,
                                TimeUnit unit)
                         throws InterruptedException

Specified by:

awaitTermination in interface com.google.api.gax.core.BackgroundResource

Throws:

InterruptedException