SessionEntityTypesClient (Google Dialogflow CX 0.71.0 API)

java.lang.Object
- com.google.cloud.dialogflow.cx.v3.SessionEntityTypesClient

All Implemented Interfaces:: com.google.api.gax.core.BackgroundResource, AutoCloseable

@Generated(value="by gapic-generator-java")
public class SessionEntityTypesClient
extends Object
implements com.google.api.gax.core.BackgroundResource

Service Description: Service for managing [SessionEntityTypes][google.cloud.dialogflow.cx.v3.SessionEntityType].

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.ofProjectLocationAgentSessionEntityTypeName(
           "[PROJECT]", "[LOCATION]", "[AGENT]", "[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.	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.	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.	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.	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, 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.	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.

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`SessionEntityTypesClient.ListLocationsFixedSizeCollection`
`static class`	`SessionEntityTypesClient.ListLocationsPage`
`static class`	`SessionEntityTypesClient.ListLocationsPagedResponse`
`static class`	`SessionEntityTypesClient.ListSessionEntityTypesFixedSizeCollection`
`static class`	`SessionEntityTypesClient.ListSessionEntityTypesPage`
`static class`	`SessionEntityTypesClient.ListSessionEntityTypesPagedResponse`

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

All Methods Static Methods Instance Methods Concrete Methods
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.
`SessionEntityType`	`createSessionEntityType(CreateSessionEntityTypeRequest request)` Creates a session entity type.
`SessionEntityType`	`createSessionEntityType(SessionName parent, SessionEntityType sessionEntityType)` Creates a session entity type.
`SessionEntityType`	`createSessionEntityType(String parent, SessionEntityType sessionEntityType)` Creates a session entity type.
`com.google.api.gax.rpc.UnaryCallable<CreateSessionEntityTypeRequest,SessionEntityType>`	`createSessionEntityTypeCallable()` Creates a session entity type.
`void`	`deleteSessionEntityType(DeleteSessionEntityTypeRequest request)` Deletes the specified session entity type.
`void`	`deleteSessionEntityType(SessionEntityTypeName name)` Deletes the specified session entity type.
`void`	`deleteSessionEntityType(String name)` Deletes the specified session entity type.
`com.google.api.gax.rpc.UnaryCallable<DeleteSessionEntityTypeRequest,com.google.protobuf.Empty>`	`deleteSessionEntityTypeCallable()` Deletes the specified session entity type.
`com.google.cloud.location.Location`	`getLocation(com.google.cloud.location.GetLocationRequest request)` Gets information about a location.
`com.google.api.gax.rpc.UnaryCallable<com.google.cloud.location.GetLocationRequest,com.google.cloud.location.Location>`	`getLocationCallable()` Gets information about a location.
`SessionEntityType`	`getSessionEntityType(GetSessionEntityTypeRequest request)` Retrieves the specified session entity type.
`SessionEntityType`	`getSessionEntityType(SessionEntityTypeName name)` Retrieves the specified session entity type.
`SessionEntityType`	`getSessionEntityType(String name)` Retrieves the specified session entity type.
`com.google.api.gax.rpc.UnaryCallable<GetSessionEntityTypeRequest,SessionEntityType>`	`getSessionEntityTypeCallable()` Retrieves the specified session entity type.
`SessionEntityTypesSettings`	`getSettings()`
`SessionEntityTypesStub`	`getStub()`
`boolean`	`isShutdown()`
`boolean`	`isTerminated()`
`SessionEntityTypesClient.ListLocationsPagedResponse`	`listLocations(com.google.cloud.location.ListLocationsRequest request)` Lists information about the supported locations for this service.
`com.google.api.gax.rpc.UnaryCallable<com.google.cloud.location.ListLocationsRequest,com.google.cloud.location.ListLocationsResponse>`	`listLocationsCallable()` Lists information about the supported locations for this service.
`com.google.api.gax.rpc.UnaryCallable<com.google.cloud.location.ListLocationsRequest,SessionEntityTypesClient.ListLocationsPagedResponse>`	`listLocationsPagedCallable()` Lists information about the supported locations for this service.
`SessionEntityTypesClient.ListSessionEntityTypesPagedResponse`	`listSessionEntityTypes(ListSessionEntityTypesRequest request)` Returns the list of all session entity types in the specified session.
`SessionEntityTypesClient.ListSessionEntityTypesPagedResponse`	`listSessionEntityTypes(SessionName parent)` Returns the list of all session entity types in the specified session.
`SessionEntityTypesClient.ListSessionEntityTypesPagedResponse`	`listSessionEntityTypes(String parent)` Returns the list of all session entity types in the specified session.
`com.google.api.gax.rpc.UnaryCallable<ListSessionEntityTypesRequest,ListSessionEntityTypesResponse>`	`listSessionEntityTypesCallable()` Returns the list of all session entity types in the specified session.
`com.google.api.gax.rpc.UnaryCallable<ListSessionEntityTypesRequest,SessionEntityTypesClient.ListSessionEntityTypesPagedResponse>`	`listSessionEntityTypesPagedCallable()` Returns the list of all session entity types in the specified session.
`void`	`shutdown()`
`void`	`shutdownNow()`
`SessionEntityType`	`updateSessionEntityType(SessionEntityType sessionEntityType, com.google.protobuf.FieldMask updateMask)` Updates the specified session entity type.
`SessionEntityType`	`updateSessionEntityType(UpdateSessionEntityTypeRequest request)` Updates the specified session entity type.
`com.google.api.gax.rpc.UnaryCallable<UpdateSessionEntityTypeRequest,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
```
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
```
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).

getSettings

public final SessionEntityTypesSettings getSettings()