Dialogflow v3 API - Class PlaybookName (3.0.0)

Version latest

• 3.0.0 (latest)
• 2.25.0
• 2.24.0
• 2.23.0
• 2.22.0
• 2.21.0
• 2.20.0
• 2.19.0
• 2.18.0
• 2.17.0
• 2.16.0
• 2.15.0
• 2.14.0
• 2.13.0
• 2.12.0
• 2.11.0
• 2.10.0
• 2.9.0
• 2.8.0
• 2.7.0
• 2.6.0
• 2.5.0
• 2.4.0
• 2.3.0
• 2.2.0
• 2.1.0
• 2.0.0
• 1.13.0
• 1.12.0
• 1.11.0
• 1.10.0
• 1.9.0
• 1.8.0
• 1.7.0
• 1.6.0
• 1.5.0
• 1.4.0
• 1.3.0
• 1.2.0
• 1.1.0
• 1.0.0

public sealed class PlaybookName : IResourceName, IEquatable<PlaybookName>

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

Resource name for the Playbook resource.

Inheritance

object > PlaybookName

Implements

IResourceName, IEquatablePlaybookName

Inherited Members

object.GetType()

Namespace

Google.Cloud.Dialogflow.Cx.V3

Assembly

Google.Cloud.Dialogflow.Cx.V3.dll

Constructors

PlaybookName(string, string, string, string)

public PlaybookName(string projectId, string locationId, string agentId, string playbookId)

Constructs a new instance of a PlaybookName class from the component parts of pattern projects/{project}/locations/{location}/agents/{agent}/playbooks/{playbook}

Parameters
Name	Description
projectId	string The Project ID. Must not be null or empty.
locationId	string The Location ID. Must not be null or empty.
agentId	string The Agent ID. Must not be null or empty.
playbookId	string The Playbook ID. Must not be null or empty.

Properties

AgentId

public string AgentId { get; }

The Agent ID. Will not be null, unless this instance contains an unparsed resource name.

Property Value
Type	Description
string

IsKnownPattern

public bool IsKnownPattern { get; }

Whether this instance contains a resource name with a known pattern.

Property Value
Type	Description
bool

LocationId

public string LocationId { get; }

The Location ID. Will not be null, unless this instance contains an unparsed resource name.

Property Value
Type	Description
string

PlaybookId

public string PlaybookId { get; }

The Playbook ID. Will not be null, unless this instance contains an unparsed resource name.

Property Value
Type	Description
string

ProjectId

public string ProjectId { get; }

The Project ID. Will not be null, unless this instance contains an unparsed resource name.

Property Value
Type	Description
string

Type

public PlaybookName.ResourceNameType Type { get; }

The PlaybookName.ResourceNameType of the contained resource name.

Property Value
Type	Description
PlaybookNameResourceNameType

UnparsedResource

public UnparsedResourceName UnparsedResource { get; }

The contained UnparsedResourceName. Only non-null if this instance contains an unparsed resource name.

Property Value
Type	Description
UnparsedResourceName

Methods

Format(string, string, string, string)

public static string Format(string projectId, string locationId, string agentId, string playbookId)

Formats the IDs into the string representation of this PlaybookName with pattern projects/{project}/locations/{location}/agents/{agent}/playbooks/{playbook}.

Parameters
Name	Description
projectId	string The Project ID. Must not be null or empty.
locationId	string The Location ID. Must not be null or empty.
agentId	string The Agent ID. Must not be null or empty.
playbookId	string The Playbook ID. Must not be null or empty.

Returns
Type	Description
string	The string representation of this PlaybookName with pattern projects/{project}/locations/{location}/agents/{agent}/playbooks/{playbook}.

FormatProjectLocationAgentPlaybook(string, string, string, string)

public static string FormatProjectLocationAgentPlaybook(string projectId, string locationId, string agentId, string playbookId)

Formats the IDs into the string representation of this PlaybookName with pattern projects/{project}/locations/{location}/agents/{agent}/playbooks/{playbook}.

Parameters
Name	Description
projectId	string The Project ID. Must not be null or empty.
locationId	string The Location ID. Must not be null or empty.
agentId	string The Agent ID. Must not be null or empty.
playbookId	string The Playbook ID. Must not be null or empty.

Returns
Type	Description
string	The string representation of this PlaybookName with pattern projects/{project}/locations/{location}/agents/{agent}/playbooks/{playbook}.

FromProjectLocationAgentPlaybook(string, string, string, string)

public static PlaybookName FromProjectLocationAgentPlaybook(string projectId, string locationId, string agentId, string playbookId)

Creates a PlaybookName with the pattern projects/{project}/locations/{location}/agents/{agent}/playbooks/{playbook}.

Parameters
Name	Description
projectId	string The Project ID. Must not be null or empty.
locationId	string The Location ID. Must not be null or empty.
agentId	string The Agent ID. Must not be null or empty.
playbookId	string The Playbook ID. Must not be null or empty.

Returns
Type	Description
PlaybookName	A new instance of PlaybookName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static PlaybookName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a PlaybookName containing an unparsed resource name.

Parameter
Name	Description
unparsedResourceName	UnparsedResourceName The unparsed resource name. Must not be null.

Returns
Type	Description
PlaybookName	A new instance of PlaybookName containing the provided unparsedResourceName .

GetHashCode()

public override int GetHashCode()

Returns a hash code for this resource name.

Returns
Type	Description
int

Overrides

object.GetHashCode()

Parse(string)

public static PlaybookName Parse(string playbookName)

Parses the given resource name string into a new PlaybookName instance.

Parameter
Name	Description
playbookName	string The resource name in string form. Must not be null.

Returns
Type	Description
PlaybookName	The parsed PlaybookName if successful.

Remarks

To parse successfully, the resource name must be formatted as one of the following:

• projects/{project}/locations/{location}/agents/{agent}/playbooks/{playbook}

Parse(string, bool)

public static PlaybookName Parse(string playbookName, bool allowUnparsed)

Parses the given resource name string into a new PlaybookName instance; optionally allowing an unparseable resource name.

Parameters
Name	Description
playbookName	string The resource name in string form. Must not be null.
allowUnparsed	bool If true will successfully store an unparseable resource name into the UnparsedResource property; otherwise will throw an ArgumentException if an unparseable resource name is specified.

Returns
Type	Description
PlaybookName	The parsed PlaybookName if successful.

Remarks

To parse successfully, the resource name must be formatted as one of the following:

• projects/{project}/locations/{location}/agents/{agent}/playbooks/{playbook}

Or may be in any format if allowUnparsed is true.

ToString()

public override string ToString()

The string representation of the resource name.

Returns
Type	Description
string	The string representation of the resource name.

Overrides

object.ToString()

TryParse(string, out PlaybookName)

public static bool TryParse(string playbookName, out PlaybookName result)

Tries to parse the given resource name string into a new PlaybookName instance.

Parameters
Name	Description
playbookName	string The resource name in string form. Must not be null.
result	PlaybookName When this method returns, the parsed PlaybookName, or null if parsing failed.

Returns
Type	Description
bool	true if the name was parsed successfully; false otherwise.

Remarks

To parse successfully, the resource name must be formatted as one of the following:

• projects/{project}/locations/{location}/agents/{agent}/playbooks/{playbook}

TryParse(string, bool, out PlaybookName)

public static bool TryParse(string playbookName, bool allowUnparsed, out PlaybookName result)

Tries to parse the given resource name string into a new PlaybookName instance; optionally allowing an unparseable resource name.

Parameters
Name	Description
playbookName	string The resource name in string form. Must not be null.
allowUnparsed	bool If true will successfully store an unparseable resource name into the UnparsedResource property; otherwise will throw an ArgumentException if an unparseable resource name is specified.
result	PlaybookName When this method returns, the parsed PlaybookName, or null if parsing failed.

Returns
Type	Description
bool	true if the name was parsed successfully; false otherwise.

Remarks

To parse successfully, the resource name must be formatted as one of the following:

• projects/{project}/locations/{location}/agents/{agent}/playbooks/{playbook}

Or may be in any format if allowUnparsed is true.

Operators

operator ==(PlaybookName, PlaybookName)

public static bool operator ==(PlaybookName a, PlaybookName b)

Determines whether two specified resource names have the same value.

Parameters
Name	Description
a	PlaybookName The first resource name to compare, or null.
b	PlaybookName The second resource name to compare, or null.

Returns
Type	Description
bool	true if the value of a is the same as the value of b; otherwise, false.

operator !=(PlaybookName, PlaybookName)

public static bool operator !=(PlaybookName a, PlaybookName b)

Determines whether two specified resource names have different values.

Parameters
Name	Description
a	PlaybookName The first resource name to compare, or null.
b	PlaybookName The second resource name to compare, or null.

Returns
Type	Description
bool	true if the value of a is different from the value of b; otherwise, false.