Class PlaybooksGrpc.PlaybooksFutureStub (0.89.0)

public static final class PlaybooksGrpc.PlaybooksFutureStub extends AbstractFutureStub<PlaybooksGrpc.PlaybooksFutureStub>

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

Service for managing Playbooks.

Inheritance

java.lang.Object > io.grpc.stub.AbstractStub > io.grpc.stub.AbstractFutureStub > PlaybooksGrpc.PlaybooksFutureStub

Methods

build(Channel channel, CallOptions callOptions)

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

createPlaybook(CreatePlaybookRequest request)

public ListenableFuture<Playbook> createPlaybook(CreatePlaybookRequest request)

Creates a playbook in a specified agent.

Parameter
Name Description
request CreatePlaybookRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<Playbook>

createPlaybookVersion(CreatePlaybookVersionRequest request)

public ListenableFuture<PlaybookVersion> createPlaybookVersion(CreatePlaybookVersionRequest request)

Creates a version for the specified Playbook.

Parameter
Name Description
request CreatePlaybookVersionRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<PlaybookVersion>

deletePlaybook(DeletePlaybookRequest request)

public ListenableFuture<Empty> deletePlaybook(DeletePlaybookRequest request)

Deletes a specified playbook.

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

deletePlaybookVersion(DeletePlaybookVersionRequest request)

public ListenableFuture<Empty> deletePlaybookVersion(DeletePlaybookVersionRequest request)

Deletes the specified version of the Playbook.

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

exportPlaybook(ExportPlaybookRequest request)

public ListenableFuture<Operation> exportPlaybook(ExportPlaybookRequest request)

Exports the specified playbook to a binary file. Note that resources (e.g. examples, tools) that the playbook references will also be exported.

Parameter
Name Description
request ExportPlaybookRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<Operation>

getPlaybook(GetPlaybookRequest request)

public ListenableFuture<Playbook> getPlaybook(GetPlaybookRequest request)

Retrieves the specified Playbook.

Parameter
Name Description
request GetPlaybookRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<Playbook>

getPlaybookVersion(GetPlaybookVersionRequest request)

public ListenableFuture<PlaybookVersion> getPlaybookVersion(GetPlaybookVersionRequest request)

Retrieves the specified version of the Playbook.

Parameter
Name Description
request GetPlaybookVersionRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<PlaybookVersion>

importPlaybook(ImportPlaybookRequest request)

public ListenableFuture<Operation> importPlaybook(ImportPlaybookRequest request)

Imports the specified playbook to the specified agent from a binary file.

Parameter
Name Description
request ImportPlaybookRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<Operation>

listPlaybookVersions(ListPlaybookVersionsRequest request)

public ListenableFuture<ListPlaybookVersionsResponse> listPlaybookVersions(ListPlaybookVersionsRequest request)

Lists versions for the specified Playbook.

Parameter
Name Description
request ListPlaybookVersionsRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<ListPlaybookVersionsResponse>

listPlaybooks(ListPlaybooksRequest request)

public ListenableFuture<ListPlaybooksResponse> listPlaybooks(ListPlaybooksRequest request)

Returns a list of playbooks in the specified agent.

Parameter
Name Description
request ListPlaybooksRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<ListPlaybooksResponse>

restorePlaybookVersion(RestorePlaybookVersionRequest request)

public ListenableFuture<RestorePlaybookVersionResponse> restorePlaybookVersion(RestorePlaybookVersionRequest request)

Retrieves the specified version of the Playbook and stores it as the current playbook draft, returning the playbook with resources updated.

Parameter
Name Description
request RestorePlaybookVersionRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<RestorePlaybookVersionResponse>

updatePlaybook(UpdatePlaybookRequest request)

public ListenableFuture<Playbook> updatePlaybook(UpdatePlaybookRequest request)

Updates the specified Playbook.

Parameter
Name Description
request UpdatePlaybookRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<Playbook>