Google Cloud Spanner Instance Administration v1 API - Class InstanceConfigName (4.3.0)

public sealed class InstanceConfigName : IResourceName, IEquatable<InstanceConfigName>

Reference documentation and code samples for the Google Cloud Spanner Instance Administration v1 API class InstanceConfigName.

Resource name for the InstanceConfig resource.

Inheritance

object > InstanceConfigName

Implements

IResourceName, IEquatable InstanceConfigName

Inherited Members

object.GetType()

object.MemberwiseClone()

Namespace

Google CloudGoogle.Cloud.SpannerGoogle.Cloud.Spanner.AdminGoogle.Cloud.Spanner.Admin.InstanceV1

Assembly

Google.Cloud.Spanner.Admin.Instance.V1.dll

Constructors

InstanceConfigName(string, string)

public InstanceConfigName(string projectId, string instanceConfigId)

Constructs a new instance of a InstanceConfigName class from the component parts of pattern projects/{project}/instanceConfigs/{instance_config}

Parameters
Name	Description
`projectId`	`string` The `Project` ID. Must not be `null` or empty.
`instanceConfigId`	`string` The `InstanceConfig` ID. Must not be `null` or empty.

Properties

InstanceConfigId

public string InstanceConfigId { get; }

The InstanceConfig 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`

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 InstanceConfigName.ResourceNameType Type { get; }

The InstanceConfigName.ResourceNameType of the contained resource name.

Property Value
Type	Description
`InstanceConfigNameResourceNameType`

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)

public static string Format(string projectId, string instanceConfigId)

Formats the IDs into the string representation of this InstanceConfigName with pattern projects/{project}/instanceConfigs/{instance_config}.

Parameters
Name	Description
`projectId`	`string` The `Project` ID. Must not be `null` or empty.
`instanceConfigId`	`string` The `InstanceConfig` ID. Must not be `null` or empty.

Returns
Type	Description
`string`	The string representation of this InstanceConfigName with pattern `projects/{project}/instanceConfigs/{instance_config}`.

FormatProjectInstanceConfig(string, string)

public static string FormatProjectInstanceConfig(string projectId, string instanceConfigId)

Formats the IDs into the string representation of this InstanceConfigName with pattern projects/{project}/instanceConfigs/{instance_config}.

Parameters
Name	Description
`projectId`	`string` The `Project` ID. Must not be `null` or empty.
`instanceConfigId`	`string` The `InstanceConfig` ID. Must not be `null` or empty.

Returns
Type	Description
`string`	The string representation of this InstanceConfigName with pattern `projects/{project}/instanceConfigs/{instance_config}`.

FromProjectInstanceConfig(string, string)

public static InstanceConfigName FromProjectInstanceConfig(string projectId, string instanceConfigId)

Creates a InstanceConfigName with the pattern projects/{project}/instanceConfigs/{instance_config}.

Parameters
Name	Description
`projectId`	`string` The `Project` ID. Must not be `null` or empty.
`instanceConfigId`	`string` The `InstanceConfig` ID. Must not be `null` or empty.

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

FromUnparsed(UnparsedResourceName)

public static InstanceConfigName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a InstanceConfigName containing an unparsed resource name.

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

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

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

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

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

Remarks

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

projects/{project}/instanceConfigs/{instance_config}

Parse(string, bool)

public static InstanceConfigName Parse(string instanceConfigName, bool allowUnparsed)

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

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

Remarks

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

projects/{project}/instanceConfigs/{instance_config}

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

public static bool TryParse(string instanceConfigName, out InstanceConfigName result)

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

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

TryParse(string, bool, out InstanceConfigName)

public static bool TryParse(string instanceConfigName, bool allowUnparsed, out InstanceConfigName result)

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

Parameters
Name	Description
`instanceConfigName`	`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`	`InstanceConfigName` When this method returns, the parsed InstanceConfigName, 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}/instanceConfigs/{instance_config}

Or may be in any format if allowUnparsed is true.

Operators

operator ==(InstanceConfigName, InstanceConfigName)

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

Parameters
Name	Description
`a`	`InstanceConfigName`
`b`	`InstanceConfigName`

Returns
Type	Description
`bool`

operator !=(InstanceConfigName, InstanceConfigName)

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

Parameters
Name	Description
`a`	`InstanceConfigName`
`b`	`InstanceConfigName`

Returns
Type	Description
`bool`