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

public sealed class DbSystemShapeName : IResourceName, IEquatable<DbSystemShapeName>

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

Resource name for the DbSystemShape resource.

Inheritance

object > DbSystemShapeName

Namespace

Google.Cloud.OracleDatabase.V1

Assembly

Google.Cloud.OracleDatabase.V1.dll

Constructors

DbSystemShapeName(string, string, string)

public DbSystemShapeName(string projectId, string locationId, string dbSystemShapeId)

Constructs a new instance of a DbSystemShapeName class from the component parts of pattern projects/{project}/locations/{location}/dbSystemShapes/{db_system_shape}

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.

dbSystemShapeId string

The DbSystemShape ID. Must not be null or empty.

Properties

DbSystemShapeId

public string DbSystemShapeId { get; }

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

The DbSystemShapeName.ResourceNameType of the contained resource name.

Property Value
Type Description
DbSystemShapeNameResourceNameType

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

Formats the IDs into the string representation of this DbSystemShapeName with pattern projects/{project}/locations/{location}/dbSystemShapes/{db_system_shape}.

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.

dbSystemShapeId string

The DbSystemShape ID. Must not be null or empty.

Returns
Type Description
string

The string representation of this DbSystemShapeName with pattern projects/{project}/locations/{location}/dbSystemShapes/{db_system_shape}.

FormatProjectLocationDbSystemShape(string, string, string)

public static string FormatProjectLocationDbSystemShape(string projectId, string locationId, string dbSystemShapeId)

Formats the IDs into the string representation of this DbSystemShapeName with pattern projects/{project}/locations/{location}/dbSystemShapes/{db_system_shape}.

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.

dbSystemShapeId string

The DbSystemShape ID. Must not be null or empty.

Returns
Type Description
string

The string representation of this DbSystemShapeName with pattern projects/{project}/locations/{location}/dbSystemShapes/{db_system_shape}.

FromProjectLocationDbSystemShape(string, string, string)

public static DbSystemShapeName FromProjectLocationDbSystemShape(string projectId, string locationId, string dbSystemShapeId)

Creates a DbSystemShapeName with the pattern projects/{project}/locations/{location}/dbSystemShapes/{db_system_shape}.

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.

dbSystemShapeId string

The DbSystemShape ID. Must not be null or empty.

Returns
Type Description
DbSystemShapeName

A new instance of DbSystemShapeName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static DbSystemShapeName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a DbSystemShapeName containing an unparsed resource name.

Parameter
Name Description
unparsedResourceName UnparsedResourceName

The unparsed resource name. Must not be null.

Returns
Type Description
DbSystemShapeName

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

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

Parameter
Name Description
dbSystemShapeName string

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

Returns
Type Description
DbSystemShapeName

The parsed DbSystemShapeName if successful.

Remarks

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

  • projects/{project}/locations/{location}/dbSystemShapes/{db_system_shape}

Parse(string, bool)

public static DbSystemShapeName Parse(string dbSystemShapeName, bool allowUnparsed)

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

Parameters
Name Description
dbSystemShapeName 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
DbSystemShapeName

The parsed DbSystemShapeName if successful.

Remarks

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

  • projects/{project}/locations/{location}/dbSystemShapes/{db_system_shape}
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 DbSystemShapeName)

public static bool TryParse(string dbSystemShapeName, out DbSystemShapeName result)

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

Parameters
Name Description
dbSystemShapeName string

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

result DbSystemShapeName

When this method returns, the parsed DbSystemShapeName, 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}/dbSystemShapes/{db_system_shape}

TryParse(string, bool, out DbSystemShapeName)

public static bool TryParse(string dbSystemShapeName, bool allowUnparsed, out DbSystemShapeName result)

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

Parameters
Name Description
dbSystemShapeName 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 DbSystemShapeName

When this method returns, the parsed DbSystemShapeName, 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}/dbSystemShapes/{db_system_shape}
Or may be in any format if allowUnparsed is true.

Operators

operator ==(DbSystemShapeName, DbSystemShapeName)

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

Determines whether two specified resource names have the same value.

Parameters
Name Description
a DbSystemShapeName

The first resource name to compare, or null.

b DbSystemShapeName

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

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

Determines whether two specified resource names have different values.

Parameters
Name Description
a DbSystemShapeName

The first resource name to compare, or null.

b DbSystemShapeName

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.