Oracle Database@Google Cloud v1 API - Class DbSystemName (1.4.0)

Version latest

• 1.4.0 (latest)
• 1.3.0
• 1.2.0
• 1.1.0
• 1.0.0

public sealed class DbSystemName : IResourceName, IEquatable<DbSystemName>

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

Resource name for the DbSystem resource.

Inheritance

object > DbSystemName

Implements

IResourceName, IEquatableDbSystemName

Inherited Members

object.GetType()

Namespace

Google.Cloud.OracleDatabase.V1

Assembly

Google.Cloud.OracleDatabase.V1.dll

Constructors

DbSystemName(string, string, string)

public DbSystemName(string projectId, string locationId, string dbSystemId)

Constructs a new instance of a DbSystemName class from the component parts of pattern projects/{project}/locations/{location}/dbSystems/{db_system}

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.
dbSystemId	string The DbSystem ID. Must not be null or empty.

Properties

DbSystemId

public string DbSystemId { get; }

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

The DbSystemName.ResourceNameType of the contained resource name.

Property Value
Type	Description
DbSystemNameResourceNameType

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

Formats the IDs into the string representation of this DbSystemName with pattern projects/{project}/locations/{location}/dbSystems/{db_system}.

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.
dbSystemId	string The DbSystem ID. Must not be null or empty.

Returns
Type	Description
string	The string representation of this DbSystemName with pattern projects/{project}/locations/{location}/dbSystems/{db_system}.

FormatProjectLocationDbSystem(string, string, string)

public static string FormatProjectLocationDbSystem(string projectId, string locationId, string dbSystemId)

Formats the IDs into the string representation of this DbSystemName with pattern projects/{project}/locations/{location}/dbSystems/{db_system}.

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.
dbSystemId	string The DbSystem ID. Must not be null or empty.

Returns
Type	Description
string	The string representation of this DbSystemName with pattern projects/{project}/locations/{location}/dbSystems/{db_system}.

FromProjectLocationDbSystem(string, string, string)

public static DbSystemName FromProjectLocationDbSystem(string projectId, string locationId, string dbSystemId)

Creates a DbSystemName with the pattern projects/{project}/locations/{location}/dbSystems/{db_system}.

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.
dbSystemId	string The DbSystem ID. Must not be null or empty.

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

FromUnparsed(UnparsedResourceName)

public static DbSystemName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a DbSystemName containing an unparsed resource name.

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

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

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

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

Returns
Type	Description
DbSystemName	The parsed DbSystemName if successful.

Remarks

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

• projects/{project}/locations/{location}/dbSystems/{db_system}

Parse(string, bool)

public static DbSystemName Parse(string dbSystemName, bool allowUnparsed)

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

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

Remarks

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

• projects/{project}/locations/{location}/dbSystems/{db_system}

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

public static bool TryParse(string dbSystemName, out DbSystemName result)

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

Parameters
Name	Description
dbSystemName	string The resource name in string form. Must not be null.
result	DbSystemName When this method returns, the parsed DbSystemName, 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}/dbSystems/{db_system}

TryParse(string, bool, out DbSystemName)

public static bool TryParse(string dbSystemName, bool allowUnparsed, out DbSystemName result)

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

Parameters
Name	Description
dbSystemName	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	DbSystemName When this method returns, the parsed DbSystemName, 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}/dbSystems/{db_system}

Or may be in any format if allowUnparsed is true.

Operators

operator ==(DbSystemName, DbSystemName)

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

Determines whether two specified resource names have the same value.

Parameters
Name	Description
a	DbSystemName The first resource name to compare, or null.
b	DbSystemName 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 !=(DbSystemName, DbSystemName)

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

Determines whether two specified resource names have different values.

Parameters
Name	Description
a	DbSystemName The first resource name to compare, or null.
b	DbSystemName 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.