Google BigQuery Storage v1 API - Class WriteStreamName (3.15.0)

public sealed class WriteStreamName : IResourceName, IEquatable<WriteStreamName>

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

Resource name for the WriteStream resource.

Inheritance

object > WriteStreamName

Namespace

Google.Cloud.BigQuery.Storage.V1

Assembly

Google.Cloud.BigQuery.Storage.V1.dll

Constructors

WriteStreamName(string, string, string, string)

public WriteStreamName(string projectId, string datasetId, string tableId, string streamId)

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

Parameters
Name Description
projectId string

The Project ID. Must not be null or empty.
datasetId string

The Dataset ID. Must not be null or empty.
tableId string

The Table ID. Must not be null or empty.
streamId string

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

StreamId

public string StreamId { get; }

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

The WriteStreamName.ResourceNameType of the contained resource name.

Property Value
Type Description
WriteStreamNameResourceNameType

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 datasetId, string tableId, string streamId)

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

Parameters
Name Description
projectId string

The Project ID. Must not be null or empty.
datasetId string

The Dataset ID. Must not be null or empty.
tableId string

The Table ID. Must not be null or empty.
streamId string

The Stream ID. Must not be null or empty.
Returns
Type Description
string

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

FormatProjectDatasetTableStream(string, string, string, string)

public static string FormatProjectDatasetTableStream(string projectId, string datasetId, string tableId, string streamId)

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

Parameters
Name Description
projectId string

The Project ID. Must not be null or empty.
datasetId string

The Dataset ID. Must not be null or empty.
tableId string

The Table ID. Must not be null or empty.
streamId string

The Stream ID. Must not be null or empty.
Returns
Type Description
string

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

FromProjectDatasetTableStream(string, string, string, string)

public static WriteStreamName FromProjectDatasetTableStream(string projectId, string datasetId, string tableId, string streamId)

Creates a WriteStreamName with the pattern projects/{project}/datasets/{dataset}/tables/{table}/streams/{stream}.

Parameters
Name Description
projectId string

The Project ID. Must not be null or empty.
datasetId string

The Dataset ID. Must not be null or empty.
tableId string

The Table ID. Must not be null or empty.
streamId string

The Stream ID. Must not be null or empty.
Returns
Type Description
WriteStreamName

A new instance of WriteStreamName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static WriteStreamName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a WriteStreamName containing an unparsed resource name.

Parameter
Name Description
unparsedResourceName UnparsedResourceName

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

A new instance of WriteStreamName containing the provided unparsedResourceName.

GetHashCode()

public override int GetHashCode()

Returns a hash code for this resource name.

Returns
Type Description
int
Overrides

Parse(string)

public static WriteStreamName Parse(string writeStreamName)

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

Parameter
Name Description
writeStreamName string

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

The parsed WriteStreamName if successful.
Remarks

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

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

Parse(string, bool)

public static WriteStreamName Parse(string writeStreamName, bool allowUnparsed)

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

Parameters
Name Description
writeStreamName 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
WriteStreamName

The parsed WriteStreamName if successful.
Remarks

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

  • projects/{project}/datasets/{dataset}/tables/{table}/streams/{stream}
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 WriteStreamName)

public static bool TryParse(string writeStreamName, out WriteStreamName result)

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

Parameters
Name Description
writeStreamName string

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

When this method returns, the parsed WriteStreamName, 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}/datasets/{dataset}/tables/{table}/streams/{stream}

TryParse(string, bool, out WriteStreamName)

public static bool TryParse(string writeStreamName, bool allowUnparsed, out WriteStreamName result)

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

Parameters
Name Description
writeStreamName 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 WriteStreamName

When this method returns, the parsed WriteStreamName, 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}/datasets/{dataset}/tables/{table}/streams/{stream}
Or may be in any format if allowUnparsed is true.

Operators

operator ==(WriteStreamName, WriteStreamName)

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

Determines whether two specified resource names have the same value.

Parameters
Name Description
a WriteStreamName

The first resource name to compare, or null.
b WriteStreamName

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 !=(WriteStreamName, WriteStreamName)

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

Determines whether two specified resource names have different values.

Parameters
Name Description
a WriteStreamName

The first resource name to compare, or null.
b WriteStreamName

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.