Discovery Engine v1 API - Class SessionName (1.1.0)

public sealed class SessionName : IResourceName, IEquatable<SessionName>

Reference documentation and code samples for the Discovery Engine v1 API class SessionName.

Resource name for the Session resource.

Inheritance

object > SessionName

Implements

IResourceName, IEquatable SessionName

Inherited Members

object.GetType()

Namespace

Google.Cloud.DiscoveryEngine.V1

Assembly

Google.Cloud.DiscoveryEngine.V1.dll

Constructors

SessionName(string, string, string, string)

public SessionName(string projectId, string locationId, string dataStoreId, string sessionId)

Constructs a new instance of a SessionName class from the component parts of pattern projects/{project}/locations/{location}/dataStores/{data_store}/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.
`dataStoreId`	`string` The `DataStore` ID. Must not be `null` or empty.
`sessionId`	`string` The `Session` ID. Must not be `null` or empty.

Properties

CollectionId

public string CollectionId { get; }

The Collection ID. May be null, depending on which resource name is contained by this instance.

Property Value
Type	Description
`string`

DataStoreId

public string DataStoreId { get; }

The DataStore ID. May be null, depending on which resource name is contained by this instance.

Property Value
Type	Description
`string`

EngineId

public string EngineId { get; }

The Engine ID. May be null, depending on which resource name is contained by this instance.

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`

LocationId

public string LocationId { get; }

The Location ID. May be null, depending on which resource name is contained by this instance.

Property Value
Type	Description
`string`

ProjectId

public string ProjectId { get; }

The Project ID. May be null, depending on which resource name is contained by this instance.

Property Value
Type	Description
`string`

SessionId

public string SessionId { get; }

The Session ID. May be null, depending on which resource name is contained by this instance.

Property Value
Type	Description
`string`

Type

public SessionName.ResourceNameType Type { get; }

The SessionName.ResourceNameType of the contained resource name.

Property Value
Type	Description
`SessionNameResourceNameType`

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

Formats the IDs into the string representation of this SessionName with pattern projects/{project}/locations/{location}/dataStores/{data_store}/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.
`dataStoreId`	`string` The `DataStore` 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 SessionName with pattern `projects/{project}/locations/{location}/dataStores/{data_store}/sessions/{session}`.

FormatProjectLocationCollectionDataStoreSession(string, string, string, string, string)

public static string FormatProjectLocationCollectionDataStoreSession(string projectId, string locationId, string collectionId, string dataStoreId, string sessionId)

Formats the IDs into the string representation of this SessionName with pattern projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/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.
`collectionId`	`string` The `Collection` ID. Must not be `null` or empty.
`dataStoreId`	`string` The `DataStore` 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 SessionName with pattern `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/sessions/{session}` .

FormatProjectLocationCollectionEngineSession(string, string, string, string, string)

public static string FormatProjectLocationCollectionEngineSession(string projectId, string locationId, string collectionId, string engineId, string sessionId)

Formats the IDs into the string representation of this SessionName with pattern projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/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.
`collectionId`	`string` The `Collection` ID. Must not be `null` or empty.
`engineId`	`string` The `Engine` 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 SessionName with pattern `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}`.

FormatProjectLocationDataStoreSession(string, string, string, string)

public static string FormatProjectLocationDataStoreSession(string projectId, string locationId, string dataStoreId, string sessionId)

Formats the IDs into the string representation of this SessionName with pattern projects/{project}/locations/{location}/dataStores/{data_store}/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.
`dataStoreId`	`string` The `DataStore` 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 SessionName with pattern `projects/{project}/locations/{location}/dataStores/{data_store}/sessions/{session}`.

FromProjectLocationCollectionDataStoreSession(string, string, string, string, string)

public static SessionName FromProjectLocationCollectionDataStoreSession(string projectId, string locationId, string collectionId, string dataStoreId, string sessionId)

Creates a SessionName with the pattern projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/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.
`collectionId`	`string` The `Collection` ID. Must not be `null` or empty.
`dataStoreId`	`string` The `DataStore` ID. Must not be `null` or empty.
`sessionId`	`string` The `Session` ID. Must not be `null` or empty.

Returns
Type	Description
`SessionName`	A new instance of SessionName constructed from the provided ids.

FromProjectLocationCollectionEngineSession(string, string, string, string, string)

public static SessionName FromProjectLocationCollectionEngineSession(string projectId, string locationId, string collectionId, string engineId, string sessionId)

Creates a SessionName with the pattern projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/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.
`collectionId`	`string` The `Collection` ID. Must not be `null` or empty.
`engineId`	`string` The `Engine` ID. Must not be `null` or empty.
`sessionId`	`string` The `Session` ID. Must not be `null` or empty.

Returns
Type	Description
`SessionName`	A new instance of SessionName constructed from the provided ids.

FromProjectLocationDataStoreSession(string, string, string, string)

public static SessionName FromProjectLocationDataStoreSession(string projectId, string locationId, string dataStoreId, string sessionId)

Creates a SessionName with the pattern projects/{project}/locations/{location}/dataStores/{data_store}/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.
`dataStoreId`	`string` The `DataStore` ID. Must not be `null` or empty.
`sessionId`	`string` The `Session` ID. Must not be `null` or empty.

Returns
Type	Description
`SessionName`	A new instance of SessionName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static SessionName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a SessionName containing an unparsed resource name.

Parameter
Name	Description
`unparsedResourceName`	`UnparsedResourceName` The unparsed resource name. Must not be `null`.

Returns
Type	Description
`SessionName`	A new instance of SessionName containing the provided `unparsedResourceName`.

GetHashCode()

public override int GetHashCode()

Returns a hash code for this resource name.

Returns
Type	Description
`int`

Overrides

object.GetHashCode()

Parse(string)

public static SessionName Parse(string sessionName)

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

Parameter
Name	Description
`sessionName`	`string` The resource name in string form. Must not be `null`.

Returns
Type	Description
`SessionName`	The parsed SessionName if successful.

Remarks

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

projects/{project}/locations/{location}/dataStores/{data_store}/sessions/{session}
projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/sessions/{session}
projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}

Parse(string, bool)

public static SessionName Parse(string sessionName, bool allowUnparsed)

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

Parameters
Name	Description
`sessionName`	`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
`SessionName`	The parsed SessionName if successful.

Remarks

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

projects/{project}/locations/{location}/dataStores/{data_store}/sessions/{session}
projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/sessions/{session}
projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/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

object.ToString()

TryParse(string, out SessionName)

public static bool TryParse(string sessionName, out SessionName result)

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

Parameters
Name	Description
`sessionName`	`string` The resource name in string form. Must not be `null`.
`result`	`SessionName` When this method returns, the parsed SessionName, 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}/dataStores/{data_store}/sessions/{session}
projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/sessions/{session}
projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}

TryParse(string, bool, out SessionName)

public static bool TryParse(string sessionName, bool allowUnparsed, out SessionName result)

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

Parameters
Name	Description
`sessionName`	`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`	`SessionName` When this method returns, the parsed SessionName, 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}/dataStores/{data_store}/sessions/{session}
projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/sessions/{session}
projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}

Or may be in any format if allowUnparsed is true.

Operators

operator ==(SessionName, SessionName)

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

Determines whether two specified resource names have the same value.

Parameters
Name	Description
`a`	`SessionName` The first resource name to compare, or null.
`b`	`SessionName` 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 !=(SessionName, SessionName)

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

Determines whether two specified resource names have different values.

Parameters
Name	Description
`a`	`SessionName` The first resource name to compare, or null.
`b`	`SessionName` 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.