Google Cloud Dialogflow v2 API - Class ConversationModelName (4.19.0)

public sealed class ConversationModelName : IResourceName, IEquatable<ConversationModelName>

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

Resource name for the ConversationModel resource.

Inheritance

object > ConversationModelName

Implements

IResourceName, IEquatable ConversationModelName

Inherited Members

object.GetType()

Namespace

Google.Cloud.Dialogflow.V2

Assembly

Google.Cloud.Dialogflow.V2.dll

Constructors

ConversationModelName(string, string, string)

public ConversationModelName(string projectId, string locationId, string conversationModelId)

Constructs a new instance of a ConversationModelName class from the component parts of pattern projects/{project}/locations/{location}/conversationModels/{conversation_model}

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.
`conversationModelId`	`string` The `ConversationModel` ID. Must not be `null` or empty.

Properties

ConversationModelId

public string ConversationModelId { get; }

The ConversationModel ID. May be null, depending on which resource name is contained by this instance.

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. May be null, depending on which resource name is contained by this instance.

Property Value
Type	Description
`string`

ProjectId

public string ProjectId { get; }

The Project ID. May be null, depending on which resource name is contained by this instance.

Property Value
Type	Description
`string`

Type

public ConversationModelName.ResourceNameType Type { get; }

The ConversationModelName.ResourceNameType of the contained resource name.

Property Value
Type	Description
`ConversationModelNameResourceNameType`

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 conversationModelId)

Formats the IDs into the string representation of this ConversationModelName with pattern projects/{project}/locations/{location}/conversationModels/{conversation_model}.

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.
`conversationModelId`	`string` The `ConversationModel` ID. Must not be `null` or empty.

Returns
Type	Description
`string`	The string representation of this ConversationModelName with pattern `projects/{project}/locations/{location}/conversationModels/{conversation_model}`.

FormatProjectConversationModel(string, string)

public static string FormatProjectConversationModel(string projectId, string conversationModelId)

Formats the IDs into the string representation of this ConversationModelName with pattern projects/{project}/conversationModels/{conversation_model}.

Parameters
Name	Description
`projectId`	`string` The `Project` ID. Must not be `null` or empty.
`conversationModelId`	`string` The `ConversationModel` ID. Must not be `null` or empty.

Returns
Type	Description
`string`	The string representation of this ConversationModelName with pattern `projects/{project}/conversationModels/{conversation_model}`.

FormatProjectLocationConversationModel(string, string, string)

public static string FormatProjectLocationConversationModel(string projectId, string locationId, string conversationModelId)

Formats the IDs into the string representation of this ConversationModelName with pattern projects/{project}/locations/{location}/conversationModels/{conversation_model}.

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.
`conversationModelId`	`string` The `ConversationModel` ID. Must not be `null` or empty.

Returns
Type	Description
`string`	The string representation of this ConversationModelName with pattern `projects/{project}/locations/{location}/conversationModels/{conversation_model}`.

FromProjectConversationModel(string, string)

public static ConversationModelName FromProjectConversationModel(string projectId, string conversationModelId)

Creates a ConversationModelName with the pattern projects/{project}/conversationModels/{conversation_model}.

Parameters
Name	Description
`projectId`	`string` The `Project` ID. Must not be `null` or empty.
`conversationModelId`	`string` The `ConversationModel` ID. Must not be `null` or empty.

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

FromProjectLocationConversationModel(string, string, string)

public static ConversationModelName FromProjectLocationConversationModel(string projectId, string locationId, string conversationModelId)

Creates a ConversationModelName with the pattern projects/{project}/locations/{location}/conversationModels/{conversation_model}.

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.
`conversationModelId`	`string` The `ConversationModel` ID. Must not be `null` or empty.

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

FromUnparsed(UnparsedResourceName)

public static ConversationModelName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a ConversationModelName containing an unparsed resource name.

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

Returns
Type	Description
`ConversationModelName`	A new instance of ConversationModelName 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 ConversationModelName Parse(string conversationModelName)

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

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

Returns
Type	Description
`ConversationModelName`	The parsed ConversationModelName if successful.

Remarks

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

projects/{project}/locations/{location}/conversationModels/{conversation_model}
projects/{project}/conversationModels/{conversation_model}

Parse(string, bool)

public static ConversationModelName Parse(string conversationModelName, bool allowUnparsed)

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

Parameters
Name	Description
`conversationModelName`	`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
`ConversationModelName`	The parsed ConversationModelName if successful.

Remarks

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

projects/{project}/locations/{location}/conversationModels/{conversation_model}
projects/{project}/conversationModels/{conversation_model}

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 ConversationModelName)

public static bool TryParse(string conversationModelName, out ConversationModelName result)

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

Parameters
Name	Description
`conversationModelName`	`string` The resource name in string form. Must not be `null`.
`result`	`ConversationModelName` When this method returns, the parsed ConversationModelName, 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}/conversationModels/{conversation_model}
projects/{project}/conversationModels/{conversation_model}

TryParse(string, bool, out ConversationModelName)

public static bool TryParse(string conversationModelName, bool allowUnparsed, out ConversationModelName result)

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

Parameters
Name	Description
`conversationModelName`	`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`	`ConversationModelName` When this method returns, the parsed ConversationModelName, 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}/conversationModels/{conversation_model}
projects/{project}/conversationModels/{conversation_model}

Or may be in any format if allowUnparsed is true.

Operators

operator ==(ConversationModelName, ConversationModelName)

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

Determines whether two specified resource names have the same value.

Parameters
Name	Description
`a`	`ConversationModelName` The first resource name to compare, or null.
`b`	`ConversationModelName` 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 !=(ConversationModelName, ConversationModelName)

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

Determines whether two specified resource names have different values.

Parameters
Name	Description
`a`	`ConversationModelName` The first resource name to compare, or null.
`b`	`ConversationModelName` 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.