Firestore Admin v1 API - Class DatabaseName (3.15.0) 

public sealed class DatabaseName : IResourceName, IEquatable<DatabaseName>

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

Resource name for the Database resource.

Inheritance

object > DatabaseName

Namespace

Google.Cloud.Firestore.Admin.V1

Assembly

Google.Cloud.Firestore.Admin.V1.dll

Constructors

DatabaseName(string, string)

public DatabaseName(string projectId, string databaseId)

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

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.

Properties

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

The DatabaseName.ResourceNameType of the contained resource name.

Property Value
Type Description
DatabaseNameResourceNameType

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)

public static string Format(string projectId, string databaseId)

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

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

The string representation of this DatabaseName with pattern projects/{project}/databases/{database}.

FormatProjectDatabase(string, string)

public static string FormatProjectDatabase(string projectId, string databaseId)

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

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

The string representation of this DatabaseName with pattern projects/{project}/databases/{database}.

FromProjectDatabase(string, string)

public static DatabaseName FromProjectDatabase(string projectId, string databaseId)

Creates a DatabaseName with the pattern projects/{project}/databases/{database}.

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

A new instance of DatabaseName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static DatabaseName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a DatabaseName containing an unparsed resource name.

Parameter
Name Description
unparsedResourceName UnparsedResourceName

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

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

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

Parameter
Name Description
databaseName string

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

The parsed DatabaseName if successful.
Remarks

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

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

Parse(string, bool)

public static DatabaseName Parse(string databaseName, bool allowUnparsed)

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

Parameters
Name Description
databaseName 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
DatabaseName

The parsed DatabaseName if successful.
Remarks

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

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

public static bool TryParse(string databaseName, out DatabaseName result)

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

Parameters
Name Description
databaseName string

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

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

TryParse(string, bool, out DatabaseName)

public static bool TryParse(string databaseName, bool allowUnparsed, out DatabaseName result)

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

Parameters
Name Description
databaseName 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 DatabaseName

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

Operators

operator ==(DatabaseName, DatabaseName)

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

Determines whether two specified resource names have the same value.

Parameters
Name Description
a DatabaseName

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

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

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

Determines whether two specified resource names have different values.

Parameters
Name Description
a DatabaseName

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

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.