@BetaApi @Generated(value="by gapic-generator-java") public class EnvironmentsClient extends Object implements com.google.api.gax.core.BackgroundResource
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 (EnvironmentsClient environmentsClient = EnvironmentsClient.create()) {
EnvironmentName name =
EnvironmentName.of("[PROJECT]", "[LOCATION]", "[AGENT]", "[ENVIRONMENT]");
Environment response = environmentsClient.getEnvironment(name);
}
Note: close() needs to be called on the EnvironmentsClient object to clean up resources such as threads. In the example above, try-with-resources is used, which automatically calls close().
| Method | Description | Method Variants |
|---|---|---|
ListEnvironments |
Returns the list of all environments in the specified [Agent][google.cloud.dialogflow.cx.v3beta1.Agent]. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
GetEnvironment |
Retrieves the specified [Environment][google.cloud.dialogflow.cx.v3beta1.Environment]. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
CreateEnvironment |
Creates an [Environment][google.cloud.dialogflow.cx.v3beta1.Environment] in the specified [Agent][google.cloud.dialogflow.cx.v3beta1.Agent]. This method is a [long-running operation](https://cloud.google.com/dialogflow/cx/docs/how/long-running-operation). The returned `Operation` type has the following method-specific fields: - `metadata`: An empty [Struct message](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#struct) - `response`: [Environment][google.cloud.dialogflow.cx.v3beta1.Environment] |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
UpdateEnvironment |
Updates the specified [Environment][google.cloud.dialogflow.cx.v3beta1.Environment]. This method is a [long-running operation](https://cloud.google.com/dialogflow/cx/docs/how/long-running-operation). The returned `Operation` type has the following method-specific fields: - `metadata`: An empty [Struct message](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#struct) - `response`: [Environment][google.cloud.dialogflow.cx.v3beta1.Environment] |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
DeleteEnvironment |
Deletes the specified [Environment][google.cloud.dialogflow.cx.v3beta1.Environment]. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
LookupEnvironmentHistory |
Looks up the history of the specified [Environment][google.cloud.dialogflow.cx.v3beta1.Environment]. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
RunContinuousTest |
Kicks off a continuous test under the specified [Environment][google.cloud.dialogflow.cx.v3beta1.Environment]. This method is a [long-running operation](https://cloud.google.com/dialogflow/cx/docs/how/long-running-operation). The returned `Operation` type has the following method-specific fields: - `metadata`: [RunContinuousTestMetadata][google.cloud.dialogflow.cx.v3beta1.RunContinuousTestMetadata] - `response`: [RunContinuousTestResponse][google.cloud.dialogflow.cx.v3beta1.RunContinuousTestResponse] |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
ListContinuousTestResults |
Fetches a list of continuous test results for a given environment. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
DeployFlow |
Deploys a flow to the specified [Environment][google.cloud.dialogflow.cx.v3beta1.Environment]. This method is a [long-running operation](https://cloud.google.com/dialogflow/cx/docs/how/long-running-operation). The returned `Operation` type has the following method-specific fields: - `metadata`: [DeployFlowMetadata][google.cloud.dialogflow.cx.v3beta1.DeployFlowMetadata] - `response`: [DeployFlowResponse][google.cloud.dialogflow.cx.v3beta1.DeployFlowResponse] |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
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.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
GetLocation |
Gets information about a location. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
Callable method variants take no parameters and return 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 EnvironmentsSettings 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
EnvironmentsSettings environmentsSettings =
EnvironmentsSettings.newBuilder()
.setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
.build();
EnvironmentsClient environmentsClient = EnvironmentsClient.create(environmentsSettings);
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
EnvironmentsSettings environmentsSettings =
EnvironmentsSettings.newBuilder().setEndpoint(myEndpoint).build();
EnvironmentsClient environmentsClient = EnvironmentsClient.create(environmentsSettings);
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
EnvironmentsSettings environmentsSettings = EnvironmentsSettings.newHttpJsonBuilder().build();
EnvironmentsClient environmentsClient = EnvironmentsClient.create(environmentsSettings);
Please refer to the GitHub repository's samples for more quickstart code snippets.
| Modifier and Type | Class and Description |
|---|---|
static class |
EnvironmentsClient.ListContinuousTestResultsFixedSizeCollection |
static class |
EnvironmentsClient.ListContinuousTestResultsPage |
static class |
EnvironmentsClient.ListContinuousTestResultsPagedResponse |
static class |
EnvironmentsClient.ListEnvironmentsFixedSizeCollection |
static class |
EnvironmentsClient.ListEnvironmentsPage |
static class |
EnvironmentsClient.ListEnvironmentsPagedResponse |
static class |
EnvironmentsClient.ListLocationsFixedSizeCollection |
static class |
EnvironmentsClient.ListLocationsPage |
static class |
EnvironmentsClient.ListLocationsPagedResponse |
static class |
EnvironmentsClient.LookupEnvironmentHistoryFixedSizeCollection |
static class |
EnvironmentsClient.LookupEnvironmentHistoryPage |
static class |
EnvironmentsClient.LookupEnvironmentHistoryPagedResponse |
| Modifier | Constructor and Description |
|---|---|
protected |
EnvironmentsClient(EnvironmentsSettings settings)
Constructs an instance of EnvironmentsClient, using the given settings.
|
protected |
EnvironmentsClient(EnvironmentsStub stub) |
| Modifier and Type | Method and Description |
|---|---|
boolean |
awaitTermination(long duration,
TimeUnit unit) |
void |
close() |
static EnvironmentsClient |
create()
Constructs an instance of EnvironmentsClient with default settings.
|
static EnvironmentsClient |
create(EnvironmentsSettings settings)
Constructs an instance of EnvironmentsClient, using the given settings.
|
static EnvironmentsClient |
create(EnvironmentsStub stub)
Constructs an instance of EnvironmentsClient, using the given stub for making calls.
|
com.google.api.gax.longrunning.OperationFuture<Environment,com.google.protobuf.Struct> |
createEnvironmentAsync(AgentName parent,
Environment environment)
Creates an [Environment][google.cloud.dialogflow.cx.v3beta1.Environment] in the specified
[Agent][google.cloud.dialogflow.cx.v3beta1.Agent].
|
com.google.api.gax.longrunning.OperationFuture<Environment,com.google.protobuf.Struct> |
createEnvironmentAsync(CreateEnvironmentRequest request)
Creates an [Environment][google.cloud.dialogflow.cx.v3beta1.Environment] in the specified
[Agent][google.cloud.dialogflow.cx.v3beta1.Agent].
|
com.google.api.gax.longrunning.OperationFuture<Environment,com.google.protobuf.Struct> |
createEnvironmentAsync(String parent,
Environment environment)
Creates an [Environment][google.cloud.dialogflow.cx.v3beta1.Environment] in the specified
[Agent][google.cloud.dialogflow.cx.v3beta1.Agent].
|
com.google.api.gax.rpc.UnaryCallable<CreateEnvironmentRequest,com.google.longrunning.Operation> |
createEnvironmentCallable()
Creates an [Environment][google.cloud.dialogflow.cx.v3beta1.Environment] in the specified
[Agent][google.cloud.dialogflow.cx.v3beta1.Agent].
|
com.google.api.gax.rpc.OperationCallable<CreateEnvironmentRequest,Environment,com.google.protobuf.Struct> |
createEnvironmentOperationCallable()
Creates an [Environment][google.cloud.dialogflow.cx.v3beta1.Environment] in the specified
[Agent][google.cloud.dialogflow.cx.v3beta1.Agent].
|
void |
deleteEnvironment(DeleteEnvironmentRequest request)
Deletes the specified [Environment][google.cloud.dialogflow.cx.v3beta1.Environment].
|
void |
deleteEnvironment(EnvironmentName name)
Deletes the specified [Environment][google.cloud.dialogflow.cx.v3beta1.Environment].
|
void |
deleteEnvironment(String name)
Deletes the specified [Environment][google.cloud.dialogflow.cx.v3beta1.Environment].
|
com.google.api.gax.rpc.UnaryCallable<DeleteEnvironmentRequest,com.google.protobuf.Empty> |
deleteEnvironmentCallable()
Deletes the specified [Environment][google.cloud.dialogflow.cx.v3beta1.Environment].
|
com.google.api.gax.longrunning.OperationFuture<DeployFlowResponse,DeployFlowMetadata> |
deployFlowAsync(DeployFlowRequest request)
Deploys a flow to the specified [Environment][google.cloud.dialogflow.cx.v3beta1.Environment].
|
com.google.api.gax.rpc.UnaryCallable<DeployFlowRequest,com.google.longrunning.Operation> |
deployFlowCallable()
Deploys a flow to the specified [Environment][google.cloud.dialogflow.cx.v3beta1.Environment].
|
com.google.api.gax.rpc.OperationCallable<DeployFlowRequest,DeployFlowResponse,DeployFlowMetadata> |
deployFlowOperationCallable()
Deploys a flow to the specified [Environment][google.cloud.dialogflow.cx.v3beta1.Environment].
|
Environment |
getEnvironment(EnvironmentName name)
Retrieves the specified [Environment][google.cloud.dialogflow.cx.v3beta1.Environment].
|
Environment |
getEnvironment(GetEnvironmentRequest request)
Retrieves the specified [Environment][google.cloud.dialogflow.cx.v3beta1.Environment].
|
Environment |
getEnvironment(String name)
Retrieves the specified [Environment][google.cloud.dialogflow.cx.v3beta1.Environment].
|
com.google.api.gax.rpc.UnaryCallable<GetEnvironmentRequest,Environment> |
getEnvironmentCallable()
Retrieves the specified [Environment][google.cloud.dialogflow.cx.v3beta1.Environment].
|
com.google.api.gax.httpjson.longrunning.OperationsClient |
getHttpJsonOperationsClient()
Returns the OperationsClient that can be used to query the status of a long-running operation
returned by another API method call.
|
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.
|
com.google.longrunning.OperationsClient |
getOperationsClient()
Returns the OperationsClient that can be used to query the status of a long-running operation
returned by another API method call.
|
EnvironmentsSettings |
getSettings() |
EnvironmentsStub |
getStub() |
boolean |
isShutdown() |
boolean |
isTerminated() |
EnvironmentsClient.ListContinuousTestResultsPagedResponse |
listContinuousTestResults(EnvironmentName parent)
Fetches a list of continuous test results for a given environment.
|
EnvironmentsClient.ListContinuousTestResultsPagedResponse |
listContinuousTestResults(ListContinuousTestResultsRequest request)
Fetches a list of continuous test results for a given environment.
|
EnvironmentsClient.ListContinuousTestResultsPagedResponse |
listContinuousTestResults(String parent)
Fetches a list of continuous test results for a given environment.
|
com.google.api.gax.rpc.UnaryCallable<ListContinuousTestResultsRequest,ListContinuousTestResultsResponse> |
listContinuousTestResultsCallable()
Fetches a list of continuous test results for a given environment.
|
com.google.api.gax.rpc.UnaryCallable<ListContinuousTestResultsRequest,EnvironmentsClient.ListContinuousTestResultsPagedResponse> |
listContinuousTestResultsPagedCallable()
Fetches a list of continuous test results for a given environment.
|
EnvironmentsClient.ListEnvironmentsPagedResponse |
listEnvironments(AgentName parent)
Returns the list of all environments in the specified
[Agent][google.cloud.dialogflow.cx.v3beta1.Agent].
|
EnvironmentsClient.ListEnvironmentsPagedResponse |
listEnvironments(ListEnvironmentsRequest request)
Returns the list of all environments in the specified
[Agent][google.cloud.dialogflow.cx.v3beta1.Agent].
|
EnvironmentsClient.ListEnvironmentsPagedResponse |
listEnvironments(String parent)
Returns the list of all environments in the specified
[Agent][google.cloud.dialogflow.cx.v3beta1.Agent].
|
com.google.api.gax.rpc.UnaryCallable<ListEnvironmentsRequest,ListEnvironmentsResponse> |
listEnvironmentsCallable()
Returns the list of all environments in the specified
[Agent][google.cloud.dialogflow.cx.v3beta1.Agent].
|
com.google.api.gax.rpc.UnaryCallable<ListEnvironmentsRequest,EnvironmentsClient.ListEnvironmentsPagedResponse> |
listEnvironmentsPagedCallable()
Returns the list of all environments in the specified
[Agent][google.cloud.dialogflow.cx.v3beta1.Agent].
|
EnvironmentsClient.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,EnvironmentsClient.ListLocationsPagedResponse> |
listLocationsPagedCallable()
Lists information about the supported locations for this service.
|
EnvironmentsClient.LookupEnvironmentHistoryPagedResponse |
lookupEnvironmentHistory(EnvironmentName name)
Looks up the history of the specified
[Environment][google.cloud.dialogflow.cx.v3beta1.Environment].
|
EnvironmentsClient.LookupEnvironmentHistoryPagedResponse |
lookupEnvironmentHistory(LookupEnvironmentHistoryRequest request)
Looks up the history of the specified
[Environment][google.cloud.dialogflow.cx.v3beta1.Environment].
|
EnvironmentsClient.LookupEnvironmentHistoryPagedResponse |
lookupEnvironmentHistory(String name)
Looks up the history of the specified
[Environment][google.cloud.dialogflow.cx.v3beta1.Environment].
|
com.google.api.gax.rpc.UnaryCallable<LookupEnvironmentHistoryRequest,LookupEnvironmentHistoryResponse> |
lookupEnvironmentHistoryCallable()
Looks up the history of the specified
[Environment][google.cloud.dialogflow.cx.v3beta1.Environment].
|
com.google.api.gax.rpc.UnaryCallable<LookupEnvironmentHistoryRequest,EnvironmentsClient.LookupEnvironmentHistoryPagedResponse> |
lookupEnvironmentHistoryPagedCallable()
Looks up the history of the specified
[Environment][google.cloud.dialogflow.cx.v3beta1.Environment].
|
com.google.api.gax.longrunning.OperationFuture<RunContinuousTestResponse,RunContinuousTestMetadata> |
runContinuousTestAsync(RunContinuousTestRequest request)
Kicks off a continuous test under the specified
[Environment][google.cloud.dialogflow.cx.v3beta1.Environment].
|
com.google.api.gax.rpc.UnaryCallable<RunContinuousTestRequest,com.google.longrunning.Operation> |
runContinuousTestCallable()
Kicks off a continuous test under the specified
[Environment][google.cloud.dialogflow.cx.v3beta1.Environment].
|
com.google.api.gax.rpc.OperationCallable<RunContinuousTestRequest,RunContinuousTestResponse,RunContinuousTestMetadata> |
runContinuousTestOperationCallable()
Kicks off a continuous test under the specified
[Environment][google.cloud.dialogflow.cx.v3beta1.Environment].
|
void |
shutdown() |
void |
shutdownNow() |
com.google.api.gax.longrunning.OperationFuture<Environment,com.google.protobuf.Struct> |
updateEnvironmentAsync(Environment environment,
com.google.protobuf.FieldMask updateMask)
Updates the specified [Environment][google.cloud.dialogflow.cx.v3beta1.Environment].
|
com.google.api.gax.longrunning.OperationFuture<Environment,com.google.protobuf.Struct> |
updateEnvironmentAsync(UpdateEnvironmentRequest request)
Updates the specified [Environment][google.cloud.dialogflow.cx.v3beta1.Environment].
|
com.google.api.gax.rpc.UnaryCallable<UpdateEnvironmentRequest,com.google.longrunning.Operation> |
updateEnvironmentCallable()
Updates the specified [Environment][google.cloud.dialogflow.cx.v3beta1.Environment].
|
com.google.api.gax.rpc.OperationCallable<UpdateEnvironmentRequest,Environment,com.google.protobuf.Struct> |
updateEnvironmentOperationCallable()
Updates the specified [Environment][google.cloud.dialogflow.cx.v3beta1.Environment].
|
protected EnvironmentsClient(EnvironmentsSettings settings) throws IOException
IOExceptionprotected EnvironmentsClient(EnvironmentsStub stub)
public static final EnvironmentsClient create() throws IOException
IOExceptionpublic static final EnvironmentsClient create(EnvironmentsSettings settings) throws IOException
IOExceptionpublic static final EnvironmentsClient create(EnvironmentsStub stub)
public final EnvironmentsSettings getSettings()
public EnvironmentsStub getStub()
public final com.google.longrunning.OperationsClient getOperationsClient()
@BetaApi public final com.google.api.gax.httpjson.longrunning.OperationsClient getHttpJsonOperationsClient()
public final EnvironmentsClient.ListEnvironmentsPagedResponse listEnvironments(AgentName parent)
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 (EnvironmentsClient environmentsClient = EnvironmentsClient.create()) {
AgentName parent = AgentName.of("[PROJECT]", "[LOCATION]", "[AGENT]");
for (Environment element : environmentsClient.listEnvironments(parent).iterateAll()) {
// doThingsWith(element);
}
}
parent - Required. The [Agent][google.cloud.dialogflow.cx.v3beta1.Agent] to list all
environments for. Format:
`projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>`.com.google.api.gax.rpc.ApiException - if the remote call failspublic final EnvironmentsClient.ListEnvironmentsPagedResponse listEnvironments(String parent)
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 (EnvironmentsClient environmentsClient = EnvironmentsClient.create()) {
String parent = AgentName.of("[PROJECT]", "[LOCATION]", "[AGENT]").toString();
for (Environment element : environmentsClient.listEnvironments(parent).iterateAll()) {
// doThingsWith(element);
}
}
parent - Required. The [Agent][google.cloud.dialogflow.cx.v3beta1.Agent] to list all
environments for. Format:
`projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>`.com.google.api.gax.rpc.ApiException - if the remote call failspublic final EnvironmentsClient.ListEnvironmentsPagedResponse listEnvironments(ListEnvironmentsRequest request)
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 (EnvironmentsClient environmentsClient = EnvironmentsClient.create()) {
ListEnvironmentsRequest request =
ListEnvironmentsRequest.newBuilder()
.setParent(AgentName.of("[PROJECT]", "[LOCATION]", "[AGENT]").toString())
.setPageSize(883849137)
.setPageToken("pageToken873572522")
.build();
for (Environment element : environmentsClient.listEnvironments(request).iterateAll()) {
// doThingsWith(element);
}
}
request - The request object containing all of the parameters for the API call.com.google.api.gax.rpc.ApiException - if the remote call failspublic final com.google.api.gax.rpc.UnaryCallable<ListEnvironmentsRequest,EnvironmentsClient.ListEnvironmentsPagedResponse> listEnvironmentsPagedCallable()
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 (EnvironmentsClient environmentsClient = EnvironmentsClient.create()) {
ListEnvironmentsRequest request =
ListEnvironmentsRequest.newBuilder()
.setParent(AgentName.of("[PROJECT]", "[LOCATION]", "[AGENT]").toString())
.setPageSize(883849137)
.setPageToken("pageToken873572522")
.build();
ApiFuture<Environment> future =
environmentsClient.listEnvironmentsPagedCallable().futureCall(request);
// Do something.
for (Environment element : future.get().iterateAll()) {
// doThingsWith(element);
}
}
public final com.google.api.gax.rpc.UnaryCallable<ListEnvironmentsRequest,ListEnvironmentsResponse> listEnvironmentsCallable()
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 (EnvironmentsClient environmentsClient = EnvironmentsClient.create()) {
ListEnvironmentsRequest request =
ListEnvironmentsRequest.newBuilder()
.setParent(AgentName.of("[PROJECT]", "[LOCATION]", "[AGENT]").toString())
.setPageSize(883849137)
.setPageToken("pageToken873572522")
.build();
while (true) {
ListEnvironmentsResponse response =
environmentsClient.listEnvironmentsCallable().call(request);
for (Environment element : response.getEnvironmentsList()) {
// doThingsWith(element);
}
String nextPageToken = response.getNextPageToken();
if (!Strings.isNullOrEmpty(nextPageToken)) {
request = request.toBuilder().setPageToken(nextPageToken).build();
} else {
break;
}
}
}
public final Environment getEnvironment(EnvironmentName name)
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 (EnvironmentsClient environmentsClient = EnvironmentsClient.create()) {
EnvironmentName name =
EnvironmentName.of("[PROJECT]", "[LOCATION]", "[AGENT]", "[ENVIRONMENT]");
Environment response = environmentsClient.getEnvironment(name);
}
name - Required. The name of the
[Environment][google.cloud.dialogflow.cx.v3beta1.Environment]. Format:
`projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/environments/<EnvironmentID>`.com.google.api.gax.rpc.ApiException - if the remote call failspublic final Environment getEnvironment(String name)
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 (EnvironmentsClient environmentsClient = EnvironmentsClient.create()) {
String name =
EnvironmentName.of("[PROJECT]", "[LOCATION]", "[AGENT]", "[ENVIRONMENT]").toString();
Environment response = environmentsClient.getEnvironment(name);
}
name - Required. The name of the
[Environment][google.cloud.dialogflow.cx.v3beta1.Environment]. Format:
`projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/environments/<EnvironmentID>`.com.google.api.gax.rpc.ApiException - if the remote call failspublic final Environment getEnvironment(GetEnvironmentRequest request)
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 (EnvironmentsClient environmentsClient = EnvironmentsClient.create()) {
GetEnvironmentRequest request =
GetEnvironmentRequest.newBuilder()
.setName(
EnvironmentName.of("[PROJECT]", "[LOCATION]", "[AGENT]", "[ENVIRONMENT]")
.toString())
.build();
Environment response = environmentsClient.getEnvironment(request);
}
request - The request object containing all of the parameters for the API call.com.google.api.gax.rpc.ApiException - if the remote call failspublic final com.google.api.gax.rpc.UnaryCallable<GetEnvironmentRequest,Environment> getEnvironmentCallable()
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 (EnvironmentsClient environmentsClient = EnvironmentsClient.create()) {
GetEnvironmentRequest request =
GetEnvironmentRequest.newBuilder()
.setName(
EnvironmentName.of("[PROJECT]", "[LOCATION]", "[AGENT]", "[ENVIRONMENT]")
.toString())
.build();
ApiFuture<Environment> future =
environmentsClient.getEnvironmentCallable().futureCall(request);
// Do something.
Environment response = future.get();
}
public final com.google.api.gax.longrunning.OperationFuture<Environment,com.google.protobuf.Struct> createEnvironmentAsync(AgentName parent, Environment environment)
This method is a [long-running operation](https://cloud.google.com/dialogflow/cx/docs/how/long-running-operation). The returned `Operation` type has the following method-specific fields:
- `metadata`: An empty [Struct message](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#struct) - `response`: [Environment][google.cloud.dialogflow.cx.v3beta1.Environment]
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 (EnvironmentsClient environmentsClient = EnvironmentsClient.create()) {
AgentName parent = AgentName.of("[PROJECT]", "[LOCATION]", "[AGENT]");
Environment environment = Environment.newBuilder().build();
Environment response = environmentsClient.createEnvironmentAsync(parent, environment).get();
}
parent - Required. The [Agent][google.cloud.dialogflow.cx.v3beta1.Agent] to create an
[Environment][google.cloud.dialogflow.cx.v3beta1.Environment] for. Format:
`projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>`.environment - Required. The environment to create.com.google.api.gax.rpc.ApiException - if the remote call failspublic final com.google.api.gax.longrunning.OperationFuture<Environment,com.google.protobuf.Struct> createEnvironmentAsync(String parent, Environment environment)
This method is a [long-running operation](https://cloud.google.com/dialogflow/cx/docs/how/long-running-operation). The returned `Operation` type has the following method-specific fields:
- `metadata`: An empty [Struct message](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#struct) - `response`: [Environment][google.cloud.dialogflow.cx.v3beta1.Environment]
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 (EnvironmentsClient environmentsClient = EnvironmentsClient.create()) {
String parent = AgentName.of("[PROJECT]", "[LOCATION]", "[AGENT]").toString();
Environment environment = Environment.newBuilder().build();
Environment response = environmentsClient.createEnvironmentAsync(parent, environment).get();
}
parent - Required. The [Agent][google.cloud.dialogflow.cx.v3beta1.Agent] to create an
[Environment][google.cloud.dialogflow.cx.v3beta1.Environment] for. Format:
`projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>`.environment - Required. The environment to create.com.google.api.gax.rpc.ApiException - if the remote call failspublic final com.google.api.gax.longrunning.OperationFuture<Environment,com.google.protobuf.Struct> createEnvironmentAsync(CreateEnvironmentRequest request)
This method is a [long-running operation](https://cloud.google.com/dialogflow/cx/docs/how/long-running-operation). The returned `Operation` type has the following method-specific fields:
- `metadata`: An empty [Struct message](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#struct) - `response`: [Environment][google.cloud.dialogflow.cx.v3beta1.Environment]
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 (EnvironmentsClient environmentsClient = EnvironmentsClient.create()) {
CreateEnvironmentRequest request =
CreateEnvironmentRequest.newBuilder()
.setParent(AgentName.of("[PROJECT]", "[LOCATION]", "[AGENT]").toString())
.setEnvironment(Environment.newBuilder().build())
.build();
Environment response = environmentsClient.createEnvironmentAsync(request).get();
}
request - The request object containing all of the parameters for the API call.com.google.api.gax.rpc.ApiException - if the remote call failspublic final com.google.api.gax.rpc.OperationCallable<CreateEnvironmentRequest,Environment,com.google.protobuf.Struct> createEnvironmentOperationCallable()
This method is a [long-running operation](https://cloud.google.com/dialogflow/cx/docs/how/long-running-operation). The returned `Operation` type has the following method-specific fields:
- `metadata`: An empty [Struct message](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#struct) - `response`: [Environment][google.cloud.dialogflow.cx.v3beta1.Environment]
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 (EnvironmentsClient environmentsClient = EnvironmentsClient.create()) {
CreateEnvironmentRequest request =
CreateEnvironmentRequest.newBuilder()
.setParent(AgentName.of("[PROJECT]", "[LOCATION]", "[AGENT]").toString())
.setEnvironment(Environment.newBuilder().build())
.build();
OperationFuture<Environment, Struct> future =
environmentsClient.createEnvironmentOperationCallable().futureCall(request);
// Do something.
Environment response = future.get();
}
public final com.google.api.gax.rpc.UnaryCallable<CreateEnvironmentRequest,com.google.longrunning.Operation> createEnvironmentCallable()
This method is a [long-running operation](https://cloud.google.com/dialogflow/cx/docs/how/long-running-operation). The returned `Operation` type has the following method-specific fields:
- `metadata`: An empty [Struct message](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#struct) - `response`: [Environment][google.cloud.dialogflow.cx.v3beta1.Environment]
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 (EnvironmentsClient environmentsClient = EnvironmentsClient.create()) {
CreateEnvironmentRequest request =
CreateEnvironmentRequest.newBuilder()
.setParent(AgentName.of("[PROJECT]", "[LOCATION]", "[AGENT]").toString())
.setEnvironment(Environment.newBuilder().build())
.build();
ApiFuture<Operation> future =
environmentsClient.createEnvironmentCallable().futureCall(request);
// Do something.
Operation response = future.get();
}
public final com.google.api.gax.longrunning.OperationFuture<Environment,com.google.protobuf.Struct> updateEnvironmentAsync(Environment environment, com.google.protobuf.FieldMask updateMask)
This method is a [long-running operation](https://cloud.google.com/dialogflow/cx/docs/how/long-running-operation). The returned `Operation` type has the following method-specific fields:
- `metadata`: An empty [Struct message](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#struct) - `response`: [Environment][google.cloud.dialogflow.cx.v3beta1.Environment]
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 (EnvironmentsClient environmentsClient = EnvironmentsClient.create()) {
Environment environment = Environment.newBuilder().build();
FieldMask updateMask = FieldMask.newBuilder().build();
Environment response =
environmentsClient.updateEnvironmentAsync(environment, updateMask).get();
}
environment - Required. The environment to update.updateMask - Required. The mask to control which fields get updated.com.google.api.gax.rpc.ApiException - if the remote call failspublic final com.google.api.gax.longrunning.OperationFuture<Environment,com.google.protobuf.Struct> updateEnvironmentAsync(UpdateEnvironmentRequest request)
This method is a [long-running operation](https://cloud.google.com/dialogflow/cx/docs/how/long-running-operation). The returned `Operation` type has the following method-specific fields:
- `metadata`: An empty [Struct message](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#struct) - `response`: [Environment][google.cloud.dialogflow.cx.v3beta1.Environment]
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 (EnvironmentsClient environmentsClient = EnvironmentsClient.create()) {
UpdateEnvironmentRequest request =
UpdateEnvironmentRequest.newBuilder()
.setEnvironment(Environment.newBuilder().build())
.setUpdateMask(FieldMask.newBuilder().build())
.build();
Environment response = environmentsClient.updateEnvironmentAsync(request).get();
}
request - The request object containing all of the parameters for the API call.com.google.api.gax.rpc.ApiException - if the remote call failspublic final com.google.api.gax.rpc.OperationCallable<UpdateEnvironmentRequest,Environment,com.google.protobuf.Struct> updateEnvironmentOperationCallable()
This method is a [long-running operation](https://cloud.google.com/dialogflow/cx/docs/how/long-running-operation). The returned `Operation` type has the following method-specific fields:
- `metadata`: An empty [Struct message](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#struct) - `response`: [Environment][google.cloud.dialogflow.cx.v3beta1.Environment]
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 (EnvironmentsClient environmentsClient = EnvironmentsClient.create()) {
UpdateEnvironmentRequest request =
UpdateEnvironmentRequest.newBuilder()
.setEnvironment(Environment.newBuilder().build())
.setUpdateMask(FieldMask.newBuilder().build())
.build();
OperationFuture<Environment, Struct> future =
environmentsClient.updateEnvironmentOperationCallable().futureCall(request);
// Do something.
Environment response = future.get();
}
public final com.google.api.gax.rpc.UnaryCallable<UpdateEnvironmentRequest,com.google.longrunning.Operation> updateEnvironmentCallable()
This method is a [long-running operation](https://cloud.google.com/dialogflow/cx/docs/how/long-running-operation). The returned `Operation` type has the following method-specific fields:
- `metadata`: An empty [Struct message](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#struct) - `response`: [Environment][google.cloud.dialogflow.cx.v3beta1.Environment]
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 (EnvironmentsClient environmentsClient = EnvironmentsClient.create()) {
UpdateEnvironmentRequest request =
UpdateEnvironmentRequest.newBuilder()
.setEnvironment(Environment.newBuilder().build())
.setUpdateMask(FieldMask.newBuilder().build())
.build();
ApiFuture<Operation> future =
environmentsClient.updateEnvironmentCallable().futureCall(request);
// Do something.
Operation response = future.get();
}
public final void deleteEnvironment(EnvironmentName name)
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 (EnvironmentsClient environmentsClient = EnvironmentsClient.create()) {
EnvironmentName name =
EnvironmentName.of("[PROJECT]", "[LOCATION]", "[AGENT]", "[ENVIRONMENT]");
environmentsClient.deleteEnvironment(name);
}
name - Required. The name of the
[Environment][google.cloud.dialogflow.cx.v3beta1.Environment] to delete. Format:
`projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/environments/<EnvironmentID>`.com.google.api.gax.rpc.ApiException - if the remote call failspublic final void deleteEnvironment(String name)
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 (EnvironmentsClient environmentsClient = EnvironmentsClient.create()) {
String name =
EnvironmentName.of("[PROJECT]", "[LOCATION]", "[AGENT]", "[ENVIRONMENT]").toString();
environmentsClient.deleteEnvironment(name);
}
name - Required. The name of the
[Environment][google.cloud.dialogflow.cx.v3beta1.Environment] to delete. Format:
`projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/environments/<EnvironmentID>`.com.google.api.gax.rpc.ApiException - if the remote call failspublic final void deleteEnvironment(DeleteEnvironmentRequest request)
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 (EnvironmentsClient environmentsClient = EnvironmentsClient.create()) {
DeleteEnvironmentRequest request =
DeleteEnvironmentRequest.newBuilder()
.setName(
EnvironmentName.of("[PROJECT]", "[LOCATION]", "[AGENT]", "[ENVIRONMENT]")
.toString())
.build();
environmentsClient.deleteEnvironment(request);
}
request - The request object containing all of the parameters for the API call.com.google.api.gax.rpc.ApiException - if the remote call failspublic final com.google.api.gax.rpc.UnaryCallable<DeleteEnvironmentRequest,com.google.protobuf.Empty> deleteEnvironmentCallable()
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 (EnvironmentsClient environmentsClient = EnvironmentsClient.create()) {
DeleteEnvironmentRequest request =
DeleteEnvironmentRequest.newBuilder()
.setName(
EnvironmentName.of("[PROJECT]", "[LOCATION]", "[AGENT]", "[ENVIRONMENT]")
.toString())
.build();
ApiFuture<Empty> future = environmentsClient.deleteEnvironmentCallable().futureCall(request);
// Do something.
future.get();
}
public final EnvironmentsClient.LookupEnvironmentHistoryPagedResponse lookupEnvironmentHistory(EnvironmentName name)
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 (EnvironmentsClient environmentsClient = EnvironmentsClient.create()) {
EnvironmentName name =
EnvironmentName.of("[PROJECT]", "[LOCATION]", "[AGENT]", "[ENVIRONMENT]");
for (Environment element : environmentsClient.lookupEnvironmentHistory(name).iterateAll()) {
// doThingsWith(element);
}
}
name - Required. Resource name of the environment to look up the history for. Format:
`projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/environments/<EnvironmentID>`.com.google.api.gax.rpc.ApiException - if the remote call failspublic final EnvironmentsClient.LookupEnvironmentHistoryPagedResponse lookupEnvironmentHistory(String name)
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 (EnvironmentsClient environmentsClient = EnvironmentsClient.create()) {
String name =
EnvironmentName.of("[PROJECT]", "[LOCATION]", "[AGENT]", "[ENVIRONMENT]").toString();
for (Environment element : environmentsClient.lookupEnvironmentHistory(name).iterateAll()) {
// doThingsWith(element);
}
}
name - Required. Resource name of the environment to look up the history for. Format:
`projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/environments/<EnvironmentID>`.com.google.api.gax.rpc.ApiException - if the remote call failspublic final EnvironmentsClient.LookupEnvironmentHistoryPagedResponse lookupEnvironmentHistory(LookupEnvironmentHistoryRequest request)
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 (EnvironmentsClient environmentsClient = EnvironmentsClient.create()) {
LookupEnvironmentHistoryRequest request =
LookupEnvironmentHistoryRequest.newBuilder()
.setName(
EnvironmentName.of("[PROJECT]", "[LOCATION]", "[AGENT]", "[ENVIRONMENT]")
.toString())
.setPageSize(883849137)
.setPageToken("pageToken873572522")
.build();
for (Environment element :
environmentsClient.lookupEnvironmentHistory(request).iterateAll()) {
// doThingsWith(element);
}
}
request - The request object containing all of the parameters for the API call.com.google.api.gax.rpc.ApiException - if the remote call failspublic final com.google.api.gax.rpc.UnaryCallable<LookupEnvironmentHistoryRequest,EnvironmentsClient.LookupEnvironmentHistoryPagedResponse> lookupEnvironmentHistoryPagedCallable()
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 (EnvironmentsClient environmentsClient = EnvironmentsClient.create()) {
LookupEnvironmentHistoryRequest request =
LookupEnvironmentHistoryRequest.newBuilder()
.setName(
EnvironmentName.of("[PROJECT]", "[LOCATION]", "[AGENT]", "[ENVIRONMENT]")
.toString())
.setPageSize(883849137)
.setPageToken("pageToken873572522")
.build();
ApiFuture<Environment> future =
environmentsClient.lookupEnvironmentHistoryPagedCallable().futureCall(request);
// Do something.
for (Environment element : future.get().iterateAll()) {
// doThingsWith(element);
}
}
public final com.google.api.gax.rpc.UnaryCallable<LookupEnvironmentHistoryRequest,LookupEnvironmentHistoryResponse> lookupEnvironmentHistoryCallable()
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 (EnvironmentsClient environmentsClient = EnvironmentsClient.create()) {
LookupEnvironmentHistoryRequest request =
LookupEnvironmentHistoryRequest.newBuilder()
.setName(
EnvironmentName.of("[PROJECT]", "[LOCATION]", "[AGENT]", "[ENVIRONMENT]")
.toString())
.setPageSize(883849137)
.setPageToken("pageToken873572522")
.build();
while (true) {
LookupEnvironmentHistoryResponse response =
environmentsClient.lookupEnvironmentHistoryCallable().call(request);
for (Environment element : response.getEnvironmentsList()) {
// doThingsWith(element);
}
String nextPageToken = response.getNextPageToken();
if (!Strings.isNullOrEmpty(nextPageToken)) {
request = request.toBuilder().setPageToken(nextPageToken).build();
} else {
break;
}
}
}
public final com.google.api.gax.longrunning.OperationFuture<RunContinuousTestResponse,RunContinuousTestMetadata> runContinuousTestAsync(RunContinuousTestRequest request)
This method is a [long-running operation](https://cloud.google.com/dialogflow/cx/docs/how/long-running-operation). The returned `Operation` type has the following method-specific fields:
- `metadata`: [RunContinuousTestMetadata][google.cloud.dialogflow.cx.v3beta1.RunContinuousTestMetadata] - `response`: [RunContinuousTestResponse][google.cloud.dialogflow.cx.v3beta1.RunContinuousTestResponse]
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 (EnvironmentsClient environmentsClient = EnvironmentsClient.create()) {
RunContinuousTestRequest request =
RunContinuousTestRequest.newBuilder()
.setEnvironment(
EnvironmentName.of("[PROJECT]", "[LOCATION]", "[AGENT]", "[ENVIRONMENT]")
.toString())
.build();
RunContinuousTestResponse response = environmentsClient.runContinuousTestAsync(request).get();
}
request - The request object containing all of the parameters for the API call.com.google.api.gax.rpc.ApiException - if the remote call failspublic final com.google.api.gax.rpc.OperationCallable<RunContinuousTestRequest,RunContinuousTestResponse,RunContinuousTestMetadata> runContinuousTestOperationCallable()
This method is a [long-running operation](https://cloud.google.com/dialogflow/cx/docs/how/long-running-operation). The returned `Operation` type has the following method-specific fields:
- `metadata`: [RunContinuousTestMetadata][google.cloud.dialogflow.cx.v3beta1.RunContinuousTestMetadata] - `response`: [RunContinuousTestResponse][google.cloud.dialogflow.cx.v3beta1.RunContinuousTestResponse]
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 (EnvironmentsClient environmentsClient = EnvironmentsClient.create()) {
RunContinuousTestRequest request =
RunContinuousTestRequest.newBuilder()
.setEnvironment(
EnvironmentName.of("[PROJECT]", "[LOCATION]", "[AGENT]", "[ENVIRONMENT]")
.toString())
.build();
OperationFuture<RunContinuousTestResponse, RunContinuousTestMetadata> future =
environmentsClient.runContinuousTestOperationCallable().futureCall(request);
// Do something.
RunContinuousTestResponse response = future.get();
}
public final com.google.api.gax.rpc.UnaryCallable<RunContinuousTestRequest,com.google.longrunning.Operation> runContinuousTestCallable()
This method is a [long-running operation](https://cloud.google.com/dialogflow/cx/docs/how/long-running-operation). The returned `Operation` type has the following method-specific fields:
- `metadata`: [RunContinuousTestMetadata][google.cloud.dialogflow.cx.v3beta1.RunContinuousTestMetadata] - `response`: [RunContinuousTestResponse][google.cloud.dialogflow.cx.v3beta1.RunContinuousTestResponse]
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 (EnvironmentsClient environmentsClient = EnvironmentsClient.create()) {
RunContinuousTestRequest request =
RunContinuousTestRequest.newBuilder()
.setEnvironment(
EnvironmentName.of("[PROJECT]", "[LOCATION]", "[AGENT]", "[ENVIRONMENT]")
.toString())
.build();
ApiFuture<Operation> future =
environmentsClient.runContinuousTestCallable().futureCall(request);
// Do something.
Operation response = future.get();
}
public final EnvironmentsClient.ListContinuousTestResultsPagedResponse listContinuousTestResults(EnvironmentName parent)
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 (EnvironmentsClient environmentsClient = EnvironmentsClient.create()) {
EnvironmentName parent =
EnvironmentName.of("[PROJECT]", "[LOCATION]", "[AGENT]", "[ENVIRONMENT]");
for (ContinuousTestResult element :
environmentsClient.listContinuousTestResults(parent).iterateAll()) {
// doThingsWith(element);
}
}
parent - Required. The environment to list results for. Format:
`projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/environments/<EnvironmentID>`.com.google.api.gax.rpc.ApiException - if the remote call failspublic final EnvironmentsClient.ListContinuousTestResultsPagedResponse listContinuousTestResults(String parent)
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 (EnvironmentsClient environmentsClient = EnvironmentsClient.create()) {
String parent =
EnvironmentName.of("[PROJECT]", "[LOCATION]", "[AGENT]", "[ENVIRONMENT]").toString();
for (ContinuousTestResult element :
environmentsClient.listContinuousTestResults(parent).iterateAll()) {
// doThingsWith(element);
}
}
parent - Required. The environment to list results for. Format:
`projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/environments/<EnvironmentID>`.com.google.api.gax.rpc.ApiException - if the remote call failspublic final EnvironmentsClient.ListContinuousTestResultsPagedResponse listContinuousTestResults(ListContinuousTestResultsRequest request)
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 (EnvironmentsClient environmentsClient = EnvironmentsClient.create()) {
ListContinuousTestResultsRequest request =
ListContinuousTestResultsRequest.newBuilder()
.setParent(
EnvironmentName.of("[PROJECT]", "[LOCATION]", "[AGENT]", "[ENVIRONMENT]")
.toString())
.setPageSize(883849137)
.setPageToken("pageToken873572522")
.build();
for (ContinuousTestResult element :
environmentsClient.listContinuousTestResults(request).iterateAll()) {
// doThingsWith(element);
}
}
request - The request object containing all of the parameters for the API call.com.google.api.gax.rpc.ApiException - if the remote call failspublic final com.google.api.gax.rpc.UnaryCallable<ListContinuousTestResultsRequest,EnvironmentsClient.ListContinuousTestResultsPagedResponse> listContinuousTestResultsPagedCallable()
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 (EnvironmentsClient environmentsClient = EnvironmentsClient.create()) {
ListContinuousTestResultsRequest request =
ListContinuousTestResultsRequest.newBuilder()
.setParent(
EnvironmentName.of("[PROJECT]", "[LOCATION]", "[AGENT]", "[ENVIRONMENT]")
.toString())
.setPageSize(883849137)
.setPageToken("pageToken873572522")
.build();
ApiFuture<ContinuousTestResult> future =
environmentsClient.listContinuousTestResultsPagedCallable().futureCall(request);
// Do something.
for (ContinuousTestResult element : future.get().iterateAll()) {
// doThingsWith(element);
}
}
public final com.google.api.gax.rpc.UnaryCallable<ListContinuousTestResultsRequest,ListContinuousTestResultsResponse> listContinuousTestResultsCallable()
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 (EnvironmentsClient environmentsClient = EnvironmentsClient.create()) {
ListContinuousTestResultsRequest request =
ListContinuousTestResultsRequest.newBuilder()
.setParent(
EnvironmentName.of("[PROJECT]", "[LOCATION]", "[AGENT]", "[ENVIRONMENT]")
.toString())
.setPageSize(883849137)
.setPageToken("pageToken873572522")
.build();
while (true) {
ListContinuousTestResultsResponse response =
environmentsClient.listContinuousTestResultsCallable().call(request);
for (ContinuousTestResult element : response.getContinuousTestResultsList()) {
// doThingsWith(element);
}
String nextPageToken = response.getNextPageToken();
if (!Strings.isNullOrEmpty(nextPageToken)) {
request = request.toBuilder().setPageToken(nextPageToken).build();
} else {
break;
}
}
}
public final com.google.api.gax.longrunning.OperationFuture<DeployFlowResponse,DeployFlowMetadata> deployFlowAsync(DeployFlowRequest request)
This method is a [long-running operation](https://cloud.google.com/dialogflow/cx/docs/how/long-running-operation). The returned `Operation` type has the following method-specific fields:
- `metadata`: [DeployFlowMetadata][google.cloud.dialogflow.cx.v3beta1.DeployFlowMetadata] - `response`: [DeployFlowResponse][google.cloud.dialogflow.cx.v3beta1.DeployFlowResponse]
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 (EnvironmentsClient environmentsClient = EnvironmentsClient.create()) {
DeployFlowRequest request =
DeployFlowRequest.newBuilder()
.setEnvironment(
EnvironmentName.of("[PROJECT]", "[LOCATION]", "[AGENT]", "[ENVIRONMENT]")
.toString())
.setFlowVersion(
VersionName.of("[PROJECT]", "[LOCATION]", "[AGENT]", "[FLOW]", "[VERSION]")
.toString())
.build();
DeployFlowResponse response = environmentsClient.deployFlowAsync(request).get();
}
request - The request object containing all of the parameters for the API call.com.google.api.gax.rpc.ApiException - if the remote call failspublic final com.google.api.gax.rpc.OperationCallable<DeployFlowRequest,DeployFlowResponse,DeployFlowMetadata> deployFlowOperationCallable()
This method is a [long-running operation](https://cloud.google.com/dialogflow/cx/docs/how/long-running-operation). The returned `Operation` type has the following method-specific fields:
- `metadata`: [DeployFlowMetadata][google.cloud.dialogflow.cx.v3beta1.DeployFlowMetadata] - `response`: [DeployFlowResponse][google.cloud.dialogflow.cx.v3beta1.DeployFlowResponse]
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 (EnvironmentsClient environmentsClient = EnvironmentsClient.create()) {
DeployFlowRequest request =
DeployFlowRequest.newBuilder()
.setEnvironment(
EnvironmentName.of("[PROJECT]", "[LOCATION]", "[AGENT]", "[ENVIRONMENT]")
.toString())
.setFlowVersion(
VersionName.of("[PROJECT]", "[LOCATION]", "[AGENT]", "[FLOW]", "[VERSION]")
.toString())
.build();
OperationFuture<DeployFlowResponse, DeployFlowMetadata> future =
environmentsClient.deployFlowOperationCallable().futureCall(request);
// Do something.
DeployFlowResponse response = future.get();
}
public final com.google.api.gax.rpc.UnaryCallable<DeployFlowRequest,com.google.longrunning.Operation> deployFlowCallable()
This method is a [long-running operation](https://cloud.google.com/dialogflow/cx/docs/how/long-running-operation). The returned `Operation` type has the following method-specific fields:
- `metadata`: [DeployFlowMetadata][google.cloud.dialogflow.cx.v3beta1.DeployFlowMetadata] - `response`: [DeployFlowResponse][google.cloud.dialogflow.cx.v3beta1.DeployFlowResponse]
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 (EnvironmentsClient environmentsClient = EnvironmentsClient.create()) {
DeployFlowRequest request =
DeployFlowRequest.newBuilder()
.setEnvironment(
EnvironmentName.of("[PROJECT]", "[LOCATION]", "[AGENT]", "[ENVIRONMENT]")
.toString())
.setFlowVersion(
VersionName.of("[PROJECT]", "[LOCATION]", "[AGENT]", "[FLOW]", "[VERSION]")
.toString())
.build();
ApiFuture<Operation> future = environmentsClient.deployFlowCallable().futureCall(request);
// Do something.
Operation response = future.get();
}
public final EnvironmentsClient.ListLocationsPagedResponse listLocations(com.google.cloud.location.ListLocationsRequest request)
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 (EnvironmentsClient environmentsClient = EnvironmentsClient.create()) {
ListLocationsRequest request =
ListLocationsRequest.newBuilder()
.setName("name3373707")
.setFilter("filter-1274492040")
.setPageSize(883849137)
.setPageToken("pageToken873572522")
.build();
for (Location element : environmentsClient.listLocations(request).iterateAll()) {
// doThingsWith(element);
}
}
request - The request object containing all of the parameters for the API call.com.google.api.gax.rpc.ApiException - if the remote call failspublic final com.google.api.gax.rpc.UnaryCallable<com.google.cloud.location.ListLocationsRequest,EnvironmentsClient.ListLocationsPagedResponse> listLocationsPagedCallable()
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 (EnvironmentsClient environmentsClient = EnvironmentsClient.create()) {
ListLocationsRequest request =
ListLocationsRequest.newBuilder()
.setName("name3373707")
.setFilter("filter-1274492040")
.setPageSize(883849137)
.setPageToken("pageToken873572522")
.build();
ApiFuture<Location> future =
environmentsClient.listLocationsPagedCallable().futureCall(request);
// Do something.
for (Location element : future.get().iterateAll()) {
// doThingsWith(element);
}
}
public final com.google.api.gax.rpc.UnaryCallable<com.google.cloud.location.ListLocationsRequest,com.google.cloud.location.ListLocationsResponse> listLocationsCallable()
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 (EnvironmentsClient environmentsClient = EnvironmentsClient.create()) {
ListLocationsRequest request =
ListLocationsRequest.newBuilder()
.setName("name3373707")
.setFilter("filter-1274492040")
.setPageSize(883849137)
.setPageToken("pageToken873572522")
.build();
while (true) {
ListLocationsResponse response = environmentsClient.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;
}
}
}
public final com.google.cloud.location.Location getLocation(com.google.cloud.location.GetLocationRequest request)
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 (EnvironmentsClient environmentsClient = EnvironmentsClient.create()) {
GetLocationRequest request = GetLocationRequest.newBuilder().setName("name3373707").build();
Location response = environmentsClient.getLocation(request);
}
request - The request object containing all of the parameters for the API call.com.google.api.gax.rpc.ApiException - if the remote call failspublic final com.google.api.gax.rpc.UnaryCallable<com.google.cloud.location.GetLocationRequest,com.google.cloud.location.Location> getLocationCallable()
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 (EnvironmentsClient environmentsClient = EnvironmentsClient.create()) {
GetLocationRequest request = GetLocationRequest.newBuilder().setName("name3373707").build();
ApiFuture<Location> future = environmentsClient.getLocationCallable().futureCall(request);
// Do something.
Location response = future.get();
}
public final void close()
close in interface AutoCloseablepublic void shutdown()
shutdown in interface com.google.api.gax.core.BackgroundResourcepublic boolean isShutdown()
isShutdown in interface com.google.api.gax.core.BackgroundResourcepublic boolean isTerminated()
isTerminated in interface com.google.api.gax.core.BackgroundResourcepublic void shutdownNow()
shutdownNow in interface com.google.api.gax.core.BackgroundResourcepublic boolean awaitTermination(long duration,
TimeUnit unit)
throws InterruptedException
awaitTermination in interface com.google.api.gax.core.BackgroundResourceInterruptedExceptionCopyright © 2025 Google LLC. All rights reserved.