Oracle Database@Google Cloud v1 API - Class DatabaseConnectionName (1.10.0)

public sealed class DatabaseConnectionName : IResourceName, IEquatable<DatabaseConnectionName>

Reference documentation and code samples for the Oracle Database@Google Cloud v1 API class DatabaseConnectionName.

Resource name for the DatabaseConnection resource.

Inheritance

object > DatabaseConnectionName

Namespace

Google.Cloud.OracleDatabase.V1

Assembly

Google.Cloud.OracleDatabase.V1.dll

Constructors

DatabaseConnectionName(string, string, string)

public DatabaseConnectionName(string projectId, string locationId, string databaseConnectionId)

Constructs a new instance of a DatabaseConnectionName class from the component parts of pattern projects/{project}/locations/{location}/databaseConnections/{database_connection}

Parameters
Name Description
projectId string

The Project ID. Must not be null or empty.

locationId string

The Location ID. Must not be null or empty.

databaseConnectionId string

The DatabaseConnection ID. Must not be null or empty.

Properties

DatabaseConnectionId

public string DatabaseConnectionId { get; }

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

LocationId

public string LocationId { get; }

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

Property Value
Type Description
string

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

The DatabaseConnectionName.ResourceNameType of the contained resource name.

Property Value
Type Description
DatabaseConnectionNameResourceNameType

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 locationId, string databaseConnectionId)

Formats the IDs into the string representation of this DatabaseConnectionName with pattern projects/{project}/locations/{location}/databaseConnections/{database_connection}.

Parameters
Name Description
projectId string

The Project ID. Must not be null or empty.

locationId string

The Location ID. Must not be null or empty.

databaseConnectionId string

The DatabaseConnection ID. Must not be null or empty.

Returns
Type Description
string

The string representation of this DatabaseConnectionName with pattern projects/{project}/locations/{location}/databaseConnections/{database_connection}.

FormatProjectLocationDatabaseConnection(string, string, string)

public static string FormatProjectLocationDatabaseConnection(string projectId, string locationId, string databaseConnectionId)

Formats the IDs into the string representation of this DatabaseConnectionName with pattern projects/{project}/locations/{location}/databaseConnections/{database_connection}.

Parameters
Name Description
projectId string

The Project ID. Must not be null or empty.

locationId string

The Location ID. Must not be null or empty.

databaseConnectionId string

The DatabaseConnection ID. Must not be null or empty.

Returns
Type Description
string

The string representation of this DatabaseConnectionName with pattern projects/{project}/locations/{location}/databaseConnections/{database_connection}.

FromProjectLocationDatabaseConnection(string, string, string)

public static DatabaseConnectionName FromProjectLocationDatabaseConnection(string projectId, string locationId, string databaseConnectionId)

Creates a DatabaseConnectionName with the pattern projects/{project}/locations/{location}/databaseConnections/{database_connection}.

Parameters
Name Description
projectId string

The Project ID. Must not be null or empty.

locationId string

The Location ID. Must not be null or empty.

databaseConnectionId string

The DatabaseConnection ID. Must not be null or empty.

Returns
Type Description
DatabaseConnectionName

A new instance of DatabaseConnectionName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static DatabaseConnectionName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a DatabaseConnectionName containing an unparsed resource name.

Parameter
Name Description
unparsedResourceName UnparsedResourceName

The unparsed resource name. Must not be null.

Returns
Type Description
DatabaseConnectionName

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

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

Parameter
Name Description
databaseConnectionName string

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

Returns
Type Description
DatabaseConnectionName

The parsed DatabaseConnectionName if successful.

Remarks

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

  • projects/{project}/locations/{location}/databaseConnections/{database_connection}

Parse(string, bool)

public static DatabaseConnectionName Parse(string databaseConnectionName, bool allowUnparsed)

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

Parameters
Name Description
databaseConnectionName 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
DatabaseConnectionName

The parsed DatabaseConnectionName if successful.

Remarks

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

  • projects/{project}/locations/{location}/databaseConnections/{database_connection}

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

public static bool TryParse(string databaseConnectionName, out DatabaseConnectionName result)

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

Parameters
Name Description
databaseConnectionName string

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

result DatabaseConnectionName

When this method returns, the parsed DatabaseConnectionName, 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}/locations/{location}/databaseConnections/{database_connection}

TryParse(string, bool, out DatabaseConnectionName)

public static bool TryParse(string databaseConnectionName, bool allowUnparsed, out DatabaseConnectionName result)

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

Parameters
Name Description
databaseConnectionName 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 DatabaseConnectionName

When this method returns, the parsed DatabaseConnectionName, 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}/locations/{location}/databaseConnections/{database_connection}

Or may be in any format if allowUnparsed is true.

Operators

operator ==(DatabaseConnectionName, DatabaseConnectionName)

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

Determines whether two specified resource names have the same value.

Parameters
Name Description
a DatabaseConnectionName

The first resource name to compare, or null.

b DatabaseConnectionName

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

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

Determines whether two specified resource names have different values.

Parameters
Name Description
a DatabaseConnectionName

The first resource name to compare, or null.

b DatabaseConnectionName

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.