public class Playbooks.PlaybooksClient : ClientBase<Playbooks.PlaybooksClient>Reference documentation and code samples for the Dialogflow v3 API class Playbooks.PlaybooksClient.
Client for Playbooks
Namespace
Google.Cloud.Dialogflow.Cx.V3Assembly
Google.Cloud.Dialogflow.Cx.V3.dll
Constructors
PlaybooksClient()
protected PlaybooksClient()Protected parameterless constructor to allow creation of test doubles.
PlaybooksClient(CallInvoker)
public PlaybooksClient(CallInvoker callInvoker)Creates a new client for Playbooks that uses a custom CallInvoker.
| Parameter | |
|---|---|
| Name | Description |
callInvoker |
CallInvokerThe callInvoker to use to make remote calls. |
PlaybooksClient(ChannelBase)
public PlaybooksClient(ChannelBase channel)Creates a new client for Playbooks
| Parameter | |
|---|---|
| Name | Description |
channel |
ChannelBaseThe channel to use to make remote calls. |
PlaybooksClient(ClientBaseConfiguration)
protected PlaybooksClient(ClientBase.ClientBaseConfiguration configuration)Protected constructor to allow creation of configured clients.
| Parameter | |
|---|---|
| Name | Description |
configuration |
ClientBaseClientBaseConfigurationThe client configuration. |
Methods
CreateLocationsClient()
public virtual Locations.LocationsClient CreateLocationsClient()Creates a new instance of Locations.LocationsClient using the same call invoker as this client.
| Returns | |
|---|---|
| Type | Description |
LocationsLocationsClient |
A new Locations.LocationsClient for the same target as this client. |
CreateOperationsClient()
public virtual Operations.OperationsClient CreateOperationsClient()Creates a new instance of Operations.OperationsClient using the same call invoker as this client.
| Returns | |
|---|---|
| Type | Description |
OperationsOperationsClient |
A new Operations client for the same target as this client. |
CreatePlaybook(CreatePlaybookRequest, CallOptions)
public virtual Playbook CreatePlaybook(CreatePlaybookRequest request, CallOptions options)Creates a playbook in a specified agent.
| Parameters | |
|---|---|
| Name | Description |
request |
CreatePlaybookRequestThe request to send to the server. |
options |
CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
Playbook |
The response received from the server. |
CreatePlaybook(CreatePlaybookRequest, Metadata, DateTime?, CancellationToken)
public virtual Playbook CreatePlaybook(CreatePlaybookRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)Creates a playbook in a specified agent.
| Parameters | |
|---|---|
| Name | Description |
request |
CreatePlaybookRequestThe request to send to the server. |
headers |
MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline |
System.DateTimeAn optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationTokenAn optional token for canceling the call. |
| Returns | |
|---|---|
| Type | Description |
Playbook |
The response received from the server. |
CreatePlaybookAsync(CreatePlaybookRequest, CallOptions)
public virtual AsyncUnaryCall<Playbook> CreatePlaybookAsync(CreatePlaybookRequest request, CallOptions options)Creates a playbook in a specified agent.
| Parameters | |
|---|---|
| Name | Description |
request |
CreatePlaybookRequestThe request to send to the server. |
options |
CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCallPlaybook |
The call object. |
CreatePlaybookAsync(CreatePlaybookRequest, Metadata, DateTime?, CancellationToken)
public virtual AsyncUnaryCall<Playbook> CreatePlaybookAsync(CreatePlaybookRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)Creates a playbook in a specified agent.
| Parameters | |
|---|---|
| Name | Description |
request |
CreatePlaybookRequestThe request to send to the server. |
headers |
MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline |
System.DateTimeAn optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationTokenAn optional token for canceling the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCallPlaybook |
The call object. |
CreatePlaybookVersion(CreatePlaybookVersionRequest, CallOptions)
public virtual PlaybookVersion CreatePlaybookVersion(CreatePlaybookVersionRequest request, CallOptions options)Creates a version for the specified Playbook.
| Parameters | |
|---|---|
| Name | Description |
request |
CreatePlaybookVersionRequestThe request to send to the server. |
options |
CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
PlaybookVersion |
The response received from the server. |
CreatePlaybookVersion(CreatePlaybookVersionRequest, Metadata, DateTime?, CancellationToken)
public virtual PlaybookVersion CreatePlaybookVersion(CreatePlaybookVersionRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)Creates a version for the specified Playbook.
| Parameters | |
|---|---|
| Name | Description |
request |
CreatePlaybookVersionRequestThe request to send to the server. |
headers |
MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline |
System.DateTimeAn optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationTokenAn optional token for canceling the call. |
| Returns | |
|---|---|
| Type | Description |
PlaybookVersion |
The response received from the server. |
CreatePlaybookVersionAsync(CreatePlaybookVersionRequest, CallOptions)
public virtual AsyncUnaryCall<PlaybookVersion> CreatePlaybookVersionAsync(CreatePlaybookVersionRequest request, CallOptions options)Creates a version for the specified Playbook.
| Parameters | |
|---|---|
| Name | Description |
request |
CreatePlaybookVersionRequestThe request to send to the server. |
options |
CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCallPlaybookVersion |
The call object. |
CreatePlaybookVersionAsync(CreatePlaybookVersionRequest, Metadata, DateTime?, CancellationToken)
public virtual AsyncUnaryCall<PlaybookVersion> CreatePlaybookVersionAsync(CreatePlaybookVersionRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)Creates a version for the specified Playbook.
| Parameters | |
|---|---|
| Name | Description |
request |
CreatePlaybookVersionRequestThe request to send to the server. |
headers |
MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline |
System.DateTimeAn optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationTokenAn optional token for canceling the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCallPlaybookVersion |
The call object. |
DeletePlaybook(DeletePlaybookRequest, CallOptions)
public virtual Empty DeletePlaybook(DeletePlaybookRequest request, CallOptions options)Deletes a specified playbook.
| Parameters | |
|---|---|
| Name | Description |
request |
DeletePlaybookRequestThe request to send to the server. |
options |
CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
Empty |
The response received from the server. |
DeletePlaybook(DeletePlaybookRequest, Metadata, DateTime?, CancellationToken)
public virtual Empty DeletePlaybook(DeletePlaybookRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)Deletes a specified playbook.
| Parameters | |
|---|---|
| Name | Description |
request |
DeletePlaybookRequestThe request to send to the server. |
headers |
MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline |
System.DateTimeAn optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationTokenAn optional token for canceling the call. |
| Returns | |
|---|---|
| Type | Description |
Empty |
The response received from the server. |
DeletePlaybookAsync(DeletePlaybookRequest, CallOptions)
public virtual AsyncUnaryCall<Empty> DeletePlaybookAsync(DeletePlaybookRequest request, CallOptions options)Deletes a specified playbook.
| Parameters | |
|---|---|
| Name | Description |
request |
DeletePlaybookRequestThe request to send to the server. |
options |
CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCallEmpty |
The call object. |
DeletePlaybookAsync(DeletePlaybookRequest, Metadata, DateTime?, CancellationToken)
public virtual AsyncUnaryCall<Empty> DeletePlaybookAsync(DeletePlaybookRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)Deletes a specified playbook.
| Parameters | |
|---|---|
| Name | Description |
request |
DeletePlaybookRequestThe request to send to the server. |
headers |
MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline |
System.DateTimeAn optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationTokenAn optional token for canceling the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCallEmpty |
The call object. |
DeletePlaybookVersion(DeletePlaybookVersionRequest, CallOptions)
public virtual Empty DeletePlaybookVersion(DeletePlaybookVersionRequest request, CallOptions options)Deletes the specified version of the Playbook.
| Parameters | |
|---|---|
| Name | Description |
request |
DeletePlaybookVersionRequestThe request to send to the server. |
options |
CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
Empty |
The response received from the server. |
DeletePlaybookVersion(DeletePlaybookVersionRequest, Metadata, DateTime?, CancellationToken)
public virtual Empty DeletePlaybookVersion(DeletePlaybookVersionRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)Deletes the specified version of the Playbook.
| Parameters | |
|---|---|
| Name | Description |
request |
DeletePlaybookVersionRequestThe request to send to the server. |
headers |
MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline |
System.DateTimeAn optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationTokenAn optional token for canceling the call. |
| Returns | |
|---|---|
| Type | Description |
Empty |
The response received from the server. |
DeletePlaybookVersionAsync(DeletePlaybookVersionRequest, CallOptions)
public virtual AsyncUnaryCall<Empty> DeletePlaybookVersionAsync(DeletePlaybookVersionRequest request, CallOptions options)Deletes the specified version of the Playbook.
| Parameters | |
|---|---|
| Name | Description |
request |
DeletePlaybookVersionRequestThe request to send to the server. |
options |
CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCallEmpty |
The call object. |
DeletePlaybookVersionAsync(DeletePlaybookVersionRequest, Metadata, DateTime?, CancellationToken)
public virtual AsyncUnaryCall<Empty> DeletePlaybookVersionAsync(DeletePlaybookVersionRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)Deletes the specified version of the Playbook.
| Parameters | |
|---|---|
| Name | Description |
request |
DeletePlaybookVersionRequestThe request to send to the server. |
headers |
MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline |
System.DateTimeAn optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationTokenAn optional token for canceling the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCallEmpty |
The call object. |
ExportPlaybook(ExportPlaybookRequest, CallOptions)
public virtual Operation ExportPlaybook(ExportPlaybookRequest request, CallOptions options)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 |
ExportPlaybookRequestThe request to send to the server. |
options |
CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
Operation |
The response received from the server. |
ExportPlaybook(ExportPlaybookRequest, Metadata, DateTime?, CancellationToken)
public virtual Operation ExportPlaybook(ExportPlaybookRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)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 |
ExportPlaybookRequestThe request to send to the server. |
headers |
MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline |
System.DateTimeAn optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationTokenAn optional token for canceling the call. |
| Returns | |
|---|---|
| Type | Description |
Operation |
The response received from the server. |
ExportPlaybookAsync(ExportPlaybookRequest, CallOptions)
public virtual AsyncUnaryCall<Operation> ExportPlaybookAsync(ExportPlaybookRequest request, CallOptions options)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 |
ExportPlaybookRequestThe request to send to the server. |
options |
CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCallOperation |
The call object. |
ExportPlaybookAsync(ExportPlaybookRequest, Metadata, DateTime?, CancellationToken)
public virtual AsyncUnaryCall<Operation> ExportPlaybookAsync(ExportPlaybookRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)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 |
ExportPlaybookRequestThe request to send to the server. |
headers |
MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline |
System.DateTimeAn optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationTokenAn optional token for canceling the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCallOperation |
The call object. |
GetPlaybook(GetPlaybookRequest, CallOptions)
public virtual Playbook GetPlaybook(GetPlaybookRequest request, CallOptions options)Retrieves the specified Playbook.
| Parameters | |
|---|---|
| Name | Description |
request |
GetPlaybookRequestThe request to send to the server. |
options |
CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
Playbook |
The response received from the server. |
GetPlaybook(GetPlaybookRequest, Metadata, DateTime?, CancellationToken)
public virtual Playbook GetPlaybook(GetPlaybookRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)Retrieves the specified Playbook.
| Parameters | |
|---|---|
| Name | Description |
request |
GetPlaybookRequestThe request to send to the server. |
headers |
MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline |
System.DateTimeAn optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationTokenAn optional token for canceling the call. |
| Returns | |
|---|---|
| Type | Description |
Playbook |
The response received from the server. |
GetPlaybookAsync(GetPlaybookRequest, CallOptions)
public virtual AsyncUnaryCall<Playbook> GetPlaybookAsync(GetPlaybookRequest request, CallOptions options)Retrieves the specified Playbook.
| Parameters | |
|---|---|
| Name | Description |
request |
GetPlaybookRequestThe request to send to the server. |
options |
CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCallPlaybook |
The call object. |
GetPlaybookAsync(GetPlaybookRequest, Metadata, DateTime?, CancellationToken)
public virtual AsyncUnaryCall<Playbook> GetPlaybookAsync(GetPlaybookRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)Retrieves the specified Playbook.
| Parameters | |
|---|---|
| Name | Description |
request |
GetPlaybookRequestThe request to send to the server. |
headers |
MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline |
System.DateTimeAn optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationTokenAn optional token for canceling the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCallPlaybook |
The call object. |
GetPlaybookVersion(GetPlaybookVersionRequest, CallOptions)
public virtual PlaybookVersion GetPlaybookVersion(GetPlaybookVersionRequest request, CallOptions options)Retrieves the specified version of the Playbook.
| Parameters | |
|---|---|
| Name | Description |
request |
GetPlaybookVersionRequestThe request to send to the server. |
options |
CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
PlaybookVersion |
The response received from the server. |
GetPlaybookVersion(GetPlaybookVersionRequest, Metadata, DateTime?, CancellationToken)
public virtual PlaybookVersion GetPlaybookVersion(GetPlaybookVersionRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)Retrieves the specified version of the Playbook.
| Parameters | |
|---|---|
| Name | Description |
request |
GetPlaybookVersionRequestThe request to send to the server. |
headers |
MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline |
System.DateTimeAn optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationTokenAn optional token for canceling the call. |
| Returns | |
|---|---|
| Type | Description |
PlaybookVersion |
The response received from the server. |
GetPlaybookVersionAsync(GetPlaybookVersionRequest, CallOptions)
public virtual AsyncUnaryCall<PlaybookVersion> GetPlaybookVersionAsync(GetPlaybookVersionRequest request, CallOptions options)Retrieves the specified version of the Playbook.
| Parameters | |
|---|---|
| Name | Description |
request |
GetPlaybookVersionRequestThe request to send to the server. |
options |
CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCallPlaybookVersion |
The call object. |
GetPlaybookVersionAsync(GetPlaybookVersionRequest, Metadata, DateTime?, CancellationToken)
public virtual AsyncUnaryCall<PlaybookVersion> GetPlaybookVersionAsync(GetPlaybookVersionRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)Retrieves the specified version of the Playbook.
| Parameters | |
|---|---|
| Name | Description |
request |
GetPlaybookVersionRequestThe request to send to the server. |
headers |
MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline |
System.DateTimeAn optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationTokenAn optional token for canceling the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCallPlaybookVersion |
The call object. |
ImportPlaybook(ImportPlaybookRequest, CallOptions)
public virtual Operation ImportPlaybook(ImportPlaybookRequest request, CallOptions options)Imports the specified playbook to the specified agent from a binary file.
| Parameters | |
|---|---|
| Name | Description |
request |
ImportPlaybookRequestThe request to send to the server. |
options |
CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
Operation |
The response received from the server. |
ImportPlaybook(ImportPlaybookRequest, Metadata, DateTime?, CancellationToken)
public virtual Operation ImportPlaybook(ImportPlaybookRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)Imports the specified playbook to the specified agent from a binary file.
| Parameters | |
|---|---|
| Name | Description |
request |
ImportPlaybookRequestThe request to send to the server. |
headers |
MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline |
System.DateTimeAn optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationTokenAn optional token for canceling the call. |
| Returns | |
|---|---|
| Type | Description |
Operation |
The response received from the server. |
ImportPlaybookAsync(ImportPlaybookRequest, CallOptions)
public virtual AsyncUnaryCall<Operation> ImportPlaybookAsync(ImportPlaybookRequest request, CallOptions options)Imports the specified playbook to the specified agent from a binary file.
| Parameters | |
|---|---|
| Name | Description |
request |
ImportPlaybookRequestThe request to send to the server. |
options |
CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCallOperation |
The call object. |
ImportPlaybookAsync(ImportPlaybookRequest, Metadata, DateTime?, CancellationToken)
public virtual AsyncUnaryCall<Operation> ImportPlaybookAsync(ImportPlaybookRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)Imports the specified playbook to the specified agent from a binary file.
| Parameters | |
|---|---|
| Name | Description |
request |
ImportPlaybookRequestThe request to send to the server. |
headers |
MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline |
System.DateTimeAn optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationTokenAn optional token for canceling the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCallOperation |
The call object. |
ListPlaybookVersions(ListPlaybookVersionsRequest, CallOptions)
public virtual ListPlaybookVersionsResponse ListPlaybookVersions(ListPlaybookVersionsRequest request, CallOptions options)Lists versions for the specified Playbook.
| Parameters | |
|---|---|
| Name | Description |
request |
ListPlaybookVersionsRequestThe request to send to the server. |
options |
CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
ListPlaybookVersionsResponse |
The response received from the server. |
ListPlaybookVersions(ListPlaybookVersionsRequest, Metadata, DateTime?, CancellationToken)
public virtual ListPlaybookVersionsResponse ListPlaybookVersions(ListPlaybookVersionsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)Lists versions for the specified Playbook.
| Parameters | |
|---|---|
| Name | Description |
request |
ListPlaybookVersionsRequestThe request to send to the server. |
headers |
MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline |
System.DateTimeAn optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationTokenAn optional token for canceling the call. |
| Returns | |
|---|---|
| Type | Description |
ListPlaybookVersionsResponse |
The response received from the server. |
ListPlaybookVersionsAsync(ListPlaybookVersionsRequest, CallOptions)
public virtual AsyncUnaryCall<ListPlaybookVersionsResponse> ListPlaybookVersionsAsync(ListPlaybookVersionsRequest request, CallOptions options)Lists versions for the specified Playbook.
| Parameters | |
|---|---|
| Name | Description |
request |
ListPlaybookVersionsRequestThe request to send to the server. |
options |
CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCallListPlaybookVersionsResponse |
The call object. |
ListPlaybookVersionsAsync(ListPlaybookVersionsRequest, Metadata, DateTime?, CancellationToken)
public virtual AsyncUnaryCall<ListPlaybookVersionsResponse> ListPlaybookVersionsAsync(ListPlaybookVersionsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)Lists versions for the specified Playbook.
| Parameters | |
|---|---|
| Name | Description |
request |
ListPlaybookVersionsRequestThe request to send to the server. |
headers |
MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline |
System.DateTimeAn optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationTokenAn optional token for canceling the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCallListPlaybookVersionsResponse |
The call object. |
ListPlaybooks(ListPlaybooksRequest, CallOptions)
public virtual ListPlaybooksResponse ListPlaybooks(ListPlaybooksRequest request, CallOptions options)Returns a list of playbooks in the specified agent.
| Parameters | |
|---|---|
| Name | Description |
request |
ListPlaybooksRequestThe request to send to the server. |
options |
CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
ListPlaybooksResponse |
The response received from the server. |
ListPlaybooks(ListPlaybooksRequest, Metadata, DateTime?, CancellationToken)
public virtual ListPlaybooksResponse ListPlaybooks(ListPlaybooksRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)Returns a list of playbooks in the specified agent.
| Parameters | |
|---|---|
| Name | Description |
request |
ListPlaybooksRequestThe request to send to the server. |
headers |
MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline |
System.DateTimeAn optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationTokenAn optional token for canceling the call. |
| Returns | |
|---|---|
| Type | Description |
ListPlaybooksResponse |
The response received from the server. |
ListPlaybooksAsync(ListPlaybooksRequest, CallOptions)
public virtual AsyncUnaryCall<ListPlaybooksResponse> ListPlaybooksAsync(ListPlaybooksRequest request, CallOptions options)Returns a list of playbooks in the specified agent.
| Parameters | |
|---|---|
| Name | Description |
request |
ListPlaybooksRequestThe request to send to the server. |
options |
CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCallListPlaybooksResponse |
The call object. |
ListPlaybooksAsync(ListPlaybooksRequest, Metadata, DateTime?, CancellationToken)
public virtual AsyncUnaryCall<ListPlaybooksResponse> ListPlaybooksAsync(ListPlaybooksRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)Returns a list of playbooks in the specified agent.
| Parameters | |
|---|---|
| Name | Description |
request |
ListPlaybooksRequestThe request to send to the server. |
headers |
MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline |
System.DateTimeAn optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationTokenAn optional token for canceling the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCallListPlaybooksResponse |
The call object. |
NewInstance(ClientBaseConfiguration)
protected override Playbooks.PlaybooksClient NewInstance(ClientBase.ClientBaseConfiguration configuration)Creates a new instance of client from given ClientBaseConfiguration.
| Parameter | |
|---|---|
| Name | Description |
configuration |
ClientBaseClientBaseConfiguration |
| Returns | |
|---|---|
| Type | Description |
PlaybooksPlaybooksClient |
|
RestorePlaybookVersion(RestorePlaybookVersionRequest, CallOptions)
public virtual RestorePlaybookVersionResponse RestorePlaybookVersion(RestorePlaybookVersionRequest request, CallOptions options)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 |
RestorePlaybookVersionRequestThe request to send to the server. |
options |
CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
RestorePlaybookVersionResponse |
The response received from the server. |
RestorePlaybookVersion(RestorePlaybookVersionRequest, Metadata, DateTime?, CancellationToken)
public virtual RestorePlaybookVersionResponse RestorePlaybookVersion(RestorePlaybookVersionRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)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 |
RestorePlaybookVersionRequestThe request to send to the server. |
headers |
MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline |
System.DateTimeAn optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationTokenAn optional token for canceling the call. |
| Returns | |
|---|---|
| Type | Description |
RestorePlaybookVersionResponse |
The response received from the server. |
RestorePlaybookVersionAsync(RestorePlaybookVersionRequest, CallOptions)
public virtual AsyncUnaryCall<RestorePlaybookVersionResponse> RestorePlaybookVersionAsync(RestorePlaybookVersionRequest request, CallOptions options)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 |
RestorePlaybookVersionRequestThe request to send to the server. |
options |
CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCallRestorePlaybookVersionResponse |
The call object. |
RestorePlaybookVersionAsync(RestorePlaybookVersionRequest, Metadata, DateTime?, CancellationToken)
public virtual AsyncUnaryCall<RestorePlaybookVersionResponse> RestorePlaybookVersionAsync(RestorePlaybookVersionRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)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 |
RestorePlaybookVersionRequestThe request to send to the server. |
headers |
MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline |
System.DateTimeAn optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationTokenAn optional token for canceling the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCallRestorePlaybookVersionResponse |
The call object. |
UpdatePlaybook(UpdatePlaybookRequest, CallOptions)
public virtual Playbook UpdatePlaybook(UpdatePlaybookRequest request, CallOptions options)Updates the specified Playbook.
| Parameters | |
|---|---|
| Name | Description |
request |
UpdatePlaybookRequestThe request to send to the server. |
options |
CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
Playbook |
The response received from the server. |
UpdatePlaybook(UpdatePlaybookRequest, Metadata, DateTime?, CancellationToken)
public virtual Playbook UpdatePlaybook(UpdatePlaybookRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)Updates the specified Playbook.
| Parameters | |
|---|---|
| Name | Description |
request |
UpdatePlaybookRequestThe request to send to the server. |
headers |
MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline |
System.DateTimeAn optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationTokenAn optional token for canceling the call. |
| Returns | |
|---|---|
| Type | Description |
Playbook |
The response received from the server. |
UpdatePlaybookAsync(UpdatePlaybookRequest, CallOptions)
public virtual AsyncUnaryCall<Playbook> UpdatePlaybookAsync(UpdatePlaybookRequest request, CallOptions options)Updates the specified Playbook.
| Parameters | |
|---|---|
| Name | Description |
request |
UpdatePlaybookRequestThe request to send to the server. |
options |
CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCallPlaybook |
The call object. |
UpdatePlaybookAsync(UpdatePlaybookRequest, Metadata, DateTime?, CancellationToken)
public virtual AsyncUnaryCall<Playbook> UpdatePlaybookAsync(UpdatePlaybookRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)Updates the specified Playbook.
| Parameters | |
|---|---|
| Name | Description |
request |
UpdatePlaybookRequestThe request to send to the server. |
headers |
MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline |
System.DateTimeAn optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationTokenAn optional token for canceling the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCallPlaybook |
The call object. |