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.
Namespace
Google.Cloud.Dialogflow.V2Assembly
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 |
conversationId | string The |
messageId | string The |
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 |
conversationId | string The |
messageId | string The |
Returns | |
---|---|
Type | Description |
string | The string representation of this MessageName with pattern
|
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 |
conversationId | string The |
messageId | string The |
Returns | |
---|---|
Type | Description |
string | The string representation of this MessageName with pattern
|
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 |
locationId | string The |
conversationId | string The |
messageId | string The |
Returns | |
---|---|
Type | Description |
string | The string representation of this MessageName with pattern
|
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 |
conversationId | string The |
messageId | string The |
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 |
locationId | string The |
conversationId | string The |
messageId | string The |
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 |
Returns | |
---|---|
Type | Description |
MessageName | A new instance of MessageName containing the provided |
GetHashCode()
public override int GetHashCode()
Returns a hash code for this resource name.
Returns | |
---|---|
Type | Description |
int |
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 |
Returns | |
---|---|
Type | Description |
MessageName | The parsed MessageName if successful. |
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 |
allowUnparsed | bool If |
Returns | |
---|---|
Type | Description |
MessageName | The parsed MessageName if successful. |
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}
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. |
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 |
result | MessageName When this method returns, the parsed MessageName, or |
Returns | |
---|---|
Type | Description |
bool |
|
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 |
allowUnparsed | bool If |
result | MessageName When this method returns, the parsed MessageName, or |
Returns | |
---|---|
Type | Description |
bool |
|
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}
allowUnparsed
is true
.
Operators
operator ==(MessageName, MessageName)
public static bool operator ==(MessageName a, MessageName b)
Parameters | |
---|---|
Name | Description |
a | MessageName |
b | MessageName |
Returns | |
---|---|
Type | Description |
bool |
operator !=(MessageName, MessageName)
public static bool operator !=(MessageName a, MessageName b)
Parameters | |
---|---|
Name | Description |
a | MessageName |
b | MessageName |
Returns | |
---|---|
Type | Description |
bool |