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

Version latest

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

public sealed class PluggableDatabaseName : IResourceName, IEquatable<PluggableDatabaseName>

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

Resource name for the PluggableDatabase resource.

Inheritance

object > PluggableDatabaseName

Implements

IResourceName, IEquatablePluggableDatabaseName

Inherited Members

object.GetType()

Namespace

Google.Cloud.OracleDatabase.V1

Assembly

Google.Cloud.OracleDatabase.V1.dll

Constructors

PluggableDatabaseName(string, string, string)

public PluggableDatabaseName(string projectId, string locationId, string pluggableDatabaseId)

Constructs a new instance of a PluggableDatabaseName class from the component parts of pattern projects/{project}/locations/{location}/pluggableDatabases/{pluggable_database}

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

Properties

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

PluggableDatabaseId

public string PluggableDatabaseId { get; }

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

The PluggableDatabaseName.ResourceNameType of the contained resource name.

Property Value
Type	Description
PluggableDatabaseNameResourceNameType

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

Formats the IDs into the string representation of this PluggableDatabaseName with pattern projects/{project}/locations/{location}/pluggableDatabases/{pluggable_database}.

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

Returns
Type	Description
string	The string representation of this PluggableDatabaseName with pattern projects/{project}/locations/{location}/pluggableDatabases/{pluggable_database}.

FormatProjectLocationPluggableDatabase(string, string, string)

public static string FormatProjectLocationPluggableDatabase(string projectId, string locationId, string pluggableDatabaseId)

Formats the IDs into the string representation of this PluggableDatabaseName with pattern projects/{project}/locations/{location}/pluggableDatabases/{pluggable_database}.

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

Returns
Type	Description
string	The string representation of this PluggableDatabaseName with pattern projects/{project}/locations/{location}/pluggableDatabases/{pluggable_database}.

FromProjectLocationPluggableDatabase(string, string, string)

public static PluggableDatabaseName FromProjectLocationPluggableDatabase(string projectId, string locationId, string pluggableDatabaseId)

Creates a PluggableDatabaseName with the pattern projects/{project}/locations/{location}/pluggableDatabases/{pluggable_database}.

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

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

FromUnparsed(UnparsedResourceName)

public static PluggableDatabaseName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a PluggableDatabaseName containing an unparsed resource name.

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

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

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

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

Returns
Type	Description
PluggableDatabaseName	The parsed PluggableDatabaseName if successful.

Remarks

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

• projects/{project}/locations/{location}/pluggableDatabases/{pluggable_database}

Parse(string, bool)

public static PluggableDatabaseName Parse(string pluggableDatabaseName, bool allowUnparsed)

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

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

Remarks

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

• projects/{project}/locations/{location}/pluggableDatabases/{pluggable_database}

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

public static bool TryParse(string pluggableDatabaseName, out PluggableDatabaseName result)

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

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

TryParse(string, bool, out PluggableDatabaseName)

public static bool TryParse(string pluggableDatabaseName, bool allowUnparsed, out PluggableDatabaseName result)

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

Parameters
Name	Description
pluggableDatabaseName	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	PluggableDatabaseName When this method returns, the parsed PluggableDatabaseName, 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}/pluggableDatabases/{pluggable_database}

Or may be in any format if allowUnparsed is true.

Operators

operator ==(PluggableDatabaseName, PluggableDatabaseName)

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

Determines whether two specified resource names have the same value.

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

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

Determines whether two specified resource names have different values.

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