Oracle Database@Google Cloud v1 API - Class DbNodeName (1.0.0) 

public sealed class DbNodeName : IResourceName, IEquatable<DbNodeName>

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

Resource name for the DbNode resource.

Inheritance

object > DbNodeName

Namespace

Google.Cloud.OracleDatabase.V1

Assembly

Google.Cloud.OracleDatabase.V1.dll

Constructors

DbNodeName(string, string, string, string)

public DbNodeName(string projectId, string locationId, string cloudVmClusterId, string dbNodeId)

Constructs a new instance of a DbNodeName class from the component parts of pattern projects/{project}/locations/{location}/cloudVmClusters/{cloud_vm_cluster}/dbNodes/{db_node}

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.
cloudVmClusterId string

The CloudVmCluster ID. Must not be null or empty.
dbNodeId string

The DbNode ID. Must not be null or empty.

Properties

CloudVmClusterId

public string CloudVmClusterId { get; }

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

Property Value
Type Description
string

DbNodeId

public string DbNodeId { get; }

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

The DbNodeName.ResourceNameType of the contained resource name.

Property Value
Type Description
DbNodeNameResourceNameType

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

Formats the IDs into the string representation of this DbNodeName with pattern projects/{project}/locations/{location}/cloudVmClusters/{cloud_vm_cluster}/dbNodes/{db_node}.

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.
cloudVmClusterId string

The CloudVmCluster ID. Must not be null or empty.
dbNodeId string

The DbNode ID. Must not be null or empty.
Returns
Type Description
string

The string representation of this DbNodeName with pattern projects/{project}/locations/{location}/cloudVmClusters/{cloud_vm_cluster}/dbNodes/{db_node}.

FormatProjectLocationCloudVmClusterDbNode(string, string, string, string)

public static string FormatProjectLocationCloudVmClusterDbNode(string projectId, string locationId, string cloudVmClusterId, string dbNodeId)

Formats the IDs into the string representation of this DbNodeName with pattern projects/{project}/locations/{location}/cloudVmClusters/{cloud_vm_cluster}/dbNodes/{db_node}.

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.
cloudVmClusterId string

The CloudVmCluster ID. Must not be null or empty.
dbNodeId string

The DbNode ID. Must not be null or empty.
Returns
Type Description
string

The string representation of this DbNodeName with pattern projects/{project}/locations/{location}/cloudVmClusters/{cloud_vm_cluster}/dbNodes/{db_node}.

FromProjectLocationCloudVmClusterDbNode(string, string, string, string)

public static DbNodeName FromProjectLocationCloudVmClusterDbNode(string projectId, string locationId, string cloudVmClusterId, string dbNodeId)

Creates a DbNodeName with the pattern projects/{project}/locations/{location}/cloudVmClusters/{cloud_vm_cluster}/dbNodes/{db_node}.

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.
cloudVmClusterId string

The CloudVmCluster ID. Must not be null or empty.
dbNodeId string

The DbNode ID. Must not be null or empty.
Returns
Type Description
DbNodeName

A new instance of DbNodeName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static DbNodeName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a DbNodeName containing an unparsed resource name.

Parameter
Name Description
unparsedResourceName UnparsedResourceName

The unparsed resource name. Must not be null.
Returns
Type Description
DbNodeName

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

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

Parameter
Name Description
dbNodeName string

The resource name in string form. Must not be null.
Returns
Type Description
DbNodeName

The parsed DbNodeName if successful.
Remarks

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

  • projects/{project}/locations/{location}/cloudVmClusters/{cloud_vm_cluster}/dbNodes/{db_node}

Parse(string, bool)

public static DbNodeName Parse(string dbNodeName, bool allowUnparsed)

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

Parameters
Name Description
dbNodeName 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
DbNodeName

The parsed DbNodeName if successful.
Remarks

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

  • projects/{project}/locations/{location}/cloudVmClusters/{cloud_vm_cluster}/dbNodes/{db_node}
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 DbNodeName)

public static bool TryParse(string dbNodeName, out DbNodeName result)

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

Parameters
Name Description
dbNodeName string

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

When this method returns, the parsed DbNodeName, 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}/cloudVmClusters/{cloud_vm_cluster}/dbNodes/{db_node}

TryParse(string, bool, out DbNodeName)

public static bool TryParse(string dbNodeName, bool allowUnparsed, out DbNodeName result)

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

Parameters
Name Description
dbNodeName 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 DbNodeName

When this method returns, the parsed DbNodeName, 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}/cloudVmClusters/{cloud_vm_cluster}/dbNodes/{db_node}
Or may be in any format if allowUnparsed is true.

Operators

operator ==(DbNodeName, DbNodeName)

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

Determines whether two specified resource names have the same value.

Parameters
Name Description
a DbNodeName

The first resource name to compare, or null.
b DbNodeName

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

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

Determines whether two specified resource names have different values.

Parameters
Name Description
a DbNodeName

The first resource name to compare, or null.
b DbNodeName

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.