Interface PlaybooksGrpc.AsyncService (0.89.0) 

public static interface PlaybooksGrpc.AsyncService

Service for managing Playbooks.

Methods

createPlaybook(CreatePlaybookRequest request, StreamObserver<Playbook> responseObserver)

public default void createPlaybook(CreatePlaybookRequest request, StreamObserver<Playbook> responseObserver)

Creates a playbook in a specified agent.

Parameters
Name Description
request CreatePlaybookRequest
responseObserver io.grpc.stub.StreamObserver<Playbook>

createPlaybookVersion(CreatePlaybookVersionRequest request, StreamObserver<PlaybookVersion> responseObserver)

public default void createPlaybookVersion(CreatePlaybookVersionRequest request, StreamObserver<PlaybookVersion> responseObserver)

Creates a version for the specified Playbook.

Parameters
Name Description
request CreatePlaybookVersionRequest
responseObserver io.grpc.stub.StreamObserver<PlaybookVersion>

deletePlaybook(DeletePlaybookRequest request, StreamObserver<Empty> responseObserver)

public default void deletePlaybook(DeletePlaybookRequest request, StreamObserver<Empty> responseObserver)

Deletes a specified playbook.

Parameters
Name Description
request DeletePlaybookRequest
responseObserver io.grpc.stub.StreamObserver<Empty>

deletePlaybookVersion(DeletePlaybookVersionRequest request, StreamObserver<Empty> responseObserver)

public default void deletePlaybookVersion(DeletePlaybookVersionRequest request, StreamObserver<Empty> responseObserver)

Deletes the specified version of the Playbook.

Parameters
Name Description
request DeletePlaybookVersionRequest
responseObserver io.grpc.stub.StreamObserver<Empty>

exportPlaybook(ExportPlaybookRequest request, StreamObserver<Operation> responseObserver)

public default void exportPlaybook(ExportPlaybookRequest request, StreamObserver<Operation> responseObserver)

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

Parameters
Name Description
request ExportPlaybookRequest
responseObserver io.grpc.stub.StreamObserver<Operation>

getPlaybook(GetPlaybookRequest request, StreamObserver<Playbook> responseObserver)

public default void getPlaybook(GetPlaybookRequest request, StreamObserver<Playbook> responseObserver)

Retrieves the specified Playbook.

Parameters
Name Description
request GetPlaybookRequest
responseObserver io.grpc.stub.StreamObserver<Playbook>

getPlaybookVersion(GetPlaybookVersionRequest request, StreamObserver<PlaybookVersion> responseObserver)

public default void getPlaybookVersion(GetPlaybookVersionRequest request, StreamObserver<PlaybookVersion> responseObserver)

Retrieves the specified version of the Playbook.

Parameters
Name Description
request GetPlaybookVersionRequest
responseObserver io.grpc.stub.StreamObserver<PlaybookVersion>

importPlaybook(ImportPlaybookRequest request, StreamObserver<Operation> responseObserver)

public default void importPlaybook(ImportPlaybookRequest request, StreamObserver<Operation> responseObserver)

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

Parameters
Name Description
request ImportPlaybookRequest
responseObserver io.grpc.stub.StreamObserver<Operation>

listPlaybookVersions(ListPlaybookVersionsRequest request, StreamObserver<ListPlaybookVersionsResponse> responseObserver)

public default void listPlaybookVersions(ListPlaybookVersionsRequest request, StreamObserver<ListPlaybookVersionsResponse> responseObserver)

Lists versions for the specified Playbook.

Parameters
Name Description
request ListPlaybookVersionsRequest
responseObserver io.grpc.stub.StreamObserver<ListPlaybookVersionsResponse>

listPlaybooks(ListPlaybooksRequest request, StreamObserver<ListPlaybooksResponse> responseObserver)

public default void listPlaybooks(ListPlaybooksRequest request, StreamObserver<ListPlaybooksResponse> responseObserver)

Returns a list of playbooks in the specified agent.

Parameters
Name Description
request ListPlaybooksRequest
responseObserver io.grpc.stub.StreamObserver<ListPlaybooksResponse>

restorePlaybookVersion(RestorePlaybookVersionRequest request, StreamObserver<RestorePlaybookVersionResponse> responseObserver)

public default void restorePlaybookVersion(RestorePlaybookVersionRequest request, StreamObserver<RestorePlaybookVersionResponse> responseObserver)

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

Parameters
Name Description
request RestorePlaybookVersionRequest
responseObserver io.grpc.stub.StreamObserver<RestorePlaybookVersionResponse>

updatePlaybook(UpdatePlaybookRequest request, StreamObserver<Playbook> responseObserver)

public default void updatePlaybook(UpdatePlaybookRequest request, StreamObserver<Playbook> responseObserver)

Updates the specified Playbook.

Parameters
Name Description
request UpdatePlaybookRequest
responseObserver io.grpc.stub.StreamObserver<Playbook>