public static final class PlaybooksGrpc.PlaybooksBlockingV2Stub extends AbstractBlockingStub<PlaybooksGrpc.PlaybooksBlockingV2Stub>A stub to allow clients to do synchronous rpc calls to service Playbooks.
Service for managing Playbooks.
Inheritance
java.lang.Object > io.grpc.stub.AbstractStub > io.grpc.stub.AbstractBlockingStub > PlaybooksGrpc.PlaybooksBlockingV2StubMethods
build(Channel channel, CallOptions callOptions)
protected PlaybooksGrpc.PlaybooksBlockingV2Stub build(Channel channel, CallOptions callOptions)| Parameters | |
|---|---|
| Name | Description |
channel |
io.grpc.Channel |
callOptions |
io.grpc.CallOptions |
| Returns | |
|---|---|
| Type | Description |
PlaybooksGrpc.PlaybooksBlockingV2Stub |
|
createPlaybook(CreatePlaybookRequest request)
public Playbook createPlaybook(CreatePlaybookRequest request)Creates a playbook in a specified agent.
| Parameter | |
|---|---|
| Name | Description |
request |
CreatePlaybookRequest |
| Returns | |
|---|---|
| Type | Description |
Playbook |
|
| Exceptions | |
|---|---|
| Type | Description |
io.grpc.StatusException |
|
createPlaybookVersion(CreatePlaybookVersionRequest request)
public PlaybookVersion createPlaybookVersion(CreatePlaybookVersionRequest request)Creates a version for the specified Playbook.
| Parameter | |
|---|---|
| Name | Description |
request |
CreatePlaybookVersionRequest |
| Returns | |
|---|---|
| Type | Description |
PlaybookVersion |
|
| Exceptions | |
|---|---|
| Type | Description |
io.grpc.StatusException |
|
deletePlaybook(DeletePlaybookRequest request)
public Empty deletePlaybook(DeletePlaybookRequest request)Deletes a specified playbook.
| Parameter | |
|---|---|
| Name | Description |
request |
DeletePlaybookRequest |
| Returns | |
|---|---|
| Type | Description |
Empty |
|
| Exceptions | |
|---|---|
| Type | Description |
io.grpc.StatusException |
|
deletePlaybookVersion(DeletePlaybookVersionRequest request)
public Empty deletePlaybookVersion(DeletePlaybookVersionRequest request)Deletes the specified version of the Playbook.
| Parameter | |
|---|---|
| Name | Description |
request |
DeletePlaybookVersionRequest |
| Returns | |
|---|---|
| Type | Description |
Empty |
|
| Exceptions | |
|---|---|
| Type | Description |
io.grpc.StatusException |
|
exportPlaybook(ExportPlaybookRequest request)
public 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 |
Operation |
|
| Exceptions | |
|---|---|
| Type | Description |
io.grpc.StatusException |
|
getPlaybook(GetPlaybookRequest request)
public Playbook getPlaybook(GetPlaybookRequest request)Retrieves the specified Playbook.
| Parameter | |
|---|---|
| Name | Description |
request |
GetPlaybookRequest |
| Returns | |
|---|---|
| Type | Description |
Playbook |
|
| Exceptions | |
|---|---|
| Type | Description |
io.grpc.StatusException |
|
getPlaybookVersion(GetPlaybookVersionRequest request)
public PlaybookVersion getPlaybookVersion(GetPlaybookVersionRequest request)Retrieves the specified version of the Playbook.
| Parameter | |
|---|---|
| Name | Description |
request |
GetPlaybookVersionRequest |
| Returns | |
|---|---|
| Type | Description |
PlaybookVersion |
|
| Exceptions | |
|---|---|
| Type | Description |
io.grpc.StatusException |
|
importPlaybook(ImportPlaybookRequest request)
public Operation importPlaybook(ImportPlaybookRequest request)Imports the specified playbook to the specified agent from a binary file.
| Parameter | |
|---|---|
| Name | Description |
request |
ImportPlaybookRequest |
| Returns | |
|---|---|
| Type | Description |
Operation |
|
| Exceptions | |
|---|---|
| Type | Description |
io.grpc.StatusException |
|
listPlaybookVersions(ListPlaybookVersionsRequest request)
public ListPlaybookVersionsResponse listPlaybookVersions(ListPlaybookVersionsRequest request)Lists versions for the specified Playbook.
| Parameter | |
|---|---|
| Name | Description |
request |
ListPlaybookVersionsRequest |
| Returns | |
|---|---|
| Type | Description |
ListPlaybookVersionsResponse |
|
| Exceptions | |
|---|---|
| Type | Description |
io.grpc.StatusException |
|
listPlaybooks(ListPlaybooksRequest request)
public ListPlaybooksResponse listPlaybooks(ListPlaybooksRequest request)Returns a list of playbooks in the specified agent.
| Parameter | |
|---|---|
| Name | Description |
request |
ListPlaybooksRequest |
| Returns | |
|---|---|
| Type | Description |
ListPlaybooksResponse |
|
| Exceptions | |
|---|---|
| Type | Description |
io.grpc.StatusException |
|
restorePlaybookVersion(RestorePlaybookVersionRequest request)
public 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 |
RestorePlaybookVersionResponse |
|
| Exceptions | |
|---|---|
| Type | Description |
io.grpc.StatusException |
|
updatePlaybook(UpdatePlaybookRequest request)
public Playbook updatePlaybook(UpdatePlaybookRequest request)Updates the specified Playbook.
| Parameter | |
|---|---|
| Name | Description |
request |
UpdatePlaybookRequest |
| Returns | |
|---|---|
| Type | Description |
Playbook |
|
| Exceptions | |
|---|---|
| Type | Description |
io.grpc.StatusException |
|