Google Cloud Dialogflow v2 API - Class ConversationDatasetName (4.26.0) 

public sealed class ConversationDatasetName : IResourceName, IEquatable<ConversationDatasetName>

Reference documentation and code samples for the Google Cloud Dialogflow v2 API class ConversationDatasetName.

Resource name for the ConversationDataset resource.

Inheritance

object > ConversationDatasetName

Namespace

Google.Cloud.Dialogflow.V2

Assembly

Google.Cloud.Dialogflow.V2.dll

Constructors

ConversationDatasetName(string, string, string)

public ConversationDatasetName(string projectId, string locationId, string conversationDatasetId)

Constructs a new instance of a ConversationDatasetName class from the component parts of pattern projects/{project}/locations/{location}/conversationDatasets/{conversation_dataset}

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

The ConversationDataset ID. Must not be null or empty.

Properties

ConversationDatasetId

public string ConversationDatasetId { get; }

The ConversationDataset 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

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 ConversationDatasetName.ResourceNameType Type { get; }

The ConversationDatasetName.ResourceNameType of the contained resource name.

Property Value
Type Description
ConversationDatasetNameResourceNameType

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)

public static string Format(string projectId, string locationId, string conversationDatasetId)

Formats the IDs into the string representation of this ConversationDatasetName with pattern projects/{project}/locations/{location}/conversationDatasets/{conversation_dataset}.

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

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

The string representation of this ConversationDatasetName with pattern projects/{project}/locations/{location}/conversationDatasets/{conversation_dataset}.

FormatProjectLocationConversationDataset(string, string, string)

public static string FormatProjectLocationConversationDataset(string projectId, string locationId, string conversationDatasetId)

Formats the IDs into the string representation of this ConversationDatasetName with pattern projects/{project}/locations/{location}/conversationDatasets/{conversation_dataset}.

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

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

The string representation of this ConversationDatasetName with pattern projects/{project}/locations/{location}/conversationDatasets/{conversation_dataset}.

FromProjectLocationConversationDataset(string, string, string)

public static ConversationDatasetName FromProjectLocationConversationDataset(string projectId, string locationId, string conversationDatasetId)

Creates a ConversationDatasetName with the pattern projects/{project}/locations/{location}/conversationDatasets/{conversation_dataset}.

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

The ConversationDataset ID. Must not be null or empty.
Returns
Type Description
ConversationDatasetName

A new instance of ConversationDatasetName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static ConversationDatasetName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a ConversationDatasetName containing an unparsed resource name.

Parameter
Name Description
unparsedResourceName UnparsedResourceName

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

A new instance of ConversationDatasetName 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 ConversationDatasetName Parse(string conversationDatasetName)

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

Parameter
Name Description
conversationDatasetName string

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

The parsed ConversationDatasetName if successful.
Remarks

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

  • projects/{project}/locations/{location}/conversationDatasets/{conversation_dataset}

Parse(string, bool)

public static ConversationDatasetName Parse(string conversationDatasetName, bool allowUnparsed)

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

Parameters
Name Description
conversationDatasetName 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
ConversationDatasetName

The parsed ConversationDatasetName if successful.
Remarks

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

  • projects/{project}/locations/{location}/conversationDatasets/{conversation_dataset}
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 ConversationDatasetName)

public static bool TryParse(string conversationDatasetName, out ConversationDatasetName result)

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

Parameters
Name Description
conversationDatasetName string

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

When this method returns, the parsed ConversationDatasetName, 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}/conversationDatasets/{conversation_dataset}

TryParse(string, bool, out ConversationDatasetName)

public static bool TryParse(string conversationDatasetName, bool allowUnparsed, out ConversationDatasetName result)

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

Parameters
Name Description
conversationDatasetName 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 ConversationDatasetName

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

Operators

operator ==(ConversationDatasetName, ConversationDatasetName)

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

Determines whether two specified resource names have the same value.

Parameters
Name Description
a ConversationDatasetName

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

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

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

Determines whether two specified resource names have different values.

Parameters
Name Description
a ConversationDatasetName

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

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.