Class SessionEntityTypesClient (4.61.0)

GitHub RepositoryProduct Reference

Service Description: Service for managing SessionEntityTypes.

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 (SessionEntityTypesClient sessionEntityTypesClient = SessionEntityTypesClient.create()) {
   SessionEntityTypeName name =
       SessionEntityTypeName.ofProjectSessionEntityTypeName(
           "[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().

Methods
Method Description Method Variants

ListSessionEntityTypes

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

This method doesn't work with Google Assistant integration. Contact Dialogflow support if you need to use session entities with Google Assistant integration.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • listSessionEntityTypes(ListSessionEntityTypesRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • listSessionEntityTypes(SessionName parent)

  • listSessionEntityTypes(String parent)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • listSessionEntityTypesPagedCallable()

  • listSessionEntityTypesCallable()

GetSessionEntityType

Retrieves the specified session entity type.

This method doesn't work with Google Assistant integration. Contact Dialogflow support if you need to use session entities with Google Assistant integration.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • getSessionEntityType(GetSessionEntityTypeRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • getSessionEntityType(SessionEntityTypeName name)

  • getSessionEntityType(String name)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • getSessionEntityTypeCallable()

CreateSessionEntityType

Creates a session entity type.

If the specified session entity type already exists, overrides the session entity type.

This method doesn't work with Google Assistant integration. Contact Dialogflow support if you need to use session entities with Google Assistant integration.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • createSessionEntityType(CreateSessionEntityTypeRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • createSessionEntityType(SessionName parent, SessionEntityType sessionEntityType)

  • createSessionEntityType(String parent, SessionEntityType sessionEntityType)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • createSessionEntityTypeCallable()

UpdateSessionEntityType

Updates the specified session entity type.

This method doesn't work with Google Assistant integration. Contact Dialogflow support if you need to use session entities with Google Assistant integration.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • updateSessionEntityType(UpdateSessionEntityTypeRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • updateSessionEntityType(SessionEntityType sessionEntityType)

  • updateSessionEntityType(SessionEntityType sessionEntityType, FieldMask updateMask)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • updateSessionEntityTypeCallable()

DeleteSessionEntityType

Deletes the specified session entity type.

This method doesn't work with Google Assistant integration. Contact Dialogflow support if you need to use session entities with Google Assistant integration.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • deleteSessionEntityType(DeleteSessionEntityTypeRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • deleteSessionEntityType(SessionEntityTypeName name)

  • deleteSessionEntityType(String name)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • deleteSessionEntityTypeCallable()

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.

  • listLocations(ListLocationsRequest request)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • listLocationsPagedCallable()

  • listLocationsCallable()

GetLocation

Gets information about a location.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • getLocation(GetLocationRequest request)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • getLocationCallable()

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:


 // 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
 SessionEntityTypesSettings sessionEntityTypesSettings =
     SessionEntityTypesSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 SessionEntityTypesClient sessionEntityTypesClient =
     SessionEntityTypesClient.create(sessionEntityTypesSettings);

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
 SessionEntityTypesSettings sessionEntityTypesSettings =
     SessionEntityTypesSettings.newBuilder().setEndpoint(myEndpoint).build();
 SessionEntityTypesClient sessionEntityTypesClient =
     SessionEntityTypesClient.create(sessionEntityTypesSettings);

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
 SessionEntityTypesSettings sessionEntityTypesSettings =
     SessionEntityTypesSettings.newHttpJsonBuilder().build();
 SessionEntityTypesClient sessionEntityTypesClient =
     SessionEntityTypesClient.create(sessionEntityTypesSettings);

Please refer to the GitHub repository's samples for more quickstart code snippets.

Inheritance

java.lang.Object > SessionEntityTypesClient

Static Methods

create()

public static final SessionEntityTypesClient create()

Constructs an instance of SessionEntityTypesClient with default settings.

Returns
Type Description
SessionEntityTypesClient
Exceptions
Type Description
IOException

create(SessionEntityTypesSettings settings)

public static final SessionEntityTypesClient create(SessionEntityTypesSettings settings)

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.

Parameter
Name Description
settings SessionEntityTypesSettings
Returns
Type Description
SessionEntityTypesClient
Exceptions
Type Description
IOException

create(SessionEntityTypesStub stub)

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 using create(SessionEntityTypesSettings).

Parameter
Name Description
stub SessionEntityTypesStub
Returns
Type Description
SessionEntityTypesClient

Constructors

SessionEntityTypesClient(SessionEntityTypesSettings settings)

protected SessionEntityTypesClient(SessionEntityTypesSettings settings)

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.

Parameter
Name Description
settings SessionEntityTypesSettings

SessionEntityTypesClient(SessionEntityTypesStub stub)

protected SessionEntityTypesClient(SessionEntityTypesStub stub)
Parameter
Name Description
stub SessionEntityTypesStub

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

createSessionEntityType(CreateSessionEntityTypeRequest request)

public final SessionEntityType createSessionEntityType(CreateSessionEntityTypeRequest request)

Creates a session entity type.

If the specified session entity type already exists, overrides the session entity type.

This method doesn't work with Google Assistant integration. Contact Dialogflow support if you need to use session entities with Google Assistant integration.

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 (SessionEntityTypesClient sessionEntityTypesClient = SessionEntityTypesClient.create()) {
   CreateSessionEntityTypeRequest request =
       CreateSessionEntityTypeRequest.newBuilder()
           .setParent(SessionName.ofProjectSessionName("[PROJECT]", "[SESSION]").toString())
           .setSessionEntityType(SessionEntityType.newBuilder().build())
           .build();
   SessionEntityType response = sessionEntityTypesClient.createSessionEntityType(request);
 }
Parameter
Name Description
request CreateSessionEntityTypeRequest

The request object containing all of the parameters for the API call.
Returns
Type Description
SessionEntityType

createSessionEntityType(SessionName parent, SessionEntityType sessionEntityType)

public final SessionEntityType createSessionEntityType(SessionName parent, SessionEntityType sessionEntityType)

Creates a session entity type.

If the specified session entity type already exists, overrides the session entity type.

This method doesn't work with Google Assistant integration. Contact Dialogflow support if you need to use session entities with Google Assistant integration.

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 (SessionEntityTypesClient sessionEntityTypesClient = SessionEntityTypesClient.create()) {
   SessionName parent = SessionName.ofProjectSessionName("[PROJECT]", "[SESSION]");
   SessionEntityType sessionEntityType = SessionEntityType.newBuilder().build();
   SessionEntityType response =
       sessionEntityTypesClient.createSessionEntityType(parent, sessionEntityType);
 }
Parameters
Name Description
parent SessionName

Required. The session to create a session entity type for. Supported formats: - projects/<Project ID>/agent/sessions/<Session ID>, - projects/<Project ID>/locations/<Location ID>/agent/sessions/<Session ID>, - projects/<Project ID>/agent/environments/<Environment ID>/users/<User ID>/sessions/<Session ID>, - projects/<Project ID>/locations/<Location ID>/agent/environments/<Environment ID>/users/<User ID>/sessions/<Session ID>,

If Location ID is not specified we assume default 'us' location. If Environment ID is not specified, we assume default 'draft' environment. If User ID` is not specified, we assume default '-' user.
sessionEntityType SessionEntityType

Required. The session entity type to create.
Returns
Type Description
SessionEntityType

createSessionEntityType(String parent, SessionEntityType sessionEntityType)

public final SessionEntityType createSessionEntityType(String parent, SessionEntityType sessionEntityType)

Creates a session entity type.

If the specified session entity type already exists, overrides the session entity type.

This method doesn't work with Google Assistant integration. Contact Dialogflow support if you need to use session entities with Google Assistant integration.

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 (SessionEntityTypesClient sessionEntityTypesClient = SessionEntityTypesClient.create()) {
   String parent = SessionName.ofProjectSessionName("[PROJECT]", "[SESSION]").toString();
   SessionEntityType sessionEntityType = SessionEntityType.newBuilder().build();
   SessionEntityType response =
       sessionEntityTypesClient.createSessionEntityType(parent, sessionEntityType);
 }
Parameters
Name Description
parent String

Required. The session to create a session entity type for. Supported formats: - projects/<Project ID>/agent/sessions/<Session ID>, - projects/<Project ID>/locations/<Location ID>/agent/sessions/<Session ID>, - projects/<Project ID>/agent/environments/<Environment ID>/users/<User ID>/sessions/<Session ID>, - projects/<Project ID>/locations/<Location ID>/agent/environments/<Environment ID>/users/<User ID>/sessions/<Session ID>,

If Location ID is not specified we assume default 'us' location. If Environment ID is not specified, we assume default 'draft' environment. If User ID` is not specified, we assume default '-' user.
sessionEntityType SessionEntityType

Required. The session entity type to create.
Returns
Type Description
SessionEntityType

createSessionEntityTypeCallable()

public final UnaryCallable<CreateSessionEntityTypeRequest,SessionEntityType> createSessionEntityTypeCallable()

Creates a session entity type.

If the specified session entity type already exists, overrides the session entity type.

This method doesn't work with Google Assistant integration. Contact Dialogflow support if you need to use session entities with Google Assistant integration.

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 (SessionEntityTypesClient sessionEntityTypesClient = SessionEntityTypesClient.create()) {
   CreateSessionEntityTypeRequest request =
       CreateSessionEntityTypeRequest.newBuilder()
           .setParent(SessionName.ofProjectSessionName("[PROJECT]", "[SESSION]").toString())
           .setSessionEntityType(SessionEntityType.newBuilder().build())
           .build();
   ApiFuture<SessionEntityType> future =
       sessionEntityTypesClient.createSessionEntityTypeCallable().futureCall(request);
   // Do something.
   SessionEntityType response = future.get();
 }
Returns
Type Description
UnaryCallable<CreateSessionEntityTypeRequest,SessionEntityType>

deleteSessionEntityType(DeleteSessionEntityTypeRequest request)

public final void deleteSessionEntityType(DeleteSessionEntityTypeRequest request)

Deletes the specified session entity type.

This method doesn't work with Google Assistant integration. Contact Dialogflow support if you need to use session entities with Google Assistant integration.

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 (SessionEntityTypesClient sessionEntityTypesClient = SessionEntityTypesClient.create()) {
   DeleteSessionEntityTypeRequest request =
       DeleteSessionEntityTypeRequest.newBuilder()
           .setName(
               SessionEntityTypeName.ofProjectSessionEntityTypeName(
                       "[PROJECT]", "[SESSION]", "[ENTITY_TYPE]")
                   .toString())
           .build();
   sessionEntityTypesClient.deleteSessionEntityType(request);
 }
Parameter
Name Description
request DeleteSessionEntityTypeRequest

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

deleteSessionEntityType(SessionEntityTypeName name)

public final void deleteSessionEntityType(SessionEntityTypeName name)

Deletes the specified session entity type.

This method doesn't work with Google Assistant integration. Contact Dialogflow support if you need to use session entities with Google Assistant integration.

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 (SessionEntityTypesClient sessionEntityTypesClient = SessionEntityTypesClient.create()) {
   SessionEntityTypeName name =
       SessionEntityTypeName.ofProjectSessionEntityTypeName(
           "[PROJECT]", "[SESSION]", "[ENTITY_TYPE]");
   sessionEntityTypesClient.deleteSessionEntityType(name);
 }
Parameter
Name Description
name SessionEntityTypeName

Required. The name of the entity type to delete. Supported formats: - projects/<Project ID>/agent/sessions/<Session ID>/entityTypes/<Entity Type Display Name> - projects/<Project ID>/locations/<Location ID>/agent/sessions/<Session ID>/entityTypes/<Entity Type Display Name> - projects/<Project ID>/agent/environments/<Environment ID>/users/<User ID>/sessions/<Session ID>/entityTypes/<Entity Type Display Name> - projects/<Project ID>/locations/<Location ID>/agent/environments/ <Environment ID>/users/<User ID>/sessions/<Session ID>/entityTypes/<Entity Type Display Name>

If Location ID is not specified we assume default 'us' location. If Environment ID is not specified, we assume default 'draft' environment. If User ID is not specified, we assume default '-' user.

deleteSessionEntityType(String name)

public final void deleteSessionEntityType(String name)

Deletes the specified session entity type.

This method doesn't work with Google Assistant integration. Contact Dialogflow support if you need to use session entities with Google Assistant integration.

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 (SessionEntityTypesClient sessionEntityTypesClient = SessionEntityTypesClient.create()) {
   String name =
       SessionEntityTypeName.ofProjectSessionEntityTypeName(
               "[PROJECT]", "[SESSION]", "[ENTITY_TYPE]")
           .toString();
   sessionEntityTypesClient.deleteSessionEntityType(name);
 }
Parameter
Name Description
name String

Required. The name of the entity type to delete. Supported formats: - projects/<Project ID>/agent/sessions/<Session ID>/entityTypes/<Entity Type Display Name> - projects/<Project ID>/locations/<Location ID>/agent/sessions/<Session ID>/entityTypes/<Entity Type Display Name> - projects/<Project ID>/agent/environments/<Environment ID>/users/<User ID>/sessions/<Session ID>/entityTypes/<Entity Type Display Name> - projects/<Project ID>/locations/<Location ID>/agent/environments/ <Environment ID>/users/<User ID>/sessions/<Session ID>/entityTypes/<Entity Type Display Name>

If Location ID is not specified we assume default 'us' location. If Environment ID is not specified, we assume default 'draft' environment. If User ID is not specified, we assume default '-' user.

deleteSessionEntityTypeCallable()

public final UnaryCallable<DeleteSessionEntityTypeRequest,Empty> deleteSessionEntityTypeCallable()

Deletes the specified session entity type.

This method doesn't work with Google Assistant integration. Contact Dialogflow support if you need to use session entities with Google Assistant integration.

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 (SessionEntityTypesClient sessionEntityTypesClient = SessionEntityTypesClient.create()) {
   DeleteSessionEntityTypeRequest request =
       DeleteSessionEntityTypeRequest.newBuilder()
           .setName(
               SessionEntityTypeName.ofProjectSessionEntityTypeName(
                       "[PROJECT]", "[SESSION]", "[ENTITY_TYPE]")
                   .toString())
           .build();
   ApiFuture<Empty> future =
       sessionEntityTypesClient.deleteSessionEntityTypeCallable().futureCall(request);
   // Do something.
   future.get();
 }
Returns
Type Description
UnaryCallable<DeleteSessionEntityTypeRequest,Empty>

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 (SessionEntityTypesClient sessionEntityTypesClient = SessionEntityTypesClient.create()) {
   GetLocationRequest request = GetLocationRequest.newBuilder().setName("name3373707").build();
   Location response = sessionEntityTypesClient.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 (SessionEntityTypesClient sessionEntityTypesClient = SessionEntityTypesClient.create()) {
   GetLocationRequest request = GetLocationRequest.newBuilder().setName("name3373707").build();
   ApiFuture<Location> future =
       sessionEntityTypesClient.getLocationCallable().futureCall(request);
   // Do something.
   Location response = future.get();
 }
Returns
Type Description
UnaryCallable<com.google.cloud.location.GetLocationRequest,com.google.cloud.location.Location>

getSessionEntityType(GetSessionEntityTypeRequest request)

public final SessionEntityType getSessionEntityType(GetSessionEntityTypeRequest request)

Retrieves the specified session entity type.

This method doesn't work with Google Assistant integration. Contact Dialogflow support if you need to use session entities with Google Assistant integration.

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 (SessionEntityTypesClient sessionEntityTypesClient = SessionEntityTypesClient.create()) {
   GetSessionEntityTypeRequest request =
       GetSessionEntityTypeRequest.newBuilder()
           .setName(
               SessionEntityTypeName.ofProjectSessionEntityTypeName(
                       "[PROJECT]", "[SESSION]", "[ENTITY_TYPE]")
                   .toString())
           .build();
   SessionEntityType response = sessionEntityTypesClient.getSessionEntityType(request);
 }
Parameter
Name Description
request GetSessionEntityTypeRequest

The request object containing all of the parameters for the API call.
Returns
Type Description
SessionEntityType

getSessionEntityType(SessionEntityTypeName name)

public final SessionEntityType getSessionEntityType(SessionEntityTypeName name)

Retrieves the specified session entity type.

This method doesn't work with Google Assistant integration. Contact Dialogflow support if you need to use session entities with Google Assistant integration.

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

Required. The name of the session entity type. Supported formats: - projects/<Project ID>/agent/sessions/<Session ID>/entityTypes/<Entity Type Display Name> - projects/<Project ID>/locations/<Location ID>/agent/sessions/<Session ID>/entityTypes/<Entity Type Display Name> - projects/<Project ID>/agent/environments/<Environment ID>/users/<User ID>/sessions/<Session ID>/entityTypes/<Entity Type Display Name> - projects/<Project ID>/locations/<Location ID>/agent/environments/ <Environment ID>/users/<User ID>/sessions/<Session ID>/entityTypes/<Entity Type Display Name>

If Location ID is not specified we assume default 'us' location. If Environment ID is not specified, we assume default 'draft' environment. If User ID is not specified, we assume default '-' user.
Returns
Type Description
SessionEntityType

getSessionEntityType(String name)

public final SessionEntityType getSessionEntityType(String name)

Retrieves the specified session entity type.

This method doesn't work with Google Assistant integration. Contact Dialogflow support if you need to use session entities with Google Assistant integration.

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

Required. The name of the session entity type. Supported formats: - projects/<Project ID>/agent/sessions/<Session ID>/entityTypes/<Entity Type Display Name> - projects/<Project ID>/locations/<Location ID>/agent/sessions/<Session ID>/entityTypes/<Entity Type Display Name> - projects/<Project ID>/agent/environments/<Environment ID>/users/<User ID>/sessions/<Session ID>/entityTypes/<Entity Type Display Name> - projects/<Project ID>/locations/<Location ID>/agent/environments/ <Environment ID>/users/<User ID>/sessions/<Session ID>/entityTypes/<Entity Type Display Name>

If Location ID is not specified we assume default 'us' location. If Environment ID is not specified, we assume default 'draft' environment. If User ID is not specified, we assume default '-' user.
Returns
Type Description
SessionEntityType

getSessionEntityTypeCallable()

public final UnaryCallable<GetSessionEntityTypeRequest,SessionEntityType> getSessionEntityTypeCallable()

Retrieves the specified session entity type.

This method doesn't work with Google Assistant integration. Contact Dialogflow support if you need to use session entities with Google Assistant integration.

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 (SessionEntityTypesClient sessionEntityTypesClient = SessionEntityTypesClient.create()) {
   GetSessionEntityTypeRequest request =
       GetSessionEntityTypeRequest.newBuilder()
           .setName(
               SessionEntityTypeName.ofProjectSessionEntityTypeName(
                       "[PROJECT]", "[SESSION]", "[ENTITY_TYPE]")
                   .toString())
           .build();
   ApiFuture<SessionEntityType> future =
       sessionEntityTypesClient.getSessionEntityTypeCallable().futureCall(request);
   // Do something.
   SessionEntityType response = future.get();
 }
Returns
Type Description
UnaryCallable<GetSessionEntityTypeRequest,SessionEntityType>

getSettings()

public final SessionEntityTypesSettings getSettings()
Returns
Type Description
SessionEntityTypesSettings

getStub()

public SessionEntityTypesStub getStub()
Returns
Type Description
SessionEntityTypesStub

isShutdown()

public boolean isShutdown()
Returns
Type Description
boolean

isTerminated()

public boolean isTerminated()
Returns
Type Description
boolean

listLocations(ListLocationsRequest request)

public final SessionEntityTypesClient.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 (SessionEntityTypesClient sessionEntityTypesClient = SessionEntityTypesClient.create()) {
   ListLocationsRequest request =
       ListLocationsRequest.newBuilder()
           .setName("name3373707")
           .setFilter("filter-1274492040")
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   for (Location element : sessionEntityTypesClient.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
SessionEntityTypesClient.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 (SessionEntityTypesClient sessionEntityTypesClient = SessionEntityTypesClient.create()) {
   ListLocationsRequest request =
       ListLocationsRequest.newBuilder()
           .setName("name3373707")
           .setFilter("filter-1274492040")
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   while (true) {
     ListLocationsResponse response =
         sessionEntityTypesClient.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,SessionEntityTypesClient.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 (SessionEntityTypesClient sessionEntityTypesClient = SessionEntityTypesClient.create()) {
   ListLocationsRequest request =
       ListLocationsRequest.newBuilder()
           .setName("name3373707")
           .setFilter("filter-1274492040")
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   ApiFuture<Location> future =
       sessionEntityTypesClient.listLocationsPagedCallable().futureCall(request);
   // Do something.
   for (Location element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }
Returns
Type Description
UnaryCallable<com.google.cloud.location.ListLocationsRequest,ListLocationsPagedResponse>

listSessionEntityTypes(ListSessionEntityTypesRequest request)

public final SessionEntityTypesClient.ListSessionEntityTypesPagedResponse listSessionEntityTypes(ListSessionEntityTypesRequest request)

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

This method doesn't work with Google Assistant integration. Contact Dialogflow support if you need to use session entities with Google Assistant integration.

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 (SessionEntityTypesClient sessionEntityTypesClient = SessionEntityTypesClient.create()) {
   ListSessionEntityTypesRequest request =
       ListSessionEntityTypesRequest.newBuilder()
           .setParent(SessionName.ofProjectSessionName("[PROJECT]", "[SESSION]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   for (SessionEntityType element :
       sessionEntityTypesClient.listSessionEntityTypes(request).iterateAll()) {
     // doThingsWith(element);
   }
 }
Parameter
Name Description
request ListSessionEntityTypesRequest

The request object containing all of the parameters for the API call.
Returns
Type Description
SessionEntityTypesClient.ListSessionEntityTypesPagedResponse

listSessionEntityTypes(SessionName parent)

public final SessionEntityTypesClient.ListSessionEntityTypesPagedResponse listSessionEntityTypes(SessionName parent)

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

This method doesn't work with Google Assistant integration. Contact Dialogflow support if you need to use session entities with Google Assistant integration.

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 (SessionEntityTypesClient sessionEntityTypesClient = SessionEntityTypesClient.create()) {
   SessionName parent = SessionName.ofProjectSessionName("[PROJECT]", "[SESSION]");
   for (SessionEntityType element :
       sessionEntityTypesClient.listSessionEntityTypes(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
Parameter
Name Description
parent SessionName

Required. The session to list all session entity types from. Supported formats: - projects/<Project ID>/agent/sessions/<Session ID>, - projects/<Project ID>/locations/<Location ID>/agent/sessions/<Session ID>, - projects/<Project ID>/agent/environments/<Environment ID>/users/<User ID>/sessions/<Session ID>, - projects/<Project ID>/locations/<Location ID>/agent/environments/<Environment ID>/users/<User ID>/sessions/<Session ID>,

If Location ID is not specified we assume default 'us' location. If Environment ID is not specified, we assume default 'draft' environment. If User ID` is not specified, we assume default '-' user.
Returns
Type Description
SessionEntityTypesClient.ListSessionEntityTypesPagedResponse

listSessionEntityTypes(String parent)

public final SessionEntityTypesClient.ListSessionEntityTypesPagedResponse listSessionEntityTypes(String parent)

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

This method doesn't work with Google Assistant integration. Contact Dialogflow support if you need to use session entities with Google Assistant integration.

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 (SessionEntityTypesClient sessionEntityTypesClient = SessionEntityTypesClient.create()) {
   String parent = SessionName.ofProjectSessionName("[PROJECT]", "[SESSION]").toString();
   for (SessionEntityType element :
       sessionEntityTypesClient.listSessionEntityTypes(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
Parameter
Name Description
parent String

Required. The session to list all session entity types from. Supported formats: - projects/<Project ID>/agent/sessions/<Session ID>, - projects/<Project ID>/locations/<Location ID>/agent/sessions/<Session ID>, - projects/<Project ID>/agent/environments/<Environment ID>/users/<User ID>/sessions/<Session ID>, - projects/<Project ID>/locations/<Location ID>/agent/environments/<Environment ID>/users/<User ID>/sessions/<Session ID>,

If Location ID is not specified we assume default 'us' location. If Environment ID is not specified, we assume default 'draft' environment. If User ID` is not specified, we assume default '-' user.
Returns
Type Description
SessionEntityTypesClient.ListSessionEntityTypesPagedResponse

listSessionEntityTypesCallable()

public final UnaryCallable<ListSessionEntityTypesRequest,ListSessionEntityTypesResponse> listSessionEntityTypesCallable()

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

This method doesn't work with Google Assistant integration. Contact Dialogflow support if you need to use session entities with Google Assistant integration.

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 (SessionEntityTypesClient sessionEntityTypesClient = SessionEntityTypesClient.create()) {
   ListSessionEntityTypesRequest request =
       ListSessionEntityTypesRequest.newBuilder()
           .setParent(SessionName.ofProjectSessionName("[PROJECT]", "[SESSION]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .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;
     }
   }
 }
Returns
Type Description
UnaryCallable<ListSessionEntityTypesRequest,ListSessionEntityTypesResponse>

listSessionEntityTypesPagedCallable()

public final UnaryCallable<ListSessionEntityTypesRequest,SessionEntityTypesClient.ListSessionEntityTypesPagedResponse> listSessionEntityTypesPagedCallable()

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

This method doesn't work with Google Assistant integration. Contact Dialogflow support if you need to use session entities with Google Assistant integration.

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 (SessionEntityTypesClient sessionEntityTypesClient = SessionEntityTypesClient.create()) {
   ListSessionEntityTypesRequest request =
       ListSessionEntityTypesRequest.newBuilder()
           .setParent(SessionName.ofProjectSessionName("[PROJECT]", "[SESSION]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   ApiFuture<SessionEntityType> future =
       sessionEntityTypesClient.listSessionEntityTypesPagedCallable().futureCall(request);
   // Do something.
   for (SessionEntityType element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }
Returns
Type Description
UnaryCallable<ListSessionEntityTypesRequest,ListSessionEntityTypesPagedResponse>

shutdown()

public void shutdown()

shutdownNow()

public void shutdownNow()

updateSessionEntityType(SessionEntityType sessionEntityType)

public final SessionEntityType updateSessionEntityType(SessionEntityType sessionEntityType)

Updates the specified session entity type.

This method doesn't work with Google Assistant integration. Contact Dialogflow support if you need to use session entities with Google Assistant integration.

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 (SessionEntityTypesClient sessionEntityTypesClient = SessionEntityTypesClient.create()) {
   SessionEntityType sessionEntityType = SessionEntityType.newBuilder().build();
   SessionEntityType response =
       sessionEntityTypesClient.updateSessionEntityType(sessionEntityType);
 }
Parameter
Name Description
sessionEntityType SessionEntityType

Required. The session entity type to update.
Returns
Type Description
SessionEntityType

updateSessionEntityType(SessionEntityType sessionEntityType, FieldMask updateMask)

public final SessionEntityType updateSessionEntityType(SessionEntityType sessionEntityType, FieldMask updateMask)

Updates the specified session entity type.

This method doesn't work with Google Assistant integration. Contact Dialogflow support if you need to use session entities with Google Assistant integration.

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 (SessionEntityTypesClient sessionEntityTypesClient = SessionEntityTypesClient.create()) {
   SessionEntityType sessionEntityType = SessionEntityType.newBuilder().build();
   FieldMask updateMask = FieldMask.newBuilder().build();
   SessionEntityType response =
       sessionEntityTypesClient.updateSessionEntityType(sessionEntityType, updateMask);
 }
Parameters
Name Description
sessionEntityType SessionEntityType

Required. The session entity type to update.
updateMask FieldMask

Optional. The mask to control which fields get updated.
Returns
Type Description
SessionEntityType

updateSessionEntityType(UpdateSessionEntityTypeRequest request)

public final SessionEntityType updateSessionEntityType(UpdateSessionEntityTypeRequest request)

Updates the specified session entity type.

This method doesn't work with Google Assistant integration. Contact Dialogflow support if you need to use session entities with Google Assistant integration.

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 (SessionEntityTypesClient sessionEntityTypesClient = SessionEntityTypesClient.create()) {
   UpdateSessionEntityTypeRequest request =
       UpdateSessionEntityTypeRequest.newBuilder()
           .setSessionEntityType(SessionEntityType.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .build();
   SessionEntityType response = sessionEntityTypesClient.updateSessionEntityType(request);
 }
Parameter
Name Description
request UpdateSessionEntityTypeRequest

The request object containing all of the parameters for the API call.
Returns
Type Description
SessionEntityType

updateSessionEntityTypeCallable()

public final UnaryCallable<UpdateSessionEntityTypeRequest,SessionEntityType> updateSessionEntityTypeCallable()

Updates the specified session entity type.

This method doesn't work with Google Assistant integration. Contact Dialogflow support if you need to use session entities with Google Assistant integration.

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 (SessionEntityTypesClient sessionEntityTypesClient = SessionEntityTypesClient.create()) {
   UpdateSessionEntityTypeRequest request =
       UpdateSessionEntityTypeRequest.newBuilder()
           .setSessionEntityType(SessionEntityType.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .build();
   ApiFuture<SessionEntityType> future =
       sessionEntityTypesClient.updateSessionEntityTypeCallable().futureCall(request);
   // Do something.
   SessionEntityType response = future.get();
 }
Returns
Type Description
UnaryCallable<UpdateSessionEntityTypeRequest,SessionEntityType>