- 0.64.0 (latest)
- 0.63.0
- 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 SessionEntityTypesClient implements BackgroundResource
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:
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().
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 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);
Please refer to the GitHub repository's samples for more quickstart code snippets.
Implements
BackgroundResourceStatic Methods
create()
public static final SessionEntityTypesClient create()
Constructs an instance of SessionEntityTypesClient with default settings.
Type | Description |
SessionEntityTypesClient |
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.
Name | Description |
settings | SessionEntityTypesSettings |
Type | Description |
SessionEntityTypesClient |
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).
Name | Description |
stub | SessionEntityTypesStub |
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.
Name | Description |
settings | SessionEntityTypesSettings |
SessionEntityTypesClient(SessionEntityTypesStub stub)
protected SessionEntityTypesClient(SessionEntityTypesStub stub)
Name | Description |
stub | SessionEntityTypesStub |
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()
createSessionEntityType(CreateSessionEntityTypeRequest request)
public final SessionEntityType createSessionEntityType(CreateSessionEntityTypeRequest request)
Creates a session entity type.
Sample code:
try (SessionEntityTypesClient sessionEntityTypesClient = SessionEntityTypesClient.create()) {
CreateSessionEntityTypeRequest request =
CreateSessionEntityTypeRequest.newBuilder()
.setParent(
SessionName.ofProjectLocationAgentSessionName(
"[PROJECT]", "[LOCATION]", "[AGENT]", "[SESSION]")
.toString())
.setSessionEntityType(SessionEntityType.newBuilder().build())
.build();
SessionEntityType response = sessionEntityTypesClient.createSessionEntityType(request);
}
Name | Description |
request | CreateSessionEntityTypeRequest The request object containing all of the parameters for the API call. |
Type | Description |
SessionEntityType |
createSessionEntityType(SessionName parent, SessionEntityType sessionEntityType)
public final SessionEntityType createSessionEntityType(SessionName parent, SessionEntityType sessionEntityType)
Creates a session entity type.
Sample code:
try (SessionEntityTypesClient sessionEntityTypesClient = SessionEntityTypesClient.create()) {
SessionName parent =
SessionName.ofProjectLocationAgentSessionName(
"[PROJECT]", "[LOCATION]", "[AGENT]", "[SESSION]");
SessionEntityType sessionEntityType = SessionEntityType.newBuilder().build();
SessionEntityType response =
sessionEntityTypesClient.createSessionEntityType(parent, sessionEntityType);
}
Name | Description |
parent | SessionName Required. The session to create a session entity type for. Format:
|
sessionEntityType | SessionEntityType Required. The session entity type to create. |
Type | Description |
SessionEntityType |
createSessionEntityType(String parent, SessionEntityType sessionEntityType)
public final SessionEntityType createSessionEntityType(String parent, SessionEntityType sessionEntityType)
Creates a session entity type.
Sample code:
try (SessionEntityTypesClient sessionEntityTypesClient = SessionEntityTypesClient.create()) {
String parent =
SessionName.ofProjectLocationAgentSessionName(
"[PROJECT]", "[LOCATION]", "[AGENT]", "[SESSION]")
.toString();
SessionEntityType sessionEntityType = SessionEntityType.newBuilder().build();
SessionEntityType response =
sessionEntityTypesClient.createSessionEntityType(parent, sessionEntityType);
}
Name | Description |
parent | String Required. The session to create a session entity type for. Format:
|
sessionEntityType | SessionEntityType Required. The session entity type to create. |
Type | Description |
SessionEntityType |
createSessionEntityTypeCallable()
public final UnaryCallable<CreateSessionEntityTypeRequest,SessionEntityType> createSessionEntityTypeCallable()
Creates a session entity type.
Sample code:
try (SessionEntityTypesClient sessionEntityTypesClient = SessionEntityTypesClient.create()) {
CreateSessionEntityTypeRequest request =
CreateSessionEntityTypeRequest.newBuilder()
.setParent(
SessionName.ofProjectLocationAgentSessionName(
"[PROJECT]", "[LOCATION]", "[AGENT]", "[SESSION]")
.toString())
.setSessionEntityType(SessionEntityType.newBuilder().build())
.build();
ApiFuture<SessionEntityType> future =
sessionEntityTypesClient.createSessionEntityTypeCallable().futureCall(request);
// Do something.
SessionEntityType response = future.get();
}
Type | Description |
UnaryCallable<CreateSessionEntityTypeRequest,SessionEntityType> |
deleteSessionEntityType(DeleteSessionEntityTypeRequest request)
public final void deleteSessionEntityType(DeleteSessionEntityTypeRequest request)
Deletes the specified session entity type.
Sample code:
try (SessionEntityTypesClient sessionEntityTypesClient = SessionEntityTypesClient.create()) {
DeleteSessionEntityTypeRequest request =
DeleteSessionEntityTypeRequest.newBuilder()
.setName(
SessionEntityTypeName.ofProjectLocationAgentSessionEntityTypeName(
"[PROJECT]", "[LOCATION]", "[AGENT]", "[SESSION]", "[ENTITY_TYPE]")
.toString())
.build();
sessionEntityTypesClient.deleteSessionEntityType(request);
}
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.
Sample code:
try (SessionEntityTypesClient sessionEntityTypesClient = SessionEntityTypesClient.create()) {
SessionEntityTypeName name =
SessionEntityTypeName.ofProjectLocationAgentSessionEntityTypeName(
"[PROJECT]", "[LOCATION]", "[AGENT]", "[SESSION]", "[ENTITY_TYPE]");
sessionEntityTypesClient.deleteSessionEntityType(name);
}
Name | Description |
name | SessionEntityTypeName Required. The name of the session entity type to delete. Format:
|
deleteSessionEntityType(String name)
public final void deleteSessionEntityType(String name)
Deletes the specified session entity type.
Sample code:
try (SessionEntityTypesClient sessionEntityTypesClient = SessionEntityTypesClient.create()) {
String name =
SessionEntityTypeName.ofProjectLocationAgentSessionEntityTypeName(
"[PROJECT]", "[LOCATION]", "[AGENT]", "[SESSION]", "[ENTITY_TYPE]")
.toString();
sessionEntityTypesClient.deleteSessionEntityType(name);
}
Name | Description |
name | String Required. The name of the session entity type to delete. Format:
|
deleteSessionEntityTypeCallable()
public final UnaryCallable<DeleteSessionEntityTypeRequest,Empty> deleteSessionEntityTypeCallable()
Deletes the specified session entity type.
Sample code:
try (SessionEntityTypesClient sessionEntityTypesClient = SessionEntityTypesClient.create()) {
DeleteSessionEntityTypeRequest request =
DeleteSessionEntityTypeRequest.newBuilder()
.setName(
SessionEntityTypeName.ofProjectLocationAgentSessionEntityTypeName(
"[PROJECT]", "[LOCATION]", "[AGENT]", "[SESSION]", "[ENTITY_TYPE]")
.toString())
.build();
ApiFuture<Empty> future =
sessionEntityTypesClient.deleteSessionEntityTypeCallable().futureCall(request);
// Do something.
future.get();
}
Type | Description |
UnaryCallable<DeleteSessionEntityTypeRequest,Empty> |
getSessionEntityType(GetSessionEntityTypeRequest request)
public final SessionEntityType getSessionEntityType(GetSessionEntityTypeRequest request)
Retrieves the specified session entity type.
Sample code:
try (SessionEntityTypesClient sessionEntityTypesClient = SessionEntityTypesClient.create()) {
GetSessionEntityTypeRequest request =
GetSessionEntityTypeRequest.newBuilder()
.setName(
SessionEntityTypeName.ofProjectLocationAgentSessionEntityTypeName(
"[PROJECT]", "[LOCATION]", "[AGENT]", "[SESSION]", "[ENTITY_TYPE]")
.toString())
.build();
SessionEntityType response = sessionEntityTypesClient.getSessionEntityType(request);
}
Name | Description |
request | GetSessionEntityTypeRequest The request object containing all of the parameters for the API call. |
Type | Description |
SessionEntityType |
getSessionEntityType(SessionEntityTypeName name)
public final SessionEntityType getSessionEntityType(SessionEntityTypeName name)
Retrieves the specified session entity type.
Sample code:
try (SessionEntityTypesClient sessionEntityTypesClient = SessionEntityTypesClient.create()) {
SessionEntityTypeName name =
SessionEntityTypeName.ofProjectLocationAgentSessionEntityTypeName(
"[PROJECT]", "[LOCATION]", "[AGENT]", "[SESSION]", "[ENTITY_TYPE]");
SessionEntityType response = sessionEntityTypesClient.getSessionEntityType(name);
}
Name | Description |
name | SessionEntityTypeName Required. The name of the session entity type. Format: |
Type | Description |
SessionEntityType |
getSessionEntityType(String name)
public final SessionEntityType getSessionEntityType(String name)
Retrieves the specified session entity type.
Sample code:
try (SessionEntityTypesClient sessionEntityTypesClient = SessionEntityTypesClient.create()) {
String name =
SessionEntityTypeName.ofProjectLocationAgentSessionEntityTypeName(
"[PROJECT]", "[LOCATION]", "[AGENT]", "[SESSION]", "[ENTITY_TYPE]")
.toString();
SessionEntityType response = sessionEntityTypesClient.getSessionEntityType(name);
}
Name | Description |
name | String Required. The name of the session entity type. Format: |
Type | Description |
SessionEntityType |
getSessionEntityTypeCallable()
public final UnaryCallable<GetSessionEntityTypeRequest,SessionEntityType> getSessionEntityTypeCallable()
Retrieves the specified session entity type.
Sample code:
try (SessionEntityTypesClient sessionEntityTypesClient = SessionEntityTypesClient.create()) {
GetSessionEntityTypeRequest request =
GetSessionEntityTypeRequest.newBuilder()
.setName(
SessionEntityTypeName.ofProjectLocationAgentSessionEntityTypeName(
"[PROJECT]", "[LOCATION]", "[AGENT]", "[SESSION]", "[ENTITY_TYPE]")
.toString())
.build();
ApiFuture<SessionEntityType> future =
sessionEntityTypesClient.getSessionEntityTypeCallable().futureCall(request);
// Do something.
SessionEntityType response = future.get();
}
Type | Description |
UnaryCallable<GetSessionEntityTypeRequest,SessionEntityType> |
getSettings()
public final SessionEntityTypesSettings getSettings()
Type | Description |
SessionEntityTypesSettings |
getStub()
public SessionEntityTypesStub getStub()
Type | Description |
SessionEntityTypesStub |
isShutdown()
public boolean isShutdown()
Type | Description |
boolean |
isTerminated()
public boolean isTerminated()
Type | Description |
boolean |
listSessionEntityTypes(ListSessionEntityTypesRequest request)
public final SessionEntityTypesClient.ListSessionEntityTypesPagedResponse listSessionEntityTypes(ListSessionEntityTypesRequest request)
Returns the list of all session entity types in the specified session.
Sample code:
try (SessionEntityTypesClient sessionEntityTypesClient = SessionEntityTypesClient.create()) {
ListSessionEntityTypesRequest request =
ListSessionEntityTypesRequest.newBuilder()
.setParent(
SessionName.ofProjectLocationAgentSessionName(
"[PROJECT]", "[LOCATION]", "[AGENT]", "[SESSION]")
.toString())
.setPageSize(883849137)
.setPageToken("pageToken873572522")
.build();
for (SessionEntityType element :
sessionEntityTypesClient.listSessionEntityTypes(request).iterateAll()) {
// doThingsWith(element);
}
}
Name | Description |
request | ListSessionEntityTypesRequest The request object containing all of the parameters for the API call. |
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.
Sample code:
try (SessionEntityTypesClient sessionEntityTypesClient = SessionEntityTypesClient.create()) {
SessionName parent =
SessionName.ofProjectLocationAgentSessionName(
"[PROJECT]", "[LOCATION]", "[AGENT]", "[SESSION]");
for (SessionEntityType element :
sessionEntityTypesClient.listSessionEntityTypes(parent).iterateAll()) {
// doThingsWith(element);
}
}
Name | Description |
parent | SessionName Required. The session to list all session entity types from. Format:
|
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.
Sample code:
try (SessionEntityTypesClient sessionEntityTypesClient = SessionEntityTypesClient.create()) {
String parent =
SessionName.ofProjectLocationAgentSessionName(
"[PROJECT]", "[LOCATION]", "[AGENT]", "[SESSION]")
.toString();
for (SessionEntityType element :
sessionEntityTypesClient.listSessionEntityTypes(parent).iterateAll()) {
// doThingsWith(element);
}
}
Name | Description |
parent | String Required. The session to list all session entity types from. Format:
|
Type | Description |
SessionEntityTypesClient.ListSessionEntityTypesPagedResponse |
listSessionEntityTypesCallable()
public final UnaryCallable<ListSessionEntityTypesRequest,ListSessionEntityTypesResponse> listSessionEntityTypesCallable()
Returns the list of all session entity types in the specified session.
Sample code:
try (SessionEntityTypesClient sessionEntityTypesClient = SessionEntityTypesClient.create()) {
ListSessionEntityTypesRequest request =
ListSessionEntityTypesRequest.newBuilder()
.setParent(
SessionName.ofProjectLocationAgentSessionName(
"[PROJECT]", "[LOCATION]", "[AGENT]", "[SESSION]")
.toString())
.setPageSize(883849137)
.setPageToken("pageToken873572522")
.build();
while (true) {
ListSessionEntityTypesResponse response =
sessionEntityTypesClient.listSessionEntityTypesCallable().call(request);
for (SessionEntityType element : response.getResponsesList()) {
// doThingsWith(element);
}
String nextPageToken = response.getNextPageToken();
if (!Strings.isNullOrEmpty(nextPageToken)) {
request = request.toBuilder().setPageToken(nextPageToken).build();
} else {
break;
}
}
}
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.
Sample code:
try (SessionEntityTypesClient sessionEntityTypesClient = SessionEntityTypesClient.create()) {
ListSessionEntityTypesRequest request =
ListSessionEntityTypesRequest.newBuilder()
.setParent(
SessionName.ofProjectLocationAgentSessionName(
"[PROJECT]", "[LOCATION]", "[AGENT]", "[SESSION]")
.toString())
.setPageSize(883849137)
.setPageToken("pageToken873572522")
.build();
ApiFuture<SessionEntityType> future =
sessionEntityTypesClient.listSessionEntityTypesPagedCallable().futureCall(request);
// Do something.
for (SessionEntityType element : future.get().iterateAll()) {
// doThingsWith(element);
}
}
Type | Description |
UnaryCallable<ListSessionEntityTypesRequest,ListSessionEntityTypesPagedResponse> |
shutdown()
public void shutdown()
shutdownNow()
public void shutdownNow()
updateSessionEntityType(SessionEntityType sessionEntityType, FieldMask updateMask)
public final SessionEntityType updateSessionEntityType(SessionEntityType sessionEntityType, FieldMask updateMask)
Updates the specified session entity type.
Sample code:
try (SessionEntityTypesClient sessionEntityTypesClient = SessionEntityTypesClient.create()) {
SessionEntityType sessionEntityType = SessionEntityType.newBuilder().build();
FieldMask updateMask = FieldMask.newBuilder().build();
SessionEntityType response =
sessionEntityTypesClient.updateSessionEntityType(sessionEntityType, updateMask);
}
Name | Description |
sessionEntityType | SessionEntityType Required. The session entity type to update. Format:
|
updateMask | FieldMask The mask to control which fields get updated. |
Type | Description |
SessionEntityType |
updateSessionEntityType(UpdateSessionEntityTypeRequest request)
public final SessionEntityType updateSessionEntityType(UpdateSessionEntityTypeRequest request)
Updates the specified session entity type.
Sample code:
try (SessionEntityTypesClient sessionEntityTypesClient = SessionEntityTypesClient.create()) {
UpdateSessionEntityTypeRequest request =
UpdateSessionEntityTypeRequest.newBuilder()
.setSessionEntityType(SessionEntityType.newBuilder().build())
.setUpdateMask(FieldMask.newBuilder().build())
.build();
SessionEntityType response = sessionEntityTypesClient.updateSessionEntityType(request);
}
Name | Description |
request | UpdateSessionEntityTypeRequest The request object containing all of the parameters for the API call. |
Type | Description |
SessionEntityType |
updateSessionEntityTypeCallable()
public final UnaryCallable<UpdateSessionEntityTypeRequest,SessionEntityType> updateSessionEntityTypeCallable()
Updates the specified session entity type.
Sample code:
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();
}
Type | Description |
UnaryCallable<UpdateSessionEntityTypeRequest,SessionEntityType> |