- 4.53.0 (latest)
- 4.52.0
- 4.51.0
- 4.50.0
- 4.49.0
- 4.48.0
- 4.47.0
- 4.46.0
- 4.45.0
- 4.43.0
- 4.42.0
- 4.41.0
- 4.40.0
- 4.39.0
- 4.38.0
- 4.37.0
- 4.36.0
- 4.35.0
- 4.34.0
- 4.33.0
- 4.30.0
- 4.29.0
- 4.28.0
- 4.27.0
- 4.26.0
- 4.25.0
- 4.24.0
- 4.23.0
- 4.22.0
- 4.21.0
- 4.20.0
- 4.19.0
- 4.18.0
- 4.17.0
- 4.15.0
- 4.14.0
- 4.13.0
- 4.12.0
- 4.11.0
- 4.10.0
- 4.9.1
- 4.8.6
- 4.7.5
- 4.6.0
- 4.5.11
- 4.4.0
- 4.3.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:
try (EnvironmentsClient environmentsClient = EnvironmentsClient.create()) {
GetEnvironmentRequest request =
GetEnvironmentRequest.newBuilder()
.setName(
EnvironmentName.ofProjectEnvironmentName("[PROJECT]", "[ENVIRONMENT]").toString())
.build();
Environment response = environmentsClient.getEnvironment(request);
}
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:
EnvironmentsSettings environmentsSettings =
EnvironmentsSettings.newBuilder()
.setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
.build();
EnvironmentsClient environmentsClient = EnvironmentsClient.create(environmentsSettings);
To customize the endpoint:
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.
Implements
BackgroundResourceConstructors
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()
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 |
createEnvironment(CreateEnvironmentRequest request)
public final Environment createEnvironment(CreateEnvironmentRequest request)
Creates an agent environment.
Sample code:
try (EnvironmentsClient environmentsClient = EnvironmentsClient.create()) {
CreateEnvironmentRequest request =
CreateEnvironmentRequest.newBuilder()
.setParent(AgentName.ofProjectName("[PROJECT]").toString())
.setEnvironment(Environment.newBuilder().build())
.setEnvironmentId("environmentId-950205810")
.build();
Environment response = environmentsClient.createEnvironment(request);
}
Name | Description |
request | CreateEnvironmentRequest The request object containing all of the parameters for the API call. |
Type | Description |
Environment |
createEnvironmentCallable()
public final UnaryCallable<CreateEnvironmentRequest,Environment> createEnvironmentCallable()
Creates an agent environment.
Sample code:
try (EnvironmentsClient environmentsClient = EnvironmentsClient.create()) {
CreateEnvironmentRequest request =
CreateEnvironmentRequest.newBuilder()
.setParent(AgentName.ofProjectName("[PROJECT]").toString())
.setEnvironment(Environment.newBuilder().build())
.setEnvironmentId("environmentId-950205810")
.build();
ApiFuture
Type | Description |
UnaryCallable<CreateEnvironmentRequest,Environment> |
deleteEnvironment(DeleteEnvironmentRequest request)
public final void deleteEnvironment(DeleteEnvironmentRequest request)
Deletes the specified agent environment.
Sample code:
try (EnvironmentsClient environmentsClient = EnvironmentsClient.create()) {
DeleteEnvironmentRequest request =
DeleteEnvironmentRequest.newBuilder()
.setName(
EnvironmentName.ofProjectEnvironmentName("[PROJECT]", "[ENVIRONMENT]").toString())
.build();
environmentsClient.deleteEnvironment(request);
}
Name | Description |
request | DeleteEnvironmentRequest The request object containing all of the parameters for the API call. |
deleteEnvironmentCallable()
public final UnaryCallable<DeleteEnvironmentRequest,Empty> deleteEnvironmentCallable()
Deletes the specified agent environment.
Sample code:
try (EnvironmentsClient environmentsClient = EnvironmentsClient.create()) {
DeleteEnvironmentRequest request =
DeleteEnvironmentRequest.newBuilder()
.setName(
EnvironmentName.ofProjectEnvironmentName("[PROJECT]", "[ENVIRONMENT]").toString())
.build();
ApiFuture
Type | Description |
UnaryCallable<DeleteEnvironmentRequest,Empty> |
getEnvironment(GetEnvironmentRequest request)
public final Environment getEnvironment(GetEnvironmentRequest request)
Retrieves the specified agent environment.
Sample code:
try (EnvironmentsClient environmentsClient = EnvironmentsClient.create()) {
GetEnvironmentRequest request =
GetEnvironmentRequest.newBuilder()
.setName(
EnvironmentName.ofProjectEnvironmentName("[PROJECT]", "[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 |
getEnvironmentCallable()
public final UnaryCallable<GetEnvironmentRequest,Environment> getEnvironmentCallable()
Retrieves the specified agent environment.
Sample code:
try (EnvironmentsClient environmentsClient = EnvironmentsClient.create()) {
GetEnvironmentRequest request =
GetEnvironmentRequest.newBuilder()
.setName(
EnvironmentName.ofProjectEnvironmentName("[PROJECT]", "[ENVIRONMENT]").toString())
.build();
ApiFuture
Type | Description |
UnaryCallable<GetEnvironmentRequest,Environment> |
getEnvironmentHistory(GetEnvironmentHistoryRequest request)
public final EnvironmentsClient.GetEnvironmentHistoryPagedResponse getEnvironmentHistory(GetEnvironmentHistoryRequest request)
Gets the history of the specified environment.
Sample code:
try (EnvironmentsClient environmentsClient = EnvironmentsClient.create()) {
GetEnvironmentHistoryRequest request =
GetEnvironmentHistoryRequest.newBuilder()
.setParent(
EnvironmentName.ofProjectEnvironmentName("[PROJECT]", "[ENVIRONMENT]").toString())
.setPageSize(883849137)
.setPageToken("pageToken873572522")
.build();
for (EnvironmentHistory.Entry element :
environmentsClient.getEnvironmentHistory(request).iterateAll()) {
// doThingsWith(element);
}
}
Name | Description |
request | GetEnvironmentHistoryRequest The request object containing all of the parameters for the API call. |
Type | Description |
EnvironmentsClient.GetEnvironmentHistoryPagedResponse |
getEnvironmentHistoryCallable()
public final UnaryCallable<GetEnvironmentHistoryRequest,EnvironmentHistory> getEnvironmentHistoryCallable()
Gets the history of the specified environment.
Sample code:
try (EnvironmentsClient environmentsClient = EnvironmentsClient.create()) {
GetEnvironmentHistoryRequest request =
GetEnvironmentHistoryRequest.newBuilder()
.setParent(
EnvironmentName.ofProjectEnvironmentName("[PROJECT]", "[ENVIRONMENT]").toString())
.setPageSize(883849137)
.setPageToken("pageToken873572522")
.build();
while (true) {
EnvironmentHistory response =
environmentsClient.getEnvironmentHistoryCallable().call(request);
for (EnvironmentHistory.Entry element : response.getResponsesList()) {
// doThingsWith(element);
}
String nextPageToken = response.getNextPageToken();
if (!Strings.isNullOrEmpty(nextPageToken)) {
request = request.toBuilder().setPageToken(nextPageToken).build();
} else {
break;
}
}
}
Type | Description |
UnaryCallable<GetEnvironmentHistoryRequest,EnvironmentHistory> |
getEnvironmentHistoryPagedCallable()
public final UnaryCallable<GetEnvironmentHistoryRequest,EnvironmentsClient.GetEnvironmentHistoryPagedResponse> getEnvironmentHistoryPagedCallable()
Gets the history of the specified environment.
Sample code:
try (EnvironmentsClient environmentsClient = EnvironmentsClient.create()) {
GetEnvironmentHistoryRequest request =
GetEnvironmentHistoryRequest.newBuilder()
.setParent(
EnvironmentName.ofProjectEnvironmentName("[PROJECT]", "[ENVIRONMENT]").toString())
.setPageSize(883849137)
.setPageToken("pageToken873572522")
.build();
ApiFuture
Type | Description |
UnaryCallable<GetEnvironmentHistoryRequest,GetEnvironmentHistoryPagedResponse> |
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 |
listEnvironments(AgentName parent)
public final EnvironmentsClient.ListEnvironmentsPagedResponse listEnvironments(AgentName parent)
Returns the list of all non-draft environments of the specified agent.
Sample code:
try (EnvironmentsClient environmentsClient = EnvironmentsClient.create()) {
AgentName parent = AgentName.ofProjectName("[PROJECT]");
for (Environment element : environmentsClient.listEnvironments(parent).iterateAll()) {
// doThingsWith(element);
}
}
Name | Description |
parent | AgentName Required. The agent to list all environments from. Format: -
|
Type | Description |
EnvironmentsClient.ListEnvironmentsPagedResponse |
listEnvironments(ListEnvironmentsRequest request)
public final EnvironmentsClient.ListEnvironmentsPagedResponse listEnvironments(ListEnvironmentsRequest request)
Returns the list of all non-draft environments of the specified agent.
Sample code:
try (EnvironmentsClient environmentsClient = EnvironmentsClient.create()) {
ListEnvironmentsRequest request =
ListEnvironmentsRequest.newBuilder()
.setParent(AgentName.ofProjectName("[PROJECT]").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 non-draft environments of the specified agent.
Sample code:
try (EnvironmentsClient environmentsClient = EnvironmentsClient.create()) {
String parent = AgentName.ofProjectName("[PROJECT]").toString();
for (Environment element : environmentsClient.listEnvironments(parent).iterateAll()) {
// doThingsWith(element);
}
}
Name | Description |
parent | String Required. The agent to list all environments from. Format: -
|
Type | Description |
EnvironmentsClient.ListEnvironmentsPagedResponse |
listEnvironmentsCallable()
public final UnaryCallable<ListEnvironmentsRequest,ListEnvironmentsResponse> listEnvironmentsCallable()
Returns the list of all non-draft environments of the specified agent.
Sample code:
try (EnvironmentsClient environmentsClient = EnvironmentsClient.create()) {
ListEnvironmentsRequest request =
ListEnvironmentsRequest.newBuilder()
.setParent(AgentName.ofProjectName("[PROJECT]").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;
}
}
}
Type | Description |
UnaryCallable<ListEnvironmentsRequest,ListEnvironmentsResponse> |
listEnvironmentsPagedCallable()
public final UnaryCallable<ListEnvironmentsRequest,EnvironmentsClient.ListEnvironmentsPagedResponse> listEnvironmentsPagedCallable()
Returns the list of all non-draft environments of the specified agent.
Sample code:
try (EnvironmentsClient environmentsClient = EnvironmentsClient.create()) {
ListEnvironmentsRequest request =
ListEnvironmentsRequest.newBuilder()
.setParent(AgentName.ofProjectName("[PROJECT]").toString())
.setPageSize(883849137)
.setPageToken("pageToken873572522")
.build();
ApiFuture
Type | Description |
UnaryCallable<ListEnvironmentsRequest,ListEnvironmentsPagedResponse> |
shutdown()
public void shutdown()
shutdownNow()
public void shutdownNow()
updateEnvironment(UpdateEnvironmentRequest request)
public final Environment updateEnvironment(UpdateEnvironmentRequest request)
Updates the specified agent environment.
This method allows you to deploy new agent versions into the environment. When an
environment is pointed to a new agent version by setting environment.agent_version
, the
environment is temporarily set to the LOADING
state. During that time, the environment keeps
on serving the previous version of the agent. After the new agent version is done loading, the
environment is set back to the RUNNING
state. You can use "-" as Environment ID in
environment name to update version in "draft" environment. WARNING: this will negate all recent
changes to draft and can't be undone. You may want to save the draft to a version before
calling this function.
Sample code:
try (EnvironmentsClient environmentsClient = EnvironmentsClient.create()) {
UpdateEnvironmentRequest request =
UpdateEnvironmentRequest.newBuilder()
.setEnvironment(Environment.newBuilder().build())
.setUpdateMask(FieldMask.newBuilder().build())
.setAllowLoadToDraftAndDiscardChanges(true)
.build();
Environment response = environmentsClient.updateEnvironment(request);
}
Name | Description |
request | UpdateEnvironmentRequest The request object containing all of the parameters for the API call. |
Type | Description |
Environment |
updateEnvironmentCallable()
public final UnaryCallable<UpdateEnvironmentRequest,Environment> updateEnvironmentCallable()
Updates the specified agent environment.
This method allows you to deploy new agent versions into the environment. When an
environment is pointed to a new agent version by setting environment.agent_version
, the
environment is temporarily set to the LOADING
state. During that time, the environment keeps
on serving the previous version of the agent. After the new agent version is done loading, the
environment is set back to the RUNNING
state. You can use "-" as Environment ID in
environment name to update version in "draft" environment. WARNING: this will negate all recent
changes to draft and can't be undone. You may want to save the draft to a version before
calling this function.
Sample code:
try (EnvironmentsClient environmentsClient = EnvironmentsClient.create()) {
UpdateEnvironmentRequest request =
UpdateEnvironmentRequest.newBuilder()
.setEnvironment(Environment.newBuilder().build())
.setUpdateMask(FieldMask.newBuilder().build())
.setAllowLoadToDraftAndDiscardChanges(true)
.build();
ApiFuture
Type | Description |
UnaryCallable<UpdateEnvironmentRequest,Environment> |