Class ConversationModelName

public sealed class ConversationModelName : IResourceName, IEquatable<ConversationModelName>

Resource name for the ConversationModel resource.

Inheritance

Object > ConversationModelName

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
NameDescription
projectIdString

The Project ID. Must not be null or empty.

locationIdString

The Location ID. Must not be null or empty.

conversationModelIdString

The ConversationModel ID. Must not be null or empty.

Properties

ConversationModelId

public string ConversationModelId { get; }

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

Property Value
TypeDescription
String

IsKnownPattern

public bool IsKnownPattern { get; }

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

Property Value
TypeDescription
Boolean

LocationId

public string LocationId { get; }

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

Property Value
TypeDescription
String

ProjectId

public string ProjectId { get; }

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

Property Value
TypeDescription
String

Type

public ConversationModelName.ResourceNameType Type { get; }

The ConversationModelName.ResourceNameType of the contained resource name.

Property Value
TypeDescription
ConversationModelName.ResourceNameType

UnparsedResource

public UnparsedResourceName UnparsedResource { get; }

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

Property Value
TypeDescription
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
NameDescription
projectIdString

The Project ID. Must not be null or empty.

locationIdString

The Location ID. Must not be null or empty.

conversationModelIdString

The ConversationModel ID. Must not be null or empty.

Returns
TypeDescription
String

The string representation of this ConversationModelName with pattern projects/{project}/locations/{location}/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
NameDescription
projectIdString

The Project ID. Must not be null or empty.

locationIdString

The Location ID. Must not be null or empty.

conversationModelIdString

The ConversationModel ID. Must not be null or empty.

Returns
TypeDescription
String

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

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
NameDescription
projectIdString

The Project ID. Must not be null or empty.

locationIdString

The Location ID. Must not be null or empty.

conversationModelIdString

The ConversationModel ID. Must not be null or empty.

Returns
TypeDescription
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
NameDescription
unparsedResourceNameUnparsedResourceName

The unparsed resource name. Must not be null.

Returns
TypeDescription
ConversationModelName

A new instance of ConversationModelName containing the provided unparsedResourceName.

GetHashCode()

public override int GetHashCode()

Returns a hash code for this resource name.

Returns
TypeDescription
Int32
Overrides

Parse(String)

public static ConversationModelName Parse(string conversationModelName)

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

Parameter
NameDescription
conversationModelNameString

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

Returns
TypeDescription
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}

Parse(String, Boolean)

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
NameDescription
conversationModelNameString

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

allowUnparsedBoolean

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
TypeDescription
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}
Or may be in any format if allowUnparsed is true.

ToString()

public override string ToString()

The string representation of the resource name.

Returns
TypeDescription
String

The string representation of the resource name.

Overrides

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
NameDescription
conversationModelNameString

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

resultConversationModelName

When this method returns, the parsed ConversationModelName, or null if parsing failed.

Returns
TypeDescription
Boolean

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}

TryParse(String, Boolean, 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
NameDescription
conversationModelNameString

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

allowUnparsedBoolean

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.

resultConversationModelName

When this method returns, the parsed ConversationModelName, or null if parsing failed.

Returns
TypeDescription
Boolean

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}
Or may be in any format if allowUnparsed is true.

Operators

Equality(ConversationModelName, ConversationModelName)

public static bool operator ==(ConversationModelName a, ConversationModelName b)
Parameters
NameDescription
aConversationModelName
bConversationModelName
Returns
TypeDescription
Boolean

Inequality(ConversationModelName, ConversationModelName)

public static bool operator !=(ConversationModelName a, ConversationModelName b)
Parameters
NameDescription
aConversationModelName
bConversationModelName
Returns
TypeDescription
Boolean