Class HotTabletName (3.1.0) 

public sealed class HotTabletName : IResourceName, IEquatable<HotTabletName>

Resource name for the HotTablet resource.

Inheritance

Object > HotTabletName

Namespace

Google.Cloud.Bigtable.Admin.V2

Assembly

Google.Cloud.Bigtable.Admin.V2.dll

Constructors

HotTabletName(String, String, String, String)

public HotTabletName(string projectId, string instanceId, string clusterId, string hotTabletId)

Constructs a new instance of a HotTabletName class from the component parts of pattern projects/{project}/instances/{instance}/clusters/{cluster}/hotTablets/{hot_tablet}

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.
hotTabletId String

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

HotTabletId

public string HotTabletId { get; }

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

The HotTabletName.ResourceNameType of the contained resource name.

Property Value
Type Description
HotTabletName.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, String, String)

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

Formats the IDs into the string representation of this HotTabletName with pattern projects/{project}/instances/{instance}/clusters/{cluster}/hotTablets/{hot_tablet}.

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.
hotTabletId String

The HotTablet ID. Must not be null or empty.
Returns
Type Description
String

The string representation of this HotTabletName with pattern projects/{project}/instances/{instance}/clusters/{cluster}/hotTablets/{hot_tablet}.

FormatProjectInstanceClusterHotTablet(String, String, String, String)

public static string FormatProjectInstanceClusterHotTablet(string projectId, string instanceId, string clusterId, string hotTabletId)

Formats the IDs into the string representation of this HotTabletName with pattern projects/{project}/instances/{instance}/clusters/{cluster}/hotTablets/{hot_tablet}.

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.
hotTabletId String

The HotTablet ID. Must not be null or empty.
Returns
Type Description
String

The string representation of this HotTabletName with pattern projects/{project}/instances/{instance}/clusters/{cluster}/hotTablets/{hot_tablet}.

FromProjectInstanceClusterHotTablet(String, String, String, String)

public static HotTabletName FromProjectInstanceClusterHotTablet(string projectId, string instanceId, string clusterId, string hotTabletId)

Creates a HotTabletName with the pattern projects/{project}/instances/{instance}/clusters/{cluster}/hotTablets/{hot_tablet}.

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.
hotTabletId String

The HotTablet ID. Must not be null or empty.
Returns
Type Description
HotTabletName

A new instance of HotTabletName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static HotTabletName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a HotTabletName containing an unparsed resource name.

Parameter
Name Description
unparsedResourceName UnparsedResourceName

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

A new instance of HotTabletName containing the provided unparsedResourceName.

GetHashCode()

public override int GetHashCode()

Returns a hash code for this resource name.

Returns
Type Description
Int32
Overrides

Parse(String)

public static HotTabletName Parse(string hotTabletName)

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

Parameter
Name Description
hotTabletName String

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

The parsed HotTabletName if successful.
Remarks

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

  • projects/{project}/instances/{instance}/clusters/{cluster}/hotTablets/{hot_tablet}

Parse(String, Boolean)

public static HotTabletName Parse(string hotTabletName, bool allowUnparsed)

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

Parameters
Name Description
hotTabletName 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
HotTabletName

The parsed HotTabletName if successful.
Remarks

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

  • projects/{project}/instances/{instance}/clusters/{cluster}/hotTablets/{hot_tablet}
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 HotTabletName)

public static bool TryParse(string hotTabletName, out HotTabletName result)

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

Parameters
Name Description
hotTabletName String

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

When this method returns, the parsed HotTabletName, 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}/clusters/{cluster}/hotTablets/{hot_tablet}

TryParse(String, Boolean, out HotTabletName)

public static bool TryParse(string hotTabletName, bool allowUnparsed, out HotTabletName result)

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

Parameters
Name Description
hotTabletName 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 HotTabletName

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

Operators

Equality(HotTabletName, HotTabletName)

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

Inequality(HotTabletName, HotTabletName)

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