Firestore Admin v1 API - Class CollectionGroupName (3.15.0) 

public sealed class CollectionGroupName : IResourceName, IEquatable<CollectionGroupName>

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

Resource name for the CollectionGroup resource.

Inheritance

object > CollectionGroupName

Namespace

Google.Cloud.Firestore.Admin.V1

Assembly

Google.Cloud.Firestore.Admin.V1.dll

Constructors

CollectionGroupName(string, string, string)

public CollectionGroupName(string projectId, string databaseId, string collectionId)

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

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.

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

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

The CollectionGroupName.ResourceNameType of the contained resource name.

Property Value
Type Description
CollectionGroupNameResourceNameType

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

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

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.
Returns
Type Description
string

The string representation of this CollectionGroupName with pattern projects/{project}/databases/{database}/collectionGroups/{collection}.

FormatProjectDatabaseCollection(string, string, string)

public static string FormatProjectDatabaseCollection(string projectId, string databaseId, string collectionId)

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

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.
Returns
Type Description
string

The string representation of this CollectionGroupName with pattern projects/{project}/databases/{database}/collectionGroups/{collection}.

FromProjectDatabaseCollection(string, string, string)

public static CollectionGroupName FromProjectDatabaseCollection(string projectId, string databaseId, string collectionId)

Creates a CollectionGroupName with the pattern projects/{project}/databases/{database}/collectionGroups/{collection}.

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.
Returns
Type Description
CollectionGroupName

A new instance of CollectionGroupName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static CollectionGroupName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a CollectionGroupName containing an unparsed resource name.

Parameter
Name Description
unparsedResourceName UnparsedResourceName

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

A new instance of CollectionGroupName 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 CollectionGroupName Parse(string collectionGroupName)

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

Parameter
Name Description
collectionGroupName string

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

The parsed CollectionGroupName if successful.
Remarks

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

  • projects/{project}/databases/{database}/collectionGroups/{collection}

Parse(string, bool)

public static CollectionGroupName Parse(string collectionGroupName, bool allowUnparsed)

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

Parameters
Name Description
collectionGroupName 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
CollectionGroupName

The parsed CollectionGroupName if successful.
Remarks

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

  • projects/{project}/databases/{database}/collectionGroups/{collection}
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 CollectionGroupName)

public static bool TryParse(string collectionGroupName, out CollectionGroupName result)

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

Parameters
Name Description
collectionGroupName string

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

When this method returns, the parsed CollectionGroupName, 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}

TryParse(string, bool, out CollectionGroupName)

public static bool TryParse(string collectionGroupName, bool allowUnparsed, out CollectionGroupName result)

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

Parameters
Name Description
collectionGroupName 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 CollectionGroupName

When this method returns, the parsed CollectionGroupName, 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}
Or may be in any format if allowUnparsed is true.

Operators

operator ==(CollectionGroupName, CollectionGroupName)

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

Determines whether two specified resource names have the same value.

Parameters
Name Description
a CollectionGroupName

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

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 !=(CollectionGroupName, CollectionGroupName)

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

Determines whether two specified resource names have different values.

Parameters
Name Description
a CollectionGroupName

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

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.