public sealed class MessageName : IResourceName, IEquatable<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 |
Boolean |
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 |
MessageName.ResourceNameType |
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 |
Int32 |
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, 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 | |
---|---|
Name | Description |
messageName | String The resource name in string form. Must not be |
allowUnparsed | Boolean 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 |
Boolean |
|
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 | |
---|---|
Name | Description |
messageName | String The resource name in string form. Must not be |
allowUnparsed | Boolean If |
result | MessageName When this method returns, the parsed MessageName, or |
Returns | |
---|---|
Type | Description |
Boolean |
|
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
Equality(MessageName, MessageName)
public static bool operator ==(MessageName a, MessageName b)
Parameters | |
---|---|
Name | Description |
a | MessageName |
b | MessageName |
Returns | |
---|---|
Type | Description |
Boolean |
Inequality(MessageName, MessageName)
public static bool operator !=(MessageName a, MessageName b)
Parameters | |
---|---|
Name | Description |
a | MessageName |
b | MessageName |
Returns | |
---|---|
Type | Description |
Boolean |