Google BigQuery Storage v1 API - Class ReadSessionName (3.14.0)

public sealed class ReadSessionName : IResourceName, IEquatable<ReadSessionName>

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

Resource name for the ReadSession resource.

Inheritance

object > ReadSessionName

Namespace

Google.Cloud.BigQuery.Storage.V1

Assembly

Google.Cloud.BigQuery.Storage.V1.dll

Constructors

ReadSessionName(string, string, string)

public ReadSessionName(string projectId, string locationId, string sessionId)

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

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.

Properties

IsKnownPattern

public bool IsKnownPattern { get; }

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

Property Value
Type Description
bool

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

Type

public ReadSessionName.ResourceNameType Type { get; }

The ReadSessionName.ResourceNameType of the contained resource name.

Property Value
Type Description
ReadSessionNameResourceNameType

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)

public static string Format(string projectId, string locationId, string sessionId)

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

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.

Returns
Type Description
string

The string representation of this ReadSessionName with pattern projects/{project}/locations/{location}/sessions/{session}.

FormatProjectLocationSession(string, string, string)

public static string FormatProjectLocationSession(string projectId, string locationId, string sessionId)

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

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.

Returns
Type Description
string

The string representation of this ReadSessionName with pattern projects/{project}/locations/{location}/sessions/{session}.

FromProjectLocationSession(string, string, string)

public static ReadSessionName FromProjectLocationSession(string projectId, string locationId, string sessionId)

Creates a ReadSessionName with the pattern projects/{project}/locations/{location}/sessions/{session}.

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.

Returns
Type Description
ReadSessionName

A new instance of ReadSessionName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static ReadSessionName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a ReadSessionName containing an unparsed resource name.

Parameter
Name Description
unparsedResourceName UnparsedResourceName

The unparsed resource name. Must not be null.

Returns
Type Description
ReadSessionName

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

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

Parameter
Name Description
readSessionName string

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

Returns
Type Description
ReadSessionName

The parsed ReadSessionName if successful.

Remarks

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

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

Parse(string, bool)

public static ReadSessionName Parse(string readSessionName, bool allowUnparsed)

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

Parameters
Name Description
readSessionName 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
ReadSessionName

The parsed ReadSessionName if successful.

Remarks

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

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

public static bool TryParse(string readSessionName, out ReadSessionName result)

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

Parameters
Name Description
readSessionName string

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

result ReadSessionName

When this method returns, the parsed ReadSessionName, 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}/locations/{location}/sessions/{session}

TryParse(string, bool, out ReadSessionName)

public static bool TryParse(string readSessionName, bool allowUnparsed, out ReadSessionName result)

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

Parameters
Name Description
readSessionName 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 ReadSessionName

When this method returns, the parsed ReadSessionName, 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}/locations/{location}/sessions/{session}
Or may be in any format if allowUnparsed is true.

Operators

operator ==(ReadSessionName, ReadSessionName)

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

Determines whether two specified resource names have the same value.

Parameters
Name Description
a ReadSessionName

The first resource name to compare, or null.

b ReadSessionName

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

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

Determines whether two specified resource names have different values.

Parameters
Name Description
a ReadSessionName

The first resource name to compare, or null.

b ReadSessionName

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.