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.
Namespace
Google.Cloud.BigQuery.Storage.V1Assembly
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 |
locationId | string The |
sessionId | string The |
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 |
locationId | string The |
sessionId | string The |
Returns | |
---|---|
Type | Description |
string | The string representation of this ReadSessionName with pattern
|
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 |
locationId | string The |
sessionId | string The |
Returns | |
---|---|
Type | Description |
string | The string representation of this ReadSessionName with pattern
|
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 |
locationId | string The |
sessionId | string The |
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 |
Returns | |
---|---|
Type | Description |
ReadSessionName | A new instance of ReadSessionName containing the provided
|
GetHashCode()
public override int GetHashCode()
Returns a hash code for this resource name.
Returns | |
---|---|
Type | Description |
int |
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 |
Returns | |
---|---|
Type | Description |
ReadSessionName | The parsed ReadSessionName if successful. |
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 |
allowUnparsed | bool If |
Returns | |
---|---|
Type | Description |
ReadSessionName | The parsed ReadSessionName if successful. |
To parse successfully, the resource name must be formatted as one of the following:
projects/{project}/locations/{location}/sessions/{session}
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. |
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 |
result | ReadSessionName When this method returns, the parsed ReadSessionName, or |
Returns | |
---|---|
Type | Description |
bool |
|
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 |
allowUnparsed | bool If |
result | ReadSessionName When this method returns, the parsed ReadSessionName, or |
Returns | |
---|---|
Type | Description |
bool |
|
To parse successfully, the resource name must be formatted as one of the following:
projects/{project}/locations/{location}/sessions/{session}
allowUnparsed
is true
.
Operators
operator ==(ReadSessionName, ReadSessionName)
public static bool operator ==(ReadSessionName a, ReadSessionName b)
Parameters | |
---|---|
Name | Description |
a | ReadSessionName |
b | ReadSessionName |
Returns | |
---|---|
Type | Description |
bool |
operator !=(ReadSessionName, ReadSessionName)
public static bool operator !=(ReadSessionName a, ReadSessionName b)
Parameters | |
---|---|
Name | Description |
a | ReadSessionName |
b | ReadSessionName |
Returns | |
---|---|
Type | Description |
bool |