Dialogflow v3 API - Class PlaybookVersionName (3.0.0) 

public sealed class PlaybookVersionName : IResourceName, IEquatable<PlaybookVersionName>

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

Resource name for the PlaybookVersion resource.

Inheritance

object > PlaybookVersionName

Namespace

Google.Cloud.Dialogflow.Cx.V3

Assembly

Google.Cloud.Dialogflow.Cx.V3.dll

Constructors

PlaybookVersionName(string, string, string, string, string)

public PlaybookVersionName(string projectId, string locationId, string agentId, string playbookId, string versionId)

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

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.
versionId string

The Version 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 PlaybookVersionName.ResourceNameType Type { get; }

The PlaybookVersionName.ResourceNameType of the contained resource name.

Property Value
Type Description
PlaybookVersionNameResourceNameType

UnparsedResource

public UnparsedResourceName UnparsedResource { get; }

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

Property Value
Type Description
UnparsedResourceName

VersionId

public string VersionId { get; }

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

Property Value
Type Description
string

Methods

Format(string, string, string, string, string)

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

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

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.
versionId string

The Version ID. Must not be null or empty.
Returns
Type Description
string

The string representation of this PlaybookVersionName with pattern projects/{project}/locations/{location}/agents/{agent}/playbooks/{playbook}/versions/{version}.

FormatProjectLocationAgentPlaybookVersion(string, string, string, string, string)

public static string FormatProjectLocationAgentPlaybookVersion(string projectId, string locationId, string agentId, string playbookId, string versionId)

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

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.
versionId string

The Version ID. Must not be null or empty.
Returns
Type Description
string

The string representation of this PlaybookVersionName with pattern projects/{project}/locations/{location}/agents/{agent}/playbooks/{playbook}/versions/{version}.

FromProjectLocationAgentPlaybookVersion(string, string, string, string, string)

public static PlaybookVersionName FromProjectLocationAgentPlaybookVersion(string projectId, string locationId, string agentId, string playbookId, string versionId)

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

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.
versionId string

The Version ID. Must not be null or empty.
Returns
Type Description
PlaybookVersionName

A new instance of PlaybookVersionName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static PlaybookVersionName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a PlaybookVersionName containing an unparsed resource name.

Parameter
Name Description
unparsedResourceName UnparsedResourceName

The unparsed resource name. Must not be null.
Returns
Type Description
PlaybookVersionName

A new instance of PlaybookVersionName containing the provided unparsedResourceName.

GetHashCode()

public override int GetHashCode()

Returns a hash code for this resource name.

Returns
Type Description
int
Overrides

Parse(string)

public static PlaybookVersionName Parse(string playbookVersionName)

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

Parameter
Name Description
playbookVersionName string

The resource name in string form. Must not be null.
Returns
Type Description
PlaybookVersionName

The parsed PlaybookVersionName 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}/versions/{version}

Parse(string, bool)

public static PlaybookVersionName Parse(string playbookVersionName, bool allowUnparsed)

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

Parameters
Name Description
playbookVersionName 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
PlaybookVersionName

The parsed PlaybookVersionName 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}/versions/{version}
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

TryParse(string, out PlaybookVersionName)

public static bool TryParse(string playbookVersionName, out PlaybookVersionName result)

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

Parameters
Name Description
playbookVersionName string

The resource name in string form. Must not be null.
result PlaybookVersionName

When this method returns, the parsed PlaybookVersionName, 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}/versions/{version}

TryParse(string, bool, out PlaybookVersionName)

public static bool TryParse(string playbookVersionName, bool allowUnparsed, out PlaybookVersionName result)

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

Parameters
Name Description
playbookVersionName 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 PlaybookVersionName

When this method returns, the parsed PlaybookVersionName, 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}/versions/{version}
Or may be in any format if allowUnparsed is true.

Operators

operator ==(PlaybookVersionName, PlaybookVersionName)

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

Determines whether two specified resource names have the same value.

Parameters
Name Description
a PlaybookVersionName

The first resource name to compare, or null.
b PlaybookVersionName

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 !=(PlaybookVersionName, PlaybookVersionName)

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

Determines whether two specified resource names have different values.

Parameters
Name Description
a PlaybookVersionName

The first resource name to compare, or null.
b PlaybookVersionName

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.