Dialogflow v3 API - Class DataStoreName (2.14.0)

Version 2.14.0

• 2.21.0 (latest)
• 2.20.0
• 2.19.0
• 2.18.0
• 2.17.0
• 2.16.0
• 2.15.0
• 2.14.0
• 2.13.0
• 2.12.0
• 2.11.0
• 2.10.0
• 2.9.0
• 2.8.0
• 2.7.0
• 2.6.0
• 2.5.0
• 2.4.0
• 2.3.0
• 2.2.0
• 2.1.0
• 2.0.0
• 1.13.0
• 1.12.0
• 1.11.0
• 1.10.0
• 1.9.0
• 1.8.0
• 1.7.0
• 1.6.0
• 1.5.0
• 1.4.0
• 1.3.0
• 1.2.0
• 1.1.0
• 1.0.0

public sealed class DataStoreName : IResourceName, IEquatable<DataStoreName>

Reference documentation and code samples for the Dialogflow v3 API class DataStoreName.

Resource name for the DataStore resource.

Inheritance

object > DataStoreName

Implements

IResourceName, IEquatableDataStoreName

Inherited Members

object.GetType()

Namespace

Google.Cloud.Dialogflow.Cx.V3

Assembly

Google.Cloud.Dialogflow.Cx.V3.dll

Constructors

DataStoreName(string, string, string)

public DataStoreName(string projectId, string locationId, string dataStoreId)

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

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.

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

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

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

The DataStoreName.ResourceNameType of the contained resource name.

Property Value
Type	Description
DataStoreNameResourceNameType

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

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

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.

Returns
Type	Description
string	The string representation of this DataStoreName with pattern projects/{project}/locations/{location}/dataStores/{data_store}.

FormatProjectLocationCollectionDataStore(string, string, string, string)

public static string FormatProjectLocationCollectionDataStore(string projectId, string locationId, string collectionId, string dataStoreId)

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

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.

Returns
Type	Description
string	The string representation of this DataStoreName with pattern projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}.

FormatProjectLocationDataStore(string, string, string)

public static string FormatProjectLocationDataStore(string projectId, string locationId, string dataStoreId)

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

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.

Returns
Type	Description
string	The string representation of this DataStoreName with pattern projects/{project}/locations/{location}/dataStores/{data_store}.

FromProjectLocationCollectionDataStore(string, string, string, string)

public static DataStoreName FromProjectLocationCollectionDataStore(string projectId, string locationId, string collectionId, string dataStoreId)

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

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.

Returns
Type	Description
DataStoreName	A new instance of DataStoreName constructed from the provided ids.

FromProjectLocationDataStore(string, string, string)

public static DataStoreName FromProjectLocationDataStore(string projectId, string locationId, string dataStoreId)

Creates a DataStoreName with the pattern projects/{project}/locations/{location}/dataStores/{data_store}.

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.

Returns
Type	Description
DataStoreName	A new instance of DataStoreName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static DataStoreName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a DataStoreName containing an unparsed resource name.

Parameter
Name	Description
unparsedResourceName	UnparsedResourceName The unparsed resource name. Must not be null.

Returns
Type	Description
DataStoreName	A new instance of DataStoreName containing the provided unparsedResourceName.

GetHashCode()

public override int GetHashCode()

Returns a hash code for this resource name.

Returns
Type	Description
int

Overrides

object.GetHashCode()

Parse(string)

public static DataStoreName Parse(string dataStoreName)

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

Parameter
Name	Description
dataStoreName	string The resource name in string form. Must not be null.

Returns
Type	Description
DataStoreName	The parsed DataStoreName if successful.

Remarks

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

• projects/{project}/locations/{location}/dataStores/{data_store}
• projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}

Parse(string, bool)

public static DataStoreName Parse(string dataStoreName, bool allowUnparsed)

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

Parameters
Name	Description
dataStoreName	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
DataStoreName	The parsed DataStoreName if successful.

Remarks

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

• projects/{project}/locations/{location}/dataStores/{data_store}
• projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}

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

object.ToString()

TryParse(string, out DataStoreName)

public static bool TryParse(string dataStoreName, out DataStoreName result)

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

Parameters
Name	Description
dataStoreName	string The resource name in string form. Must not be null.
result	DataStoreName When this method returns, the parsed DataStoreName, 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}
• projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}

TryParse(string, bool, out DataStoreName)

public static bool TryParse(string dataStoreName, bool allowUnparsed, out DataStoreName result)

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

Parameters
Name	Description
dataStoreName	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	DataStoreName When this method returns, the parsed DataStoreName, 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}
• projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}

Or may be in any format if allowUnparsed is true.

Operators

operator ==(DataStoreName, DataStoreName)

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

Parameters
Name	Description
a	DataStoreName
b	DataStoreName

Returns
Type	Description
bool

operator !=(DataStoreName, DataStoreName)

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

Parameters
Name	Description
a	DataStoreName
b	DataStoreName

Returns
Type	Description
bool