Google.Cloud.Spanner.Common.V1 - Class InstanceName (5.0.0-beta04) 

public sealed class InstanceName : IResourceName, IEquatable<InstanceName>

Reference documentation and code samples for the Google.Cloud.Spanner.Common.V1 class InstanceName.

Resource name for the Instance resource.

Inheritance

object > InstanceName

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; }

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

The InstanceName.ResourceNameType of the contained resource name.

Property Value
Type Description
InstanceNameResourceNameType

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
int
Overrides

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

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

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
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}/instances/{instance}

TryParse(string, bool, 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 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 InstanceName

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

Operators

operator ==(InstanceName, InstanceName)

public static bool operator ==(InstanceName a, InstanceName b)
Parameters
Name Description
a InstanceName
b InstanceName
Returns
Type Description
bool

operator !=(InstanceName, InstanceName)

public static bool operator !=(InstanceName a, InstanceName b)
Parameters
Name Description
a InstanceName
b InstanceName
Returns
Type Description
bool