Interface PlaybooksGrpc.AsyncService (0.98.0)

0.98.0 (latest) 0.96.0 0.94.0 0.93.0 0.92.0 0.91.0 0.89.0 0.87.0 0.86.0 0.85.0 0.84.0 0.83.0 0.81.0 0.79.0 0.78.0 0.75.0 0.74.0 0.73.0 0.71.0 0.70.0 0.69.0 0.68.0 0.67.0 0.66.0 0.65.0 0.64.0 0.63.0 0.62.0 0.60.0 0.59.0 0.58.0 0.57.0 0.56.0 0.55.0 0.54.0 0.53.0 0.52.0 0.51.0 0.50.0 0.48.0 0.47.0 0.46.0 0.45.0 0.44.0 0.43.0 0.42.0 0.41.0 0.40.0 0.39.0 0.38.0 0.35.0 0.34.0 0.33.0 0.32.0 0.31.0 0.30.0 0.29.0 0.28.0 0.27.0 0.26.0 0.25.0 0.24.0 0.23.0 0.22.0 0.20.0 0.19.0 0.18.0 0.17.0 0.16.0 0.15.0 0.14.7 0.13.1 0.12.1 0.11.5

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>