Discovery Engine v1beta API - Class ConversationName (1.0.0-beta17) 

public sealed class ConversationName : IResourceName, IEquatable<ConversationName>

Reference documentation and code samples for the Discovery Engine v1beta API class ConversationName.

Resource name for the Conversation resource.

Inheritance

object > ConversationName

Namespace

Google.Cloud.DiscoveryEngine.V1Beta

Assembly

Google.Cloud.DiscoveryEngine.V1Beta.dll

Constructors

ConversationName(string, string, string, string)

public ConversationName(string projectId, string locationId, string dataStoreId, string conversationId)

Constructs a new instance of a ConversationName class from the component parts of pattern projects/{project}/locations/{location}/dataStores/{data_store}/conversations/{conversation}

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.
dataStoreId string

The DataStore ID. Must not be null or empty.
conversationId string

The Conversation ID. Must not be null or empty.

Properties

CollectionId

public string CollectionId { get; }

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

Property Value
Type Description
string

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

DataStoreId

public string DataStoreId { get; }

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

Property Value
Type Description
string

EngineId

public string EngineId { get; }

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

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

The ConversationName.ResourceNameType of the contained resource name.

Property Value
Type Description
ConversationNameResourceNameType

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, string)

public static string Format(string projectId, string locationId, string dataStoreId, string conversationId)

Formats the IDs into the string representation of this ConversationName with pattern projects/{project}/locations/{location}/dataStores/{data_store}/conversations/{conversation}.

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.
dataStoreId string

The DataStore ID. Must not be null or empty.
conversationId string

The Conversation ID. Must not be null or empty.
Returns
Type Description
string

The string representation of this ConversationName with pattern projects/{project}/locations/{location}/dataStores/{data_store}/conversations/{conversation}.

FormatProjectLocationCollectionDataStoreConversation(string, string, string, string, string)

public static string FormatProjectLocationCollectionDataStoreConversation(string projectId, string locationId, string collectionId, string dataStoreId, string conversationId)

Formats the IDs into the string representation of this ConversationName with pattern projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/conversations/{conversation} .

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.
collectionId string

The Collection ID. Must not be null or empty.
dataStoreId string

The DataStore ID. Must not be null or empty.
conversationId string

The Conversation ID. Must not be null or empty.
Returns
Type Description
string

The string representation of this ConversationName with pattern projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/conversations/{conversation} .

FormatProjectLocationCollectionEngineConversation(string, string, string, string, string)

public static string FormatProjectLocationCollectionEngineConversation(string projectId, string locationId, string collectionId, string engineId, string conversationId)

Formats the IDs into the string representation of this ConversationName with pattern projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/conversations/{conversation} .

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.
collectionId string

The Collection ID. Must not be null or empty.
engineId string

The Engine ID. Must not be null or empty.
conversationId string

The Conversation ID. Must not be null or empty.
Returns
Type Description
string

The string representation of this ConversationName with pattern projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/conversations/{conversation} .

FormatProjectLocationDataStoreConversation(string, string, string, string)

public static string FormatProjectLocationDataStoreConversation(string projectId, string locationId, string dataStoreId, string conversationId)

Formats the IDs into the string representation of this ConversationName with pattern projects/{project}/locations/{location}/dataStores/{data_store}/conversations/{conversation}.

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.
dataStoreId string

The DataStore ID. Must not be null or empty.
conversationId string

The Conversation ID. Must not be null or empty.
Returns
Type Description
string

The string representation of this ConversationName with pattern projects/{project}/locations/{location}/dataStores/{data_store}/conversations/{conversation}.

FromProjectLocationCollectionDataStoreConversation(string, string, string, string, string)

public static ConversationName FromProjectLocationCollectionDataStoreConversation(string projectId, string locationId, string collectionId, string dataStoreId, string conversationId)

Creates a ConversationName with the pattern projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/conversations/{conversation} .

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.
collectionId string

The Collection ID. Must not be null or empty.
dataStoreId string

The DataStore ID. Must not be null or empty.
conversationId string

The Conversation ID. Must not be null or empty.
Returns
Type Description
ConversationName

A new instance of ConversationName constructed from the provided ids.

FromProjectLocationCollectionEngineConversation(string, string, string, string, string)

public static ConversationName FromProjectLocationCollectionEngineConversation(string projectId, string locationId, string collectionId, string engineId, string conversationId)

Creates a ConversationName with the pattern projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/conversations/{conversation} .

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.
collectionId string

The Collection ID. Must not be null or empty.
engineId string

The Engine ID. Must not be null or empty.
conversationId string

The Conversation ID. Must not be null or empty.
Returns
Type Description
ConversationName

A new instance of ConversationName constructed from the provided ids.

FromProjectLocationDataStoreConversation(string, string, string, string)

public static ConversationName FromProjectLocationDataStoreConversation(string projectId, string locationId, string dataStoreId, string conversationId)

Creates a ConversationName with the pattern projects/{project}/locations/{location}/dataStores/{data_store}/conversations/{conversation}.

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.
dataStoreId string

The DataStore ID. Must not be null or empty.
conversationId string

The Conversation ID. Must not be null or empty.
Returns
Type Description
ConversationName

A new instance of ConversationName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static ConversationName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a ConversationName containing an unparsed resource name.

Parameter
Name Description
unparsedResourceName UnparsedResourceName

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

A new instance of ConversationName containing the provided unparsedResourceName.

GetHashCode()

public override int GetHashCode()

Returns a hash code for this resource name.

Returns
Type Description
int
Overrides

Parse(string)

public static ConversationName Parse(string conversationName)

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

Parameter
Name Description
conversationName string

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

The parsed ConversationName if successful.
Remarks

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

  • projects/{project}/locations/{location}/dataStores/{data_store}/conversations/{conversation}
  • projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/conversations/{conversation}
  • projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/conversations/{conversation}

Parse(string, bool)

public static ConversationName Parse(string conversationName, bool allowUnparsed)

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

Parameters
Name Description
conversationName string

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

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
ConversationName

The parsed ConversationName if successful.
Remarks

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

  • projects/{project}/locations/{location}/dataStores/{data_store}/conversations/{conversation}
  • projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/conversations/{conversation}
  • projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/conversations/{conversation}
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 ConversationName)

public static bool TryParse(string conversationName, out ConversationName result)

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

Parameters
Name Description
conversationName string

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

When this method returns, the parsed ConversationName, or null if parsing failed.
Returns
Type Description
bool

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}/locations/{location}/dataStores/{data_store}/conversations/{conversation}
  • projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/conversations/{conversation}
  • projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/conversations/{conversation}

TryParse(string, bool, out ConversationName)

public static bool TryParse(string conversationName, bool allowUnparsed, out ConversationName result)

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

Parameters
Name Description
conversationName string

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

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 ConversationName

When this method returns, the parsed ConversationName, or null if parsing failed.
Returns
Type Description
bool

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}/locations/{location}/dataStores/{data_store}/conversations/{conversation}
  • projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/conversations/{conversation}
  • projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/conversations/{conversation}
Or may be in any format if allowUnparsed is true.

Operators

operator ==(ConversationName, ConversationName)

public static bool operator ==(ConversationName a, ConversationName b)

Determines whether two specified resource names have the same value.

Parameters
Name Description
a ConversationName

The first resource name to compare, or null.
b ConversationName

The second resource name to compare, or null.
Returns
Type Description
bool

true if the value of a is the same as the value of b; otherwise, false.

operator !=(ConversationName, ConversationName)

public static bool operator !=(ConversationName a, ConversationName b)

Determines whether two specified resource names have different values.

Parameters
Name Description
a ConversationName

The first resource name to compare, or null.
b ConversationName

The second resource name to compare, or null.
Returns
Type Description
bool

true if the value of a is different from the value of b; otherwise, false.