Dialogflow v3 API - Class SessionName (2.12.0)

Version 2.12.0

• 2.21.0 (latest)
• 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.13.0
• 1.12.0
• 1.11.0
• 1.10.0
• 1.9.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 Dialogflow v3 API class SessionName.

Resource name for the Session resource.

Inheritance

object > SessionName

Implements

IResourceName, IEquatableSessionName

Inherited Members

object.GetType()

Namespace

Google.Cloud.Dialogflow.Cx.V3

Assembly

Google.Cloud.Dialogflow.Cx.V3.dll

Constructors

SessionName(string, string, string, string)

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

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

Properties

AgentId

public string AgentId { get; }

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

Property Value
Type	Description
string

EnvironmentId

public string EnvironmentId { get; }

The Environment 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 agentId, string sessionId)

Formats the IDs into the string representation of this SessionName with pattern projects/{project}/locations/{location}/agents/{agent}/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.
agentId	string The Agent 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}/agents/{agent}/sessions/{session}.

FormatProjectLocationAgentEnvironmentSession(string, string, string, string, string)

public static string FormatProjectLocationAgentEnvironmentSession(string projectId, string locationId, string agentId, string environmentId, string sessionId)

Formats the IDs into the string representation of this SessionName with pattern projects/{project}/locations/{location}/agents/{agent}/environments/{environment}/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.
agentId	string The Agent ID. Must not be null or empty.
environmentId	string The Environment 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}/agents/{agent}/environments/{environment}/sessions/{session}.

FormatProjectLocationAgentSession(string, string, string, string)

public static string FormatProjectLocationAgentSession(string projectId, string locationId, string agentId, string sessionId)

Formats the IDs into the string representation of this SessionName with pattern projects/{project}/locations/{location}/agents/{agent}/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.
agentId	string The Agent 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}/agents/{agent}/sessions/{session}.

FromProjectLocationAgentEnvironmentSession(string, string, string, string, string)

public static SessionName FromProjectLocationAgentEnvironmentSession(string projectId, string locationId, string agentId, string environmentId, string sessionId)

Creates a SessionName with the pattern projects/{project}/locations/{location}/agents/{agent}/environments/{environment}/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.
agentId	string The Agent ID. Must not be null or empty.
environmentId	string The Environment 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.

FromProjectLocationAgentSession(string, string, string, string)

public static SessionName FromProjectLocationAgentSession(string projectId, string locationId, string agentId, string sessionId)

Creates a SessionName with the pattern projects/{project}/locations/{location}/agents/{agent}/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.
agentId	string The Agent 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}/agents/{agent}/sessions/{session}
• projects/{project}/locations/{location}/agents/{agent}/environments/{environment}/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}/agents/{agent}/sessions/{session}
• projects/{project}/locations/{location}/agents/{agent}/environments/{environment}/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}/agents/{agent}/sessions/{session}
• projects/{project}/locations/{location}/agents/{agent}/environments/{environment}/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}/agents/{agent}/sessions/{session}
• projects/{project}/locations/{location}/agents/{agent}/environments/{environment}/sessions/{session}

Or may be in any format if allowUnparsed is true.

Operators

operator ==(SessionName, SessionName)

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

Parameters
Name	Description
a	SessionName
b	SessionName

Returns
Type	Description
bool

operator !=(SessionName, SessionName)

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

Parameters
Name	Description
a	SessionName
b	SessionName

Returns
Type	Description
bool