3.78.0 (latest) 3.77.0 3.76.0 3.75.0 3.74.0 3.73.0 3.72.0 3.71.0 3.70.0 3.69.0 3.68.0 3.67.0 3.66.0 3.65.0 3.64.0 3.63.0 3.62.0 3.61.0 3.60.0 3.59.0 3.58.0 3.57.0 3.56.0 3.55.0 3.54.0 3.53.0 3.52.0 3.51.0 3.50.0 3.49.0 3.48.0 3.47.0 3.46.0 3.45.0 3.44.0 3.43.0 3.42.0 3.41.0 3.40.0 3.39.0 3.38.0 3.37.0 3.36.0 3.35.0 3.34.0 3.33.0 3.32.0 3.31.0 3.30.0 3.29.0 3.28.0 3.27.0 3.26.0 3.25.0 3.24.0 3.23.0 3.22.0 3.21.0 3.20.0 3.19.0 3.18.0 3.17.0 3.16.0 3.15.0 3.14.0 3.13.0 3.12.0 3.11.0 3.10.0 3.9.0 3.8.0 3.7.0 3.6.0 3.5.0 3.4.0 3.3.0 3.2.0 3.1.0 3.0.0 2.28.0 2.27.0 2.26.0 2.25.0 2.24.0 2.23.0 2.22.0 2.21.0 2.20.0 2.19.0 2.18.0 2.17.0 2.16.0 2.15.0 2.14.0 2.13.0 2.12.0 2.11.0 2.10.0 2.9.0 2.8.0 2.7.0 2.6.0 2.5.0 2.4.0 2.3.0 2.2.0 2.1.0 2.0.0 1.8.0 1.7.0 1.6.0 1.5.0 1.4.0 1.3.0 1.2.0 1.1.0 1.0.0

    public sealed class SessionName : IResourceName, IEquatable<SessionName>

Reference documentation and code samples for the Vertex AI v1 API class SessionName.

Resource name for the `Session` resource.

## Inheritance

[object](https://learn.microsoft.com/dotnet/api/system.object) \> SessionName

## Implements

[IResourceName](https://docs.cloud.google.com/dotnet/docs/reference/Google.Api.Gax/latest/Google.Api.Gax.IResourceName.md.txt), [IEquatable](https://learn.microsoft.com/dotnet/api/system.iequatable-1)[SessionName](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.AIPlatform.V1/latest/Google.Cloud.AIPlatform.V1.SessionName.md.txt)

## Inherited Members

[object.GetType()](https://learn.microsoft.com/dotnet/api/system.object.gettype)

## Namespace

[Google.Cloud.AIPlatform.V1](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.AIPlatform.V1/latest/Google.Cloud.AIPlatform.V1.md.txt)

## Assembly

Google.Cloud.AIPlatform.V1.dll

## Constructors

### SessionName(string, string, string, string)

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

Constructs a new instance of a [SessionName](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.AIPlatform.V1/latest/Google.Cloud.AIPlatform.V1.SessionName.md.txt) class from the component parts of pattern
`projects/{project}/locations/{location}/reasoningEngines/{reasoning_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. |
| `reasoningEngineId` | `string` The `ReasoningEngine` 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` |   |

### ReasoningEngineId

    public string ReasoningEngineId { get; }

The `ReasoningEngine` 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 SessionName.ResourceNameType Type { get; }

The [SessionName.ResourceNameType](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.AIPlatform.V1/latest/Google.Cloud.AIPlatform.V1.SessionName.ResourceNameType.md.txt) of the contained resource name.

| **Property Value** ||
|---|---|
| **Type** | **Description** |
| `SessionNameResourceNameType` |   |

### UnparsedResource

    public UnparsedResourceName UnparsedResource { get; }

The contained [UnparsedResourceName](https://docs.cloud.google.com/dotnet/docs/reference/Google.Api.Gax/latest/Google.Api.Gax.UnparsedResourceName.md.txt). 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 reasoningEngineId, string sessionId)

Formats the IDs into the string representation of this [SessionName](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.AIPlatform.V1/latest/Google.Cloud.AIPlatform.V1.SessionName.md.txt) with pattern
`projects/{project}/locations/{location}/reasoningEngines/{reasoning_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. |
| `reasoningEngineId` | `string` The `ReasoningEngine` 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](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.AIPlatform.V1/latest/Google.Cloud.AIPlatform.V1.SessionName.md.txt) with pattern `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/sessions/{session}`. |

### FormatProjectLocationReasoningEngineSession(string, string, string, string)

    public static string FormatProjectLocationReasoningEngineSession(string projectId, string locationId, string reasoningEngineId, string sessionId)

Formats the IDs into the string representation of this [SessionName](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.AIPlatform.V1/latest/Google.Cloud.AIPlatform.V1.SessionName.md.txt) with pattern
`projects/{project}/locations/{location}/reasoningEngines/{reasoning_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. |
| `reasoningEngineId` | `string` The `ReasoningEngine` 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](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.AIPlatform.V1/latest/Google.Cloud.AIPlatform.V1.SessionName.md.txt) with pattern `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/sessions/{session}`. |

### FromProjectLocationReasoningEngineSession(string, string, string, string)

    public static SessionName FromProjectLocationReasoningEngineSession(string projectId, string locationId, string reasoningEngineId, string sessionId)

Creates a [SessionName](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.AIPlatform.V1/latest/Google.Cloud.AIPlatform.V1.SessionName.md.txt) with the pattern
`projects/{project}/locations/{location}/reasoningEngines/{reasoning_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. |
| `reasoningEngineId` | `string` The `ReasoningEngine` 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](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.AIPlatform.V1/latest/Google.Cloud.AIPlatform.V1.SessionName.md.txt) constructed from the provided ids. |

### FromUnparsed(UnparsedResourceName)

    public static SessionName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a [SessionName](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.AIPlatform.V1/latest/Google.Cloud.AIPlatform.V1.SessionName.md.txt) 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](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.AIPlatform.V1/latest/Google.Cloud.AIPlatform.V1.SessionName.md.txt) containing the provided `unparsedResourceName`. |

### GetHashCode()

    public override int GetHashCode()

Returns a hash code for this resource name.

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `int` |   |

**Overrides** [object.GetHashCode()](https://learn.microsoft.com/dotnet/api/system.object.gethashcode)

### Parse(string)

    public static SessionName Parse(string sessionName)

Parses the given resource name string into a new [SessionName](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.AIPlatform.V1/latest/Google.Cloud.AIPlatform.V1.SessionName.md.txt) instance.

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

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `SessionName` | The parsed [SessionName](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.AIPlatform.V1/latest/Google.Cloud.AIPlatform.V1.SessionName.md.txt) if successful. |

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

- `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/sessions/{session}`

### Parse(string, bool)

    public static SessionName Parse(string sessionName, bool allowUnparsed)

Parses the given resource name string into a new [SessionName](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.AIPlatform.V1/latest/Google.Cloud.AIPlatform.V1.SessionName.md.txt) 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](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.AIPlatform.V1/latest/Google.Cloud.AIPlatform.V1.SessionName.md.txt#Google_Cloud_AIPlatform_V1_SessionName_UnparsedResource) property; otherwise will throw an [ArgumentException](https://learn.microsoft.com/dotnet/api/system.argumentexception) if an unparseable resource name is specified. |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `SessionName` | The parsed [SessionName](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.AIPlatform.V1/latest/Google.Cloud.AIPlatform.V1.SessionName.md.txt) if successful. |

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

- `projects/{project}/locations/{location}/reasoningEngines/{reasoning_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()](https://learn.microsoft.com/dotnet/api/system.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](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.AIPlatform.V1/latest/Google.Cloud.AIPlatform.V1.SessionName.md.txt) 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](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.AIPlatform.V1/latest/Google.Cloud.AIPlatform.V1.SessionName.md.txt), 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}/reasoningEngines/{reasoning_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](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.AIPlatform.V1/latest/Google.Cloud.AIPlatform.V1.SessionName.md.txt) 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](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.AIPlatform.V1/latest/Google.Cloud.AIPlatform.V1.SessionName.md.txt#Google_Cloud_AIPlatform_V1_SessionName_UnparsedResource) property; otherwise will throw an [ArgumentException](https://learn.microsoft.com/dotnet/api/system.argumentexception) if an unparseable resource name is specified. |
| `result` | `SessionName` When this method returns, the parsed [SessionName](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.AIPlatform.V1/latest/Google.Cloud.AIPlatform.V1.SessionName.md.txt), 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}/reasoningEngines/{reasoning_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. |