- 0.58.0 (latest)
- 0.57.0
- 0.56.0
- 0.55.0
- 0.54.0
- 0.53.0
- 0.52.0
- 0.51.0
- 0.50.0
- 0.48.0
- 0.47.0
- 0.46.0
- 0.45.0
- 0.44.0
- 0.43.0
- 0.42.0
- 0.41.0
- 0.40.0
- 0.39.0
- 0.38.0
- 0.35.0
- 0.34.0
- 0.33.0
- 0.32.0
- 0.31.0
- 0.30.0
- 0.29.0
- 0.28.0
- 0.27.0
- 0.26.0
- 0.25.0
- 0.24.0
- 0.23.0
- 0.22.0
- 0.20.0
- 0.19.0
- 0.18.0
- 0.17.0
- 0.16.0
- 0.15.0
- 0.14.7
- 0.13.1
- 0.12.1
- 0.11.5
public class 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 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().
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 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.newBuilder()
.setTransportChannelProvider(
EnvironmentsSettings.defaultHttpJsonTransportProviderBuilder().build())
.build();
EnvironmentsClient environmentsClient = EnvironmentsClient.create(environmentsSettings);
Please refer to the GitHub repository's samples for more quickstart code snippets.
Implements
BackgroundResourceStatic Methods
create()
public static final EnvironmentsClient create()
Constructs an instance of EnvironmentsClient with default settings.
Type | Description |
EnvironmentsClient |
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.
Name | Description |
settings | EnvironmentsSettings |
Type | Description |
EnvironmentsClient |
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).
Name | Description |
stub | EnvironmentsStub |
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.
Name | Description |
settings | EnvironmentsSettings |
EnvironmentsClient(EnvironmentsStub stub)
protected EnvironmentsClient(EnvironmentsStub stub)
Name | Description |
stub | EnvironmentsStub |
Methods
awaitTermination(long duration, TimeUnit unit)
public boolean awaitTermination(long duration, TimeUnit unit)
Name | Description |
duration | long |
unit | TimeUnit |
Type | Description |
boolean |
Type | Description |
InterruptedException |
close()
public final void close()
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
: EnvironmentSample 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(); }
Name | Description |
parent | AgentName Required. The Agent to create an
Environment for. Format:
|
environment | Environment Required. The environment to create. |
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
: EnvironmentSample 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(); }
Name | Description |
request | CreateEnvironmentRequest The request object containing all of the parameters for the API call. |
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
: EnvironmentSample 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(); }
Name | Description |
parent | String Required. The Agent to create an
Environment for. Format:
|
environment | Environment Required. The environment to create. |
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
: EnvironmentSample 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(); }
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
: EnvironmentSample 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(); }
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 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);
}
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 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 | Description |
name | EnvironmentName Required. The name of the
Environment to delete. Format:
|
deleteEnvironment(String name)
public final void deleteEnvironment(String name)
Deletes the specified 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 name =
EnvironmentName.of("[PROJECT]", "[LOCATION]", "[AGENT]", "[ENVIRONMENT]").toString();
environmentsClient.deleteEnvironment(name);
}
Name | Description |
name | String Required. The name of the
Environment to delete. Format:
|
deleteEnvironmentCallable()
public final UnaryCallable<DeleteEnvironmentRequest,Empty> deleteEnvironmentCallable()
Deletes the specified 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()) {
DeleteEnvironmentRequest request =
DeleteEnvironmentRequest.newBuilder()
.setName(
EnvironmentName.of("[PROJECT]", "[LOCATION]", "[AGENT]", "[ENVIRONMENT]")
.toString())
.build();
ApiFuture<Empty> future = environmentsClient.deleteEnvironmentCallable().futureCall(request);
// Do something.
future.get();
}
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 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();
}
Name | Description |
request | DeployFlowRequest The request object containing all of the parameters for the API call. |
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 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();
}
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 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();
}
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 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 | Description |
name | EnvironmentName Required. The name of the
Environment. Format:
|
Type | Description |
Environment |
getEnvironment(GetEnvironmentRequest request)
public final Environment getEnvironment(GetEnvironmentRequest request)
Retrieves the specified 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()) {
GetEnvironmentRequest request =
GetEnvironmentRequest.newBuilder()
.setName(
EnvironmentName.of("[PROJECT]", "[LOCATION]", "[AGENT]", "[ENVIRONMENT]")
.toString())
.build();
Environment response = environmentsClient.getEnvironment(request);
}
Name | Description |
request | GetEnvironmentRequest The request object containing all of the parameters for the API call. |
Type | Description |
Environment |
getEnvironment(String name)
public final Environment getEnvironment(String name)
Retrieves the specified 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 name =
EnvironmentName.of("[PROJECT]", "[LOCATION]", "[AGENT]", "[ENVIRONMENT]").toString();
Environment response = environmentsClient.getEnvironment(name);
}
Name | Description |
name | String Required. The name of the
Environment. Format:
|
Type | Description |
Environment |
getEnvironmentCallable()
public final UnaryCallable<GetEnvironmentRequest,Environment> getEnvironmentCallable()
Retrieves the specified 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()) {
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();
}
Type | Description |
UnaryCallable<GetEnvironmentRequest,Environment> |
getHttpJsonOperationsClient()
public final OperationsClient getHttpJsonOperationsClient()
Returns the OperationsClient that can be used to query the status of a long-running operation returned by another API method call.
Type | Description |
OperationsClient |
getLocation(GetLocationRequest request)
public final Location getLocation(GetLocationRequest request)
Gets information about a location.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (EnvironmentsClient environmentsClient = EnvironmentsClient.create()) {
GetLocationRequest request = GetLocationRequest.newBuilder().setName("name3373707").build();
Location response = environmentsClient.getLocation(request);
}
Name | Description |
request | com.google.cloud.location.GetLocationRequest The request object containing all of the parameters for the API call. |
Type | Description |
com.google.cloud.location.Location |
getLocationCallable()
public final UnaryCallable<GetLocationRequest,Location> getLocationCallable()
Gets information about a location.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (EnvironmentsClient environmentsClient = EnvironmentsClient.create()) {
GetLocationRequest request = GetLocationRequest.newBuilder().setName("name3373707").build();
ApiFuture<Location> future = environmentsClient.getLocationCallable().futureCall(request);
// Do something.
Location response = future.get();
}
Type | Description |
UnaryCallable<com.google.cloud.location.GetLocationRequest,com.google.cloud.location.Location> |
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.
Type | Description |
OperationsClient |
getSettings()
public final EnvironmentsSettings getSettings()
Type | Description |
EnvironmentsSettings |
getStub()
public EnvironmentsStub getStub()
Type | Description |
EnvironmentsStub |
isShutdown()
public boolean isShutdown()
Type | Description |
boolean |
isTerminated()
public boolean isTerminated()
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 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);
}
}
Name | Description |
parent | EnvironmentName Required. The environment to list results for. Format: |
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 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);
}
}
Name | Description |
request | ListContinuousTestResultsRequest The request object containing all of the parameters for the API call. |
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 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);
}
}
Name | Description |
parent | String Required. The environment to list results for. Format: |
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 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;
}
}
}
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 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);
}
}
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 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);
}
}
Name | Description |
parent | AgentName Required. The Agent to list all
environments for. Format: |
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 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);
}
}
Name | Description |
request | ListEnvironmentsRequest The request object containing all of the parameters for the API call. |
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 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);
}
}
Name | Description |
parent | String Required. The Agent to list all
environments for. Format: |
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 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;
}
}
}
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 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);
}
}
Type | Description |
UnaryCallable<ListEnvironmentsRequest,ListEnvironmentsPagedResponse> |
listLocations(ListLocationsRequest request)
public final EnvironmentsClient.ListLocationsPagedResponse listLocations(ListLocationsRequest request)
Lists information about the supported locations for this service.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (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);
}
}
Name | Description |
request | com.google.cloud.location.ListLocationsRequest The request object containing all of the parameters for the API call. |
Type | Description |
EnvironmentsClient.ListLocationsPagedResponse |
listLocationsCallable()
public final UnaryCallable<ListLocationsRequest,ListLocationsResponse> listLocationsCallable()
Lists information about the supported locations for this service.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (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;
}
}
}
Type | Description |
UnaryCallable<com.google.cloud.location.ListLocationsRequest,com.google.cloud.location.ListLocationsResponse> |
listLocationsPagedCallable()
public final UnaryCallable<ListLocationsRequest,EnvironmentsClient.ListLocationsPagedResponse> listLocationsPagedCallable()
Lists information about the supported locations for this service.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (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);
}
}
Type | Description |
UnaryCallable<com.google.cloud.location.ListLocationsRequest,ListLocationsPagedResponse> |
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 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 | Description |
name | EnvironmentName Required. Resource name of the environment to look up the history for. Format:
|
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 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);
}
}
Name | Description |
request | LookupEnvironmentHistoryRequest The request object containing all of the parameters for the API call. |
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 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 | Description |
name | String Required. Resource name of the environment to look up the history for. Format:
|
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 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;
}
}
}
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 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);
}
}
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 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();
}
Name | Description |
request | RunContinuousTestRequest The request object containing all of the parameters for the API call. |
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 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();
}
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 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();
}
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
: EnvironmentSample 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(); }
Name | Description |
environment | Environment Required. The environment to update. |
updateMask | FieldMask Required. The mask to control which fields get updated. |
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
: EnvironmentSample 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(); }
Name | Description |
request | UpdateEnvironmentRequest The request object containing all of the parameters for the API call. |
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
: EnvironmentSample 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(); }
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
: EnvironmentSample 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(); }
Type | Description |
OperationCallable<UpdateEnvironmentRequest,Environment,Struct> |