Class TableName

Resource name for the Table resource.

Inheritance

object

TableName

Implements

IResourceName

IEquatable<TableName>

Inherited Members

object.GetType()

Namespace: Google.Area120.Tables.V1Alpha1

Assembly: Google.Area120.Tables.V1Alpha1.dll

Syntax

public sealed class TableName : IResourceName, IEquatable<TableName>

Constructors

TableName(string)

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

Declaration

public TableName(string tableId)

Parameters

Type	Name	Description
string	tableId	The Table ID. Must not be null or empty.

Properties

IsKnownPattern

Whether this instance contains a resource name with a known pattern.

Declaration

public bool IsKnownPattern { get; }

Property Value

Type	Description
bool

Implements

IResourceName.IsKnownPattern

TableId

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

Declaration

public string TableId { get; }

Property Value

Type	Description
string

Type

The TableName.ResourceNameType of the contained resource name.

Declaration

public TableName.ResourceNameType Type { get; }

Property Value

Type	Description
TableName.ResourceNameType

UnparsedResource

The contained UnparsedResourceName. Only non-null if this instance contains an unparsed resource name.

Declaration

public UnparsedResourceName UnparsedResource { get; }

Property Value

Type	Description
UnparsedResourceName

Methods

Format(string)

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

Declaration

public static string Format(string tableId)

Parameters

Type	Name	Description
string	tableId	The Table ID. Must not be null or empty.

Returns

Type	Description
string	The string representation of this TableName with pattern tables/{table}.

FormatTable(string)

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

Declaration

public static string FormatTable(string tableId)

Parameters

Type	Name	Description
string	tableId	The Table ID. Must not be null or empty.

Returns

Type	Description
string	The string representation of this TableName with pattern tables/{table}.

FromTable(string)

Creates a TableName with the pattern tables/{table}.

Declaration

public static TableName FromTable(string tableId)

Parameters

Type	Name	Description
string	tableId	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)

Creates a TableName containing an unparsed resource name.

Declaration

public static TableName FromUnparsed(UnparsedResourceName unparsedResourceName)

Parameters

Type	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()

Returns a hash code for this resource name.

Declaration

public override int GetHashCode()

Returns

Type	Description
int

Overrides

object.GetHashCode()

Parse(string)

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

Declaration

public static TableName Parse(string tableName)

Parameters

Type	Name	Description
string	tableName	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:

• tables/{table}

Parse(string, bool)

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

Declaration

public static TableName Parse(string tableName, bool allowUnparsed)

Parameters

Type	Name	Description
string	tableName	The resource name in string form. Must not be null.
bool	allowUnparsed	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:

• tables/{table}

Or may be in any format if allowUnparsed is true.

ToString()

The string representation of the resource name.

Declaration

public override string ToString()

Returns

Type	Description
string	The string representation of the resource name.

Overrides

object.ToString()

Implements

IResourceName.ToString()

TryParse(string, out TableName)

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

Declaration

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

Parameters

Type	Name	Description
string	tableName	The resource name in string form. Must not be null.
TableName	result	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:

• tables/{table}

TryParse(string, bool, out TableName)

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

Declaration

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

Parameters

Type	Name	Description
string	tableName	The resource name in string form. Must not be null.
bool	allowUnparsed	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.
TableName	result	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:

• tables/{table}

Or may be in any format if allowUnparsed is true.

Operators

operator ==(TableName, TableName)

Determines whether two specified resource names have the same value.

Declaration

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

Parameters

Type	Name	Description
TableName	a	The first resource name to compare, or null.
TableName	b	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 !=(TableName, TableName)

Determines whether two specified resource names have different values.

Declaration

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

Parameters

Type	Name	Description
TableName	a	The first resource name to compare, or null.
TableName	b	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.