Dialogflow v3 API - Class PlaybooksClient (3.0.0)

public abstract class PlaybooksClient

Reference documentation and code samples for the Dialogflow v3 API class PlaybooksClient.

Playbooks client wrapper, for convenient use.

Inheritance

object > PlaybooksClient

Inherited Members

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ToString()

Derived Types

PlaybooksClientImpl

Namespace

Google.Cloud.Dialogflow.Cx.V3

Assembly

Google.Cloud.Dialogflow.Cx.V3.dll

Remarks

Service for managing [Playbooks][google.cloud.dialogflow.cx.v3.Playbook].

Properties

DefaultEndpoint

public static string DefaultEndpoint { get; }

The default endpoint for the Playbooks service, which is a host of "dialogflow.googleapis.com" and a port of 443.

Property Value
Type	Description
`string`

DefaultScopes

public static IReadOnlyList<string> DefaultScopes { get; }

The default Playbooks scopes.

Property Value
Type	Description
`IReadOnlyListstring`

Remarks

The default Playbooks scopes are:

ExportPlaybookOperationsClient

public virtual OperationsClient ExportPlaybookOperationsClient { get; }

The long-running operations client for ExportPlaybook.

Property Value
Type	Description
`OperationsClient`

GrpcClient

public virtual Playbooks.PlaybooksClient GrpcClient { get; }

The underlying gRPC Playbooks client

Property Value
Type	Description
`PlaybooksPlaybooksClient`

ImportPlaybookOperationsClient

public virtual OperationsClient ImportPlaybookOperationsClient { get; }

The long-running operations client for ImportPlaybook.

Property Value
Type	Description
`OperationsClient`

LocationsClient

public virtual LocationsClient LocationsClient { get; }

The LocationsClient associated with this client.

Property Value
Type	Description
`LocationsClient`

ServiceMetadata

public static ServiceMetadata ServiceMetadata { get; }

The service metadata associated with this client type.

Property Value
Type	Description
`ServiceMetadata`

Methods

Create()

public static PlaybooksClient Create()

Synchronously creates a PlaybooksClient using the default credentials, endpoint and settings. To specify custom credentials or other settings, use PlaybooksClientBuilder.

Returns
Type	Description
`PlaybooksClient`	The created PlaybooksClient.

CreateAsync(CancellationToken)

public static Task<PlaybooksClient> CreateAsync(CancellationToken cancellationToken = default)

Asynchronously creates a PlaybooksClient using the default credentials, endpoint and settings. To specify custom credentials or other settings, use PlaybooksClientBuilder.

Parameter
Name	Description
`cancellationToken`	`CancellationToken` The CancellationToken to use while creating the client.

Returns
Type	Description
`TaskPlaybooksClient`	The task representing the created PlaybooksClient.

CreatePlaybook(AgentName, Playbook, CallSettings)

public virtual Playbook CreatePlaybook(AgentName parent, Playbook playbook, CallSettings callSettings = null)

Creates a playbook in a specified agent.

Parameters
Name	Description
`parent`	`AgentName` Required. The agent to create a playbook for. Format: `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>`.
`playbook`	`Playbook` Required. The playbook to create.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`Playbook`	The RPC response.

Example

// Create client
PlaybooksClient playbooksClient = PlaybooksClient.Create();
// Initialize request argument(s)
AgentName parent = AgentName.FromProjectLocationAgent("[PROJECT]", "[LOCATION]", "[AGENT]");
Playbook playbook = new Playbook();
// Make the request
Playbook response = playbooksClient.CreatePlaybook(parent, playbook);

CreatePlaybook(CreatePlaybookRequest, CallSettings)

public virtual Playbook CreatePlaybook(CreatePlaybookRequest request, CallSettings callSettings = null)

Creates a playbook in a specified agent.

Parameters
Name	Description
`request`	`CreatePlaybookRequest` The request object containing all of the parameters for the API call.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`Playbook`	The RPC response.

Example

// Create client
PlaybooksClient playbooksClient = PlaybooksClient.Create();
// Initialize request argument(s)
CreatePlaybookRequest request = new CreatePlaybookRequest
{
    ParentAsAgentName = AgentName.FromProjectLocationAgent("[PROJECT]", "[LOCATION]", "[AGENT]"),
    Playbook = new Playbook(),
};
// Make the request
Playbook response = playbooksClient.CreatePlaybook(request);

CreatePlaybook(string, Playbook, CallSettings)

public virtual Playbook CreatePlaybook(string parent, Playbook playbook, CallSettings callSettings = null)

Creates a playbook in a specified agent.

Parameters
Name	Description
`parent`	`string` Required. The agent to create a playbook for. Format: `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>`.
`playbook`	`Playbook` Required. The playbook to create.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`Playbook`	The RPC response.

Example

// Create client
PlaybooksClient playbooksClient = PlaybooksClient.Create();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]/agents/[AGENT]";
Playbook playbook = new Playbook();
// Make the request
Playbook response = playbooksClient.CreatePlaybook(parent, playbook);

CreatePlaybookAsync(AgentName, Playbook, CallSettings)

public virtual Task<Playbook> CreatePlaybookAsync(AgentName parent, Playbook playbook, CallSettings callSettings = null)

Creates a playbook in a specified agent.

Parameters
Name	Description
`parent`	`AgentName` Required. The agent to create a playbook for. Format: `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>`.
`playbook`	`Playbook` Required. The playbook to create.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`TaskPlaybook`	A Task containing the RPC response.

Example

// Create client
PlaybooksClient playbooksClient = await PlaybooksClient.CreateAsync();
// Initialize request argument(s)
AgentName parent = AgentName.FromProjectLocationAgent("[PROJECT]", "[LOCATION]", "[AGENT]");
Playbook playbook = new Playbook();
// Make the request
Playbook response = await playbooksClient.CreatePlaybookAsync(parent, playbook);

CreatePlaybookAsync(AgentName, Playbook, CancellationToken)

public virtual Task<Playbook> CreatePlaybookAsync(AgentName parent, Playbook playbook, CancellationToken cancellationToken)

Creates a playbook in a specified agent.

Parameters
Name	Description
`parent`	`AgentName` Required. The agent to create a playbook for. Format: `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>`.
`playbook`	`Playbook` Required. The playbook to create.
`cancellationToken`	`CancellationToken` A CancellationToken to use for this RPC.

Returns
Type	Description
`TaskPlaybook`	A Task containing the RPC response.

Example

// Create client
PlaybooksClient playbooksClient = await PlaybooksClient.CreateAsync();
// Initialize request argument(s)
AgentName parent = AgentName.FromProjectLocationAgent("[PROJECT]", "[LOCATION]", "[AGENT]");
Playbook playbook = new Playbook();
// Make the request
Playbook response = await playbooksClient.CreatePlaybookAsync(parent, playbook);

CreatePlaybookAsync(CreatePlaybookRequest, CallSettings)

public virtual Task<Playbook> CreatePlaybookAsync(CreatePlaybookRequest request, CallSettings callSettings = null)

Creates a playbook in a specified agent.

Parameters
Name	Description
`request`	`CreatePlaybookRequest` The request object containing all of the parameters for the API call.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`TaskPlaybook`	A Task containing the RPC response.

Example

// Create client
PlaybooksClient playbooksClient = await PlaybooksClient.CreateAsync();
// Initialize request argument(s)
CreatePlaybookRequest request = new CreatePlaybookRequest
{
    ParentAsAgentName = AgentName.FromProjectLocationAgent("[PROJECT]", "[LOCATION]", "[AGENT]"),
    Playbook = new Playbook(),
};
// Make the request
Playbook response = await playbooksClient.CreatePlaybookAsync(request);

CreatePlaybookAsync(CreatePlaybookRequest, CancellationToken)

public virtual Task<Playbook> CreatePlaybookAsync(CreatePlaybookRequest request, CancellationToken cancellationToken)

Creates a playbook in a specified agent.

Parameters
Name	Description
`request`	`CreatePlaybookRequest` The request object containing all of the parameters for the API call.
`cancellationToken`	`CancellationToken` A CancellationToken to use for this RPC.

Returns
Type	Description
`TaskPlaybook`	A Task containing the RPC response.

Example

// Create client
PlaybooksClient playbooksClient = await PlaybooksClient.CreateAsync();
// Initialize request argument(s)
CreatePlaybookRequest request = new CreatePlaybookRequest
{
    ParentAsAgentName = AgentName.FromProjectLocationAgent("[PROJECT]", "[LOCATION]", "[AGENT]"),
    Playbook = new Playbook(),
};
// Make the request
Playbook response = await playbooksClient.CreatePlaybookAsync(request);

CreatePlaybookAsync(string, Playbook, CallSettings)

public virtual Task<Playbook> CreatePlaybookAsync(string parent, Playbook playbook, CallSettings callSettings = null)

Creates a playbook in a specified agent.

Parameters
Name	Description
`parent`	`string` Required. The agent to create a playbook for. Format: `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>`.
`playbook`	`Playbook` Required. The playbook to create.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`TaskPlaybook`	A Task containing the RPC response.

Example

// Create client
PlaybooksClient playbooksClient = await PlaybooksClient.CreateAsync();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]/agents/[AGENT]";
Playbook playbook = new Playbook();
// Make the request
Playbook response = await playbooksClient.CreatePlaybookAsync(parent, playbook);

CreatePlaybookAsync(string, Playbook, CancellationToken)

public virtual Task<Playbook> CreatePlaybookAsync(string parent, Playbook playbook, CancellationToken cancellationToken)

Creates a playbook in a specified agent.

Parameters
Name	Description
`parent`	`string` Required. The agent to create a playbook for. Format: `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>`.
`playbook`	`Playbook` Required. The playbook to create.
`cancellationToken`	`CancellationToken` A CancellationToken to use for this RPC.

Returns
Type	Description
`TaskPlaybook`	A Task containing the RPC response.

Example

// Create client
PlaybooksClient playbooksClient = await PlaybooksClient.CreateAsync();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]/agents/[AGENT]";
Playbook playbook = new Playbook();
// Make the request
Playbook response = await playbooksClient.CreatePlaybookAsync(parent, playbook);

CreatePlaybookVersion(CreatePlaybookVersionRequest, CallSettings)

public virtual PlaybookVersion CreatePlaybookVersion(CreatePlaybookVersionRequest request, CallSettings callSettings = null)

Creates a version for the specified Playbook.

Parameters
Name	Description
`request`	`CreatePlaybookVersionRequest` The request object containing all of the parameters for the API call.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`PlaybookVersion`	The RPC response.

Example

// Create client
PlaybooksClient playbooksClient = PlaybooksClient.Create();
// Initialize request argument(s)
CreatePlaybookVersionRequest request = new CreatePlaybookVersionRequest
{
    ParentAsPlaybookName = PlaybookName.FromProjectLocationAgentPlaybook("[PROJECT]", "[LOCATION]", "[AGENT]", "[PLAYBOOK]"),
    PlaybookVersion = new PlaybookVersion(),
};
// Make the request
PlaybookVersion response = playbooksClient.CreatePlaybookVersion(request);

CreatePlaybookVersion(PlaybookName, PlaybookVersion, CallSettings)

public virtual PlaybookVersion CreatePlaybookVersion(PlaybookName parent, PlaybookVersion playbookVersion, CallSettings callSettings = null)

Creates a version for the specified Playbook.

Parameters
Name	Description
`parent`	`PlaybookName` Required. The playbook to create a version for. Format: `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/playbooks/<PlaybookID>`.
`playbookVersion`	`PlaybookVersion` Required. The playbook version to create.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`PlaybookVersion`	The RPC response.

Example

// Create client
PlaybooksClient playbooksClient = PlaybooksClient.Create();
// Initialize request argument(s)
PlaybookName parent = PlaybookName.FromProjectLocationAgentPlaybook("[PROJECT]", "[LOCATION]", "[AGENT]", "[PLAYBOOK]");
PlaybookVersion playbookVersion = new PlaybookVersion();
// Make the request
PlaybookVersion response = playbooksClient.CreatePlaybookVersion(parent, playbookVersion);

CreatePlaybookVersion(string, PlaybookVersion, CallSettings)

public virtual PlaybookVersion CreatePlaybookVersion(string parent, PlaybookVersion playbookVersion, CallSettings callSettings = null)

Creates a version for the specified Playbook.

Parameters
Name	Description
`parent`	`string` Required. The playbook to create a version for. Format: `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/playbooks/<PlaybookID>`.
`playbookVersion`	`PlaybookVersion` Required. The playbook version to create.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`PlaybookVersion`	The RPC response.

Example

// Create client
PlaybooksClient playbooksClient = PlaybooksClient.Create();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]/agents/[AGENT]/playbooks/[PLAYBOOK]";
PlaybookVersion playbookVersion = new PlaybookVersion();
// Make the request
PlaybookVersion response = playbooksClient.CreatePlaybookVersion(parent, playbookVersion);

CreatePlaybookVersionAsync(CreatePlaybookVersionRequest, CallSettings)

public virtual Task<PlaybookVersion> CreatePlaybookVersionAsync(CreatePlaybookVersionRequest request, CallSettings callSettings = null)

Creates a version for the specified Playbook.

Parameters
Name	Description
`request`	`CreatePlaybookVersionRequest` The request object containing all of the parameters for the API call.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`TaskPlaybookVersion`	A Task containing the RPC response.

Example

// Create client
PlaybooksClient playbooksClient = await PlaybooksClient.CreateAsync();
// Initialize request argument(s)
CreatePlaybookVersionRequest request = new CreatePlaybookVersionRequest
{
    ParentAsPlaybookName = PlaybookName.FromProjectLocationAgentPlaybook("[PROJECT]", "[LOCATION]", "[AGENT]", "[PLAYBOOK]"),
    PlaybookVersion = new PlaybookVersion(),
};
// Make the request
PlaybookVersion response = await playbooksClient.CreatePlaybookVersionAsync(request);

CreatePlaybookVersionAsync(CreatePlaybookVersionRequest, CancellationToken)

public virtual Task<PlaybookVersion> CreatePlaybookVersionAsync(CreatePlaybookVersionRequest request, CancellationToken cancellationToken)

Creates a version for the specified Playbook.

Parameters
Name	Description
`request`	`CreatePlaybookVersionRequest` The request object containing all of the parameters for the API call.
`cancellationToken`	`CancellationToken` A CancellationToken to use for this RPC.

Returns
Type	Description
`TaskPlaybookVersion`	A Task containing the RPC response.

Example

// Create client
PlaybooksClient playbooksClient = await PlaybooksClient.CreateAsync();
// Initialize request argument(s)
CreatePlaybookVersionRequest request = new CreatePlaybookVersionRequest
{
    ParentAsPlaybookName = PlaybookName.FromProjectLocationAgentPlaybook("[PROJECT]", "[LOCATION]", "[AGENT]", "[PLAYBOOK]"),
    PlaybookVersion = new PlaybookVersion(),
};
// Make the request
PlaybookVersion response = await playbooksClient.CreatePlaybookVersionAsync(request);

CreatePlaybookVersionAsync(PlaybookName, PlaybookVersion, CallSettings)

public virtual Task<PlaybookVersion> CreatePlaybookVersionAsync(PlaybookName parent, PlaybookVersion playbookVersion, CallSettings callSettings = null)

Creates a version for the specified Playbook.

Parameters
Name	Description
`parent`	`PlaybookName` Required. The playbook to create a version for. Format: `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/playbooks/<PlaybookID>`.
`playbookVersion`	`PlaybookVersion` Required. The playbook version to create.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`TaskPlaybookVersion`	A Task containing the RPC response.

Example

// Create client
PlaybooksClient playbooksClient = await PlaybooksClient.CreateAsync();
// Initialize request argument(s)
PlaybookName parent = PlaybookName.FromProjectLocationAgentPlaybook("[PROJECT]", "[LOCATION]", "[AGENT]", "[PLAYBOOK]");
PlaybookVersion playbookVersion = new PlaybookVersion();
// Make the request
PlaybookVersion response = await playbooksClient.CreatePlaybookVersionAsync(parent, playbookVersion);

CreatePlaybookVersionAsync(PlaybookName, PlaybookVersion, CancellationToken)

public virtual Task<PlaybookVersion> CreatePlaybookVersionAsync(PlaybookName parent, PlaybookVersion playbookVersion, CancellationToken cancellationToken)

Creates a version for the specified Playbook.

Parameters
Name	Description
`parent`	`PlaybookName` Required. The playbook to create a version for. Format: `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/playbooks/<PlaybookID>`.
`playbookVersion`	`PlaybookVersion` Required. The playbook version to create.
`cancellationToken`	`CancellationToken` A CancellationToken to use for this RPC.

Returns
Type	Description
`TaskPlaybookVersion`	A Task containing the RPC response.

Example

// Create client
PlaybooksClient playbooksClient = await PlaybooksClient.CreateAsync();
// Initialize request argument(s)
PlaybookName parent = PlaybookName.FromProjectLocationAgentPlaybook("[PROJECT]", "[LOCATION]", "[AGENT]", "[PLAYBOOK]");
PlaybookVersion playbookVersion = new PlaybookVersion();
// Make the request
PlaybookVersion response = await playbooksClient.CreatePlaybookVersionAsync(parent, playbookVersion);

CreatePlaybookVersionAsync(string, PlaybookVersion, CallSettings)

public virtual Task<PlaybookVersion> CreatePlaybookVersionAsync(string parent, PlaybookVersion playbookVersion, CallSettings callSettings = null)

Creates a version for the specified Playbook.

Parameters
Name	Description
`parent`	`string` Required. The playbook to create a version for. Format: `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/playbooks/<PlaybookID>`.
`playbookVersion`	`PlaybookVersion` Required. The playbook version to create.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`TaskPlaybookVersion`	A Task containing the RPC response.

Example

// Create client
PlaybooksClient playbooksClient = await PlaybooksClient.CreateAsync();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]/agents/[AGENT]/playbooks/[PLAYBOOK]";
PlaybookVersion playbookVersion = new PlaybookVersion();
// Make the request
PlaybookVersion response = await playbooksClient.CreatePlaybookVersionAsync(parent, playbookVersion);

CreatePlaybookVersionAsync(string, PlaybookVersion, CancellationToken)

public virtual Task<PlaybookVersion> CreatePlaybookVersionAsync(string parent, PlaybookVersion playbookVersion, CancellationToken cancellationToken)

Creates a version for the specified Playbook.

Parameters
Name	Description
`parent`	`string` Required. The playbook to create a version for. Format: `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/playbooks/<PlaybookID>`.
`playbookVersion`	`PlaybookVersion` Required. The playbook version to create.
`cancellationToken`	`CancellationToken` A CancellationToken to use for this RPC.

Returns
Type	Description
`TaskPlaybookVersion`	A Task containing the RPC response.

Example

// Create client
PlaybooksClient playbooksClient = await PlaybooksClient.CreateAsync();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]/agents/[AGENT]/playbooks/[PLAYBOOK]";
PlaybookVersion playbookVersion = new PlaybookVersion();
// Make the request
PlaybookVersion response = await playbooksClient.CreatePlaybookVersionAsync(parent, playbookVersion);

DeletePlaybook(DeletePlaybookRequest, CallSettings)

public virtual void DeletePlaybook(DeletePlaybookRequest request, CallSettings callSettings = null)

Deletes a specified playbook.

Parameters
Name	Description
`request`	`DeletePlaybookRequest` The request object containing all of the parameters for the API call.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Example

// Create client
PlaybooksClient playbooksClient = PlaybooksClient.Create();
// Initialize request argument(s)
DeletePlaybookRequest request = new DeletePlaybookRequest
{
    PlaybookName = PlaybookName.FromProjectLocationAgentPlaybook("[PROJECT]", "[LOCATION]", "[AGENT]", "[PLAYBOOK]"),
};
// Make the request
playbooksClient.DeletePlaybook(request);

DeletePlaybook(PlaybookName, CallSettings)

public virtual void DeletePlaybook(PlaybookName name, CallSettings callSettings = null)

Deletes a specified playbook.

Parameters
Name	Description
`name`	`PlaybookName` Required. The name of the playbook to delete. Format: `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/playbooks/<PlaybookID>`.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Example

// Create client
PlaybooksClient playbooksClient = PlaybooksClient.Create();
// Initialize request argument(s)
PlaybookName name = PlaybookName.FromProjectLocationAgentPlaybook("[PROJECT]", "[LOCATION]", "[AGENT]", "[PLAYBOOK]");
// Make the request
playbooksClient.DeletePlaybook(name);

DeletePlaybook(string, CallSettings)

public virtual void DeletePlaybook(string name, CallSettings callSettings = null)

Deletes a specified playbook.

Parameters
Name	Description
`name`	`string` Required. The name of the playbook to delete. Format: `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/playbooks/<PlaybookID>`.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Example

// Create client
PlaybooksClient playbooksClient = PlaybooksClient.Create();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/agents/[AGENT]/playbooks/[PLAYBOOK]";
// Make the request
playbooksClient.DeletePlaybook(name);

DeletePlaybookAsync(DeletePlaybookRequest, CallSettings)

public virtual Task DeletePlaybookAsync(DeletePlaybookRequest request, CallSettings callSettings = null)

Deletes a specified playbook.

Parameters
Name	Description
`request`	`DeletePlaybookRequest` The request object containing all of the parameters for the API call.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`Task`	A Task containing the RPC response.

Example

// Create client
PlaybooksClient playbooksClient = await PlaybooksClient.CreateAsync();
// Initialize request argument(s)
DeletePlaybookRequest request = new DeletePlaybookRequest
{
    PlaybookName = PlaybookName.FromProjectLocationAgentPlaybook("[PROJECT]", "[LOCATION]", "[AGENT]", "[PLAYBOOK]"),
};
// Make the request
await playbooksClient.DeletePlaybookAsync(request);

DeletePlaybookAsync(DeletePlaybookRequest, CancellationToken)

public virtual Task DeletePlaybookAsync(DeletePlaybookRequest request, CancellationToken cancellationToken)

Deletes a specified playbook.

Parameters
Name	Description
`request`	`DeletePlaybookRequest` The request object containing all of the parameters for the API call.
`cancellationToken`	`CancellationToken` A CancellationToken to use for this RPC.

Returns
Type	Description
`Task`	A Task containing the RPC response.

Example

// Create client
PlaybooksClient playbooksClient = await PlaybooksClient.CreateAsync();
// Initialize request argument(s)
DeletePlaybookRequest request = new DeletePlaybookRequest
{
    PlaybookName = PlaybookName.FromProjectLocationAgentPlaybook("[PROJECT]", "[LOCATION]", "[AGENT]", "[PLAYBOOK]"),
};
// Make the request
await playbooksClient.DeletePlaybookAsync(request);

DeletePlaybookAsync(PlaybookName, CallSettings)

public virtual Task DeletePlaybookAsync(PlaybookName name, CallSettings callSettings = null)

Deletes a specified playbook.

Parameters
Name	Description
`name`	`PlaybookName` Required. The name of the playbook to delete. Format: `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/playbooks/<PlaybookID>`.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`Task`	A Task containing the RPC response.

Example

// Create client
PlaybooksClient playbooksClient = await PlaybooksClient.CreateAsync();
// Initialize request argument(s)
PlaybookName name = PlaybookName.FromProjectLocationAgentPlaybook("[PROJECT]", "[LOCATION]", "[AGENT]", "[PLAYBOOK]");
// Make the request
await playbooksClient.DeletePlaybookAsync(name);

DeletePlaybookAsync(PlaybookName, CancellationToken)

public virtual Task DeletePlaybookAsync(PlaybookName name, CancellationToken cancellationToken)

Deletes a specified playbook.

Parameters
Name	Description
`name`	`PlaybookName` Required. The name of the playbook to delete. Format: `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/playbooks/<PlaybookID>`.
`cancellationToken`	`CancellationToken` A CancellationToken to use for this RPC.

Returns
Type	Description
`Task`	A Task containing the RPC response.

Example

// Create client
PlaybooksClient playbooksClient = await PlaybooksClient.CreateAsync();
// Initialize request argument(s)
PlaybookName name = PlaybookName.FromProjectLocationAgentPlaybook("[PROJECT]", "[LOCATION]", "[AGENT]", "[PLAYBOOK]");
// Make the request
await playbooksClient.DeletePlaybookAsync(name);

DeletePlaybookAsync(string, CallSettings)

public virtual Task DeletePlaybookAsync(string name, CallSettings callSettings = null)

Deletes a specified playbook.

Parameters
Name	Description
`name`	`string` Required. The name of the playbook to delete. Format: `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/playbooks/<PlaybookID>`.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`Task`	A Task containing the RPC response.

Example

// Create client
PlaybooksClient playbooksClient = await PlaybooksClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/agents/[AGENT]/playbooks/[PLAYBOOK]";
// Make the request
await playbooksClient.DeletePlaybookAsync(name);

DeletePlaybookAsync(string, CancellationToken)

public virtual Task DeletePlaybookAsync(string name, CancellationToken cancellationToken)

Deletes a specified playbook.

Parameters
Name	Description
`name`	`string` Required. The name of the playbook to delete. Format: `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/playbooks/<PlaybookID>`.
`cancellationToken`	`CancellationToken` A CancellationToken to use for this RPC.

Returns
Type	Description
`Task`	A Task containing the RPC response.

Example

// Create client
PlaybooksClient playbooksClient = await PlaybooksClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/agents/[AGENT]/playbooks/[PLAYBOOK]";
// Make the request
await playbooksClient.DeletePlaybookAsync(name);

DeletePlaybookVersion(DeletePlaybookVersionRequest, CallSettings)

public virtual void DeletePlaybookVersion(DeletePlaybookVersionRequest request, CallSettings callSettings = null)

Deletes the specified version of the Playbook.

Parameters
Name	Description
`request`	`DeletePlaybookVersionRequest` The request object containing all of the parameters for the API call.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Example

// Create client
PlaybooksClient playbooksClient = PlaybooksClient.Create();
// Initialize request argument(s)
DeletePlaybookVersionRequest request = new DeletePlaybookVersionRequest
{
    PlaybookVersionName = PlaybookVersionName.FromProjectLocationAgentPlaybookVersion("[PROJECT]", "[LOCATION]", "[AGENT]", "[PLAYBOOK]", "[VERSION]"),
};
// Make the request
playbooksClient.DeletePlaybookVersion(request);

DeletePlaybookVersion(PlaybookVersionName, CallSettings)

public virtual void DeletePlaybookVersion(PlaybookVersionName name, CallSettings callSettings = null)

Deletes the specified version of the Playbook.

Parameters
Name	Description
`name`	`PlaybookVersionName` Required. The name of the playbook version to delete. Format: `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/playbooks/<PlaybookID>/versions/<VersionID>`.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Example

// Create client
PlaybooksClient playbooksClient = PlaybooksClient.Create();
// Initialize request argument(s)
PlaybookVersionName name = PlaybookVersionName.FromProjectLocationAgentPlaybookVersion("[PROJECT]", "[LOCATION]", "[AGENT]", "[PLAYBOOK]", "[VERSION]");
// Make the request
playbooksClient.DeletePlaybookVersion(name);

DeletePlaybookVersion(string, CallSettings)

public virtual void DeletePlaybookVersion(string name, CallSettings callSettings = null)

Deletes the specified version of the Playbook.

Parameters
Name	Description
`name`	`string` Required. The name of the playbook version to delete. Format: `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/playbooks/<PlaybookID>/versions/<VersionID>`.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Example

// Create client
PlaybooksClient playbooksClient = PlaybooksClient.Create();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/agents/[AGENT]/playbooks/[PLAYBOOK]/versions/[VERSION]";
// Make the request
playbooksClient.DeletePlaybookVersion(name);

DeletePlaybookVersionAsync(DeletePlaybookVersionRequest, CallSettings)

public virtual Task DeletePlaybookVersionAsync(DeletePlaybookVersionRequest request, CallSettings callSettings = null)

Deletes the specified version of the Playbook.

Parameters
Name	Description
`request`	`DeletePlaybookVersionRequest` The request object containing all of the parameters for the API call.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`Task`	A Task containing the RPC response.

Example

// Create client
PlaybooksClient playbooksClient = await PlaybooksClient.CreateAsync();
// Initialize request argument(s)
DeletePlaybookVersionRequest request = new DeletePlaybookVersionRequest
{
    PlaybookVersionName = PlaybookVersionName.FromProjectLocationAgentPlaybookVersion("[PROJECT]", "[LOCATION]", "[AGENT]", "[PLAYBOOK]", "[VERSION]"),
};
// Make the request
await playbooksClient.DeletePlaybookVersionAsync(request);

DeletePlaybookVersionAsync(DeletePlaybookVersionRequest, CancellationToken)

public virtual Task DeletePlaybookVersionAsync(DeletePlaybookVersionRequest request, CancellationToken cancellationToken)

Deletes the specified version of the Playbook.

Parameters
Name	Description
`request`	`DeletePlaybookVersionRequest` The request object containing all of the parameters for the API call.
`cancellationToken`	`CancellationToken` A CancellationToken to use for this RPC.

Returns
Type	Description
`Task`	A Task containing the RPC response.

Example

// Create client
PlaybooksClient playbooksClient = await PlaybooksClient.CreateAsync();
// Initialize request argument(s)
DeletePlaybookVersionRequest request = new DeletePlaybookVersionRequest
{
    PlaybookVersionName = PlaybookVersionName.FromProjectLocationAgentPlaybookVersion("[PROJECT]", "[LOCATION]", "[AGENT]", "[PLAYBOOK]", "[VERSION]"),
};
// Make the request
await playbooksClient.DeletePlaybookVersionAsync(request);

DeletePlaybookVersionAsync(PlaybookVersionName, CallSettings)

public virtual Task DeletePlaybookVersionAsync(PlaybookVersionName name, CallSettings callSettings = null)

Deletes the specified version of the Playbook.

Parameters
Name	Description
`name`	`PlaybookVersionName` Required. The name of the playbook version to delete. Format: `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/playbooks/<PlaybookID>/versions/<VersionID>`.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`Task`	A Task containing the RPC response.

Example

// Create client
PlaybooksClient playbooksClient = await PlaybooksClient.CreateAsync();
// Initialize request argument(s)
PlaybookVersionName name = PlaybookVersionName.FromProjectLocationAgentPlaybookVersion("[PROJECT]", "[LOCATION]", "[AGENT]", "[PLAYBOOK]", "[VERSION]");
// Make the request
await playbooksClient.DeletePlaybookVersionAsync(name);

DeletePlaybookVersionAsync(PlaybookVersionName, CancellationToken)

public virtual Task DeletePlaybookVersionAsync(PlaybookVersionName name, CancellationToken cancellationToken)

Deletes the specified version of the Playbook.

Parameters
Name	Description
`name`	`PlaybookVersionName` Required. The name of the playbook version to delete. Format: `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/playbooks/<PlaybookID>/versions/<VersionID>`.
`cancellationToken`	`CancellationToken` A CancellationToken to use for this RPC.

Returns
Type	Description
`Task`	A Task containing the RPC response.

Example

// Create client
PlaybooksClient playbooksClient = await PlaybooksClient.CreateAsync();
// Initialize request argument(s)
PlaybookVersionName name = PlaybookVersionName.FromProjectLocationAgentPlaybookVersion("[PROJECT]", "[LOCATION]", "[AGENT]", "[PLAYBOOK]", "[VERSION]");
// Make the request
await playbooksClient.DeletePlaybookVersionAsync(name);

DeletePlaybookVersionAsync(string, CallSettings)

public virtual Task DeletePlaybookVersionAsync(string name, CallSettings callSettings = null)

Deletes the specified version of the Playbook.

Parameters
Name	Description
`name`	`string` Required. The name of the playbook version to delete. Format: `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/playbooks/<PlaybookID>/versions/<VersionID>`.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`Task`	A Task containing the RPC response.

Example

// Create client
PlaybooksClient playbooksClient = await PlaybooksClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/agents/[AGENT]/playbooks/[PLAYBOOK]/versions/[VERSION]";
// Make the request
await playbooksClient.DeletePlaybookVersionAsync(name);

DeletePlaybookVersionAsync(string, CancellationToken)

public virtual Task DeletePlaybookVersionAsync(string name, CancellationToken cancellationToken)

Deletes the specified version of the Playbook.

Parameters
Name	Description
`name`	`string` Required. The name of the playbook version to delete. Format: `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/playbooks/<PlaybookID>/versions/<VersionID>`.
`cancellationToken`	`CancellationToken` A CancellationToken to use for this RPC.

Returns
Type	Description
`Task`	A Task containing the RPC response.

Example

// Create client
PlaybooksClient playbooksClient = await PlaybooksClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/agents/[AGENT]/playbooks/[PLAYBOOK]/versions/[VERSION]";
// Make the request
await playbooksClient.DeletePlaybookVersionAsync(name);

ExportPlaybook(ExportPlaybookRequest, CallSettings)

public virtual Operation<ExportPlaybookResponse, Struct> ExportPlaybook(ExportPlaybookRequest request, CallSettings callSettings = null)

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` The request object containing all of the parameters for the API call.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`OperationExportPlaybookResponseStruct`	The RPC response.

Example

// Create client
PlaybooksClient playbooksClient = PlaybooksClient.Create();
// Initialize request argument(s)
ExportPlaybookRequest request = new ExportPlaybookRequest
{
    PlaybookName = PlaybookName.FromProjectLocationAgentPlaybook("[PROJECT]", "[LOCATION]", "[AGENT]", "[PLAYBOOK]"),
    PlaybookUri = "",
    DataFormat = ExportPlaybookRequest.Types.DataFormat.Unspecified,
};
// Make the request
Operation<ExportPlaybookResponse, Struct> response = playbooksClient.ExportPlaybook(request);

// Poll until the returned long-running operation is complete
Operation<ExportPlaybookResponse, Struct> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
ExportPlaybookResponse result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<ExportPlaybookResponse, Struct> retrievedResponse = playbooksClient.PollOnceExportPlaybook(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    ExportPlaybookResponse retrievedResult = retrievedResponse.Result;
}

ExportPlaybookAsync(ExportPlaybookRequest, CallSettings)

public virtual Task<Operation<ExportPlaybookResponse, Struct>> ExportPlaybookAsync(ExportPlaybookRequest request, CallSettings callSettings = null)

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` The request object containing all of the parameters for the API call.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`TaskOperationExportPlaybookResponseStruct`	A Task containing the RPC response.

Example

// Create client
PlaybooksClient playbooksClient = await PlaybooksClient.CreateAsync();
// Initialize request argument(s)
ExportPlaybookRequest request = new ExportPlaybookRequest
{
    PlaybookName = PlaybookName.FromProjectLocationAgentPlaybook("[PROJECT]", "[LOCATION]", "[AGENT]", "[PLAYBOOK]"),
    PlaybookUri = "",
    DataFormat = ExportPlaybookRequest.Types.DataFormat.Unspecified,
};
// Make the request
Operation<ExportPlaybookResponse, Struct> response = await playbooksClient.ExportPlaybookAsync(request);

// Poll until the returned long-running operation is complete
Operation<ExportPlaybookResponse, Struct> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
ExportPlaybookResponse result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<ExportPlaybookResponse, Struct> retrievedResponse = await playbooksClient.PollOnceExportPlaybookAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    ExportPlaybookResponse retrievedResult = retrievedResponse.Result;
}

ExportPlaybookAsync(ExportPlaybookRequest, CancellationToken)

public virtual Task<Operation<ExportPlaybookResponse, Struct>> ExportPlaybookAsync(ExportPlaybookRequest request, CancellationToken cancellationToken)

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` The request object containing all of the parameters for the API call.
`cancellationToken`	`CancellationToken` A CancellationToken to use for this RPC.

Returns
Type	Description
`TaskOperationExportPlaybookResponseStruct`	A Task containing the RPC response.

Example

// Create client
PlaybooksClient playbooksClient = await PlaybooksClient.CreateAsync();
// Initialize request argument(s)
ExportPlaybookRequest request = new ExportPlaybookRequest
{
    PlaybookName = PlaybookName.FromProjectLocationAgentPlaybook("[PROJECT]", "[LOCATION]", "[AGENT]", "[PLAYBOOK]"),
    PlaybookUri = "",
    DataFormat = ExportPlaybookRequest.Types.DataFormat.Unspecified,
};
// Make the request
Operation<ExportPlaybookResponse, Struct> response = await playbooksClient.ExportPlaybookAsync(request);

// Poll until the returned long-running operation is complete
Operation<ExportPlaybookResponse, Struct> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
ExportPlaybookResponse result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<ExportPlaybookResponse, Struct> retrievedResponse = await playbooksClient.PollOnceExportPlaybookAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    ExportPlaybookResponse retrievedResult = retrievedResponse.Result;
}

GetPlaybook(GetPlaybookRequest, CallSettings)

public virtual Playbook GetPlaybook(GetPlaybookRequest request, CallSettings callSettings = null)

Retrieves the specified Playbook.

Parameters
Name	Description
`request`	`GetPlaybookRequest` The request object containing all of the parameters for the API call.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`Playbook`	The RPC response.

Example

// Create client
PlaybooksClient playbooksClient = PlaybooksClient.Create();
// Initialize request argument(s)
GetPlaybookRequest request = new GetPlaybookRequest
{
    PlaybookName = PlaybookName.FromProjectLocationAgentPlaybook("[PROJECT]", "[LOCATION]", "[AGENT]", "[PLAYBOOK]"),
};
// Make the request
Playbook response = playbooksClient.GetPlaybook(request);

GetPlaybook(PlaybookName, CallSettings)

public virtual Playbook GetPlaybook(PlaybookName name, CallSettings callSettings = null)

Retrieves the specified Playbook.

Parameters
Name	Description
`name`	`PlaybookName` Required. The name of the playbook. Format: `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/playbooks/<PlaybookID>`.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`Playbook`	The RPC response.

Example

// Create client
PlaybooksClient playbooksClient = PlaybooksClient.Create();
// Initialize request argument(s)
PlaybookName name = PlaybookName.FromProjectLocationAgentPlaybook("[PROJECT]", "[LOCATION]", "[AGENT]", "[PLAYBOOK]");
// Make the request
Playbook response = playbooksClient.GetPlaybook(name);

GetPlaybook(string, CallSettings)

public virtual Playbook GetPlaybook(string name, CallSettings callSettings = null)

Retrieves the specified Playbook.

Parameters
Name	Description
`name`	`string` Required. The name of the playbook. Format: `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/playbooks/<PlaybookID>`.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`Playbook`	The RPC response.

Example

// Create client
PlaybooksClient playbooksClient = PlaybooksClient.Create();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/agents/[AGENT]/playbooks/[PLAYBOOK]";
// Make the request
Playbook response = playbooksClient.GetPlaybook(name);

GetPlaybookAsync(GetPlaybookRequest, CallSettings)

public virtual Task<Playbook> GetPlaybookAsync(GetPlaybookRequest request, CallSettings callSettings = null)

Retrieves the specified Playbook.

Parameters
Name	Description
`request`	`GetPlaybookRequest` The request object containing all of the parameters for the API call.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`TaskPlaybook`	A Task containing the RPC response.

Example

// Create client
PlaybooksClient playbooksClient = await PlaybooksClient.CreateAsync();
// Initialize request argument(s)
GetPlaybookRequest request = new GetPlaybookRequest
{
    PlaybookName = PlaybookName.FromProjectLocationAgentPlaybook("[PROJECT]", "[LOCATION]", "[AGENT]", "[PLAYBOOK]"),
};
// Make the request
Playbook response = await playbooksClient.GetPlaybookAsync(request);

GetPlaybookAsync(GetPlaybookRequest, CancellationToken)

public virtual Task<Playbook> GetPlaybookAsync(GetPlaybookRequest request, CancellationToken cancellationToken)

Retrieves the specified Playbook.

Parameters
Name	Description
`request`	`GetPlaybookRequest` The request object containing all of the parameters for the API call.
`cancellationToken`	`CancellationToken` A CancellationToken to use for this RPC.

Returns
Type	Description
`TaskPlaybook`	A Task containing the RPC response.

Example

// Create client
PlaybooksClient playbooksClient = await PlaybooksClient.CreateAsync();
// Initialize request argument(s)
GetPlaybookRequest request = new GetPlaybookRequest
{
    PlaybookName = PlaybookName.FromProjectLocationAgentPlaybook("[PROJECT]", "[LOCATION]", "[AGENT]", "[PLAYBOOK]"),
};
// Make the request
Playbook response = await playbooksClient.GetPlaybookAsync(request);

GetPlaybookAsync(PlaybookName, CallSettings)

public virtual Task<Playbook> GetPlaybookAsync(PlaybookName name, CallSettings callSettings = null)

Retrieves the specified Playbook.

Parameters
Name	Description
`name`	`PlaybookName` Required. The name of the playbook. Format: `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/playbooks/<PlaybookID>`.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`TaskPlaybook`	A Task containing the RPC response.

Example

// Create client
PlaybooksClient playbooksClient = await PlaybooksClient.CreateAsync();
// Initialize request argument(s)
PlaybookName name = PlaybookName.FromProjectLocationAgentPlaybook("[PROJECT]", "[LOCATION]", "[AGENT]", "[PLAYBOOK]");
// Make the request
Playbook response = await playbooksClient.GetPlaybookAsync(name);

GetPlaybookAsync(PlaybookName, CancellationToken)

public virtual Task<Playbook> GetPlaybookAsync(PlaybookName name, CancellationToken cancellationToken)

Retrieves the specified Playbook.

Parameters
Name	Description
`name`	`PlaybookName` Required. The name of the playbook. Format: `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/playbooks/<PlaybookID>`.
`cancellationToken`	`CancellationToken` A CancellationToken to use for this RPC.

Returns
Type	Description
`TaskPlaybook`	A Task containing the RPC response.

Example

// Create client
PlaybooksClient playbooksClient = await PlaybooksClient.CreateAsync();
// Initialize request argument(s)
PlaybookName name = PlaybookName.FromProjectLocationAgentPlaybook("[PROJECT]", "[LOCATION]", "[AGENT]", "[PLAYBOOK]");
// Make the request
Playbook response = await playbooksClient.GetPlaybookAsync(name);

GetPlaybookAsync(string, CallSettings)

public virtual Task<Playbook> GetPlaybookAsync(string name, CallSettings callSettings = null)

Retrieves the specified Playbook.

Parameters
Name	Description
`name`	`string` Required. The name of the playbook. Format: `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/playbooks/<PlaybookID>`.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`TaskPlaybook`	A Task containing the RPC response.

Example

// Create client
PlaybooksClient playbooksClient = await PlaybooksClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/agents/[AGENT]/playbooks/[PLAYBOOK]";
// Make the request
Playbook response = await playbooksClient.GetPlaybookAsync(name);

GetPlaybookAsync(string, CancellationToken)

public virtual Task<Playbook> GetPlaybookAsync(string name, CancellationToken cancellationToken)

Retrieves the specified Playbook.

Parameters
Name	Description
`name`	`string` Required. The name of the playbook. Format: `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/playbooks/<PlaybookID>`.
`cancellationToken`	`CancellationToken` A CancellationToken to use for this RPC.

Returns
Type	Description
`TaskPlaybook`	A Task containing the RPC response.

Example

// Create client
PlaybooksClient playbooksClient = await PlaybooksClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/agents/[AGENT]/playbooks/[PLAYBOOK]";
// Make the request
Playbook response = await playbooksClient.GetPlaybookAsync(name);

GetPlaybookVersion(GetPlaybookVersionRequest, CallSettings)

public virtual PlaybookVersion GetPlaybookVersion(GetPlaybookVersionRequest request, CallSettings callSettings = null)

Retrieves the specified version of the Playbook.

Parameters
Name	Description
`request`	`GetPlaybookVersionRequest` The request object containing all of the parameters for the API call.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`PlaybookVersion`	The RPC response.

Example

// Create client
PlaybooksClient playbooksClient = PlaybooksClient.Create();
// Initialize request argument(s)
GetPlaybookVersionRequest request = new GetPlaybookVersionRequest
{
    PlaybookVersionName = PlaybookVersionName.FromProjectLocationAgentPlaybookVersion("[PROJECT]", "[LOCATION]", "[AGENT]", "[PLAYBOOK]", "[VERSION]"),
};
// Make the request
PlaybookVersion response = playbooksClient.GetPlaybookVersion(request);

GetPlaybookVersion(PlaybookVersionName, CallSettings)

public virtual PlaybookVersion GetPlaybookVersion(PlaybookVersionName name, CallSettings callSettings = null)

Retrieves the specified version of the Playbook.

Parameters
Name	Description
`name`	`PlaybookVersionName` Required. The name of the playbook version. Format: `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/playbooks/<PlaybookID>/versions/<VersionID>`.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`PlaybookVersion`	The RPC response.

Example

// Create client
PlaybooksClient playbooksClient = PlaybooksClient.Create();
// Initialize request argument(s)
PlaybookVersionName name = PlaybookVersionName.FromProjectLocationAgentPlaybookVersion("[PROJECT]", "[LOCATION]", "[AGENT]", "[PLAYBOOK]", "[VERSION]");
// Make the request
PlaybookVersion response = playbooksClient.GetPlaybookVersion(name);

GetPlaybookVersion(string, CallSettings)

public virtual PlaybookVersion GetPlaybookVersion(string name, CallSettings callSettings = null)

Retrieves the specified version of the Playbook.

Parameters
Name	Description
`name`	`string` Required. The name of the playbook version. Format: `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/playbooks/<PlaybookID>/versions/<VersionID>`.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`PlaybookVersion`	The RPC response.

Example

// Create client
PlaybooksClient playbooksClient = PlaybooksClient.Create();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/agents/[AGENT]/playbooks/[PLAYBOOK]/versions/[VERSION]";
// Make the request
PlaybookVersion response = playbooksClient.GetPlaybookVersion(name);

GetPlaybookVersionAsync(GetPlaybookVersionRequest, CallSettings)

public virtual Task<PlaybookVersion> GetPlaybookVersionAsync(GetPlaybookVersionRequest request, CallSettings callSettings = null)

Retrieves the specified version of the Playbook.

Parameters
Name	Description
`request`	`GetPlaybookVersionRequest` The request object containing all of the parameters for the API call.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`TaskPlaybookVersion`	A Task containing the RPC response.

Example

// Create client
PlaybooksClient playbooksClient = await PlaybooksClient.CreateAsync();
// Initialize request argument(s)
GetPlaybookVersionRequest request = new GetPlaybookVersionRequest
{
    PlaybookVersionName = PlaybookVersionName.FromProjectLocationAgentPlaybookVersion("[PROJECT]", "[LOCATION]", "[AGENT]", "[PLAYBOOK]", "[VERSION]"),
};
// Make the request
PlaybookVersion response = await playbooksClient.GetPlaybookVersionAsync(request);

GetPlaybookVersionAsync(GetPlaybookVersionRequest, CancellationToken)

public virtual Task<PlaybookVersion> GetPlaybookVersionAsync(GetPlaybookVersionRequest request, CancellationToken cancellationToken)

Retrieves the specified version of the Playbook.

Parameters
Name	Description
`request`	`GetPlaybookVersionRequest` The request object containing all of the parameters for the API call.
`cancellationToken`	`CancellationToken` A CancellationToken to use for this RPC.

Returns
Type	Description
`TaskPlaybookVersion`	A Task containing the RPC response.

Example

// Create client
PlaybooksClient playbooksClient = await PlaybooksClient.CreateAsync();
// Initialize request argument(s)
GetPlaybookVersionRequest request = new GetPlaybookVersionRequest
{
    PlaybookVersionName = PlaybookVersionName.FromProjectLocationAgentPlaybookVersion("[PROJECT]", "[LOCATION]", "[AGENT]", "[PLAYBOOK]", "[VERSION]"),
};
// Make the request
PlaybookVersion response = await playbooksClient.GetPlaybookVersionAsync(request);

GetPlaybookVersionAsync(PlaybookVersionName, CallSettings)

public virtual Task<PlaybookVersion> GetPlaybookVersionAsync(PlaybookVersionName name, CallSettings callSettings = null)

Retrieves the specified version of the Playbook.

Parameters
Name	Description
`name`	`PlaybookVersionName` Required. The name of the playbook version. Format: `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/playbooks/<PlaybookID>/versions/<VersionID>`.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`TaskPlaybookVersion`	A Task containing the RPC response.

Example

// Create client
PlaybooksClient playbooksClient = await PlaybooksClient.CreateAsync();
// Initialize request argument(s)
PlaybookVersionName name = PlaybookVersionName.FromProjectLocationAgentPlaybookVersion("[PROJECT]", "[LOCATION]", "[AGENT]", "[PLAYBOOK]", "[VERSION]");
// Make the request
PlaybookVersion response = await playbooksClient.GetPlaybookVersionAsync(name);

GetPlaybookVersionAsync(PlaybookVersionName, CancellationToken)

public virtual Task<PlaybookVersion> GetPlaybookVersionAsync(PlaybookVersionName name, CancellationToken cancellationToken)

Retrieves the specified version of the Playbook.

Parameters
Name	Description
`name`	`PlaybookVersionName` Required. The name of the playbook version. Format: `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/playbooks/<PlaybookID>/versions/<VersionID>`.
`cancellationToken`	`CancellationToken` A CancellationToken to use for this RPC.

Returns
Type	Description
`TaskPlaybookVersion`	A Task containing the RPC response.

Example

// Create client
PlaybooksClient playbooksClient = await PlaybooksClient.CreateAsync();
// Initialize request argument(s)
PlaybookVersionName name = PlaybookVersionName.FromProjectLocationAgentPlaybookVersion("[PROJECT]", "[LOCATION]", "[AGENT]", "[PLAYBOOK]", "[VERSION]");
// Make the request
PlaybookVersion response = await playbooksClient.GetPlaybookVersionAsync(name);

GetPlaybookVersionAsync(string, CallSettings)

public virtual Task<PlaybookVersion> GetPlaybookVersionAsync(string name, CallSettings callSettings = null)

Retrieves the specified version of the Playbook.

Parameters
Name	Description
`name`	`string` Required. The name of the playbook version. Format: `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/playbooks/<PlaybookID>/versions/<VersionID>`.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`TaskPlaybookVersion`	A Task containing the RPC response.

Example

// Create client
PlaybooksClient playbooksClient = await PlaybooksClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/agents/[AGENT]/playbooks/[PLAYBOOK]/versions/[VERSION]";
// Make the request
PlaybookVersion response = await playbooksClient.GetPlaybookVersionAsync(name);

GetPlaybookVersionAsync(string, CancellationToken)

public virtual Task<PlaybookVersion> GetPlaybookVersionAsync(string name, CancellationToken cancellationToken)

Retrieves the specified version of the Playbook.

Parameters
Name	Description
`name`	`string` Required. The name of the playbook version. Format: `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/playbooks/<PlaybookID>/versions/<VersionID>`.
`cancellationToken`	`CancellationToken` A CancellationToken to use for this RPC.

Returns
Type	Description
`TaskPlaybookVersion`	A Task containing the RPC response.

Example

// Create client
PlaybooksClient playbooksClient = await PlaybooksClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/agents/[AGENT]/playbooks/[PLAYBOOK]/versions/[VERSION]";
// Make the request
PlaybookVersion response = await playbooksClient.GetPlaybookVersionAsync(name);

ImportPlaybook(ImportPlaybookRequest, CallSettings)

public virtual Operation<ImportPlaybookResponse, Struct> ImportPlaybook(ImportPlaybookRequest request, CallSettings callSettings = null)

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

Parameters
Name	Description
`request`	`ImportPlaybookRequest` The request object containing all of the parameters for the API call.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`OperationImportPlaybookResponseStruct`	The RPC response.

Example

// Create client
PlaybooksClient playbooksClient = PlaybooksClient.Create();
// Initialize request argument(s)
ImportPlaybookRequest request = new ImportPlaybookRequest
{
    ParentAsAgentName = AgentName.FromProjectLocationAgent("[PROJECT]", "[LOCATION]", "[AGENT]"),
    PlaybookUri = "",
    ImportStrategy = new PlaybookImportStrategy(),
};
// Make the request
Operation<ImportPlaybookResponse, Struct> response = playbooksClient.ImportPlaybook(request);

// Poll until the returned long-running operation is complete
Operation<ImportPlaybookResponse, Struct> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
ImportPlaybookResponse result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<ImportPlaybookResponse, Struct> retrievedResponse = playbooksClient.PollOnceImportPlaybook(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    ImportPlaybookResponse retrievedResult = retrievedResponse.Result;
}

ImportPlaybookAsync(ImportPlaybookRequest, CallSettings)

public virtual Task<Operation<ImportPlaybookResponse, Struct>> ImportPlaybookAsync(ImportPlaybookRequest request, CallSettings callSettings = null)

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

Parameters
Name	Description
`request`	`ImportPlaybookRequest` The request object containing all of the parameters for the API call.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`TaskOperationImportPlaybookResponseStruct`	A Task containing the RPC response.

Example

// Create client
PlaybooksClient playbooksClient = await PlaybooksClient.CreateAsync();
// Initialize request argument(s)
ImportPlaybookRequest request = new ImportPlaybookRequest
{
    ParentAsAgentName = AgentName.FromProjectLocationAgent("[PROJECT]", "[LOCATION]", "[AGENT]"),
    PlaybookUri = "",
    ImportStrategy = new PlaybookImportStrategy(),
};
// Make the request
Operation<ImportPlaybookResponse, Struct> response = await playbooksClient.ImportPlaybookAsync(request);

// Poll until the returned long-running operation is complete
Operation<ImportPlaybookResponse, Struct> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
ImportPlaybookResponse result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<ImportPlaybookResponse, Struct> retrievedResponse = await playbooksClient.PollOnceImportPlaybookAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    ImportPlaybookResponse retrievedResult = retrievedResponse.Result;
}

ImportPlaybookAsync(ImportPlaybookRequest, CancellationToken)

public virtual Task<Operation<ImportPlaybookResponse, Struct>> ImportPlaybookAsync(ImportPlaybookRequest request, CancellationToken cancellationToken)

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

Parameters
Name	Description
`request`	`ImportPlaybookRequest` The request object containing all of the parameters for the API call.
`cancellationToken`	`CancellationToken` A CancellationToken to use for this RPC.

Returns
Type	Description
`TaskOperationImportPlaybookResponseStruct`	A Task containing the RPC response.

Example

// Create client
PlaybooksClient playbooksClient = await PlaybooksClient.CreateAsync();
// Initialize request argument(s)
ImportPlaybookRequest request = new ImportPlaybookRequest
{
    ParentAsAgentName = AgentName.FromProjectLocationAgent("[PROJECT]", "[LOCATION]", "[AGENT]"),
    PlaybookUri = "",
    ImportStrategy = new PlaybookImportStrategy(),
};
// Make the request
Operation<ImportPlaybookResponse, Struct> response = await playbooksClient.ImportPlaybookAsync(request);

// Poll until the returned long-running operation is complete
Operation<ImportPlaybookResponse, Struct> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
ImportPlaybookResponse result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<ImportPlaybookResponse, Struct> retrievedResponse = await playbooksClient.PollOnceImportPlaybookAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    ImportPlaybookResponse retrievedResult = retrievedResponse.Result;
}

ListPlaybookVersions(ListPlaybookVersionsRequest, CallSettings)

public virtual PagedEnumerable<ListPlaybookVersionsResponse, PlaybookVersion> ListPlaybookVersions(ListPlaybookVersionsRequest request, CallSettings callSettings = null)

Lists versions for the specified Playbook.

Parameters
Name	Description
`request`	`ListPlaybookVersionsRequest` The request object containing all of the parameters for the API call.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`PagedEnumerableListPlaybookVersionsResponsePlaybookVersion`	A pageable sequence of PlaybookVersion resources.

Example

// Create client
PlaybooksClient playbooksClient = PlaybooksClient.Create();
// Initialize request argument(s)
ListPlaybookVersionsRequest request = new ListPlaybookVersionsRequest
{
    ParentAsPlaybookName = PlaybookName.FromProjectLocationAgentPlaybook("[PROJECT]", "[LOCATION]", "[AGENT]", "[PLAYBOOK]"),
};
// Make the request
PagedEnumerable<ListPlaybookVersionsResponse, PlaybookVersion> response = playbooksClient.ListPlaybookVersions(request);

// Iterate over all response items, lazily performing RPCs as required
foreach (PlaybookVersion item in response)
{
    // Do something with each item
    Console.WriteLine(item);
}

// Or iterate over pages (of server-defined size), performing one RPC per page
foreach (ListPlaybookVersionsResponse page in response.AsRawResponses())
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (PlaybookVersion item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
}

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<PlaybookVersion> singlePage = response.ReadPage(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (PlaybookVersion item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListPlaybookVersions(PlaybookName, string, int?, CallSettings)

public virtual PagedEnumerable<ListPlaybookVersionsResponse, PlaybookVersion> ListPlaybookVersions(PlaybookName parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

Lists versions for the specified Playbook.

Parameters
Name	Description
`parent`	`PlaybookName` Required. The playbook to list versions for. Format: `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/playbooks/<PlaybookID>`.
`pageToken`	`string` The token returned from the previous request. A value of `null` or an empty string retrieves the first page.
`pageSize`	`int` The size of page to request. The response will not be larger than this, but may be smaller. A value of `null` or `0` uses a server-defined page size.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`PagedEnumerableListPlaybookVersionsResponsePlaybookVersion`	A pageable sequence of PlaybookVersion resources.

Example

// Create client
PlaybooksClient playbooksClient = PlaybooksClient.Create();
// Initialize request argument(s)
PlaybookName parent = PlaybookName.FromProjectLocationAgentPlaybook("[PROJECT]", "[LOCATION]", "[AGENT]", "[PLAYBOOK]");
// Make the request
PagedEnumerable<ListPlaybookVersionsResponse, PlaybookVersion> response = playbooksClient.ListPlaybookVersions(parent);

// Iterate over all response items, lazily performing RPCs as required
foreach (PlaybookVersion item in response)
{
    // Do something with each item
    Console.WriteLine(item);
}

// Or iterate over pages (of server-defined size), performing one RPC per page
foreach (ListPlaybookVersionsResponse page in response.AsRawResponses())
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (PlaybookVersion item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
}

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<PlaybookVersion> singlePage = response.ReadPage(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (PlaybookVersion item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListPlaybookVersions(string, string, int?, CallSettings)

public virtual PagedEnumerable<ListPlaybookVersionsResponse, PlaybookVersion> ListPlaybookVersions(string parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

Lists versions for the specified Playbook.

Parameters
Name	Description
`parent`	`string` Required. The playbook to list versions for. Format: `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/playbooks/<PlaybookID>`.
`pageToken`	`string` The token returned from the previous request. A value of `null` or an empty string retrieves the first page.
`pageSize`	`int` The size of page to request. The response will not be larger than this, but may be smaller. A value of `null` or `0` uses a server-defined page size.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`PagedEnumerableListPlaybookVersionsResponsePlaybookVersion`	A pageable sequence of PlaybookVersion resources.

Example

// Create client
PlaybooksClient playbooksClient = PlaybooksClient.Create();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]/agents/[AGENT]/playbooks/[PLAYBOOK]";
// Make the request
PagedEnumerable<ListPlaybookVersionsResponse, PlaybookVersion> response = playbooksClient.ListPlaybookVersions(parent);

// Iterate over all response items, lazily performing RPCs as required
foreach (PlaybookVersion item in response)
{
    // Do something with each item
    Console.WriteLine(item);
}

// Or iterate over pages (of server-defined size), performing one RPC per page
foreach (ListPlaybookVersionsResponse page in response.AsRawResponses())
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (PlaybookVersion item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
}

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<PlaybookVersion> singlePage = response.ReadPage(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (PlaybookVersion item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListPlaybookVersionsAsync(ListPlaybookVersionsRequest, CallSettings)

public virtual PagedAsyncEnumerable<ListPlaybookVersionsResponse, PlaybookVersion> ListPlaybookVersionsAsync(ListPlaybookVersionsRequest request, CallSettings callSettings = null)

Lists versions for the specified Playbook.

Parameters
Name	Description
`request`	`ListPlaybookVersionsRequest` The request object containing all of the parameters for the API call.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`PagedAsyncEnumerableListPlaybookVersionsResponsePlaybookVersion`	A pageable asynchronous sequence of PlaybookVersion resources.

Example

// Create client
PlaybooksClient playbooksClient = await PlaybooksClient.CreateAsync();
// Initialize request argument(s)
ListPlaybookVersionsRequest request = new ListPlaybookVersionsRequest
{
    ParentAsPlaybookName = PlaybookName.FromProjectLocationAgentPlaybook("[PROJECT]", "[LOCATION]", "[AGENT]", "[PLAYBOOK]"),
};
// Make the request
PagedAsyncEnumerable<ListPlaybookVersionsResponse, PlaybookVersion> response = playbooksClient.ListPlaybookVersionsAsync(request);

// Iterate over all response items, lazily performing RPCs as required
await foreach (PlaybookVersion item in response)
{
    // Do something with each item
    Console.WriteLine(item);
}

// Or iterate over pages (of server-defined size), performing one RPC per page
await foreach (ListPlaybookVersionsResponse page in response.AsRawResponses())
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (PlaybookVersion item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
}

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<PlaybookVersion> singlePage = await response.ReadPageAsync(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (PlaybookVersion item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListPlaybookVersionsAsync(PlaybookName, string, int?, CallSettings)

public virtual PagedAsyncEnumerable<ListPlaybookVersionsResponse, PlaybookVersion> ListPlaybookVersionsAsync(PlaybookName parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

Lists versions for the specified Playbook.

Parameters
Name	Description
`parent`	`PlaybookName` Required. The playbook to list versions for. Format: `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/playbooks/<PlaybookID>`.
`pageToken`	`string` The token returned from the previous request. A value of `null` or an empty string retrieves the first page.
`pageSize`	`int` The size of page to request. The response will not be larger than this, but may be smaller. A value of `null` or `0` uses a server-defined page size.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`PagedAsyncEnumerableListPlaybookVersionsResponsePlaybookVersion`	A pageable asynchronous sequence of PlaybookVersion resources.

Example

// Create client
PlaybooksClient playbooksClient = await PlaybooksClient.CreateAsync();
// Initialize request argument(s)
PlaybookName parent = PlaybookName.FromProjectLocationAgentPlaybook("[PROJECT]", "[LOCATION]", "[AGENT]", "[PLAYBOOK]");
// Make the request
PagedAsyncEnumerable<ListPlaybookVersionsResponse, PlaybookVersion> response = playbooksClient.ListPlaybookVersionsAsync(parent);

// Iterate over all response items, lazily performing RPCs as required
await foreach (PlaybookVersion item in response)
{
    // Do something with each item
    Console.WriteLine(item);
}

// Or iterate over pages (of server-defined size), performing one RPC per page
await foreach (ListPlaybookVersionsResponse page in response.AsRawResponses())
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (PlaybookVersion item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
}

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<PlaybookVersion> singlePage = await response.ReadPageAsync(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (PlaybookVersion item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListPlaybookVersionsAsync(string, string, int?, CallSettings)

public virtual PagedAsyncEnumerable<ListPlaybookVersionsResponse, PlaybookVersion> ListPlaybookVersionsAsync(string parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

Lists versions for the specified Playbook.

Parameters
Name	Description
`parent`	`string` Required. The playbook to list versions for. Format: `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/playbooks/<PlaybookID>`.
`pageToken`	`string` The token returned from the previous request. A value of `null` or an empty string retrieves the first page.
`pageSize`	`int` The size of page to request. The response will not be larger than this, but may be smaller. A value of `null` or `0` uses a server-defined page size.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`PagedAsyncEnumerableListPlaybookVersionsResponsePlaybookVersion`	A pageable asynchronous sequence of PlaybookVersion resources.

Example

// Create client
PlaybooksClient playbooksClient = await PlaybooksClient.CreateAsync();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]/agents/[AGENT]/playbooks/[PLAYBOOK]";
// Make the request
PagedAsyncEnumerable<ListPlaybookVersionsResponse, PlaybookVersion> response = playbooksClient.ListPlaybookVersionsAsync(parent);

// Iterate over all response items, lazily performing RPCs as required
await foreach (PlaybookVersion item in response)
{
    // Do something with each item
    Console.WriteLine(item);
}

// Or iterate over pages (of server-defined size), performing one RPC per page
await foreach (ListPlaybookVersionsResponse page in response.AsRawResponses())
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (PlaybookVersion item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
}

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<PlaybookVersion> singlePage = await response.ReadPageAsync(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (PlaybookVersion item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListPlaybooks(AgentName, string, int?, CallSettings)

public virtual PagedEnumerable<ListPlaybooksResponse, Playbook> ListPlaybooks(AgentName parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

Returns a list of playbooks in the specified agent.

Parameters
Name	Description
`parent`	`AgentName` Required. The agent to list playbooks from. Format: `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>`.
`pageToken`	`string` The token returned from the previous request. A value of `null` or an empty string retrieves the first page.
`pageSize`	`int` The size of page to request. The response will not be larger than this, but may be smaller. A value of `null` or `0` uses a server-defined page size.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`PagedEnumerableListPlaybooksResponsePlaybook`	A pageable sequence of Playbook resources.

Example

// Create client
PlaybooksClient playbooksClient = PlaybooksClient.Create();
// Initialize request argument(s)
AgentName parent = AgentName.FromProjectLocationAgent("[PROJECT]", "[LOCATION]", "[AGENT]");
// Make the request
PagedEnumerable<ListPlaybooksResponse, Playbook> response = playbooksClient.ListPlaybooks(parent);

// Iterate over all response items, lazily performing RPCs as required
foreach (Playbook item in response)
{
    // Do something with each item
    Console.WriteLine(item);
}

// Or iterate over pages (of server-defined size), performing one RPC per page
foreach (ListPlaybooksResponse page in response.AsRawResponses())
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (Playbook item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
}

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<Playbook> singlePage = response.ReadPage(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (Playbook item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListPlaybooks(ListPlaybooksRequest, CallSettings)

public virtual PagedEnumerable<ListPlaybooksResponse, Playbook> ListPlaybooks(ListPlaybooksRequest request, CallSettings callSettings = null)

Returns a list of playbooks in the specified agent.

Parameters
Name	Description
`request`	`ListPlaybooksRequest` The request object containing all of the parameters for the API call.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`PagedEnumerableListPlaybooksResponsePlaybook`	A pageable sequence of Playbook resources.

Example

// Create client
PlaybooksClient playbooksClient = PlaybooksClient.Create();
// Initialize request argument(s)
ListPlaybooksRequest request = new ListPlaybooksRequest
{
    ParentAsAgentName = AgentName.FromProjectLocationAgent("[PROJECT]", "[LOCATION]", "[AGENT]"),
};
// Make the request
PagedEnumerable<ListPlaybooksResponse, Playbook> response = playbooksClient.ListPlaybooks(request);

// Iterate over all response items, lazily performing RPCs as required
foreach (Playbook item in response)
{
    // Do something with each item
    Console.WriteLine(item);
}

// Or iterate over pages (of server-defined size), performing one RPC per page
foreach (ListPlaybooksResponse page in response.AsRawResponses())
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (Playbook item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
}

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<Playbook> singlePage = response.ReadPage(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (Playbook item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListPlaybooks(string, string, int?, CallSettings)

public virtual PagedEnumerable<ListPlaybooksResponse, Playbook> ListPlaybooks(string parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

Returns a list of playbooks in the specified agent.

Parameters
Name	Description
`parent`	`string` Required. The agent to list playbooks from. Format: `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>`.
`pageToken`	`string` The token returned from the previous request. A value of `null` or an empty string retrieves the first page.
`pageSize`	`int` The size of page to request. The response will not be larger than this, but may be smaller. A value of `null` or `0` uses a server-defined page size.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`PagedEnumerableListPlaybooksResponsePlaybook`	A pageable sequence of Playbook resources.

Example

// Create client
PlaybooksClient playbooksClient = PlaybooksClient.Create();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]/agents/[AGENT]";
// Make the request
PagedEnumerable<ListPlaybooksResponse, Playbook> response = playbooksClient.ListPlaybooks(parent);

// Iterate over all response items, lazily performing RPCs as required
foreach (Playbook item in response)
{
    // Do something with each item
    Console.WriteLine(item);
}

// Or iterate over pages (of server-defined size), performing one RPC per page
foreach (ListPlaybooksResponse page in response.AsRawResponses())
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (Playbook item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
}

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<Playbook> singlePage = response.ReadPage(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (Playbook item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListPlaybooksAsync(AgentName, string, int?, CallSettings)

public virtual PagedAsyncEnumerable<ListPlaybooksResponse, Playbook> ListPlaybooksAsync(AgentName parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

Returns a list of playbooks in the specified agent.

Parameters
Name	Description
`parent`	`AgentName` Required. The agent to list playbooks from. Format: `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>`.
`pageToken`	`string` The token returned from the previous request. A value of `null` or an empty string retrieves the first page.
`pageSize`	`int` The size of page to request. The response will not be larger than this, but may be smaller. A value of `null` or `0` uses a server-defined page size.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`PagedAsyncEnumerableListPlaybooksResponsePlaybook`	A pageable asynchronous sequence of Playbook resources.

Example

// Create client
PlaybooksClient playbooksClient = await PlaybooksClient.CreateAsync();
// Initialize request argument(s)
AgentName parent = AgentName.FromProjectLocationAgent("[PROJECT]", "[LOCATION]", "[AGENT]");
// Make the request
PagedAsyncEnumerable<ListPlaybooksResponse, Playbook> response = playbooksClient.ListPlaybooksAsync(parent);

// Iterate over all response items, lazily performing RPCs as required
await foreach (Playbook item in response)
{
    // Do something with each item
    Console.WriteLine(item);
}

// Or iterate over pages (of server-defined size), performing one RPC per page
await foreach (ListPlaybooksResponse page in response.AsRawResponses())
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (Playbook item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
}

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<Playbook> singlePage = await response.ReadPageAsync(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (Playbook item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListPlaybooksAsync(ListPlaybooksRequest, CallSettings)

public virtual PagedAsyncEnumerable<ListPlaybooksResponse, Playbook> ListPlaybooksAsync(ListPlaybooksRequest request, CallSettings callSettings = null)

Returns a list of playbooks in the specified agent.

Parameters
Name	Description
`request`	`ListPlaybooksRequest` The request object containing all of the parameters for the API call.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`PagedAsyncEnumerableListPlaybooksResponsePlaybook`	A pageable asynchronous sequence of Playbook resources.

Example

// Create client
PlaybooksClient playbooksClient = await PlaybooksClient.CreateAsync();
// Initialize request argument(s)
ListPlaybooksRequest request = new ListPlaybooksRequest
{
    ParentAsAgentName = AgentName.FromProjectLocationAgent("[PROJECT]", "[LOCATION]", "[AGENT]"),
};
// Make the request
PagedAsyncEnumerable<ListPlaybooksResponse, Playbook> response = playbooksClient.ListPlaybooksAsync(request);

// Iterate over all response items, lazily performing RPCs as required
await foreach (Playbook item in response)
{
    // Do something with each item
    Console.WriteLine(item);
}

// Or iterate over pages (of server-defined size), performing one RPC per page
await foreach (ListPlaybooksResponse page in response.AsRawResponses())
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (Playbook item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
}

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<Playbook> singlePage = await response.ReadPageAsync(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (Playbook item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListPlaybooksAsync(string, string, int?, CallSettings)

public virtual PagedAsyncEnumerable<ListPlaybooksResponse, Playbook> ListPlaybooksAsync(string parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

Returns a list of playbooks in the specified agent.

Parameters
Name	Description
`parent`	`string` Required. The agent to list playbooks from. Format: `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>`.
`pageToken`	`string` The token returned from the previous request. A value of `null` or an empty string retrieves the first page.
`pageSize`	`int` The size of page to request. The response will not be larger than this, but may be smaller. A value of `null` or `0` uses a server-defined page size.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`PagedAsyncEnumerableListPlaybooksResponsePlaybook`	A pageable asynchronous sequence of Playbook resources.

Example

// Create client
PlaybooksClient playbooksClient = await PlaybooksClient.CreateAsync();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]/agents/[AGENT]";
// Make the request
PagedAsyncEnumerable<ListPlaybooksResponse, Playbook> response = playbooksClient.ListPlaybooksAsync(parent);

// Iterate over all response items, lazily performing RPCs as required
await foreach (Playbook item in response)
{
    // Do something with each item
    Console.WriteLine(item);
}

// Or iterate over pages (of server-defined size), performing one RPC per page
await foreach (ListPlaybooksResponse page in response.AsRawResponses())
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (Playbook item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
}

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<Playbook> singlePage = await response.ReadPageAsync(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (Playbook item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

PollOnceExportPlaybook(string, CallSettings)

public virtual Operation<ExportPlaybookResponse, Struct> PollOnceExportPlaybook(string operationName, CallSettings callSettings = null)

Poll an operation once, using an operationName from a previous invocation of ExportPlaybook.

Parameters
Name	Description
`operationName`	`string` The name of a previously invoked operation. Must not be `null` or empty.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`OperationExportPlaybookResponseStruct`	The result of polling the operation.

PollOnceExportPlaybookAsync(string, CallSettings)

public virtual Task<Operation<ExportPlaybookResponse, Struct>> PollOnceExportPlaybookAsync(string operationName, CallSettings callSettings = null)

Asynchronously poll an operation once, using an operationName from a previous invocation of ExportPlaybook.

Parameters
Name	Description
`operationName`	`string` The name of a previously invoked operation. Must not be `null` or empty.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`TaskOperationExportPlaybookResponseStruct`	A task representing the result of polling the operation.

PollOnceImportPlaybook(string, CallSettings)

public virtual Operation<ImportPlaybookResponse, Struct> PollOnceImportPlaybook(string operationName, CallSettings callSettings = null)

Poll an operation once, using an operationName from a previous invocation of ImportPlaybook.

Parameters
Name	Description
`operationName`	`string` The name of a previously invoked operation. Must not be `null` or empty.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`OperationImportPlaybookResponseStruct`	The result of polling the operation.

PollOnceImportPlaybookAsync(string, CallSettings)

public virtual Task<Operation<ImportPlaybookResponse, Struct>> PollOnceImportPlaybookAsync(string operationName, CallSettings callSettings = null)

Asynchronously poll an operation once, using an operationName from a previous invocation of ImportPlaybook.

Parameters
Name	Description
`operationName`	`string` The name of a previously invoked operation. Must not be `null` or empty.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`TaskOperationImportPlaybookResponseStruct`	A task representing the result of polling the operation.

RestorePlaybookVersion(PlaybookVersionName, CallSettings)

public virtual RestorePlaybookVersionResponse RestorePlaybookVersion(PlaybookVersionName name, CallSettings callSettings = null)

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

Parameters
Name	Description
`name`	`PlaybookVersionName` Required. The name of the playbook version. Format: `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/playbooks/<PlaybookID>/versions/<VersionID>`.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`RestorePlaybookVersionResponse`	The RPC response.

Example

// Create client
PlaybooksClient playbooksClient = PlaybooksClient.Create();
// Initialize request argument(s)
PlaybookVersionName name = PlaybookVersionName.FromProjectLocationAgentPlaybookVersion("[PROJECT]", "[LOCATION]", "[AGENT]", "[PLAYBOOK]", "[VERSION]");
// Make the request
RestorePlaybookVersionResponse response = playbooksClient.RestorePlaybookVersion(name);

RestorePlaybookVersion(RestorePlaybookVersionRequest, CallSettings)

public virtual RestorePlaybookVersionResponse RestorePlaybookVersion(RestorePlaybookVersionRequest request, CallSettings callSettings = null)

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` The request object containing all of the parameters for the API call.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`RestorePlaybookVersionResponse`	The RPC response.

Example

// Create client
PlaybooksClient playbooksClient = PlaybooksClient.Create();
// Initialize request argument(s)
RestorePlaybookVersionRequest request = new RestorePlaybookVersionRequest
{
    PlaybookVersionName = PlaybookVersionName.FromProjectLocationAgentPlaybookVersion("[PROJECT]", "[LOCATION]", "[AGENT]", "[PLAYBOOK]", "[VERSION]"),
};
// Make the request
RestorePlaybookVersionResponse response = playbooksClient.RestorePlaybookVersion(request);

RestorePlaybookVersion(string, CallSettings)

public virtual RestorePlaybookVersionResponse RestorePlaybookVersion(string name, CallSettings callSettings = null)

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

Parameters
Name	Description
`name`	`string` Required. The name of the playbook version. Format: `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/playbooks/<PlaybookID>/versions/<VersionID>`.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`RestorePlaybookVersionResponse`	The RPC response.

Example

// Create client
PlaybooksClient playbooksClient = PlaybooksClient.Create();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/agents/[AGENT]/playbooks/[PLAYBOOK]/versions/[VERSION]";
// Make the request
RestorePlaybookVersionResponse response = playbooksClient.RestorePlaybookVersion(name);

RestorePlaybookVersionAsync(PlaybookVersionName, CallSettings)

public virtual Task<RestorePlaybookVersionResponse> RestorePlaybookVersionAsync(PlaybookVersionName name, CallSettings callSettings = null)

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

Parameters
Name	Description
`name`	`PlaybookVersionName` Required. The name of the playbook version. Format: `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/playbooks/<PlaybookID>/versions/<VersionID>`.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`TaskRestorePlaybookVersionResponse`	A Task containing the RPC response.

Example

// Create client
PlaybooksClient playbooksClient = await PlaybooksClient.CreateAsync();
// Initialize request argument(s)
PlaybookVersionName name = PlaybookVersionName.FromProjectLocationAgentPlaybookVersion("[PROJECT]", "[LOCATION]", "[AGENT]", "[PLAYBOOK]", "[VERSION]");
// Make the request
RestorePlaybookVersionResponse response = await playbooksClient.RestorePlaybookVersionAsync(name);

RestorePlaybookVersionAsync(PlaybookVersionName, CancellationToken)

public virtual Task<RestorePlaybookVersionResponse> RestorePlaybookVersionAsync(PlaybookVersionName name, CancellationToken cancellationToken)

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

Parameters
Name	Description
`name`	`PlaybookVersionName` Required. The name of the playbook version. Format: `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/playbooks/<PlaybookID>/versions/<VersionID>`.
`cancellationToken`	`CancellationToken` A CancellationToken to use for this RPC.

Returns
Type	Description
`TaskRestorePlaybookVersionResponse`	A Task containing the RPC response.

Example

// Create client
PlaybooksClient playbooksClient = await PlaybooksClient.CreateAsync();
// Initialize request argument(s)
PlaybookVersionName name = PlaybookVersionName.FromProjectLocationAgentPlaybookVersion("[PROJECT]", "[LOCATION]", "[AGENT]", "[PLAYBOOK]", "[VERSION]");
// Make the request
RestorePlaybookVersionResponse response = await playbooksClient.RestorePlaybookVersionAsync(name);

RestorePlaybookVersionAsync(RestorePlaybookVersionRequest, CallSettings)

public virtual Task<RestorePlaybookVersionResponse> RestorePlaybookVersionAsync(RestorePlaybookVersionRequest request, CallSettings callSettings = null)

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` The request object containing all of the parameters for the API call.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`TaskRestorePlaybookVersionResponse`	A Task containing the RPC response.

Example

// Create client
PlaybooksClient playbooksClient = await PlaybooksClient.CreateAsync();
// Initialize request argument(s)
RestorePlaybookVersionRequest request = new RestorePlaybookVersionRequest
{
    PlaybookVersionName = PlaybookVersionName.FromProjectLocationAgentPlaybookVersion("[PROJECT]", "[LOCATION]", "[AGENT]", "[PLAYBOOK]", "[VERSION]"),
};
// Make the request
RestorePlaybookVersionResponse response = await playbooksClient.RestorePlaybookVersionAsync(request);

RestorePlaybookVersionAsync(RestorePlaybookVersionRequest, CancellationToken)

public virtual Task<RestorePlaybookVersionResponse> RestorePlaybookVersionAsync(RestorePlaybookVersionRequest request, CancellationToken cancellationToken)

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` The request object containing all of the parameters for the API call.
`cancellationToken`	`CancellationToken` A CancellationToken to use for this RPC.

Returns
Type	Description
`TaskRestorePlaybookVersionResponse`	A Task containing the RPC response.

Example

// Create client
PlaybooksClient playbooksClient = await PlaybooksClient.CreateAsync();
// Initialize request argument(s)
RestorePlaybookVersionRequest request = new RestorePlaybookVersionRequest
{
    PlaybookVersionName = PlaybookVersionName.FromProjectLocationAgentPlaybookVersion("[PROJECT]", "[LOCATION]", "[AGENT]", "[PLAYBOOK]", "[VERSION]"),
};
// Make the request
RestorePlaybookVersionResponse response = await playbooksClient.RestorePlaybookVersionAsync(request);

RestorePlaybookVersionAsync(string, CallSettings)

public virtual Task<RestorePlaybookVersionResponse> RestorePlaybookVersionAsync(string name, CallSettings callSettings = null)

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

Parameters
Name	Description
`name`	`string` Required. The name of the playbook version. Format: `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/playbooks/<PlaybookID>/versions/<VersionID>`.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`TaskRestorePlaybookVersionResponse`	A Task containing the RPC response.

Example

// Create client
PlaybooksClient playbooksClient = await PlaybooksClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/agents/[AGENT]/playbooks/[PLAYBOOK]/versions/[VERSION]";
// Make the request
RestorePlaybookVersionResponse response = await playbooksClient.RestorePlaybookVersionAsync(name);

RestorePlaybookVersionAsync(string, CancellationToken)

public virtual Task<RestorePlaybookVersionResponse> RestorePlaybookVersionAsync(string name, CancellationToken cancellationToken)

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

Parameters
Name	Description
`name`	`string` Required. The name of the playbook version. Format: `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/playbooks/<PlaybookID>/versions/<VersionID>`.
`cancellationToken`	`CancellationToken` A CancellationToken to use for this RPC.

Returns
Type	Description
`TaskRestorePlaybookVersionResponse`	A Task containing the RPC response.

Example

// Create client
PlaybooksClient playbooksClient = await PlaybooksClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/agents/[AGENT]/playbooks/[PLAYBOOK]/versions/[VERSION]";
// Make the request
RestorePlaybookVersionResponse response = await playbooksClient.RestorePlaybookVersionAsync(name);

ShutdownDefaultChannelsAsync()

public static Task ShutdownDefaultChannelsAsync()

Shuts down any channels automatically created by Create() and CreateAsync(CancellationToken). Channels which weren't automatically created are not affected.

Returns
Type	Description
`Task`	A task representing the asynchronous shutdown operation.

Remarks

After calling this method, further calls to Create() and CreateAsync(CancellationToken) will create new channels, which could in turn be shut down by another call to this method.

UpdatePlaybook(Playbook, FieldMask, CallSettings)

public virtual Playbook UpdatePlaybook(Playbook playbook, FieldMask updateMask, CallSettings callSettings = null)

Updates the specified Playbook.

Parameters
Name	Description
`playbook`	`Playbook` Required. The playbook to update.
`updateMask`	`FieldMask` The mask to control which fields get updated. If the mask is not present, all fields will be updated.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`Playbook`	The RPC response.

Example

// Create client
PlaybooksClient playbooksClient = PlaybooksClient.Create();
// Initialize request argument(s)
Playbook playbook = new Playbook();
FieldMask updateMask = new FieldMask();
// Make the request
Playbook response = playbooksClient.UpdatePlaybook(playbook, updateMask);

UpdatePlaybook(UpdatePlaybookRequest, CallSettings)

public virtual Playbook UpdatePlaybook(UpdatePlaybookRequest request, CallSettings callSettings = null)

Updates the specified Playbook.

Parameters
Name	Description
`request`	`UpdatePlaybookRequest` The request object containing all of the parameters for the API call.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`Playbook`	The RPC response.

Example

// Create client
PlaybooksClient playbooksClient = PlaybooksClient.Create();
// Initialize request argument(s)
UpdatePlaybookRequest request = new UpdatePlaybookRequest
{
    Playbook = new Playbook(),
    UpdateMask = new FieldMask(),
};
// Make the request
Playbook response = playbooksClient.UpdatePlaybook(request);

UpdatePlaybookAsync(Playbook, FieldMask, CallSettings)

public virtual Task<Playbook> UpdatePlaybookAsync(Playbook playbook, FieldMask updateMask, CallSettings callSettings = null)

Updates the specified Playbook.

Parameters
Name	Description
`playbook`	`Playbook` Required. The playbook to update.
`updateMask`	`FieldMask` The mask to control which fields get updated. If the mask is not present, all fields will be updated.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`TaskPlaybook`	A Task containing the RPC response.

Example

// Create client
PlaybooksClient playbooksClient = await PlaybooksClient.CreateAsync();
// Initialize request argument(s)
Playbook playbook = new Playbook();
FieldMask updateMask = new FieldMask();
// Make the request
Playbook response = await playbooksClient.UpdatePlaybookAsync(playbook, updateMask);

UpdatePlaybookAsync(Playbook, FieldMask, CancellationToken)

public virtual Task<Playbook> UpdatePlaybookAsync(Playbook playbook, FieldMask updateMask, CancellationToken cancellationToken)

Updates the specified Playbook.

Parameters
Name	Description
`playbook`	`Playbook` Required. The playbook to update.
`updateMask`	`FieldMask` The mask to control which fields get updated. If the mask is not present, all fields will be updated.
`cancellationToken`	`CancellationToken` A CancellationToken to use for this RPC.

Returns
Type	Description
`TaskPlaybook`	A Task containing the RPC response.

Example

// Create client
PlaybooksClient playbooksClient = await PlaybooksClient.CreateAsync();
// Initialize request argument(s)
Playbook playbook = new Playbook();
FieldMask updateMask = new FieldMask();
// Make the request
Playbook response = await playbooksClient.UpdatePlaybookAsync(playbook, updateMask);

UpdatePlaybookAsync(UpdatePlaybookRequest, CallSettings)

public virtual Task<Playbook> UpdatePlaybookAsync(UpdatePlaybookRequest request, CallSettings callSettings = null)

Updates the specified Playbook.

Parameters
Name	Description
`request`	`UpdatePlaybookRequest` The request object containing all of the parameters for the API call.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`TaskPlaybook`	A Task containing the RPC response.

Example

// Create client
PlaybooksClient playbooksClient = await PlaybooksClient.CreateAsync();
// Initialize request argument(s)
UpdatePlaybookRequest request = new UpdatePlaybookRequest
{
    Playbook = new Playbook(),
    UpdateMask = new FieldMask(),
};
// Make the request
Playbook response = await playbooksClient.UpdatePlaybookAsync(request);

UpdatePlaybookAsync(UpdatePlaybookRequest, CancellationToken)

public virtual Task<Playbook> UpdatePlaybookAsync(UpdatePlaybookRequest request, CancellationToken cancellationToken)

Updates the specified Playbook.

Parameters
Name	Description
`request`	`UpdatePlaybookRequest` The request object containing all of the parameters for the API call.
`cancellationToken`	`CancellationToken` A CancellationToken to use for this RPC.

Returns
Type	Description
`TaskPlaybook`	A Task containing the RPC response.

Example

// Create client
PlaybooksClient playbooksClient = await PlaybooksClient.CreateAsync();
// Initialize request argument(s)
UpdatePlaybookRequest request = new UpdatePlaybookRequest
{
    Playbook = new Playbook(),
    UpdateMask = new FieldMask(),
};
// Make the request
Playbook response = await playbooksClient.UpdatePlaybookAsync(request);

Dialogflow v3 API - Class PlaybooksClient (3.0.0) Stay organized with collections Save and categorize content based on your preferences.

Inheritance

Inherited Members

Derived Types

Namespace

Assembly

Remarks

Properties

DefaultEndpoint

DefaultScopes

ExportPlaybookOperationsClient

GrpcClient

ImportPlaybookOperationsClient

LocationsClient

ServiceMetadata

Methods

Create()

CreateAsync(CancellationToken)

CreatePlaybook(AgentName, Playbook, CallSettings)

CreatePlaybook(CreatePlaybookRequest, CallSettings)

CreatePlaybook(string, Playbook, CallSettings)

CreatePlaybookAsync(AgentName, Playbook, CallSettings)

CreatePlaybookAsync(AgentName, Playbook, CancellationToken)

CreatePlaybookAsync(CreatePlaybookRequest, CallSettings)

CreatePlaybookAsync(CreatePlaybookRequest, CancellationToken)

CreatePlaybookAsync(string, Playbook, CallSettings)

CreatePlaybookAsync(string, Playbook, CancellationToken)

CreatePlaybookVersion(CreatePlaybookVersionRequest, CallSettings)

CreatePlaybookVersion(PlaybookName, PlaybookVersion, CallSettings)

CreatePlaybookVersion(string, PlaybookVersion, CallSettings)

CreatePlaybookVersionAsync(CreatePlaybookVersionRequest, CallSettings)

CreatePlaybookVersionAsync(CreatePlaybookVersionRequest, CancellationToken)

CreatePlaybookVersionAsync(PlaybookName, PlaybookVersion, CallSettings)

CreatePlaybookVersionAsync(PlaybookName, PlaybookVersion, CancellationToken)

CreatePlaybookVersionAsync(string, PlaybookVersion, CallSettings)

CreatePlaybookVersionAsync(string, PlaybookVersion, CancellationToken)

DeletePlaybook(DeletePlaybookRequest, CallSettings)

DeletePlaybook(PlaybookName, CallSettings)

DeletePlaybook(string, CallSettings)

DeletePlaybookAsync(DeletePlaybookRequest, CallSettings)

DeletePlaybookAsync(DeletePlaybookRequest, CancellationToken)

DeletePlaybookAsync(PlaybookName, CallSettings)

DeletePlaybookAsync(PlaybookName, CancellationToken)

DeletePlaybookAsync(string, CallSettings)

DeletePlaybookAsync(string, CancellationToken)

DeletePlaybookVersion(DeletePlaybookVersionRequest, CallSettings)

DeletePlaybookVersion(PlaybookVersionName, CallSettings)

DeletePlaybookVersion(string, CallSettings)

DeletePlaybookVersionAsync(DeletePlaybookVersionRequest, CallSettings)

DeletePlaybookVersionAsync(DeletePlaybookVersionRequest, CancellationToken)

DeletePlaybookVersionAsync(PlaybookVersionName, CallSettings)

DeletePlaybookVersionAsync(PlaybookVersionName, CancellationToken)

DeletePlaybookVersionAsync(string, CallSettings)

DeletePlaybookVersionAsync(string, CancellationToken)

ExportPlaybook(ExportPlaybookRequest, CallSettings)

ExportPlaybookAsync(ExportPlaybookRequest, CallSettings)

ExportPlaybookAsync(ExportPlaybookRequest, CancellationToken)

GetPlaybook(GetPlaybookRequest, CallSettings)

GetPlaybook(PlaybookName, CallSettings)

GetPlaybook(string, CallSettings)

GetPlaybookAsync(GetPlaybookRequest, CallSettings)

GetPlaybookAsync(GetPlaybookRequest, CancellationToken)

GetPlaybookAsync(PlaybookName, CallSettings)

GetPlaybookAsync(PlaybookName, CancellationToken)

GetPlaybookAsync(string, CallSettings)

GetPlaybookAsync(string, CancellationToken)

GetPlaybookVersion(GetPlaybookVersionRequest, CallSettings)

GetPlaybookVersion(PlaybookVersionName, CallSettings)

GetPlaybookVersion(string, CallSettings)

GetPlaybookVersionAsync(GetPlaybookVersionRequest, CallSettings)

GetPlaybookVersionAsync(GetPlaybookVersionRequest, CancellationToken)

GetPlaybookVersionAsync(PlaybookVersionName, CallSettings)

GetPlaybookVersionAsync(PlaybookVersionName, CancellationToken)

GetPlaybookVersionAsync(string, CallSettings)

GetPlaybookVersionAsync(string, CancellationToken)

ImportPlaybook(ImportPlaybookRequest, CallSettings)

ImportPlaybookAsync(ImportPlaybookRequest, CallSettings)

ImportPlaybookAsync(ImportPlaybookRequest, CancellationToken)

ListPlaybookVersions(ListPlaybookVersionsRequest, CallSettings)

ListPlaybookVersions(PlaybookName, string, int?, CallSettings)

Dialogflow v3 API - Class PlaybooksClient (3.0.0)