Google.Cloud.Bigtable.Common.V2 - Class TableName (3.2.0)

Version latest

• 3.2.0 (latest)
• 3.1.0
• 3.0.0
• 2.1.0

public sealed class TableName : IResourceName, IEquatable<TableName>

Reference documentation and code samples for the Google.Cloud.Bigtable.Common.V2 class TableName.

Resource name for the Table resource.

Inheritance

object > TableName

Implements

IResourceName, IEquatableTableName

Inherited Members

object.GetType()

Namespace

Google.Cloud.Bigtable.Common.V2

Assembly

Google.Cloud.Bigtable.Common.V2.dll

Constructors

TableName(string, string, string)

public TableName(string projectId, string instanceId, string tableId)

Constructs a new instance of a TableName class from the component parts of pattern projects/{project}/instances/{instance}/tables/{table}

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.
tableId	string The Table 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

TableId

public string TableId { get; }

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

Property Value
Type	Description
string

Type

public TableName.ResourceNameType Type { get; }

The TableName.ResourceNameType of the contained resource name.

Property Value
Type	Description
TableNameResourceNameType

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

Formats the IDs into the string representation of this TableName with pattern projects/{project}/instances/{instance}/tables/{table}.

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.
tableId	string The Table ID. Must not be null or empty.

Returns
Type	Description
string	The string representation of this TableName with pattern projects/{project}/instances/{instance}/tables/{table}.

FormatProjectInstanceTable(string, string, string)

public static string FormatProjectInstanceTable(string projectId, string instanceId, string tableId)

Formats the IDs into the string representation of this TableName with pattern projects/{project}/instances/{instance}/tables/{table}.

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.
tableId	string The Table ID. Must not be null or empty.

Returns
Type	Description
string	The string representation of this TableName with pattern projects/{project}/instances/{instance}/tables/{table}.

FromProjectInstanceTable(string, string, string)

public static TableName FromProjectInstanceTable(string projectId, string instanceId, string tableId)

Creates a TableName with the pattern projects/{project}/instances/{instance}/tables/{table} .

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.
tableId	string The Table ID. Must not be null or empty.

Returns
Type	Description
TableName	A new instance of TableName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static TableName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a TableName containing an unparsed resource name.

Parameter
Name	Description
unparsedResourceName	UnparsedResourceName The unparsed resource name. Must not be null.

Returns
Type	Description
TableName	A new instance of TableName containing the provided unparsedResourceName.

GetHashCode()

public override int GetHashCode()

Returns
Type	Description
int

Overrides

object.GetHashCode()

Parse(string)

public static TableName Parse(string tableName)

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

Parameter
Name	Description
tableName	string The resource name in string form. Must not be null.

Returns
Type	Description
TableName	The parsed TableName if successful.

Remarks

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

• projects/{project}/instances/{instance}/tables/{table}

Parse(string, bool)

public static TableName Parse(string tableName, bool allowUnparsed)

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

Parameters
Name	Description
tableName	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
TableName	The parsed TableName if successful.

Remarks

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

• projects/{project}/instances/{instance}/tables/{table}

Or may be in any format if allowUnparsed is true.

ToString()

public override string ToString()

Returns
Type	Description
string

Overrides

object.ToString()

TryParse(string, out TableName)

public static bool TryParse(string tableName, out TableName result)

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

Parameters
Name	Description
tableName	string The resource name in string form. Must not be null.
result	TableName When this method returns, the parsed TableName, 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}/tables/{table}

TryParse(string, bool, out TableName)

public static bool TryParse(string tableName, bool allowUnparsed, out TableName result)

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

Parameters
Name	Description
tableName	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	TableName When this method returns, the parsed TableName, 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}/tables/{table}

Or may be in any format if allowUnparsed is true.

Operators

operator ==(TableName, TableName)

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

Parameters
Name	Description
a	TableName
b	TableName

Returns
Type	Description
bool

operator !=(TableName, TableName)

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

Parameters
Name	Description
a	TableName
b	TableName

Returns
Type	Description
bool