Class WriteStreamName

public sealed class WriteStreamName : IResourceName, IEquatable<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
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.

streamIdString

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

StreamId

public string StreamId { get; }

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

The WriteStreamName.ResourceNameType of the contained resource name.

Property Value
TypeDescription
WriteStreamName.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, 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
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.

streamIdString

The Stream ID. Must not be null or empty.

Returns
TypeDescription
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
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.

streamIdString

The Stream ID. Must not be null or empty.

Returns
TypeDescription
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
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.

streamIdString

The Stream ID. Must not be null or empty.

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

The unparsed resource name. Must not be null.

Returns
TypeDescription
WriteStreamName

A new instance of WriteStreamName 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 WriteStreamName Parse(string writeStreamName)

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

Parameter
NameDescription
writeStreamNameString

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

Returns
TypeDescription
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, Boolean)

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

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
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
TypeDescription
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
NameDescription
writeStreamNameString

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

resultWriteStreamName

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

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

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.

resultWriteStreamName

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

Operators

Equality(WriteStreamName, WriteStreamName)

public static bool operator ==(WriteStreamName a, WriteStreamName b)
Parameters
NameDescription
aWriteStreamName
bWriteStreamName
Returns
TypeDescription
Boolean

Inequality(WriteStreamName, WriteStreamName)

public static bool operator !=(WriteStreamName a, WriteStreamName b)
Parameters
NameDescription
aWriteStreamName
bWriteStreamName
Returns
TypeDescription
Boolean