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

public sealed class DbServerName : IResourceName, IEquatable<DbServerName>

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

Resource name for the DbServer resource.

Inheritance

object > DbServerName

Namespace

Google.Cloud.OracleDatabase.V1

Assembly

Google.Cloud.OracleDatabase.V1.dll

Constructors

DbServerName(string, string, string, string)

public DbServerName(string projectId, string locationId, string cloudExadataInfrastructureId, string dbServerId)

Constructs a new instance of a DbServerName class from the component parts of pattern projects/{project}/locations/{location}/cloudExadataInfrastructures/{cloud_exadata_infrastructure}/dbServers/{db_server}

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.

cloudExadataInfrastructureId string

The CloudExadataInfrastructure ID. Must not be null or empty.

dbServerId string

The DbServer ID. Must not be null or empty.

Properties

CloudExadataInfrastructureId

public string CloudExadataInfrastructureId { get; }

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

Property Value
Type Description
string

DbServerId

public string DbServerId { get; }

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

The DbServerName.ResourceNameType of the contained resource name.

Property Value
Type Description
DbServerNameResourceNameType

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 cloudExadataInfrastructureId, string dbServerId)

Formats the IDs into the string representation of this DbServerName with pattern projects/{project}/locations/{location}/cloudExadataInfrastructures/{cloud_exadata_infrastructure}/dbServers/{db_server} .

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.

cloudExadataInfrastructureId string

The CloudExadataInfrastructure ID. Must not be null or empty.

dbServerId string

The DbServer ID. Must not be null or empty.

Returns
Type Description
string

The string representation of this DbServerName with pattern projects/{project}/locations/{location}/cloudExadataInfrastructures/{cloud_exadata_infrastructure}/dbServers/{db_server} .

FormatProjectLocationCloudExadataInfrastructureDbServer(string, string, string, string)

public static string FormatProjectLocationCloudExadataInfrastructureDbServer(string projectId, string locationId, string cloudExadataInfrastructureId, string dbServerId)

Formats the IDs into the string representation of this DbServerName with pattern projects/{project}/locations/{location}/cloudExadataInfrastructures/{cloud_exadata_infrastructure}/dbServers/{db_server} .

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.

cloudExadataInfrastructureId string

The CloudExadataInfrastructure ID. Must not be null or empty.

dbServerId string

The DbServer ID. Must not be null or empty.

Returns
Type Description
string

The string representation of this DbServerName with pattern projects/{project}/locations/{location}/cloudExadataInfrastructures/{cloud_exadata_infrastructure}/dbServers/{db_server} .

FromProjectLocationCloudExadataInfrastructureDbServer(string, string, string, string)

public static DbServerName FromProjectLocationCloudExadataInfrastructureDbServer(string projectId, string locationId, string cloudExadataInfrastructureId, string dbServerId)

Creates a DbServerName with the pattern projects/{project}/locations/{location}/cloudExadataInfrastructures/{cloud_exadata_infrastructure}/dbServers/{db_server} .

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.

cloudExadataInfrastructureId string

The CloudExadataInfrastructure ID. Must not be null or empty.

dbServerId string

The DbServer ID. Must not be null or empty.

Returns
Type Description
DbServerName

A new instance of DbServerName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static DbServerName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a DbServerName containing an unparsed resource name.

Parameter
Name Description
unparsedResourceName UnparsedResourceName

The unparsed resource name. Must not be null.

Returns
Type Description
DbServerName

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

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

Parameter
Name Description
dbServerName string

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

Returns
Type Description
DbServerName

The parsed DbServerName if successful.

Remarks

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

  • projects/{project}/locations/{location}/cloudExadataInfrastructures/{cloud_exadata_infrastructure}/dbServers/{db_server}

Parse(string, bool)

public static DbServerName Parse(string dbServerName, bool allowUnparsed)

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

Parameters
Name Description
dbServerName 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
DbServerName

The parsed DbServerName if successful.

Remarks

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

  • projects/{project}/locations/{location}/cloudExadataInfrastructures/{cloud_exadata_infrastructure}/dbServers/{db_server}
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 DbServerName)

public static bool TryParse(string dbServerName, out DbServerName result)

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

Parameters
Name Description
dbServerName string

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

result DbServerName

When this method returns, the parsed DbServerName, 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}/cloudExadataInfrastructures/{cloud_exadata_infrastructure}/dbServers/{db_server}

TryParse(string, bool, out DbServerName)

public static bool TryParse(string dbServerName, bool allowUnparsed, out DbServerName result)

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

Parameters
Name Description
dbServerName 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 DbServerName

When this method returns, the parsed DbServerName, 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}/cloudExadataInfrastructures/{cloud_exadata_infrastructure}/dbServers/{db_server}
Or may be in any format if allowUnparsed is true.

Operators

operator ==(DbServerName, DbServerName)

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

Determines whether two specified resource names have the same value.

Parameters
Name Description
a DbServerName

The first resource name to compare, or null.

b DbServerName

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

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

Determines whether two specified resource names have different values.

Parameters
Name Description
a DbServerName

The first resource name to compare, or null.

b DbServerName

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.