Class ConversationProfileName (4.0.0)

public sealed class ConversationProfileName : IResourceName, IEquatable<ConversationProfileName>

Resource name for the ConversationProfile resource.

Inheritance

Object > ConversationProfileName

Namespace

Google.Cloud.Dialogflow.V2

Assembly

Google.Cloud.Dialogflow.V2.dll

Constructors

ConversationProfileName(String, String)

public ConversationProfileName(string projectId, string conversationProfileId)

Constructs a new instance of a ConversationProfileName class from the component parts of pattern projects/{project}/conversationProfiles/{conversation_profile}

Parameters
NameDescription
projectIdString

The Project ID. Must not be null or empty.

conversationProfileIdString

The ConversationProfile ID. Must not be null or empty.

Properties

ConversationProfileId

public string ConversationProfileId { get; }

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

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 ConversationProfileName.ResourceNameType Type { get; }

The ConversationProfileName.ResourceNameType of the contained resource name.

Property Value
TypeDescription
ConversationProfileName.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)

public static string Format(string projectId, string conversationProfileId)

Formats the IDs into the string representation of this ConversationProfileName with pattern projects/{project}/conversationProfiles/{conversation_profile}.

Parameters
NameDescription
projectIdString

The Project ID. Must not be null or empty.

conversationProfileIdString

The ConversationProfile ID. Must not be null or empty.

Returns
TypeDescription
String

The string representation of this ConversationProfileName with pattern projects/{project}/conversationProfiles/{conversation_profile}.

FormatProjectConversationProfile(String, String)

public static string FormatProjectConversationProfile(string projectId, string conversationProfileId)

Formats the IDs into the string representation of this ConversationProfileName with pattern projects/{project}/conversationProfiles/{conversation_profile}.

Parameters
NameDescription
projectIdString

The Project ID. Must not be null or empty.

conversationProfileIdString

The ConversationProfile ID. Must not be null or empty.

Returns
TypeDescription
String

The string representation of this ConversationProfileName with pattern projects/{project}/conversationProfiles/{conversation_profile}.

FormatProjectLocationConversationProfile(String, String, String)

public static string FormatProjectLocationConversationProfile(string projectId, string locationId, string conversationProfileId)

Formats the IDs into the string representation of this ConversationProfileName with pattern projects/{project}/locations/{location}/conversationProfiles/{conversation_profile}.

Parameters
NameDescription
projectIdString

The Project ID. Must not be null or empty.

locationIdString

The Location ID. Must not be null or empty.

conversationProfileIdString

The ConversationProfile ID. Must not be null or empty.

Returns
TypeDescription
String

The string representation of this ConversationProfileName with pattern projects/{project}/locations/{location}/conversationProfiles/{conversation_profile}.

FromProjectConversationProfile(String, String)

public static ConversationProfileName FromProjectConversationProfile(string projectId, string conversationProfileId)

Creates a ConversationProfileName with the pattern projects/{project}/conversationProfiles/{conversation_profile}.

Parameters
NameDescription
projectIdString

The Project ID. Must not be null or empty.

conversationProfileIdString

The ConversationProfile ID. Must not be null or empty.

Returns
TypeDescription
ConversationProfileName

A new instance of ConversationProfileName constructed from the provided ids.

FromProjectLocationConversationProfile(String, String, String)

public static ConversationProfileName FromProjectLocationConversationProfile(string projectId, string locationId, string conversationProfileId)

Creates a ConversationProfileName with the pattern projects/{project}/locations/{location}/conversationProfiles/{conversation_profile}.

Parameters
NameDescription
projectIdString

The Project ID. Must not be null or empty.

locationIdString

The Location ID. Must not be null or empty.

conversationProfileIdString

The ConversationProfile ID. Must not be null or empty.

Returns
TypeDescription
ConversationProfileName

A new instance of ConversationProfileName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static ConversationProfileName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a ConversationProfileName containing an unparsed resource name.

Parameter
NameDescription
unparsedResourceNameUnparsedResourceName

The unparsed resource name. Must not be null.

Returns
TypeDescription
ConversationProfileName

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

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

Parameter
NameDescription
conversationProfileNameString

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

Returns
TypeDescription
ConversationProfileName

The parsed ConversationProfileName if successful.

Remarks

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

  • projects/{project}/conversationProfiles/{conversation_profile}
  • projects/{project}/locations/{location}/conversationProfiles/{conversation_profile}

Parse(String, Boolean)

public static ConversationProfileName Parse(string conversationProfileName, bool allowUnparsed)

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

Parameters
NameDescription
conversationProfileNameString

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
ConversationProfileName

The parsed ConversationProfileName if successful.

Remarks

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

  • projects/{project}/conversationProfiles/{conversation_profile}
  • projects/{project}/locations/{location}/conversationProfiles/{conversation_profile}
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 ConversationProfileName)

public static bool TryParse(string conversationProfileName, out ConversationProfileName result)

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

Parameters
NameDescription
conversationProfileNameString

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

resultConversationProfileName

When this method returns, the parsed ConversationProfileName, 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}/conversationProfiles/{conversation_profile}
  • projects/{project}/locations/{location}/conversationProfiles/{conversation_profile}

TryParse(String, Boolean, out ConversationProfileName)

public static bool TryParse(string conversationProfileName, bool allowUnparsed, out ConversationProfileName result)

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

Parameters
NameDescription
conversationProfileNameString

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.

resultConversationProfileName

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

Operators

Equality(ConversationProfileName, ConversationProfileName)

public static bool operator ==(ConversationProfileName a, ConversationProfileName b)
Parameters
NameDescription
aConversationProfileName
bConversationProfileName
Returns
TypeDescription
Boolean

Inequality(ConversationProfileName, ConversationProfileName)

public static bool operator !=(ConversationProfileName a, ConversationProfileName b)
Parameters
NameDescription
aConversationProfileName
bConversationProfileName
Returns
TypeDescription
Boolean