Class ReadStreamName (3.0.0) 

public sealed class ReadStreamName : IResourceName, IEquatable<ReadStreamName>

Resource name for the ReadStream resource.

Inheritance

Object > ReadStreamName

Namespace

Google.Cloud.BigQuery.Storage.V1

Assembly

Google.Cloud.BigQuery.Storage.V1.dll

Constructors

ReadStreamName(String, String, String, String)

public ReadStreamName(string projectId, string locationId, string sessionId, string streamId)

Constructs a new instance of a ReadStreamName class from the component parts of pattern projects/{project}/locations/{location}/sessions/{session}/streams/{stream}

Parameters
Name Description
projectId String

The Project ID. Must not be null or empty.
locationId String

The Location ID. Must not be null or empty.
sessionId String

The Session ID. Must not be null or empty.
streamId String

The Stream ID. Must not be null or empty.

Properties

IsKnownPattern

public bool IsKnownPattern { get; }

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

Property Value
Type Description
Boolean

LocationId

public string LocationId { get; }

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

Property Value
Type Description
String

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

SessionId

public string SessionId { get; }

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

Type

public ReadStreamName.ResourceNameType Type { get; }

The ReadStreamName.ResourceNameType of the contained resource name.

Property Value
Type Description
ReadStreamName.ResourceNameType

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 locationId, string sessionId, string streamId)

Formats the IDs into the string representation of this ReadStreamName with pattern projects/{project}/locations/{location}/sessions/{session}/streams/{stream}.

Parameters
Name Description
projectId String

The Project ID. Must not be null or empty.
locationId String

The Location ID. Must not be null or empty.
sessionId String

The Session 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 ReadStreamName with pattern projects/{project}/locations/{location}/sessions/{session}/streams/{stream}.

FormatProjectLocationSessionStream(String, String, String, String)

public static string FormatProjectLocationSessionStream(string projectId, string locationId, string sessionId, string streamId)

Formats the IDs into the string representation of this ReadStreamName with pattern projects/{project}/locations/{location}/sessions/{session}/streams/{stream}.

Parameters
Name Description
projectId String

The Project ID. Must not be null or empty.
locationId String

The Location ID. Must not be null or empty.
sessionId String

The Session 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 ReadStreamName with pattern projects/{project}/locations/{location}/sessions/{session}/streams/{stream}.

FromProjectLocationSessionStream(String, String, String, String)

public static ReadStreamName FromProjectLocationSessionStream(string projectId, string locationId, string sessionId, string streamId)

Creates a ReadStreamName with the pattern projects/{project}/locations/{location}/sessions/{session}/streams/{stream}.

Parameters
Name Description
projectId String

The Project ID. Must not be null or empty.
locationId String

The Location ID. Must not be null or empty.
sessionId String

The Session ID. Must not be null or empty.
streamId String

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

A new instance of ReadStreamName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static ReadStreamName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a ReadStreamName containing an unparsed resource name.

Parameter
Name Description
unparsedResourceName UnparsedResourceName

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

A new instance of ReadStreamName containing the provided unparsedResourceName.

GetHashCode()

public override int GetHashCode()

Returns a hash code for this resource name.

Returns
Type Description
Int32
Overrides

Parse(String)

public static ReadStreamName Parse(string readStreamName)

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

Parameter
Name Description
readStreamName String

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

The parsed ReadStreamName if successful.
Remarks

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

  • projects/{project}/locations/{location}/sessions/{session}/streams/{stream}

Parse(String, Boolean)

public static ReadStreamName Parse(string readStreamName, bool allowUnparsed)

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

Parameters
Name Description
readStreamName String

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

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
ReadStreamName

The parsed ReadStreamName if successful.
Remarks

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

  • projects/{project}/locations/{location}/sessions/{session}/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 ReadStreamName)

public static bool TryParse(string readStreamName, out ReadStreamName result)

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

Parameters
Name Description
readStreamName String

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

When this method returns, the parsed ReadStreamName, or null if parsing failed.
Returns
Type Description
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}/locations/{location}/sessions/{session}/streams/{stream}

TryParse(String, Boolean, out ReadStreamName)

public static bool TryParse(string readStreamName, bool allowUnparsed, out ReadStreamName result)

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

Parameters
Name Description
readStreamName String

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

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 ReadStreamName

When this method returns, the parsed ReadStreamName, or null if parsing failed.
Returns
Type Description
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}/locations/{location}/sessions/{session}/streams/{stream}
Or may be in any format if allowUnparsed is true.

Operators

Equality(ReadStreamName, ReadStreamName)

public static bool operator ==(ReadStreamName a, ReadStreamName b)
Parameters
Name Description
a ReadStreamName
b ReadStreamName
Returns
Type Description
Boolean

Inequality(ReadStreamName, ReadStreamName)

public static bool operator !=(ReadStreamName a, ReadStreamName b)
Parameters
Name Description
a ReadStreamName
b ReadStreamName
Returns
Type Description
Boolean