Class MessageName

public sealed class MessageName : IResourceName, IEquatable<MessageName>

Resource name for the Message resource.

Inheritance

Object > MessageName

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

The Project ID. Must not be null or empty.

conversationIdString

The Conversation ID. Must not be null or empty.

messageIdString

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

Property Value
TypeDescription
String

MessageId

public string MessageId { get; }

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

Property Value
TypeDescription
String

ProjectId

public string ProjectId { get; }

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

Property Value
TypeDescription
String

Type

public MessageName.ResourceNameType Type { get; }

The MessageName.ResourceNameType of the contained resource name.

Property Value
TypeDescription
MessageName.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 conversationId, string messageId)

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

Parameters
NameDescription
projectIdString

The Project ID. Must not be null or empty.

conversationIdString

The Conversation ID. Must not be null or empty.

messageIdString

The Message ID. Must not be null or empty.

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

The Project ID. Must not be null or empty.

conversationIdString

The Conversation ID. Must not be null or empty.

messageIdString

The Message ID. Must not be null or empty.

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

The Project ID. Must not be null or empty.

locationIdString

The Location ID. Must not be null or empty.

conversationIdString

The Conversation ID. Must not be null or empty.

messageIdString

The Message ID. Must not be null or empty.

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

The Project ID. Must not be null or empty.

conversationIdString

The Conversation ID. Must not be null or empty.

messageIdString

The Message ID. Must not be null or empty.

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

The Project ID. Must not be null or empty.

locationIdString

The Location ID. Must not be null or empty.

conversationIdString

The Conversation ID. Must not be null or empty.

messageIdString

The Message ID. Must not be null or empty.

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

The unparsed resource name. Must not be null.

Returns
TypeDescription
MessageName

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

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

Parameter
NameDescription
messageNameString

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

Returns
TypeDescription
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, Boolean)

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

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
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
TypeDescription
String

The string representation of the resource name.

Overrides

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

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

resultMessageName

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

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

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.

resultMessageName

When this method returns, the parsed MessageName, 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}/conversations/{conversation}/messages/{message}
  • projects/{project}/locations/{location}/conversations/{conversation}/messages/{message}
Or may be in any format if allowUnparsed is true.

Operators

Equality(MessageName, MessageName)

public static bool operator ==(MessageName a, MessageName b)
Parameters
NameDescription
aMessageName
bMessageName
Returns
TypeDescription
Boolean

Inequality(MessageName, MessageName)

public static bool operator !=(MessageName a, MessageName b)
Parameters
NameDescription
aMessageName
bMessageName
Returns
TypeDescription
Boolean