Google Cloud Spanner Database Administration v1 API - Class DatabaseRoleName (4.3.0)

Version 4.3.0

• 5.0.0-beta03 (latest)
• 5.0.0-beta02
• 4.6.0
• 4.5.0
• 4.4.0
• 4.3.0
• 4.2.0
• 4.1.0
• 4.0.0
• 3.15.1
• 3.14.0
• 3.13.0
• 3.12.0
• 3.11.0
• 3.10.0
• 3.9.0
• 3.8.0
• 3.7.0
• 3.6.0
• 3.5.0

public sealed class DatabaseRoleName : IResourceName, IEquatable<DatabaseRoleName>

Reference documentation and code samples for the Google Cloud Spanner Database Administration v1 API class DatabaseRoleName.

Resource name for the DatabaseRole resource.

Inheritance

object > DatabaseRoleName

Implements

IResourceName, IEquatableDatabaseRoleName

Inherited Members

object.GetType()

object.MemberwiseClone()

Namespace

GoogleCloudGoogle.Cloud.SpannerGoogle.Cloud.Spanner.AdminGoogle.Cloud.Spanner.Admin.DatabaseV1

Assembly

Google.Cloud.Spanner.Admin.Database.V1.dll

Constructors

DatabaseRoleName(string, string, string, string)

public DatabaseRoleName(string projectId, string instanceId, string databaseId, string roleId)

Constructs a new instance of a DatabaseRoleName class from the component parts of pattern projects/{project}/instances/{instance}/databases/{database}/databaseRoles/{role}

Parameters
Name	Description
projectId	string The Project ID. Must not be null or empty.
instanceId	string The Instance ID. Must not be null or empty.
databaseId	string The Database ID. Must not be null or empty.
roleId	string The Role 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

InstanceId

public string InstanceId { get; }

The Instance 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

RoleId

public string RoleId { get; }

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

Property Value
Type	Description
string

Type

public DatabaseRoleName.ResourceNameType Type { get; }

The DatabaseRoleName.ResourceNameType of the contained resource name.

Property Value
Type	Description
DatabaseRoleNameResourceNameType

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

Formats the IDs into the string representation of this DatabaseRoleName with pattern projects/{project}/instances/{instance}/databases/{database}/databaseRoles/{role}.

Parameters
Name	Description
projectId	string The Project ID. Must not be null or empty.
instanceId	string The Instance ID. Must not be null or empty.
databaseId	string The Database ID. Must not be null or empty.
roleId	string The Role ID. Must not be null or empty.

Returns
Type	Description
string	The string representation of this DatabaseRoleName with pattern projects/{project}/instances/{instance}/databases/{database}/databaseRoles/{role}.

FormatProjectInstanceDatabaseRole(string, string, string, string)

public static string FormatProjectInstanceDatabaseRole(string projectId, string instanceId, string databaseId, string roleId)

Formats the IDs into the string representation of this DatabaseRoleName with pattern projects/{project}/instances/{instance}/databases/{database}/databaseRoles/{role}.

Parameters
Name	Description
projectId	string The Project ID. Must not be null or empty.
instanceId	string The Instance ID. Must not be null or empty.
databaseId	string The Database ID. Must not be null or empty.
roleId	string The Role ID. Must not be null or empty.

Returns
Type	Description
string	The string representation of this DatabaseRoleName with pattern projects/{project}/instances/{instance}/databases/{database}/databaseRoles/{role}.

FromProjectInstanceDatabaseRole(string, string, string, string)

public static DatabaseRoleName FromProjectInstanceDatabaseRole(string projectId, string instanceId, string databaseId, string roleId)

Creates a DatabaseRoleName with the pattern projects/{project}/instances/{instance}/databases/{database}/databaseRoles/{role}.

Parameters
Name	Description
projectId	string The Project ID. Must not be null or empty.
instanceId	string The Instance ID. Must not be null or empty.
databaseId	string The Database ID. Must not be null or empty.
roleId	string The Role ID. Must not be null or empty.

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

FromUnparsed(UnparsedResourceName)

public static DatabaseRoleName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a DatabaseRoleName containing an unparsed resource name.

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

Returns
Type	Description
DatabaseRoleName	A new instance of DatabaseRoleName 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 DatabaseRoleName Parse(string databaseRoleName)

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

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

Returns
Type	Description
DatabaseRoleName	The parsed DatabaseRoleName if successful.

Remarks

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

• projects/{project}/instances/{instance}/databases/{database}/databaseRoles/{role}

Parse(string, bool)

public static DatabaseRoleName Parse(string databaseRoleName, bool allowUnparsed)

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

Parameters
Name	Description
databaseRoleName	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
DatabaseRoleName	The parsed DatabaseRoleName if successful.

Remarks

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

• projects/{project}/instances/{instance}/databases/{database}/databaseRoles/{role}

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

public static bool TryParse(string databaseRoleName, out DatabaseRoleName result)

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

Parameters
Name	Description
databaseRoleName	string The resource name in string form. Must not be null.
result	DatabaseRoleName When this method returns, the parsed DatabaseRoleName, 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}/instances/{instance}/databases/{database}/databaseRoles/{role}

TryParse(string, bool, out DatabaseRoleName)

public static bool TryParse(string databaseRoleName, bool allowUnparsed, out DatabaseRoleName result)

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

Parameters
Name	Description
databaseRoleName	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	DatabaseRoleName When this method returns, the parsed DatabaseRoleName, 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}/instances/{instance}/databases/{database}/databaseRoles/{role}

Or may be in any format if allowUnparsed is true.

Operators

operator ==(DatabaseRoleName, DatabaseRoleName)

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

Parameters
Name	Description
a	DatabaseRoleName
b	DatabaseRoleName

Returns
Type	Description
bool

operator !=(DatabaseRoleName, DatabaseRoleName)

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

Parameters
Name	Description
a	DatabaseRoleName
b	DatabaseRoleName

Returns
Type	Description
bool