Google Cloud Dialogflow v2 API - Class MessageName (4.18.0)

public sealed class MessageName : IResourceName, IEquatable<MessageName>

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

Resource name for the Message resource.

Inheritance

object > MessageName

Implements

IResourceName, IEquatable MessageName

Inherited Members

object.GetType()

Namespace

Google.Cloud.Dialogflow.V2

Assembly

Google.Cloud.Dialogflow.V2.dll

Constructors

MessageName(string, string, string)

public MessageName(string projectId, string conversationId, string messageId)

Constructs a new instance of a MessageName class from the component parts of pattern projects/{project}/conversations/{conversation}/messages/{message}

Parameters
Name	Description
`projectId`	`string` The `Project` ID. Must not be `null` or empty.
`conversationId`	`string` The `Conversation` ID. Must not be `null` or empty.
`messageId`	`string` The `Message` ID. Must not be `null` or empty.

Properties

ConversationId

public string ConversationId { get; }

The Conversation 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`

MessageId

public string MessageId { get; }

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

The MessageName.ResourceNameType of the contained resource name.

Property Value
Type	Description
`MessageNameResourceNameType`

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 conversationId, string messageId)

Formats the IDs into the string representation of this MessageName with pattern projects/{project}/conversations/{conversation}/messages/{message}.

Parameters
Name	Description
`projectId`	`string` The `Project` ID. Must not be `null` or empty.
`conversationId`	`string` The `Conversation` ID. Must not be `null` or empty.
`messageId`	`string` The `Message` ID. Must not be `null` or empty.

Returns
Type	Description
`string`	The string representation of this MessageName with pattern `projects/{project}/conversations/{conversation}/messages/{message}`.

FormatProjectConversationMessage(string, string, string)

public static string FormatProjectConversationMessage(string projectId, string conversationId, string messageId)

Formats the IDs into the string representation of this MessageName with pattern projects/{project}/conversations/{conversation}/messages/{message}.

Parameters
Name	Description
`projectId`	`string` The `Project` ID. Must not be `null` or empty.
`conversationId`	`string` The `Conversation` ID. Must not be `null` or empty.
`messageId`	`string` The `Message` ID. Must not be `null` or empty.

Returns
Type	Description
`string`	The string representation of this MessageName with pattern `projects/{project}/conversations/{conversation}/messages/{message}`.

FormatProjectLocationConversationMessage(string, string, string, string)

public static string FormatProjectLocationConversationMessage(string projectId, string locationId, string conversationId, string messageId)

Formats the IDs into the string representation of this MessageName with pattern projects/{project}/locations/{location}/conversations/{conversation}/messages/{message}.

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.
`conversationId`	`string` The `Conversation` ID. Must not be `null` or empty.
`messageId`	`string` The `Message` ID. Must not be `null` or empty.

Returns
Type	Description
`string`	The string representation of this MessageName with pattern `projects/{project}/locations/{location}/conversations/{conversation}/messages/{message}`.

FromProjectConversationMessage(string, string, string)

public static MessageName FromProjectConversationMessage(string projectId, string conversationId, string messageId)

Creates a MessageName with the pattern projects/{project}/conversations/{conversation}/messages/{message}.

Parameters
Name	Description
`projectId`	`string` The `Project` ID. Must not be `null` or empty.
`conversationId`	`string` The `Conversation` ID. Must not be `null` or empty.
`messageId`	`string` The `Message` ID. Must not be `null` or empty.

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

FromProjectLocationConversationMessage(string, string, string, string)

public static MessageName FromProjectLocationConversationMessage(string projectId, string locationId, string conversationId, string messageId)

Creates a MessageName with the pattern projects/{project}/locations/{location}/conversations/{conversation}/messages/{message}.

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.
`conversationId`	`string` The `Conversation` ID. Must not be `null` or empty.
`messageId`	`string` The `Message` ID. Must not be `null` or empty.

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

FromUnparsed(UnparsedResourceName)

public static MessageName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a MessageName containing an unparsed resource name.

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

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

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

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

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

Remarks

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

projects/{project}/conversations/{conversation}/messages/{message}
projects/{project}/locations/{location}/conversations/{conversation}/messages/{message}

Parse(string, bool)

public static MessageName Parse(string messageName, bool allowUnparsed)

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

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

Remarks

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

projects/{project}/conversations/{conversation}/messages/{message}
projects/{project}/locations/{location}/conversations/{conversation}/messages/{message}

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

public static bool TryParse(string messageName, out MessageName result)

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

Parameters
Name	Description
`messageName`	`string` The resource name in string form. Must not be `null`.
`result`	`MessageName` When this method returns, the parsed MessageName, 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}/conversations/{conversation}/messages/{message}
projects/{project}/locations/{location}/conversations/{conversation}/messages/{message}

TryParse(string, bool, out MessageName)

public static bool TryParse(string messageName, bool allowUnparsed, out MessageName result)

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

Parameters
Name	Description
`messageName`	`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`	`MessageName` When this method returns, the parsed MessageName, 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}/conversations/{conversation}/messages/{message}
projects/{project}/locations/{location}/conversations/{conversation}/messages/{message}

Or may be in any format if allowUnparsed is true.

Operators

operator ==(MessageName, MessageName)

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

Determines whether two specified resource names have the same value.

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

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

Determines whether two specified resource names have different values.

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