Google Cloud Bigtable Administration v2 API - Class SnapshotName (3.15.0) 

public sealed class SnapshotName : IResourceName, IEquatable<SnapshotName>

Reference documentation and code samples for the Google Cloud Bigtable Administration v2 API class SnapshotName.

Resource name for the Snapshot resource.

Inheritance

object > SnapshotName

Namespace

Google.Cloud.Bigtable.Admin.V2

Assembly

Google.Cloud.Bigtable.Admin.V2.dll

Constructors

SnapshotName(string, string, string, string)

public SnapshotName(string projectId, string instanceId, string clusterId, string snapshotId)

Constructs a new instance of a SnapshotName class from the component parts of pattern projects/{project}/instances/{instance}/clusters/{cluster}/snapshots/{snapshot}

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

The Cluster ID. Must not be null or empty.
snapshotId string

The Snapshot ID. Must not be null or empty.

Properties

ClusterId

public string ClusterId { get; }

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

Property Value
Type Description
string

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

SnapshotId

public string SnapshotId { get; }

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

Property Value
Type Description
string

Type

public SnapshotName.ResourceNameType Type { get; }

The SnapshotName.ResourceNameType of the contained resource name.

Property Value
Type Description
SnapshotNameResourceNameType

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

public static string Format(string projectId, string instanceId, string clusterId, string snapshotId)

Formats the IDs into the string representation of this SnapshotName with pattern projects/{project}/instances/{instance}/clusters/{cluster}/snapshots/{snapshot}.

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

The Cluster ID. Must not be null or empty.
snapshotId string

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

The string representation of this SnapshotName with pattern projects/{project}/instances/{instance}/clusters/{cluster}/snapshots/{snapshot}.

FormatProjectInstanceClusterSnapshot(string, string, string, string)

public static string FormatProjectInstanceClusterSnapshot(string projectId, string instanceId, string clusterId, string snapshotId)

Formats the IDs into the string representation of this SnapshotName with pattern projects/{project}/instances/{instance}/clusters/{cluster}/snapshots/{snapshot}.

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

The Cluster ID. Must not be null or empty.
snapshotId string

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

The string representation of this SnapshotName with pattern projects/{project}/instances/{instance}/clusters/{cluster}/snapshots/{snapshot}.

FromProjectInstanceClusterSnapshot(string, string, string, string)

public static SnapshotName FromProjectInstanceClusterSnapshot(string projectId, string instanceId, string clusterId, string snapshotId)

Creates a SnapshotName with the pattern projects/{project}/instances/{instance}/clusters/{cluster}/snapshots/{snapshot}.

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

The Cluster ID. Must not be null or empty.
snapshotId string

The Snapshot ID. Must not be null or empty.
Returns
Type Description
SnapshotName

A new instance of SnapshotName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static SnapshotName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a SnapshotName containing an unparsed resource name.

Parameter
Name Description
unparsedResourceName UnparsedResourceName

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

A new instance of SnapshotName 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 SnapshotName Parse(string snapshotName)

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

Parameter
Name Description
snapshotName string

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

The parsed SnapshotName if successful.
Remarks

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

  • projects/{project}/instances/{instance}/clusters/{cluster}/snapshots/{snapshot}

Parse(string, bool)

public static SnapshotName Parse(string snapshotName, bool allowUnparsed)

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

Parameters
Name Description
snapshotName 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
SnapshotName

The parsed SnapshotName if successful.
Remarks

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

  • projects/{project}/instances/{instance}/clusters/{cluster}/snapshots/{snapshot}
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 SnapshotName)

public static bool TryParse(string snapshotName, out SnapshotName result)

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

Parameters
Name Description
snapshotName string

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

When this method returns, the parsed SnapshotName, 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}/clusters/{cluster}/snapshots/{snapshot}

TryParse(string, bool, out SnapshotName)

public static bool TryParse(string snapshotName, bool allowUnparsed, out SnapshotName result)

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

Parameters
Name Description
snapshotName 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 SnapshotName

When this method returns, the parsed SnapshotName, 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}/clusters/{cluster}/snapshots/{snapshot}
Or may be in any format if allowUnparsed is true.

Operators

operator ==(SnapshotName, SnapshotName)

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

Determines whether two specified resource names have the same value.

Parameters
Name Description
a SnapshotName

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

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 !=(SnapshotName, SnapshotName)

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

Determines whether two specified resource names have different values.

Parameters
Name Description
a SnapshotName

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

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.