Class EnvironmentsGrpc.EnvironmentsFutureStub (4.48.0)

public static final class EnvironmentsGrpc.EnvironmentsFutureStub extends AbstractFutureStub<EnvironmentsGrpc.EnvironmentsFutureStub>

A stub to allow clients to do ListenableFuture-style rpc calls to service Environments.

Service for managing Environments.

Inheritance

java.lang.Object > io.grpc.stub.AbstractStub > io.grpc.stub.AbstractFutureStub > EnvironmentsGrpc.EnvironmentsFutureStub

Methods

build(Channel channel, CallOptions callOptions)

protected EnvironmentsGrpc.EnvironmentsFutureStub build(Channel channel, CallOptions callOptions)
Parameters
Name Description
channel io.grpc.Channel
callOptions io.grpc.CallOptions
Returns
Type Description
EnvironmentsGrpc.EnvironmentsFutureStub
Overrides
io.grpc.stub.AbstractStub.build(io.grpc.Channel,io.grpc.CallOptions)

createEnvironment(CreateEnvironmentRequest request)

public ListenableFuture<Environment> createEnvironment(CreateEnvironmentRequest request)

Creates an agent environment.

Parameter
Name Description
request CreateEnvironmentRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<Environment>

deleteEnvironment(DeleteEnvironmentRequest request)

public ListenableFuture<Empty> deleteEnvironment(DeleteEnvironmentRequest request)

Deletes the specified agent environment.

Parameter
Name Description
request DeleteEnvironmentRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<Empty>

getEnvironment(GetEnvironmentRequest request)

public ListenableFuture<Environment> getEnvironment(GetEnvironmentRequest request)

Retrieves the specified agent environment.

Parameter
Name Description
request GetEnvironmentRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<Environment>

getEnvironmentHistory(GetEnvironmentHistoryRequest request)

public ListenableFuture<EnvironmentHistory> getEnvironmentHistory(GetEnvironmentHistoryRequest request)

Gets the history of the specified environment.

Parameter
Name Description
request GetEnvironmentHistoryRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<EnvironmentHistory>

listEnvironments(ListEnvironmentsRequest request)

public ListenableFuture<ListEnvironmentsResponse> listEnvironments(ListEnvironmentsRequest request)

Returns the list of all non-draft environments of the specified agent.

Parameter
Name Description
request ListEnvironmentsRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<ListEnvironmentsResponse>

updateEnvironment(UpdateEnvironmentRequest request)

public ListenableFuture<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.

Parameter
Name Description
request UpdateEnvironmentRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<Environment>