Class InstanceConfigName (3.11.0)

Version 3.11.0

• 5.0.0-beta05 (latest)
• 5.0.0-beta04
• 4.6.0
• 4.5.0
• 4.4.0
• 4.3.0
• 4.2.0
• 4.1.0
• 4.0.0
• 3.15.1
• 3.14.0
• 3.13.0
• 3.12.0
• 3.11.0
• 3.10.0
• 3.9.0
• 3.8.0
• 3.7.0
• 3.6.0
• 3.5.0

public sealed class InstanceConfigName : IResourceName, IEquatable<InstanceConfigName>

Resource name for the InstanceConfig resource.

Inheritance

Object > InstanceConfigName

Implements

IResourceName, IEquatable<InstanceConfigName>

Inherited Members

Object.GetType()

Object.MemberwiseClone()

Namespace

Google.Cloud.Spanner.Admin.Instance.V1

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
Boolean

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
InstanceConfigName.ResourceNameType

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
Int32

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, Boolean)

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	Boolean 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
Boolean	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, Boolean, 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	Boolean 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
Boolean	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

Equality(InstanceConfigName, InstanceConfigName)

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

Parameters
Name	Description
a	InstanceConfigName
b	InstanceConfigName

Returns
Type	Description
Boolean

Inequality(InstanceConfigName, InstanceConfigName)

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

Parameters
Name	Description
a	InstanceConfigName
b	InstanceConfigName

Returns
Type	Description
Boolean