Google BigQuery Storage v1 API - Class TableName (3.3.0)

Stay organized with collections Save and categorize content based on your preferences.
public sealed class TableName : IResourceName, IEquatable<TableName>

Reference documentation and code samples for the Google BigQuery Storage v1 API class TableName.

Resource name for the Table resource.

Inheritance

Object > TableName

Namespace

Google.Cloud.BigQuery.Storage.V1

Assembly

Google.Cloud.BigQuery.Storage.V1.dll

Constructors

TableName(String, String, String)

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

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

Parameters
NameDescription
projectIdString

The Project ID. Must not be null or empty.

datasetIdString

The Dataset ID. Must not be null or empty.

tableIdString

The Table ID. Must not be null or empty.

Properties

DatasetId

public string DatasetId { get; }

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

Property Value
TypeDescription
String

IsKnownPattern

public bool IsKnownPattern { get; }

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

Property Value
TypeDescription
Boolean

ProjectId

public string ProjectId { get; }

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

Property Value
TypeDescription
String

TableId

public string TableId { get; }

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

Property Value
TypeDescription
String

Type

public TableName.ResourceNameType Type { get; }

The TableName.ResourceNameType of the contained resource name.

Property Value
TypeDescription
TableName.ResourceNameType

UnparsedResource

public UnparsedResourceName UnparsedResource { get; }

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

Property Value
TypeDescription
UnparsedResourceName

Methods

Format(String, String, String)

public static string Format(string projectId, string datasetId, string tableId)

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

Parameters
NameDescription
projectIdString

The Project ID. Must not be null or empty.

datasetIdString

The Dataset ID. Must not be null or empty.

tableIdString

The Table ID. Must not be null or empty.

Returns
TypeDescription
String

The string representation of this TableName with pattern projects/{project}/datasets/{dataset}/tables/{table}.

FormatProjectDatasetTable(String, String, String)

public static string FormatProjectDatasetTable(string projectId, string datasetId, string tableId)

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

Parameters
NameDescription
projectIdString

The Project ID. Must not be null or empty.

datasetIdString

The Dataset ID. Must not be null or empty.

tableIdString

The Table ID. Must not be null or empty.

Returns
TypeDescription
String

The string representation of this TableName with pattern projects/{project}/datasets/{dataset}/tables/{table}.

FromProjectDatasetTable(String, String, String)

public static TableName FromProjectDatasetTable(string projectId, string datasetId, string tableId)

Creates a TableName with the pattern projects/{project}/datasets/{dataset}/tables/{table} .

Parameters
NameDescription
projectIdString

The Project ID. Must not be null or empty.

datasetIdString

The Dataset ID. Must not be null or empty.

tableIdString

The Table ID. Must not be null or empty.

Returns
TypeDescription
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
NameDescription
unparsedResourceNameUnparsedResourceName

The unparsed resource name. Must not be null.

Returns
TypeDescription
TableName

A new instance of TableName containing the provided unparsedResourceName.

GetHashCode()

public override int GetHashCode()

Returns a hash code for this resource name.

Returns
TypeDescription
Int32
Overrides

Parse(String)

public static TableName Parse(string tableName)

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

Parameter
NameDescription
tableNameString

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

Returns
TypeDescription
TableName

The parsed TableName if successful.

Remarks

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

  • projects/{project}/datasets/{dataset}/tables/{table}

Parse(String, Boolean)

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
NameDescription
tableNameString

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

allowUnparsedBoolean

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
TypeDescription
TableName

The parsed TableName if successful.

Remarks

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

  • projects/{project}/datasets/{dataset}/tables/{table}
Or may be in any format if allowUnparsed is true.

ToString()

public override string ToString()

The string representation of the resource name.

Returns
TypeDescription
String

The string representation of the resource name.

Overrides

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
NameDescription
tableNameString

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

resultTableName

When this method returns, the parsed TableName, or null if parsing failed.

Returns
TypeDescription
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}/datasets/{dataset}/tables/{table}

TryParse(String, Boolean, 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
NameDescription
tableNameString

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

allowUnparsedBoolean

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.

resultTableName

When this method returns, the parsed TableName, or null if parsing failed.

Returns
TypeDescription
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}/datasets/{dataset}/tables/{table}
Or may be in any format if allowUnparsed is true.

Operators

Equality(TableName, TableName)

public static bool operator ==(TableName a, TableName b)
Parameters
NameDescription
aTableName
bTableName
Returns
TypeDescription
Boolean

Inequality(TableName, TableName)

public static bool operator !=(TableName a, TableName b)
Parameters
NameDescription
aTableName
bTableName
Returns
TypeDescription
Boolean