Class EnvironmentsClient (0.13.1)

public class EnvironmentsClient implements BackgroundResource

Service Description: Service for managing Environments.

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 for illustrative purposes only.
 // It may require modifications to work in your environment.
 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().

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 EnvironmentsSettings to create(). For example:

To customize credentials:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 EnvironmentsSettings environmentsSettings =
     EnvironmentsSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 EnvironmentsClient environmentsClient = EnvironmentsClient.create(environmentsSettings);

To customize the endpoint:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 EnvironmentsSettings environmentsSettings =
     EnvironmentsSettings.newBuilder().setEndpoint(myEndpoint).build();
 EnvironmentsClient environmentsClient = EnvironmentsClient.create(environmentsSettings);

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

Inheritance

java.lang.Object > EnvironmentsClient

Implements

BackgroundResource

Inherited Members

Object.clone()

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.toString()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Methods

create()

public static final EnvironmentsClient create()

Constructs an instance of EnvironmentsClient with default settings.

Returns

Type	Description
EnvironmentsClient

Exceptions

Type	Description
IOException

create(EnvironmentsSettings settings)

public static final EnvironmentsClient create(EnvironmentsSettings settings)

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

Parameter

Name	Description
settings	`EnvironmentsSettings`

Returns

Type	Description
EnvironmentsClient

Exceptions

Type	Description
IOException

create(EnvironmentsStub stub)

public static final EnvironmentsClient create(EnvironmentsStub stub)

Constructs an instance of EnvironmentsClient, using the given stub for making calls. This is for advanced usage - prefer using create(EnvironmentsSettings).

Parameter

Name	Description
stub	`EnvironmentsStub`

Returns

Type	Description
EnvironmentsClient

Constructors

EnvironmentsClient(EnvironmentsSettings settings)

protected EnvironmentsClient(EnvironmentsSettings settings)

Constructs an instance of EnvironmentsClient, using the given settings. This is protected so that it is easy to make a subclass, but otherwise, the static factory methods should be preferred.

Parameter

Name	Description
settings	`EnvironmentsSettings`

EnvironmentsClient(EnvironmentsStub stub)

protected EnvironmentsClient(EnvironmentsStub stub)

Parameter

Name	Description
stub	`EnvironmentsStub`

Methods

awaitTermination(long duration, TimeUnit unit)

public boolean awaitTermination(long duration, TimeUnit unit)

Parameters

Name	Description
duration	`long`
unit	`TimeUnit`

Returns

Type	Description
boolean

Exceptions

Type	Description
InterruptedException

close()

public final void close()

createEnvironmentAsync(AgentName parent, Environment environment)

public final OperationFuture<Environment,Struct> createEnvironmentAsync(AgentName parent, Environment environment)

Creates an Environment in the specified Agent.

This method is a long-running operation. The returned Operation type has the following method-specific fields:

- metadata: An empty Struct message

response: Environment

Sample code:


// This snippet has been automatically generated for illustrative purposes only.
// It may require modifications to work in your environment.
try (EnvironmentsClient environmentsClient = EnvironmentsClient.create()) {
AgentName parent = AgentName.of("[PROJECT]", "[LOCATION]", "[AGENT]");
Environment environment = Environment.newBuilder().build();
Environment response = environmentsClient.createEnvironmentAsync(parent, environment).get();
}

Parameters

Name	Description
parent	`AgentName` Required. The Agent to create an Environment for. Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>`.
environment	`Environment` Required. The environment to create.

Returns

Type	Description
OperationFuture<Environment,Struct>

createEnvironmentAsync(CreateEnvironmentRequest request)

public final OperationFuture<Environment,Struct> createEnvironmentAsync(CreateEnvironmentRequest request)

Creates an Environment in the specified Agent.

This method is a long-running operation. The returned Operation type has the following method-specific fields:

- metadata: An empty Struct message

response: Environment

Sample code:


// This snippet has been automatically generated for illustrative purposes only.
// It may require modifications to work in your environment.
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();
}

Parameter

Name	Description
request	`CreateEnvironmentRequest` The request object containing all of the parameters for the API call.

Returns

Type	Description
OperationFuture<Environment,Struct>

createEnvironmentAsync(String parent, Environment environment)

public final OperationFuture<Environment,Struct> createEnvironmentAsync(String parent, Environment environment)

Creates an Environment in the specified Agent.

This method is a long-running operation. The returned Operation type has the following method-specific fields:

- metadata: An empty Struct message

response: Environment

Sample code:


// This snippet has been automatically generated for illustrative purposes only.
// It may require modifications to work in your environment.
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();
}

Parameters

Name	Description
parent	`String` Required. The Agent to create an Environment for. Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>`.
environment	`Environment` Required. The environment to create.

Returns

Type	Description
OperationFuture<Environment,Struct>

createEnvironmentCallable()

public final UnaryCallable<CreateEnvironmentRequest,Operation> createEnvironmentCallable()

Creates an Environment in the specified Agent.

This method is a long-running operation. The returned Operation type has the following method-specific fields:

- metadata: An empty Struct message

response: Environment

Sample code:


// This snippet has been automatically generated for illustrative purposes only.
// It may require modifications to work in your environment.
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();
}

Returns

Type	Description
UnaryCallable<CreateEnvironmentRequest,Operation>

createEnvironmentOperationCallable()

public final OperationCallable<CreateEnvironmentRequest,Environment,Struct> createEnvironmentOperationCallable()

Creates an Environment in the specified Agent.

This method is a long-running operation. The returned Operation type has the following method-specific fields:

- metadata: An empty Struct message

response: Environment

Sample code:


// This snippet has been automatically generated for illustrative purposes only.
// It may require modifications to work in your environment.
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();
}

Returns

Type	Description
OperationCallable<CreateEnvironmentRequest,Environment,Struct>

deleteEnvironment(DeleteEnvironmentRequest request)

public final void deleteEnvironment(DeleteEnvironmentRequest request)

Deletes the specified Environment.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (EnvironmentsClient environmentsClient = EnvironmentsClient.create()) {
   DeleteEnvironmentRequest request =
       DeleteEnvironmentRequest.newBuilder()
           .setName(
               EnvironmentName.of("[PROJECT]", "[LOCATION]", "[AGENT]", "[ENVIRONMENT]")
                   .toString())
           .build();
   environmentsClient.deleteEnvironment(request);
 }

Parameter

Name	Description
request	`DeleteEnvironmentRequest` The request object containing all of the parameters for the API call.

deleteEnvironment(EnvironmentName name)

public final void deleteEnvironment(EnvironmentName name)

Deletes the specified Environment.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (EnvironmentsClient environmentsClient = EnvironmentsClient.create()) {
   EnvironmentName name =
       EnvironmentName.of("[PROJECT]", "[LOCATION]", "[AGENT]", "[ENVIRONMENT]");
   environmentsClient.deleteEnvironment(name);
 }

Parameter

Name	Description
name	`EnvironmentName` Required. The name of the Environment to delete. Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/environments/<Environment ID>`.

deleteEnvironment(String name)

public final void deleteEnvironment(String name)

Deletes the specified Environment.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (EnvironmentsClient environmentsClient = EnvironmentsClient.create()) {
   String name =
       EnvironmentName.of("[PROJECT]", "[LOCATION]", "[AGENT]", "[ENVIRONMENT]").toString();
   environmentsClient.deleteEnvironment(name);
 }

Parameter

Name	Description
name	`String` Required. The name of the Environment to delete. Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/environments/<Environment ID>`.

deleteEnvironmentCallable()

public final UnaryCallable<DeleteEnvironmentRequest,Empty> deleteEnvironmentCallable()

Deletes the specified Environment.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 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();
 }

Returns

Type	Description
UnaryCallable<DeleteEnvironmentRequest,Empty>

deployFlowAsync(DeployFlowRequest request)

public final OperationFuture<DeployFlowResponse,DeployFlowMetadata> deployFlowAsync(DeployFlowRequest request)

Deploys a flow to the specified Environment.

This method is a long-running operation. The returned Operation type has the following method-specific fields:

- metadata: DeployFlowMetadata - response: DeployFlowResponse

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 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();
 }

Parameter

Name	Description
request	`DeployFlowRequest` The request object containing all of the parameters for the API call.

Returns

Type	Description
OperationFuture<DeployFlowResponse,DeployFlowMetadata>

deployFlowCallable()

public final UnaryCallable<DeployFlowRequest,Operation> deployFlowCallable()

Deploys a flow to the specified Environment.

This method is a long-running operation. The returned Operation type has the following method-specific fields:

- metadata: DeployFlowMetadata - response: DeployFlowResponse

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 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();
 }

Returns

Type	Description
UnaryCallable<DeployFlowRequest,Operation>

deployFlowOperationCallable()

public final OperationCallable<DeployFlowRequest,DeployFlowResponse,DeployFlowMetadata> deployFlowOperationCallable()

Deploys a flow to the specified Environment.

This method is a long-running operation. The returned Operation type has the following method-specific fields:

- metadata: DeployFlowMetadata - response: DeployFlowResponse

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 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();
 }

Returns

Type	Description
OperationCallable<DeployFlowRequest,DeployFlowResponse,DeployFlowMetadata>

getEnvironment(EnvironmentName name)

public final Environment getEnvironment(EnvironmentName name)

Retrieves the specified Environment.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (EnvironmentsClient environmentsClient = EnvironmentsClient.create()) {
   EnvironmentName name =
       EnvironmentName.of("[PROJECT]", "[LOCATION]", "[AGENT]", "[ENVIRONMENT]");
   Environment response = environmentsClient.getEnvironment(name);
 }

Parameter

Name	Description
name	`EnvironmentName` Required. The name of the Environment. Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/environments/<Environment ID>`.

Returns

Type	Description
Environment

getEnvironment(GetEnvironmentRequest request)

public final Environment getEnvironment(GetEnvironmentRequest request)

Retrieves the specified Environment.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (EnvironmentsClient environmentsClient = EnvironmentsClient.create()) {
   GetEnvironmentRequest request =
       GetEnvironmentRequest.newBuilder()
           .setName(
               EnvironmentName.of("[PROJECT]", "[LOCATION]", "[AGENT]", "[ENVIRONMENT]")
                   .toString())
           .build();
   Environment response = environmentsClient.getEnvironment(request);
 }

Parameter

Name	Description
request	`GetEnvironmentRequest` The request object containing all of the parameters for the API call.

Returns

Type	Description
Environment

getEnvironment(String name)

public final Environment getEnvironment(String name)

Retrieves the specified Environment.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (EnvironmentsClient environmentsClient = EnvironmentsClient.create()) {
   String name =
       EnvironmentName.of("[PROJECT]", "[LOCATION]", "[AGENT]", "[ENVIRONMENT]").toString();
   Environment response = environmentsClient.getEnvironment(name);
 }

Parameter

Name	Description
name	`String` Required. The name of the Environment. Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/environments/<Environment ID>`.

Returns

Type	Description
Environment

getEnvironmentCallable()

public final UnaryCallable<GetEnvironmentRequest,Environment> getEnvironmentCallable()

Retrieves the specified Environment.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 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();
 }

Returns

Type	Description
UnaryCallable<GetEnvironmentRequest,Environment>

getOperationsClient()

public final OperationsClient getOperationsClient()

Returns the OperationsClient that can be used to query the status of a long-running operation returned by another API method call.

Returns

Type	Description
OperationsClient

getSettings()

public final EnvironmentsSettings getSettings()

Returns

Type	Description
EnvironmentsSettings

getStub()

public EnvironmentsStub getStub()

Returns

Type	Description
EnvironmentsStub

isShutdown()

public boolean isShutdown()

Returns

Type	Description
boolean

isTerminated()

public boolean isTerminated()

Returns

Type	Description
boolean

listContinuousTestResults(EnvironmentName parent)

public final EnvironmentsClient.ListContinuousTestResultsPagedResponse listContinuousTestResults(EnvironmentName parent)

Fetches a list of continuous test results for a given environment.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (EnvironmentsClient environmentsClient = EnvironmentsClient.create()) {
   EnvironmentName parent =
       EnvironmentName.of("[PROJECT]", "[LOCATION]", "[AGENT]", "[ENVIRONMENT]");
   for (ContinuousTestResult element :
       environmentsClient.listContinuousTestResults(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }

Parameter

Name	Description
parent	`EnvironmentName` Required. The environment to list results for. Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/ environments/<Environment ID>`.

Returns

Type	Description
EnvironmentsClient.ListContinuousTestResultsPagedResponse

listContinuousTestResults(ListContinuousTestResultsRequest request)

public final EnvironmentsClient.ListContinuousTestResultsPagedResponse listContinuousTestResults(ListContinuousTestResultsRequest request)

Fetches a list of continuous test results for a given environment.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 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);
   }
 }

Parameter

Name	Description
request	`ListContinuousTestResultsRequest` The request object containing all of the parameters for the API call.

Returns

Type	Description
EnvironmentsClient.ListContinuousTestResultsPagedResponse

listContinuousTestResults(String parent)

public final EnvironmentsClient.ListContinuousTestResultsPagedResponse listContinuousTestResults(String parent)

Fetches a list of continuous test results for a given environment.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (EnvironmentsClient environmentsClient = EnvironmentsClient.create()) {
   String parent =
       EnvironmentName.of("[PROJECT]", "[LOCATION]", "[AGENT]", "[ENVIRONMENT]").toString();
   for (ContinuousTestResult element :
       environmentsClient.listContinuousTestResults(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }

Parameter

Name	Description
parent	`String` Required. The environment to list results for. Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/ environments/<Environment ID>`.

Returns

Type	Description
EnvironmentsClient.ListContinuousTestResultsPagedResponse

listContinuousTestResultsCallable()

public final UnaryCallable<ListContinuousTestResultsRequest,ListContinuousTestResultsResponse> listContinuousTestResultsCallable()

Fetches a list of continuous test results for a given environment.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 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.getResponsesList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }

Returns

Type	Description
UnaryCallable<ListContinuousTestResultsRequest,ListContinuousTestResultsResponse>

listContinuousTestResultsPagedCallable()

public final UnaryCallable<ListContinuousTestResultsRequest,EnvironmentsClient.ListContinuousTestResultsPagedResponse> listContinuousTestResultsPagedCallable()

Fetches a list of continuous test results for a given environment.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 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);
   }
 }

Returns

Type	Description
UnaryCallable<ListContinuousTestResultsRequest,ListContinuousTestResultsPagedResponse>

listEnvironments(AgentName parent)

public final EnvironmentsClient.ListEnvironmentsPagedResponse listEnvironments(AgentName parent)

Returns the list of all environments in the specified Agent.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (EnvironmentsClient environmentsClient = EnvironmentsClient.create()) {
   AgentName parent = AgentName.of("[PROJECT]", "[LOCATION]", "[AGENT]");
   for (Environment element : environmentsClient.listEnvironments(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }

Parameter

Name	Description
parent	`AgentName` Required. The Agent to list all environments for. Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>`.

Returns

Type	Description
EnvironmentsClient.ListEnvironmentsPagedResponse

listEnvironments(ListEnvironmentsRequest request)

public final EnvironmentsClient.ListEnvironmentsPagedResponse listEnvironments(ListEnvironmentsRequest request)

Returns the list of all environments in the specified Agent.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 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);
   }
 }

Parameter

Name	Description
request	`ListEnvironmentsRequest` The request object containing all of the parameters for the API call.

Returns

Type	Description
EnvironmentsClient.ListEnvironmentsPagedResponse

listEnvironments(String parent)

public final EnvironmentsClient.ListEnvironmentsPagedResponse listEnvironments(String parent)

Returns the list of all environments in the specified Agent.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (EnvironmentsClient environmentsClient = EnvironmentsClient.create()) {
   String parent = AgentName.of("[PROJECT]", "[LOCATION]", "[AGENT]").toString();
   for (Environment element : environmentsClient.listEnvironments(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }

Parameter

Name	Description
parent	`String` Required. The Agent to list all environments for. Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>`.

Returns

Type	Description
EnvironmentsClient.ListEnvironmentsPagedResponse

listEnvironmentsCallable()

public final UnaryCallable<ListEnvironmentsRequest,ListEnvironmentsResponse> listEnvironmentsCallable()

Returns the list of all environments in the specified Agent.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 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.getResponsesList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }

Returns

Type	Description
UnaryCallable<ListEnvironmentsRequest,ListEnvironmentsResponse>

listEnvironmentsPagedCallable()

public final UnaryCallable<ListEnvironmentsRequest,EnvironmentsClient.ListEnvironmentsPagedResponse> listEnvironmentsPagedCallable()

Returns the list of all environments in the specified Agent.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 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);
   }
 }

Returns

Type	Description
UnaryCallable<ListEnvironmentsRequest,ListEnvironmentsPagedResponse>

lookupEnvironmentHistory(EnvironmentName name)

public final EnvironmentsClient.LookupEnvironmentHistoryPagedResponse lookupEnvironmentHistory(EnvironmentName name)

Looks up the history of the specified Environment.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (EnvironmentsClient environmentsClient = EnvironmentsClient.create()) {
   EnvironmentName name =
       EnvironmentName.of("[PROJECT]", "[LOCATION]", "[AGENT]", "[ENVIRONMENT]");
   for (Environment element : environmentsClient.lookupEnvironmentHistory(name).iterateAll()) {
     // doThingsWith(element);
   }
 }

Parameter

Name	Description
name	`EnvironmentName` Required. Resource name of the environment to look up the history for. Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/environments/<Environment ID>`.

Returns

Type	Description
EnvironmentsClient.LookupEnvironmentHistoryPagedResponse

lookupEnvironmentHistory(LookupEnvironmentHistoryRequest request)

public final EnvironmentsClient.LookupEnvironmentHistoryPagedResponse lookupEnvironmentHistory(LookupEnvironmentHistoryRequest request)

Looks up the history of the specified Environment.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 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);
   }
 }

Parameter

Name	Description
request	`LookupEnvironmentHistoryRequest` The request object containing all of the parameters for the API call.

Returns

Type	Description
EnvironmentsClient.LookupEnvironmentHistoryPagedResponse

lookupEnvironmentHistory(String name)

public final EnvironmentsClient.LookupEnvironmentHistoryPagedResponse lookupEnvironmentHistory(String name)

Looks up the history of the specified Environment.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (EnvironmentsClient environmentsClient = EnvironmentsClient.create()) {
   String name =
       EnvironmentName.of("[PROJECT]", "[LOCATION]", "[AGENT]", "[ENVIRONMENT]").toString();
   for (Environment element : environmentsClient.lookupEnvironmentHistory(name).iterateAll()) {
     // doThingsWith(element);
   }
 }

Parameter

Name	Description
name	`String` Required. Resource name of the environment to look up the history for. Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/environments/<Environment ID>`.

Returns

Type	Description
EnvironmentsClient.LookupEnvironmentHistoryPagedResponse

lookupEnvironmentHistoryCallable()

public final UnaryCallable<LookupEnvironmentHistoryRequest,LookupEnvironmentHistoryResponse> lookupEnvironmentHistoryCallable()

Looks up the history of the specified Environment.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 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.getResponsesList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }

Returns

Type	Description
UnaryCallable<LookupEnvironmentHistoryRequest,LookupEnvironmentHistoryResponse>

lookupEnvironmentHistoryPagedCallable()

public final UnaryCallable<LookupEnvironmentHistoryRequest,EnvironmentsClient.LookupEnvironmentHistoryPagedResponse> lookupEnvironmentHistoryPagedCallable()

Looks up the history of the specified Environment.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 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);
   }
 }

Returns

Type	Description
UnaryCallable<LookupEnvironmentHistoryRequest,LookupEnvironmentHistoryPagedResponse>

runContinuousTestAsync(RunContinuousTestRequest request)

public final OperationFuture<RunContinuousTestResponse,RunContinuousTestMetadata> runContinuousTestAsync(RunContinuousTestRequest request)

Kicks off a continuous test under the specified Environment.

This method is a long-running operation. The returned Operation type has the following method-specific fields:

- metadata: RunContinuousTestMetadata - response: RunContinuousTestResponse

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (EnvironmentsClient environmentsClient = EnvironmentsClient.create()) {
   RunContinuousTestRequest request =
       RunContinuousTestRequest.newBuilder()
           .setEnvironment(
               EnvironmentName.of("[PROJECT]", "[LOCATION]", "[AGENT]", "[ENVIRONMENT]")
                   .toString())
           .build();
   RunContinuousTestResponse response = environmentsClient.runContinuousTestAsync(request).get();
 }

Parameter

Name	Description
request	`RunContinuousTestRequest` The request object containing all of the parameters for the API call.

Returns

Type	Description
OperationFuture<RunContinuousTestResponse,RunContinuousTestMetadata>

runContinuousTestCallable()

public final UnaryCallable<RunContinuousTestRequest,Operation> runContinuousTestCallable()

Kicks off a continuous test under the specified Environment.

This method is a long-running operation. The returned Operation type has the following method-specific fields:

- metadata: RunContinuousTestMetadata - response: RunContinuousTestResponse

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 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();
 }

Returns

Type	Description
UnaryCallable<RunContinuousTestRequest,Operation>

runContinuousTestOperationCallable()

public final OperationCallable<RunContinuousTestRequest,RunContinuousTestResponse,RunContinuousTestMetadata> runContinuousTestOperationCallable()

Kicks off a continuous test under the specified Environment.

This method is a long-running operation. The returned Operation type has the following method-specific fields:

- metadata: RunContinuousTestMetadata - response: RunContinuousTestResponse

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 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();
 }

Returns

Type	Description
OperationCallable<RunContinuousTestRequest,RunContinuousTestResponse,RunContinuousTestMetadata>

shutdown()

public void shutdown()

shutdownNow()

public void shutdownNow()

updateEnvironmentAsync(Environment environment, FieldMask updateMask)

public final OperationFuture<Environment,Struct> updateEnvironmentAsync(Environment environment, FieldMask updateMask)

Updates the specified Environment.

This method is a long-running operation. The returned Operation type has the following method-specific fields:

- metadata: An empty Struct message

response: Environment

Sample code:


// This snippet has been automatically generated for illustrative purposes only.
// It may require modifications to work in your environment.
try (EnvironmentsClient environmentsClient = EnvironmentsClient.create()) {
Environment environment = Environment.newBuilder().build();
FieldMask updateMask = FieldMask.newBuilder().build();
Environment response =
    environmentsClient.updateEnvironmentAsync(environment, updateMask).get();
}

Parameters

Name	Description
environment	`Environment` Required. The environment to update.
updateMask	`FieldMask` Required. The mask to control which fields get updated.

Returns

Type	Description
OperationFuture<Environment,Struct>

updateEnvironmentAsync(UpdateEnvironmentRequest request)

public final OperationFuture<Environment,Struct> updateEnvironmentAsync(UpdateEnvironmentRequest request)

Updates the specified Environment.

This method is a long-running operation. The returned Operation type has the following method-specific fields:

- metadata: An empty Struct message

response: Environment

Sample code:


// This snippet has been automatically generated for illustrative purposes only.
// It may require modifications to work in your environment.
try (EnvironmentsClient environmentsClient = EnvironmentsClient.create()) {
UpdateEnvironmentRequest request =
    UpdateEnvironmentRequest.newBuilder()
        .setEnvironment(Environment.newBuilder().build())
        .setUpdateMask(FieldMask.newBuilder().build())
        .build();
Environment response = environmentsClient.updateEnvironmentAsync(request).get();
}

Parameter

Name	Description
request	`UpdateEnvironmentRequest` The request object containing all of the parameters for the API call.

Returns

Type	Description
OperationFuture<Environment,Struct>

updateEnvironmentCallable()

public final UnaryCallable<UpdateEnvironmentRequest,Operation> updateEnvironmentCallable()

Updates the specified Environment.

This method is a long-running operation. The returned Operation type has the following method-specific fields:

- metadata: An empty Struct message

response: Environment

Sample code:


// This snippet has been automatically generated for illustrative purposes only.
// It may require modifications to work in your environment.
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();
}

Returns

Type	Description
UnaryCallable<UpdateEnvironmentRequest,Operation>

updateEnvironmentOperationCallable()

public final OperationCallable<UpdateEnvironmentRequest,Environment,Struct> updateEnvironmentOperationCallable()

Updates the specified Environment.

This method is a long-running operation. The returned Operation type has the following method-specific fields:

- metadata: An empty Struct message

response: Environment

Sample code:


// This snippet has been automatically generated for illustrative purposes only.
// It may require modifications to work in your environment.
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();
}

Returns

Type	Description
OperationCallable<UpdateEnvironmentRequest,Environment,Struct>