Class ParticipantName (4.0.0) 

public sealed class ParticipantName : IResourceName, IEquatable<ParticipantName>

Resource name for the Participant resource.

Inheritance

System.Object > ParticipantName

Namespace

Google.Cloud.Dialogflow.V2

Assembly

Google.Cloud.Dialogflow.V2.dll

Constructors

ParticipantName(String, String, String)

public ParticipantName(string projectId, string conversationId, string participantId)

Constructs a new instance of a ParticipantName class from the component parts of pattern projects/{project}/conversations/{conversation}/participants/{participant}

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.
participantId String

The Participant 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
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

ParticipantId

public string ParticipantId { get; }

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

The ParticipantName.ResourceNameType of the contained resource name.

Property Value
Type Description
ParticipantName.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 participantId)

Formats the IDs into the string representation of this ParticipantName with pattern projects/{project}/conversations/{conversation}/participants/{participant}.

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.
participantId String

The Participant ID. Must not be null or empty.
Returns
Type Description
String

The string representation of this ParticipantName with pattern projects/{project}/conversations/{conversation}/participants/{participant}.

FormatProjectConversationParticipant(String, String, String)

public static string FormatProjectConversationParticipant(string projectId, string conversationId, string participantId)

Formats the IDs into the string representation of this ParticipantName with pattern projects/{project}/conversations/{conversation}/participants/{participant}.

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.
participantId String

The Participant ID. Must not be null or empty.
Returns
Type Description
String

The string representation of this ParticipantName with pattern projects/{project}/conversations/{conversation}/participants/{participant}.

FormatProjectLocationConversationParticipant(String, String, String, String)

public static string FormatProjectLocationConversationParticipant(string projectId, string locationId, string conversationId, string participantId)

Formats the IDs into the string representation of this ParticipantName with pattern projects/{project}/locations/{location}/conversations/{conversation}/participants/{participant}.

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.
participantId String

The Participant ID. Must not be null or empty.
Returns
Type Description
String

The string representation of this ParticipantName with pattern projects/{project}/locations/{location}/conversations/{conversation}/participants/{participant}.

FromProjectConversationParticipant(String, String, String)

public static ParticipantName FromProjectConversationParticipant(string projectId, string conversationId, string participantId)

Creates a ParticipantName with the pattern projects/{project}/conversations/{conversation}/participants/{participant}.

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.
participantId String

The Participant ID. Must not be null or empty.
Returns
Type Description
ParticipantName

A new instance of ParticipantName constructed from the provided ids.

FromProjectLocationConversationParticipant(String, String, String, String)

public static ParticipantName FromProjectLocationConversationParticipant(string projectId, string locationId, string conversationId, string participantId)

Creates a ParticipantName with the pattern projects/{project}/locations/{location}/conversations/{conversation}/participants/{participant}.

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.
participantId String

The Participant ID. Must not be null or empty.
Returns
Type Description
ParticipantName

A new instance of ParticipantName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static ParticipantName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a ParticipantName containing an unparsed resource name.

Parameter
Name Description
unparsedResourceName UnparsedResourceName

The unparsed resource name. Must not be null.
Returns
Type Description
ParticipantName

A new instance of ParticipantName containing the provided unparsedResourceName.

GetHashCode()

public override int GetHashCode()

Returns a hash code for this resource name.

Returns
Type Description
Int32
Overrides

Parse(String)

public static ParticipantName Parse(string participantName)

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

Parameter
Name Description
participantName String

The resource name in string form. Must not be null.
Returns
Type Description
ParticipantName

The parsed ParticipantName if successful.
Remarks

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

  • projects/{project}/conversations/{conversation}/participants/{participant}
  • projects/{project}/locations/{location}/conversations/{conversation}/participants/{participant}

Parse(String, Boolean)

public static ParticipantName Parse(string participantName, bool allowUnparsed)

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

Parameters
Name Description
participantName String

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

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
ParticipantName

The parsed ParticipantName if successful.
Remarks

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

  • projects/{project}/conversations/{conversation}/participants/{participant}
  • projects/{project}/locations/{location}/conversations/{conversation}/participants/{participant}
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

TryParse(String, out ParticipantName)

public static bool TryParse(string participantName, out ParticipantName result)

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

Parameters
Name Description
participantName String

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

When this method returns, the parsed ParticipantName, or null if parsing failed.
Returns
Type Description
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}/participants/{participant}
  • projects/{project}/locations/{location}/conversations/{conversation}/participants/{participant}

TryParse(String, Boolean, out ParticipantName)

public static bool TryParse(string participantName, bool allowUnparsed, out ParticipantName result)

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

Parameters
Name Description
participantName String

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

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 ParticipantName

When this method returns, the parsed ParticipantName, or null if parsing failed.
Returns
Type Description
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}/participants/{participant}
  • projects/{project}/locations/{location}/conversations/{conversation}/participants/{participant}
Or may be in any format if allowUnparsed is true.

Operators

Equality(ParticipantName, ParticipantName)

public static bool operator ==(ParticipantName a, ParticipantName b)
Parameters
Name Description
a ParticipantName
b ParticipantName
Returns
Type Description
Boolean

Inequality(ParticipantName, ParticipantName)

public static bool operator !=(ParticipantName a, ParticipantName b)
Parameters
Name Description
a ParticipantName
b ParticipantName
Returns
Type Description
Boolean