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

Stay organized with collections Save and categorize content based on your preferences.
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

Namespace

Google.Cloud.Spanner.Admin.Database.V1

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
NameDescription
projectIdString

The Project ID. Must not be null or empty.

instanceIdString

The Instance ID. Must not be null or empty.

databaseIdString

The Database ID. Must not be null or empty.

roleIdString

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
TypeDescription
String

InstanceId

public string InstanceId { get; }

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

Property Value
TypeDescription
String

IsKnownPattern

public bool IsKnownPattern { get; }

Whether this instance contains a resource name with a known pattern.

Property Value
TypeDescription
Boolean

ProjectId

public string ProjectId { get; }

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

Property Value
TypeDescription
String

RoleId

public string RoleId { get; }

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

Property Value
TypeDescription
String

Type

public DatabaseRoleName.ResourceNameType Type { get; }

The DatabaseRoleName.ResourceNameType of the contained resource name.

Property Value
TypeDescription
DatabaseRoleName.ResourceNameType

UnparsedResource

public UnparsedResourceName UnparsedResource { get; }

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

Property Value
TypeDescription
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
NameDescription
projectIdString

The Project ID. Must not be null or empty.

instanceIdString

The Instance ID. Must not be null or empty.

databaseIdString

The Database ID. Must not be null or empty.

roleIdString

The Role ID. Must not be null or empty.

Returns
TypeDescription
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
NameDescription
projectIdString

The Project ID. Must not be null or empty.

instanceIdString

The Instance ID. Must not be null or empty.

databaseIdString

The Database ID. Must not be null or empty.

roleIdString

The Role ID. Must not be null or empty.

Returns
TypeDescription
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
NameDescription
projectIdString

The Project ID. Must not be null or empty.

instanceIdString

The Instance ID. Must not be null or empty.

databaseIdString

The Database ID. Must not be null or empty.

roleIdString

The Role ID. Must not be null or empty.

Returns
TypeDescription
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
NameDescription
unparsedResourceNameUnparsedResourceName

The unparsed resource name. Must not be null.

Returns
TypeDescription
DatabaseRoleName

A new instance of DatabaseRoleName containing the provided unparsedResourceName.

GetHashCode()

public override int GetHashCode()

Returns a hash code for this resource name.

Returns
TypeDescription
Int32
Overrides

Parse(String)

public static DatabaseRoleName Parse(string databaseRoleName)

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

Parameter
NameDescription
databaseRoleNameString

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

Returns
TypeDescription
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, Boolean)

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
NameDescription
databaseRoleNameString

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

allowUnparsedBoolean

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
TypeDescription
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
TypeDescription
String

The string representation of the resource name.

Overrides

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
NameDescription
databaseRoleNameString

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

resultDatabaseRoleName

When this method returns, the parsed DatabaseRoleName, or null if parsing failed.

Returns
TypeDescription
Boolean

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, Boolean, 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
NameDescription
databaseRoleNameString

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

allowUnparsedBoolean

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.

resultDatabaseRoleName

When this method returns, the parsed DatabaseRoleName, or null if parsing failed.

Returns
TypeDescription
Boolean

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

Equality(DatabaseRoleName, DatabaseRoleName)

public static bool operator ==(DatabaseRoleName a, DatabaseRoleName b)
Parameters
NameDescription
aDatabaseRoleName
bDatabaseRoleName
Returns
TypeDescription
Boolean

Inequality(DatabaseRoleName, DatabaseRoleName)

public static bool operator !=(DatabaseRoleName a, DatabaseRoleName b)
Parameters
NameDescription
aDatabaseRoleName
bDatabaseRoleName
Returns
TypeDescription
Boolean