Firestore Admin v1 API - Class UserCredsName (3.13.0) 

public sealed class UserCredsName : IResourceName, IEquatable<UserCredsName>

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

Resource name for the UserCreds resource.

Inheritance

object > UserCredsName

Namespace

Google.Cloud.Firestore.Admin.V1

Assembly

Google.Cloud.Firestore.Admin.V1.dll

Constructors

UserCredsName(string, string, string)

public UserCredsName(string projectId, string databaseId, string userCredsId)

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

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.
userCredsId string

The UserCreds 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 UserCredsName.ResourceNameType Type { get; }

The UserCredsName.ResourceNameType of the contained resource name.

Property Value
Type Description
UserCredsNameResourceNameType

UnparsedResource

public UnparsedResourceName UnparsedResource { get; }

The contained UnparsedResourceName. Only non-null if this instance contains an unparsed resource name.

Property Value
Type Description
UnparsedResourceName

UserCredsId

public string UserCredsId { get; }

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

Property Value
Type Description
string

Methods

Format(string, string, string)

public static string Format(string projectId, string databaseId, string userCredsId)

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

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.
userCredsId string

The UserCreds ID. Must not be null or empty.
Returns
Type Description
string

The string representation of this UserCredsName with pattern projects/{project}/databases/{database}/userCreds/{user_creds}.

FormatProjectDatabaseUserCreds(string, string, string)

public static string FormatProjectDatabaseUserCreds(string projectId, string databaseId, string userCredsId)

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

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.
userCredsId string

The UserCreds ID. Must not be null or empty.
Returns
Type Description
string

The string representation of this UserCredsName with pattern projects/{project}/databases/{database}/userCreds/{user_creds}.

FromProjectDatabaseUserCreds(string, string, string)

public static UserCredsName FromProjectDatabaseUserCreds(string projectId, string databaseId, string userCredsId)

Creates a UserCredsName with the pattern projects/{project}/databases/{database}/userCreds/{user_creds}.

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.
userCredsId string

The UserCreds ID. Must not be null or empty.
Returns
Type Description
UserCredsName

A new instance of UserCredsName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static UserCredsName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a UserCredsName containing an unparsed resource name.

Parameter
Name Description
unparsedResourceName UnparsedResourceName

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

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

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

Parameter
Name Description
userCredsName string

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

The parsed UserCredsName if successful.
Remarks

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

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

Parse(string, bool)

public static UserCredsName Parse(string userCredsName, bool allowUnparsed)

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

Parameters
Name Description
userCredsName 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
UserCredsName

The parsed UserCredsName if successful.
Remarks

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

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

public static bool TryParse(string userCredsName, out UserCredsName result)

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

Parameters
Name Description
userCredsName string

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

When this method returns, the parsed UserCredsName, 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}/userCreds/{user_creds}

TryParse(string, bool, out UserCredsName)

public static bool TryParse(string userCredsName, bool allowUnparsed, out UserCredsName result)

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

Parameters
Name Description
userCredsName 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 UserCredsName

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

Operators

operator ==(UserCredsName, UserCredsName)

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

Determines whether two specified resource names have the same value.

Parameters
Name Description
a UserCredsName

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

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

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

Determines whether two specified resource names have different values.

Parameters
Name Description
a UserCredsName

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

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.