Gemini Enterprise for Customer Experience v1beta API - Class AssistantSessionName (1.0.0-beta10) 

public sealed class AssistantSessionName : IResourceName, IEquatable<AssistantSessionName>

Reference documentation and code samples for the Gemini Enterprise for Customer Experience v1beta API class AssistantSessionName.

Resource name for the AssistantSession resource.

Inheritance

object > AssistantSessionName

Namespace

Google.Cloud.Ces.V1Beta

Assembly

Google.Cloud.Ces.V1Beta.dll

Constructors

AssistantSessionName(string, string, string, string)

public AssistantSessionName(string projectId, string locationId, string appId, string assistantSessionId)

Constructs a new instance of a AssistantSessionName class from the component parts of pattern projects/{project}/locations/{location}/apps/{app}/assistantSessions/{assistant_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.
appId string

The App ID. Must not be null or empty.
assistantSessionId string

The AssistantSession ID. Must not be null or empty.

Properties

AppId

public string AppId { get; }

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

Property Value
Type Description
string

AssistantSessionId

public string AssistantSessionId { get; }

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

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. 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

Type

public AssistantSessionName.ResourceNameType Type { get; }

The AssistantSessionName.ResourceNameType of the contained resource name.

Property Value
Type Description
AssistantSessionNameResourceNameType

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 appId, string assistantSessionId)

Formats the IDs into the string representation of this AssistantSessionName with pattern projects/{project}/locations/{location}/apps/{app}/assistantSessions/{assistant_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.
appId string

The App ID. Must not be null or empty.
assistantSessionId string

The AssistantSession ID. Must not be null or empty.
Returns
Type Description
string

The string representation of this AssistantSessionName with pattern projects/{project}/locations/{location}/apps/{app}/assistantSessions/{assistant_session}.

FormatProjectLocationAppAssistantSession(string, string, string, string)

public static string FormatProjectLocationAppAssistantSession(string projectId, string locationId, string appId, string assistantSessionId)

Formats the IDs into the string representation of this AssistantSessionName with pattern projects/{project}/locations/{location}/apps/{app}/assistantSessions/{assistant_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.
appId string

The App ID. Must not be null or empty.
assistantSessionId string

The AssistantSession ID. Must not be null or empty.
Returns
Type Description
string

The string representation of this AssistantSessionName with pattern projects/{project}/locations/{location}/apps/{app}/assistantSessions/{assistant_session}.

FromProjectLocationAppAssistantSession(string, string, string, string)

public static AssistantSessionName FromProjectLocationAppAssistantSession(string projectId, string locationId, string appId, string assistantSessionId)

Creates a AssistantSessionName with the pattern projects/{project}/locations/{location}/apps/{app}/assistantSessions/{assistant_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.
appId string

The App ID. Must not be null or empty.
assistantSessionId string

The AssistantSession ID. Must not be null or empty.
Returns
Type Description
AssistantSessionName

A new instance of AssistantSessionName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static AssistantSessionName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a AssistantSessionName containing an unparsed resource name.

Parameter
Name Description
unparsedResourceName UnparsedResourceName

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

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

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

Parameter
Name Description
assistantSessionName string

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

The parsed AssistantSessionName if successful.
Remarks

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

  • projects/{project}/locations/{location}/apps/{app}/assistantSessions/{assistant_session}

Parse(string, bool)

public static AssistantSessionName Parse(string assistantSessionName, bool allowUnparsed)

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

Parameters
Name Description
assistantSessionName 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
AssistantSessionName

The parsed AssistantSessionName if successful.
Remarks

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

  • projects/{project}/locations/{location}/apps/{app}/assistantSessions/{assistant_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 AssistantSessionName)

public static bool TryParse(string assistantSessionName, out AssistantSessionName result)

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

Parameters
Name Description
assistantSessionName string

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

When this method returns, the parsed AssistantSessionName, 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}/apps/{app}/assistantSessions/{assistant_session}

TryParse(string, bool, out AssistantSessionName)

public static bool TryParse(string assistantSessionName, bool allowUnparsed, out AssistantSessionName result)

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

Parameters
Name Description
assistantSessionName 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 AssistantSessionName

When this method returns, the parsed AssistantSessionName, 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}/apps/{app}/assistantSessions/{assistant_session}

Or may be in any format if allowUnparsed is true.

Operators

operator ==(AssistantSessionName, AssistantSessionName)

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

Determines whether two specified resource names have the same value.

Parameters
Name Description
a AssistantSessionName

The first resource name to compare, or null.
b AssistantSessionName

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

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

Determines whether two specified resource names have different values.

Parameters
Name Description
a AssistantSessionName

The first resource name to compare, or null.
b AssistantSessionName

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.