AlloyDB v1 API - Class SupportedDatabaseFlagName (1.4.0)

public sealed class SupportedDatabaseFlagName : IResourceName, IEquatable<SupportedDatabaseFlagName>

Reference documentation and code samples for the AlloyDB v1 API class SupportedDatabaseFlagName.

Resource name for the SupportedDatabaseFlag resource.

Inheritance

object > SupportedDatabaseFlagName

Implements

IResourceName, IEquatable SupportedDatabaseFlagName

Inherited Members

object.GetType()

Namespace

Google.Cloud.AlloyDb.V1

Assembly

Google.Cloud.AlloyDb.V1.dll

Constructors

SupportedDatabaseFlagName(string, string, string)

public SupportedDatabaseFlagName(string projectId, string locationId, string flagId)

Constructs a new instance of a SupportedDatabaseFlagName class from the component parts of pattern projects/{project}/locations/{location}/flags/{flag}

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.
`flagId`	`string` The `Flag` ID. Must not be `null` or empty.

Properties

FlagId

public string FlagId { get; }

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

The SupportedDatabaseFlagName.ResourceNameType of the contained resource name.

Property Value
Type	Description
`SupportedDatabaseFlagNameResourceNameType`

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

Formats the IDs into the string representation of this SupportedDatabaseFlagName with pattern projects/{project}/locations/{location}/flags/{flag}.

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.
`flagId`	`string` The `Flag` ID. Must not be `null` or empty.

Returns
Type	Description
`string`	The string representation of this SupportedDatabaseFlagName with pattern `projects/{project}/locations/{location}/flags/{flag}`.

FormatProjectLocationFlag(string, string, string)

public static string FormatProjectLocationFlag(string projectId, string locationId, string flagId)

Formats the IDs into the string representation of this SupportedDatabaseFlagName with pattern projects/{project}/locations/{location}/flags/{flag}.

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.
`flagId`	`string` The `Flag` ID. Must not be `null` or empty.

Returns
Type	Description
`string`	The string representation of this SupportedDatabaseFlagName with pattern `projects/{project}/locations/{location}/flags/{flag}`.

FromProjectLocationFlag(string, string, string)

public static SupportedDatabaseFlagName FromProjectLocationFlag(string projectId, string locationId, string flagId)

Creates a SupportedDatabaseFlagName with the pattern projects/{project}/locations/{location}/flags/{flag}.

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.
`flagId`	`string` The `Flag` ID. Must not be `null` or empty.

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

FromUnparsed(UnparsedResourceName)

public static SupportedDatabaseFlagName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a SupportedDatabaseFlagName containing an unparsed resource name.

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

Returns
Type	Description
`SupportedDatabaseFlagName`	A new instance of SupportedDatabaseFlagName 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 SupportedDatabaseFlagName Parse(string supportedDatabaseFlagName)

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

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

Returns
Type	Description
`SupportedDatabaseFlagName`	The parsed SupportedDatabaseFlagName if successful.

Remarks

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

projects/{project}/locations/{location}/flags/{flag}

Parse(string, bool)

public static SupportedDatabaseFlagName Parse(string supportedDatabaseFlagName, bool allowUnparsed)

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

Parameters
Name	Description
`supportedDatabaseFlagName`	`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
`SupportedDatabaseFlagName`	The parsed SupportedDatabaseFlagName if successful.

Remarks

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

projects/{project}/locations/{location}/flags/{flag}

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

public static bool TryParse(string supportedDatabaseFlagName, out SupportedDatabaseFlagName result)

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

Parameters
Name	Description
`supportedDatabaseFlagName`	`string` The resource name in string form. Must not be `null`.
`result`	`SupportedDatabaseFlagName` When this method returns, the parsed SupportedDatabaseFlagName, 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}/flags/{flag}

TryParse(string, bool, out SupportedDatabaseFlagName)

public static bool TryParse(string supportedDatabaseFlagName, bool allowUnparsed, out SupportedDatabaseFlagName result)

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

Parameters
Name	Description
`supportedDatabaseFlagName`	`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`	`SupportedDatabaseFlagName` When this method returns, the parsed SupportedDatabaseFlagName, 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}/flags/{flag}

Or may be in any format if allowUnparsed is true.

Operators

operator ==(SupportedDatabaseFlagName, SupportedDatabaseFlagName)

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

Parameters
Name	Description
`a`	`SupportedDatabaseFlagName`
`b`	`SupportedDatabaseFlagName`

Returns
Type	Description
`bool`

operator !=(SupportedDatabaseFlagName, SupportedDatabaseFlagName)

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

Parameters
Name	Description
`a`	`SupportedDatabaseFlagName`
`b`	`SupportedDatabaseFlagName`

Returns
Type	Description
`bool`