Firestore Admin v1 API - Class IndexName (3.6.0)

public sealed class IndexName : IResourceName, IEquatable<IndexName>

Reference documentation and code samples for the Firestore Admin v1 API class IndexName.

Resource name for the Index resource.

Inheritance

object > IndexName

Implements

IResourceName, IEquatable IndexName

Inherited Members

object.GetType()

Namespace

Google.Cloud.Firestore.Admin.V1

Assembly

Google.Cloud.Firestore.Admin.V1.dll

Constructors

IndexName(string, string, string, string)

public IndexName(string projectId, string databaseId, string collectionId, string indexId)

Constructs a new instance of a IndexName class from the component parts of pattern projects/{project}/databases/{database}/collectionGroups/{collection}/indexes/{index}

Parameters
Name	Description
`projectId`	`string` The `Project` ID. Must not be `null` or empty.
`databaseId`	`string` The `Database` ID. Must not be `null` or empty.
`collectionId`	`string` The `Collection` ID. Must not be `null` or empty.
`indexId`	`string` The `Index` ID. Must not be `null` or empty.

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`

DatabaseId

public string DatabaseId { get; }

The Database ID. Will not be null, unless this instance contains an unparsed resource name.

Property Value
Type	Description
`string`

IndexId

public string IndexId { get; }

The Index 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`

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

The IndexName.ResourceNameType of the contained resource name.

Property Value
Type	Description
`IndexNameResourceNameType`

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 databaseId, string collectionId, string indexId)

Formats the IDs into the string representation of this IndexName with pattern projects/{project}/databases/{database}/collectionGroups/{collection}/indexes/{index}.

Parameters
Name	Description
`projectId`	`string` The `Project` ID. Must not be `null` or empty.
`databaseId`	`string` The `Database` ID. Must not be `null` or empty.
`collectionId`	`string` The `Collection` ID. Must not be `null` or empty.
`indexId`	`string` The `Index` ID. Must not be `null` or empty.

Returns
Type	Description
`string`	The string representation of this IndexName with pattern `projects/{project}/databases/{database}/collectionGroups/{collection}/indexes/{index}`.

FormatProjectDatabaseCollectionIndex(string, string, string, string)

public static string FormatProjectDatabaseCollectionIndex(string projectId, string databaseId, string collectionId, string indexId)

Formats the IDs into the string representation of this IndexName with pattern projects/{project}/databases/{database}/collectionGroups/{collection}/indexes/{index}.

Parameters
Name	Description
`projectId`	`string` The `Project` ID. Must not be `null` or empty.
`databaseId`	`string` The `Database` ID. Must not be `null` or empty.
`collectionId`	`string` The `Collection` ID. Must not be `null` or empty.
`indexId`	`string` The `Index` ID. Must not be `null` or empty.

Returns
Type	Description
`string`	The string representation of this IndexName with pattern `projects/{project}/databases/{database}/collectionGroups/{collection}/indexes/{index}`.

FromProjectDatabaseCollectionIndex(string, string, string, string)

public static IndexName FromProjectDatabaseCollectionIndex(string projectId, string databaseId, string collectionId, string indexId)

Creates a IndexName with the pattern projects/{project}/databases/{database}/collectionGroups/{collection}/indexes/{index}.

Parameters
Name	Description
`projectId`	`string` The `Project` ID. Must not be `null` or empty.
`databaseId`	`string` The `Database` ID. Must not be `null` or empty.
`collectionId`	`string` The `Collection` ID. Must not be `null` or empty.
`indexId`	`string` The `Index` ID. Must not be `null` or empty.

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

FromUnparsed(UnparsedResourceName)

public static IndexName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a IndexName containing an unparsed resource name.

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

Returns
Type	Description
`IndexName`	A new instance of IndexName 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 IndexName Parse(string indexName)

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

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

Returns
Type	Description
`IndexName`	The parsed IndexName if successful.

Remarks

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

projects/{project}/databases/{database}/collectionGroups/{collection}/indexes/{index}

Parse(string, bool)

public static IndexName Parse(string indexName, bool allowUnparsed)

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

Parameters
Name	Description
`indexName`	`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
`IndexName`	The parsed IndexName if successful.

Remarks

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

projects/{project}/databases/{database}/collectionGroups/{collection}/indexes/{index}

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 IndexName)

public static bool TryParse(string indexName, out IndexName result)

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

Parameters
Name	Description
`indexName`	`string` The resource name in string form. Must not be `null`.
`result`	`IndexName` When this method returns, the parsed IndexName, 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}/databases/{database}/collectionGroups/{collection}/indexes/{index}

TryParse(string, bool, out IndexName)

public static bool TryParse(string indexName, bool allowUnparsed, out IndexName result)

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

Parameters
Name	Description
`indexName`	`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`	`IndexName` When this method returns, the parsed IndexName, 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}/databases/{database}/collectionGroups/{collection}/indexes/{index}

Or may be in any format if allowUnparsed is true.

Operators

operator ==(IndexName, IndexName)

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

Determines whether two specified resource names have the same value.

Parameters
Name	Description
`a`	`IndexName` The first resource name to compare, or null.
`b`	`IndexName` 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 !=(IndexName, IndexName)

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

Determines whether two specified resource names have different values.

Parameters
Name	Description
`a`	`IndexName` The first resource name to compare, or null.
`b`	`IndexName` 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.