public sealed class DataStoreName : IResourceName, IEquatable<DataStoreName>
Reference documentation and code samples for the Discovery Engine v1beta API class DataStoreName.
Resource name for the DataStore
resource.
Namespace
Google.Cloud.DiscoveryEngine.V1BetaAssembly
Google.Cloud.DiscoveryEngine.V1Beta.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 |
locationId |
string The |
dataStoreId |
string The |
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 |
locationId |
string The |
dataStoreId |
string The |
Returns | |
---|---|
Type | Description |
string |
The string representation of this DataStoreName with pattern
|
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 |
locationId |
string The |
collectionId |
string The |
dataStoreId |
string The |
Returns | |
---|---|
Type | Description |
string |
The string representation of this DataStoreName with pattern
|
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 |
locationId |
string The |
dataStoreId |
string The |
Returns | |
---|---|
Type | Description |
string |
The string representation of this DataStoreName with pattern
|
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 |
locationId |
string The |
collectionId |
string The |
dataStoreId |
string The |
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 |
locationId |
string The |
dataStoreId |
string The |
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 |
Returns | |
---|---|
Type | Description |
DataStoreName |
A new instance of DataStoreName containing the provided
|
GetHashCode()
public override int GetHashCode()
Returns a hash code for this resource name.
Returns | |
---|---|
Type | Description |
int |
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 |
Returns | |
---|---|
Type | Description |
DataStoreName |
The parsed DataStoreName if successful. |
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 |
allowUnparsed |
bool If |
Returns | |
---|---|
Type | Description |
DataStoreName |
The parsed DataStoreName if successful. |
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}
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 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 |
result |
DataStoreName When this method returns, the parsed DataStoreName, or |
Returns | |
---|---|
Type | Description |
bool |
|
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 |
allowUnparsed |
bool If |
result |
DataStoreName When this method returns, the parsed DataStoreName, or |
Returns | |
---|---|
Type | Description |
bool |
|
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}
allowUnparsed
is true
.
Operators
operator ==(DataStoreName, DataStoreName)
public static bool operator ==(DataStoreName a, DataStoreName b)
Determines whether two specified resource names have the same value.
Parameters | |
---|---|
Name | Description |
a |
DataStoreName The first resource name to compare, or null. |
b |
DataStoreName The second resource name to compare, or null. |
Returns | |
---|---|
Type | Description |
bool |
true if the value of |
operator !=(DataStoreName, DataStoreName)
public static bool operator !=(DataStoreName a, DataStoreName b)
Determines whether two specified resource names have different values.
Parameters | |
---|---|
Name | Description |
a |
DataStoreName The first resource name to compare, or null. |
b |
DataStoreName The second resource name to compare, or null. |
Returns | |
---|---|
Type | Description |
bool |
true if the value of |