public sealed class CollectionName : IResourceName, IEquatable<CollectionName>
Reference documentation and code samples for the Discovery Engine v1 API class CollectionName.
Resource name for the Collection
resource.
Namespace
Google.Cloud.DiscoveryEngine.V1Assembly
Google.Cloud.DiscoveryEngine.V1.dll
Constructors
CollectionName(string, string, string)
public CollectionName(string projectId, string locationId, string collectionId)
Constructs a new instance of a CollectionName class from the component parts of pattern
projects/{project}/locations/{location}/collections/{collection}
Parameters | |
---|---|
Name | Description |
projectId |
string The |
locationId |
string The |
collectionId |
string The |
Properties
CollectionId
public string CollectionId { get; }
The Collection
ID. Will not be null
, unless this instance contains an unparsed resource name.
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. Will not be null
, unless this instance contains an unparsed resource name.
Property Value | |
---|---|
Type | Description |
string |
ProjectId
public string ProjectId { get; }
The Project
ID. Will not be null
, unless this instance contains an unparsed resource name.
Property Value | |
---|---|
Type | Description |
string |
Type
public CollectionName.ResourceNameType Type { get; }
The CollectionName.ResourceNameType of the contained resource name.
Property Value | |
---|---|
Type | Description |
CollectionNameResourceNameType |
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 collectionId)
Formats the IDs into the string representation of this CollectionName with pattern
projects/{project}/locations/{location}/collections/{collection}
.
Parameters | |
---|---|
Name | Description |
projectId |
string The |
locationId |
string The |
collectionId |
string The |
Returns | |
---|---|
Type | Description |
string |
The string representation of this CollectionName with pattern
|
FormatProjectLocationCollection(string, string, string)
public static string FormatProjectLocationCollection(string projectId, string locationId, string collectionId)
Formats the IDs into the string representation of this CollectionName with pattern
projects/{project}/locations/{location}/collections/{collection}
.
Parameters | |
---|---|
Name | Description |
projectId |
string The |
locationId |
string The |
collectionId |
string The |
Returns | |
---|---|
Type | Description |
string |
The string representation of this CollectionName with pattern
|
FromProjectLocationCollection(string, string, string)
public static CollectionName FromProjectLocationCollection(string projectId, string locationId, string collectionId)
Creates a CollectionName with the pattern
projects/{project}/locations/{location}/collections/{collection}
.
Parameters | |
---|---|
Name | Description |
projectId |
string The |
locationId |
string The |
collectionId |
string The |
Returns | |
---|---|
Type | Description |
CollectionName |
A new instance of CollectionName constructed from the provided ids. |
FromUnparsed(UnparsedResourceName)
public static CollectionName FromUnparsed(UnparsedResourceName unparsedResourceName)
Creates a CollectionName containing an unparsed resource name.
Parameter | |
---|---|
Name | Description |
unparsedResourceName |
UnparsedResourceName The unparsed resource name. Must not be |
Returns | |
---|---|
Type | Description |
CollectionName |
A new instance of CollectionName containing the provided
|
GetHashCode()
public override int GetHashCode()
Returns a hash code for this resource name.
Returns | |
---|---|
Type | Description |
int |
Parse(string)
public static CollectionName Parse(string collectionName)
Parses the given resource name string into a new CollectionName instance.
Parameter | |
---|---|
Name | Description |
collectionName |
string The resource name in string form. Must not be |
Returns | |
---|---|
Type | Description |
CollectionName |
The parsed CollectionName if successful. |
To parse successfully, the resource name must be formatted as one of the following:
projects/{project}/locations/{location}/collections/{collection}
Parse(string, bool)
public static CollectionName Parse(string collectionName, bool allowUnparsed)
Parses the given resource name string into a new CollectionName instance; optionally allowing an unparseable resource name.
Parameters | |
---|---|
Name | Description |
collectionName |
string The resource name in string form. Must not be |
allowUnparsed |
bool If |
Returns | |
---|---|
Type | Description |
CollectionName |
The parsed CollectionName if successful. |
To parse successfully, the resource name must be formatted as one of the following:
projects/{project}/locations/{location}/collections/{collection}
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 CollectionName)
public static bool TryParse(string collectionName, out CollectionName result)
Tries to parse the given resource name string into a new CollectionName instance.
Parameters | |
---|---|
Name | Description |
collectionName |
string The resource name in string form. Must not be |
result |
CollectionName When this method returns, the parsed CollectionName, or |
Returns | |
---|---|
Type | Description |
bool |
|
To parse successfully, the resource name must be formatted as one of the following:
projects/{project}/locations/{location}/collections/{collection}
TryParse(string, bool, out CollectionName)
public static bool TryParse(string collectionName, bool allowUnparsed, out CollectionName result)
Tries to parse the given resource name string into a new CollectionName instance; optionally allowing an unparseable resource name.
Parameters | |
---|---|
Name | Description |
collectionName |
string The resource name in string form. Must not be |
allowUnparsed |
bool If |
result |
CollectionName When this method returns, the parsed CollectionName, or |
Returns | |
---|---|
Type | Description |
bool |
|
To parse successfully, the resource name must be formatted as one of the following:
projects/{project}/locations/{location}/collections/{collection}
allowUnparsed
is true
.
Operators
operator ==(CollectionName, CollectionName)
public static bool operator ==(CollectionName a, CollectionName b)
Determines whether two specified resource names have the same value.
Parameters | |
---|---|
Name | Description |
a |
CollectionName The first resource name to compare, or null. |
b |
CollectionName The second resource name to compare, or null. |
Returns | |
---|---|
Type | Description |
bool |
true if the value of |
operator !=(CollectionName, CollectionName)
public static bool operator !=(CollectionName a, CollectionName b)
Determines whether two specified resource names have different values.
Parameters | |
---|---|
Name | Description |
a |
CollectionName The first resource name to compare, or null. |
b |
CollectionName The second resource name to compare, or null. |
Returns | |
---|---|
Type | Description |
bool |
true if the value of |