Class InstanceName (3.13.0)

Version 3.13.0

• 5.0.0-beta04 (latest)
• 5.0.0-beta03
• 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 InstanceName : IResourceName, IEquatable<InstanceName>

Resource name for the Instance resource.

Inheritance

Object > InstanceName

Implements

IResourceName, IEquatable<InstanceName>

Inherited Members

Object.GetType()

Object.MemberwiseClone()

Namespace

Google.Cloud.Spanner.Common.V1

Assembly

Google.Cloud.Spanner.Common.V1.dll

Constructors

InstanceName(String, String)

public InstanceName(string projectId, string instanceId)

Constructs a new instance of a InstanceName class from the component parts of pattern projects/{project}/instances/{instance}

Parameters
Name	Description
projectId	String The Project ID. Must not be null or empty.
instanceId	String The Instance ID. Must not be null or empty.

Properties

InstanceId

public string InstanceId { get; }

The Instance ID. Will not be null, unless this instance contains an unparsed resource name.

Property Value
Type	Description
String

IsKnownPattern

public bool IsKnownPattern { get; }

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

The InstanceName.ResourceNameType of the contained resource name.

Property Value
Type	Description
InstanceName.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 instanceId)

Formats the IDs into the string representation of this InstanceName with pattern projects/{project}/instances/{instance}.

Parameters
Name	Description
projectId	String The Project ID. Must not be null or empty.
instanceId	String The Instance ID. Must not be null or empty.

Returns
Type	Description
String	The string representation of this InstanceName with pattern projects/{project}/instances/{instance}.

FormatProjectInstance(String, String)

public static string FormatProjectInstance(string projectId, string instanceId)

Formats the IDs into the string representation of this InstanceName with pattern projects/{project}/instances/{instance}.

Parameters
Name	Description
projectId	String The Project ID. Must not be null or empty.
instanceId	String The Instance ID. Must not be null or empty.

Returns
Type	Description
String	The string representation of this InstanceName with pattern projects/{project}/instances/{instance}.

FromProjectInstance(String, String)

public static InstanceName FromProjectInstance(string projectId, string instanceId)

Creates a InstanceName with the pattern projects/{project}/instances/{instance}.

Parameters
Name	Description
projectId	String The Project ID. Must not be null or empty.
instanceId	String The Instance ID. Must not be null or empty.

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

FromUnparsed(UnparsedResourceName)

public static InstanceName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a InstanceName containing an unparsed resource name.

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

Returns
Type	Description
InstanceName	A new instance of InstanceName containing the provided unparsedResourceName .

GetHashCode()

public override int GetHashCode()

Returns
Type	Description
Int32

Overrides

Object.GetHashCode()

Parse(String)

public static InstanceName Parse(string instanceName)

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

Parameter
Name	Description
instanceName	String The resource name in string form. Must not be null.

Returns
Type	Description
InstanceName	The parsed InstanceName if successful.

Remarks

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

• projects/{project}/instances/{instance}

Parse(String, Boolean)

public static InstanceName Parse(string instanceName, bool allowUnparsed)

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

Parameters
Name	Description
instanceName	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
InstanceName	The parsed InstanceName if successful.

Remarks

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

• projects/{project}/instances/{instance}

Or may be in any format if allowUnparsed is true.

ToString()

public override string ToString()

Returns
Type	Description
String

Overrides

Object.ToString()

TryParse(String, out InstanceName)

public static bool TryParse(string instanceName, out InstanceName result)

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

Parameters
Name	Description
instanceName	String The resource name in string form. Must not be null.
result	InstanceName When this method returns, the parsed InstanceName, 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}/instances/{instance}

TryParse(String, Boolean, out InstanceName)

public static bool TryParse(string instanceName, bool allowUnparsed, out InstanceName result)

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

Parameters
Name	Description
instanceName	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	InstanceName When this method returns, the parsed InstanceName, 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}/instances/{instance}

Or may be in any format if allowUnparsed is true.

Operators

Equality(InstanceName, InstanceName)

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

Parameters
Name	Description
a	InstanceName
b	InstanceName

Returns
Type	Description
Boolean

Inequality(InstanceName, InstanceName)

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

Parameters
Name	Description
a	InstanceName
b	InstanceName

Returns
Type	Description
Boolean