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

public sealed class DatabaseCharacterSetName : IResourceName, IEquatable<DatabaseCharacterSetName>

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

Resource name for the DatabaseCharacterSet resource.

Inheritance

object > DatabaseCharacterSetName

Namespace

Google.Cloud.OracleDatabase.V1

Assembly

Google.Cloud.OracleDatabase.V1.dll

Constructors

DatabaseCharacterSetName(string, string, string)

public DatabaseCharacterSetName(string projectId, string locationId, string databaseCharacterSetId)

Constructs a new instance of a DatabaseCharacterSetName class from the component parts of pattern projects/{project}/locations/{location}/databaseCharacterSets/{database_character_set}

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.

databaseCharacterSetId string

The DatabaseCharacterSet ID. Must not be null or empty.

Properties

DatabaseCharacterSetId

public string DatabaseCharacterSetId { get; }

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

The DatabaseCharacterSetName.ResourceNameType of the contained resource name.

Property Value
Type Description
DatabaseCharacterSetNameResourceNameType

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

Formats the IDs into the string representation of this DatabaseCharacterSetName with pattern projects/{project}/locations/{location}/databaseCharacterSets/{database_character_set}.

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.

databaseCharacterSetId string

The DatabaseCharacterSet ID. Must not be null or empty.

Returns
Type Description
string

The string representation of this DatabaseCharacterSetName with pattern projects/{project}/locations/{location}/databaseCharacterSets/{database_character_set}.

FormatProjectLocationDatabaseCharacterSet(string, string, string)

public static string FormatProjectLocationDatabaseCharacterSet(string projectId, string locationId, string databaseCharacterSetId)

Formats the IDs into the string representation of this DatabaseCharacterSetName with pattern projects/{project}/locations/{location}/databaseCharacterSets/{database_character_set}.

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.

databaseCharacterSetId string

The DatabaseCharacterSet ID. Must not be null or empty.

Returns
Type Description
string

The string representation of this DatabaseCharacterSetName with pattern projects/{project}/locations/{location}/databaseCharacterSets/{database_character_set}.

FromProjectLocationDatabaseCharacterSet(string, string, string)

public static DatabaseCharacterSetName FromProjectLocationDatabaseCharacterSet(string projectId, string locationId, string databaseCharacterSetId)

Creates a DatabaseCharacterSetName with the pattern projects/{project}/locations/{location}/databaseCharacterSets/{database_character_set}.

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.

databaseCharacterSetId string

The DatabaseCharacterSet ID. Must not be null or empty.

Returns
Type Description
DatabaseCharacterSetName

A new instance of DatabaseCharacterSetName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static DatabaseCharacterSetName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a DatabaseCharacterSetName containing an unparsed resource name.

Parameter
Name Description
unparsedResourceName UnparsedResourceName

The unparsed resource name. Must not be null.

Returns
Type Description
DatabaseCharacterSetName

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

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

Parameter
Name Description
databaseCharacterSetName string

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

Returns
Type Description
DatabaseCharacterSetName

The parsed DatabaseCharacterSetName if successful.

Remarks

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

  • projects/{project}/locations/{location}/databaseCharacterSets/{database_character_set}

Parse(string, bool)

public static DatabaseCharacterSetName Parse(string databaseCharacterSetName, bool allowUnparsed)

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

Parameters
Name Description
databaseCharacterSetName 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
DatabaseCharacterSetName

The parsed DatabaseCharacterSetName if successful.

Remarks

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

  • projects/{project}/locations/{location}/databaseCharacterSets/{database_character_set}
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 DatabaseCharacterSetName)

public static bool TryParse(string databaseCharacterSetName, out DatabaseCharacterSetName result)

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

Parameters
Name Description
databaseCharacterSetName string

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

result DatabaseCharacterSetName

When this method returns, the parsed DatabaseCharacterSetName, 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}/databaseCharacterSets/{database_character_set}

TryParse(string, bool, out DatabaseCharacterSetName)

public static bool TryParse(string databaseCharacterSetName, bool allowUnparsed, out DatabaseCharacterSetName result)

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

Parameters
Name Description
databaseCharacterSetName 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 DatabaseCharacterSetName

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

Operators

operator ==(DatabaseCharacterSetName, DatabaseCharacterSetName)

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

Determines whether two specified resource names have the same value.

Parameters
Name Description
a DatabaseCharacterSetName

The first resource name to compare, or null.

b DatabaseCharacterSetName

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

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

Determines whether two specified resource names have different values.

Parameters
Name Description
a DatabaseCharacterSetName

The first resource name to compare, or null.

b DatabaseCharacterSetName

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.