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

Version latest

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

public sealed class OdbNetworkName : IResourceName, IEquatable<OdbNetworkName>

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

Resource name for the OdbNetwork resource.

Inheritance

object > OdbNetworkName

Implements

IResourceName, IEquatableOdbNetworkName

Inherited Members

object.GetType()

Namespace

Google.Cloud.OracleDatabase.V1

Assembly

Google.Cloud.OracleDatabase.V1.dll

Constructors

OdbNetworkName(string, string, string)

public OdbNetworkName(string projectId, string locationId, string odbNetworkId)

Constructs a new instance of a OdbNetworkName class from the component parts of pattern projects/{project}/locations/{location}/odbNetworks/{odb_network}

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.
odbNetworkId	string The OdbNetwork 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

OdbNetworkId

public string OdbNetworkId { get; }

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

The OdbNetworkName.ResourceNameType of the contained resource name.

Property Value
Type	Description
OdbNetworkNameResourceNameType

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

Formats the IDs into the string representation of this OdbNetworkName with pattern projects/{project}/locations/{location}/odbNetworks/{odb_network}.

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

Returns
Type	Description
string	The string representation of this OdbNetworkName with pattern projects/{project}/locations/{location}/odbNetworks/{odb_network}.

FormatProjectLocationOdbNetwork(string, string, string)

public static string FormatProjectLocationOdbNetwork(string projectId, string locationId, string odbNetworkId)

Formats the IDs into the string representation of this OdbNetworkName with pattern projects/{project}/locations/{location}/odbNetworks/{odb_network}.

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

Returns
Type	Description
string	The string representation of this OdbNetworkName with pattern projects/{project}/locations/{location}/odbNetworks/{odb_network}.

FromProjectLocationOdbNetwork(string, string, string)

public static OdbNetworkName FromProjectLocationOdbNetwork(string projectId, string locationId, string odbNetworkId)

Creates a OdbNetworkName with the pattern projects/{project}/locations/{location}/odbNetworks/{odb_network}.

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

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

FromUnparsed(UnparsedResourceName)

public static OdbNetworkName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a OdbNetworkName containing an unparsed resource name.

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

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

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

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

Returns
Type	Description
OdbNetworkName	The parsed OdbNetworkName if successful.

Remarks

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

• projects/{project}/locations/{location}/odbNetworks/{odb_network}

Parse(string, bool)

public static OdbNetworkName Parse(string odbNetworkName, bool allowUnparsed)

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

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

Remarks

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

• projects/{project}/locations/{location}/odbNetworks/{odb_network}

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

public static bool TryParse(string odbNetworkName, out OdbNetworkName result)

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

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

TryParse(string, bool, out OdbNetworkName)

public static bool TryParse(string odbNetworkName, bool allowUnparsed, out OdbNetworkName result)

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

Parameters
Name	Description
odbNetworkName	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	OdbNetworkName When this method returns, the parsed OdbNetworkName, 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}/odbNetworks/{odb_network}

Or may be in any format if allowUnparsed is true.

Operators

operator ==(OdbNetworkName, OdbNetworkName)

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

Determines whether two specified resource names have the same value.

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

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

Determines whether two specified resource names have different values.

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