Google Cloud Spanner Instance Administration v1 API - Class InstancePartitionName (5.0.0-beta05) 

public sealed class InstancePartitionName : IResourceName, IEquatable<InstancePartitionName>

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

Resource name for the InstancePartition resource.

Inheritance

object > InstancePartitionName

Namespace

Google.Cloud.Spanner.Admin.Instance.V1

Assembly

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

Constructors

InstancePartitionName(string, string, string)

public InstancePartitionName(string projectId, string instanceId, string instancePartitionId)

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

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.
instancePartitionId string

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

InstancePartitionId

public string InstancePartitionId { get; }

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

The InstancePartitionName.ResourceNameType of the contained resource name.

Property Value
Type Description
InstancePartitionNameResourceNameType

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 instanceId, string instancePartitionId)

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

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.
instancePartitionId string

The InstancePartition ID. Must not be null or empty.
Returns
Type Description
string

The string representation of this InstancePartitionName with pattern projects/{project}/instances/{instance}/instancePartitions/{instance_partition}.

FormatProjectInstanceInstancePartition(string, string, string)

public static string FormatProjectInstanceInstancePartition(string projectId, string instanceId, string instancePartitionId)

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

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.
instancePartitionId string

The InstancePartition ID. Must not be null or empty.
Returns
Type Description
string

The string representation of this InstancePartitionName with pattern projects/{project}/instances/{instance}/instancePartitions/{instance_partition}.

FromProjectInstanceInstancePartition(string, string, string)

public static InstancePartitionName FromProjectInstanceInstancePartition(string projectId, string instanceId, string instancePartitionId)

Creates a InstancePartitionName with the pattern projects/{project}/instances/{instance}/instancePartitions/{instance_partition}.

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.
instancePartitionId string

The InstancePartition ID. Must not be null or empty.
Returns
Type Description
InstancePartitionName

A new instance of InstancePartitionName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static InstancePartitionName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a InstancePartitionName containing an unparsed resource name.

Parameter
Name Description
unparsedResourceName UnparsedResourceName

The unparsed resource name. Must not be null.
Returns
Type Description
InstancePartitionName

A new instance of InstancePartitionName containing the provided unparsedResourceName.

GetHashCode()

public override int GetHashCode()

Returns a hash code for this resource name.

Returns
Type Description
int
Overrides

Parse(string)

public static InstancePartitionName Parse(string instancePartitionName)

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

Parameter
Name Description
instancePartitionName string

The resource name in string form. Must not be null.
Returns
Type Description
InstancePartitionName

The parsed InstancePartitionName if successful.
Remarks

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

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

Parse(string, bool)

public static InstancePartitionName Parse(string instancePartitionName, bool allowUnparsed)

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

Parameters
Name Description
instancePartitionName 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
InstancePartitionName

The parsed InstancePartitionName if successful.
Remarks

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

  • projects/{project}/instances/{instance}/instancePartitions/{instance_partition}
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

TryParse(string, out InstancePartitionName)

public static bool TryParse(string instancePartitionName, out InstancePartitionName result)

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

Parameters
Name Description
instancePartitionName string

The resource name in string form. Must not be null.
result InstancePartitionName

When this method returns, the parsed InstancePartitionName, 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}/instancePartitions/{instance_partition}

TryParse(string, bool, out InstancePartitionName)

public static bool TryParse(string instancePartitionName, bool allowUnparsed, out InstancePartitionName result)

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

Parameters
Name Description
instancePartitionName 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 InstancePartitionName

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

Operators

operator ==(InstancePartitionName, InstancePartitionName)

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

Determines whether two specified resource names have the same value.

Parameters
Name Description
a InstancePartitionName

The first resource name to compare, or null.
b InstancePartitionName

The second resource name to compare, or null.
Returns
Type Description
bool

true if the value of a is the same as the value of b; otherwise, false.

operator !=(InstancePartitionName, InstancePartitionName)

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

Determines whether two specified resource names have different values.

Parameters
Name Description
a InstancePartitionName

The first resource name to compare, or null.
b InstancePartitionName

The second resource name to compare, or null.
Returns
Type Description
bool

true if the value of a is different from the value of b; otherwise, false.