Class EnvironmentsGrpc.EnvironmentsBlockingStub (4.61.0)

public static final class EnvironmentsGrpc.EnvironmentsBlockingStub extends AbstractBlockingStub<EnvironmentsGrpc.EnvironmentsBlockingStub>

A stub to allow clients to do synchronous rpc calls to service Environments.

Service for managing Environments.

Inheritance

java.lang.Object > io.grpc.stub.AbstractStub > io.grpc.stub.AbstractBlockingStub > EnvironmentsGrpc.EnvironmentsBlockingStub

Inherited Members

io.grpc.stub.AbstractBlockingStub.<T>newStub(io.grpc.stub.AbstractStub.StubFactory<T>,io.grpc.Channel)

io.grpc.stub.AbstractBlockingStub.<T>newStub(io.grpc.stub.AbstractStub.StubFactory<T>,io.grpc.Channel,io.grpc.CallOptions)

io.grpc.stub.AbstractStub.<T>withOption(io.grpc.CallOptions.Key<T>,T)

io.grpc.stub.AbstractStub.build(io.grpc.Channel,io.grpc.CallOptions)

io.grpc.stub.AbstractStub.getCallOptions()

io.grpc.stub.AbstractStub.getChannel()

io.grpc.stub.AbstractStub.withCallCredentials(io.grpc.CallCredentials)

io.grpc.stub.AbstractStub.withChannel(io.grpc.Channel)

io.grpc.stub.AbstractStub.withCompression(java.lang.String)

io.grpc.stub.AbstractStub.withDeadline(io.grpc.Deadline)

io.grpc.stub.AbstractStub.withDeadlineAfter(java.time.Duration)

io.grpc.stub.AbstractStub.withDeadlineAfter(long,java.util.concurrent.TimeUnit)

io.grpc.stub.AbstractStub.withExecutor(java.util.concurrent.Executor)

io.grpc.stub.AbstractStub.withInterceptors(io.grpc.ClientInterceptor...)

io.grpc.stub.AbstractStub.withMaxInboundMessageSize(int)

io.grpc.stub.AbstractStub.withMaxOutboundMessageSize(int)

io.grpc.stub.AbstractStub.withOnReadyThreshold(int)

io.grpc.stub.AbstractStub.withWaitForReady()

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)

Methods

build(Channel channel, CallOptions callOptions)

protected EnvironmentsGrpc.EnvironmentsBlockingStub build(Channel channel, CallOptions callOptions)

Parameters
Name	Description
`channel`	`io.grpc.Channel`
`callOptions`	`io.grpc.CallOptions`

Returns
Type	Description
`EnvironmentsGrpc.EnvironmentsBlockingStub`

Overrides

io.grpc.stub.AbstractStub.build(io.grpc.Channel,io.grpc.CallOptions)

createEnvironment(CreateEnvironmentRequest request)

public Environment createEnvironment(CreateEnvironmentRequest request)

Creates an agent environment.

Parameter
Name	Description
`request`	`CreateEnvironmentRequest`

Returns
Type	Description
`Environment`

deleteEnvironment(DeleteEnvironmentRequest request)

public Empty deleteEnvironment(DeleteEnvironmentRequest request)

Deletes the specified agent environment.

Parameter
Name	Description
`request`	`DeleteEnvironmentRequest`

Returns
Type	Description
`Empty`

getEnvironment(GetEnvironmentRequest request)

public Environment getEnvironment(GetEnvironmentRequest request)

Retrieves the specified agent environment.

Parameter
Name	Description
`request`	`GetEnvironmentRequest`

Returns
Type	Description
`Environment`

getEnvironmentHistory(GetEnvironmentHistoryRequest request)

public EnvironmentHistory getEnvironmentHistory(GetEnvironmentHistoryRequest request)

Gets the history of the specified environment.

Parameter
Name	Description
`request`	`GetEnvironmentHistoryRequest`

Returns
Type	Description
`EnvironmentHistory`

listEnvironments(ListEnvironmentsRequest request)

public ListEnvironmentsResponse listEnvironments(ListEnvironmentsRequest request)

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

Parameter
Name	Description
`request`	`ListEnvironmentsRequest`

Returns
Type	Description
`ListEnvironmentsResponse`

updateEnvironment(UpdateEnvironmentRequest request)

public 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
`Environment`