public sealed class HotTabletName : IResourceName, IEquatable<HotTabletName>
Reference documentation and code samples for the Google Cloud Bigtable Administration v2 API class HotTabletName.
Resource name for the HotTablet
resource.
Namespace
Google.Cloud.Bigtable.Admin.V2Assembly
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 |
instanceId |
string The |
clusterId |
string The |
hotTabletId |
string The |
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 |
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 HotTabletName.ResourceNameType Type { get; }
The HotTabletName.ResourceNameType of the contained resource name.
Property Value | |
---|---|
Type | Description |
HotTabletNameResourceNameType |
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 |
instanceId |
string The |
clusterId |
string The |
hotTabletId |
string The |
Returns | |
---|---|
Type | Description |
string |
The string representation of this HotTabletName with pattern
|
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 |
instanceId |
string The |
clusterId |
string The |
hotTabletId |
string The |
Returns | |
---|---|
Type | Description |
string |
The string representation of this HotTabletName with pattern
|
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 |
instanceId |
string The |
clusterId |
string The |
hotTabletId |
string The |
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 |
Returns | |
---|---|
Type | Description |
HotTabletName |
A new instance of HotTabletName containing the provided
|
GetHashCode()
public override int GetHashCode()
Returns a hash code for this resource name.
Returns | |
---|---|
Type | Description |
int |
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 |
Returns | |
---|---|
Type | Description |
HotTabletName |
The parsed HotTabletName if successful. |
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, bool)
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 |
allowUnparsed |
bool If |
Returns | |
---|---|
Type | Description |
HotTabletName |
The parsed HotTabletName if successful. |
To parse successfully, the resource name must be formatted as one of the following:
-
projects/{project}/instances/{instance}/clusters/{cluster}/hotTablets/{hot_tablet}
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. |
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 |
result |
HotTabletName When this method returns, the parsed HotTabletName, or |
Returns | |
---|---|
Type | Description |
bool |
|
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, bool, 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 |
allowUnparsed |
bool If |
result |
HotTabletName When this method returns, the parsed HotTabletName, or |
Returns | |
---|---|
Type | Description |
bool |
|
To parse successfully, the resource name must be formatted as one of the following:
-
projects/{project}/instances/{instance}/clusters/{cluster}/hotTablets/{hot_tablet}
allowUnparsed
is true
.
Operators
operator ==(HotTabletName, HotTabletName)
public static bool operator ==(HotTabletName a, HotTabletName b)
Determines whether two specified resource names have the same value.
Parameters | |
---|---|
Name | Description |
a |
HotTabletName The first resource name to compare, or null. |
b |
HotTabletName The second resource name to compare, or null. |
Returns | |
---|---|
Type | Description |
bool |
true if the value of |
operator !=(HotTabletName, HotTabletName)
public static bool operator !=(HotTabletName a, HotTabletName b)
Determines whether two specified resource names have different values.
Parameters | |
---|---|
Name | Description |
a |
HotTabletName The first resource name to compare, or null. |
b |
HotTabletName The second resource name to compare, or null. |
Returns | |
---|---|
Type | Description |
bool |
true if the value of |