Class SessionName (4.1.0) 

public sealed class SessionName : IResourceName, IEquatable<SessionName>

Resource name for the Session resource.

Inheritance

Object > SessionName

Namespace

Google.Cloud.Dialogflow.V2

Assembly

Google.Cloud.Dialogflow.V2.dll

Constructors

SessionName(String, String)

public SessionName(string projectId, string sessionId)

Constructs a new instance of a SessionName class from the component parts of pattern projects/{project}/agent/sessions/{session}

Parameters
Name Description
projectId String

The Project ID. Must not be null or empty.
sessionId String

The Session ID. Must not be null or empty.

Properties

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
Boolean

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

UnparsedResource

public UnparsedResourceName UnparsedResource { get; }

The contained UnparsedResourceName. Only non-null if this instance contains an unparsed resource name.

Property Value
Type Description
UnparsedResourceName

UserId

public string UserId { get; }

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

Property Value
Type Description
String

Methods

Format(String, String)

public static string Format(string projectId, string sessionId)

Formats the IDs into the string representation of this SessionName with pattern projects/{project}/agent/sessions/{session}.

Parameters
Name Description
projectId String

The Project 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}/agent/sessions/{session}.

FormatProjectEnvironmentUserSession(String, String, String, String)

public static string FormatProjectEnvironmentUserSession(string projectId, string environmentId, string userId, string sessionId)

Formats the IDs into the string representation of this SessionName with pattern projects/{project}/agent/environments/{environment}/users/{user}/sessions/{session}.

Parameters
Name Description
projectId String

The Project ID. Must not be null or empty.
environmentId String

The Environment ID. Must not be null or empty.
userId String

The User 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}/agent/environments/{environment}/users/{user}/sessions/{session}.

FormatProjectLocationEnvironmentUserSession(String, String, String, String, String)

public static string FormatProjectLocationEnvironmentUserSession(string projectId, string locationId, string environmentId, string userId, string sessionId)

Formats the IDs into the string representation of this SessionName with pattern projects/{project}/locations/{location}/agent/environments/{environment}/users/{user}/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.
environmentId String

The Environment ID. Must not be null or empty.
userId String

The User 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}/agent/environments/{environment}/users/{user}/sessions/{session} .

FormatProjectLocationSession(String, String, String)

public static string FormatProjectLocationSession(string projectId, string locationId, string sessionId)

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

FormatProjectSession(String, String)

public static string FormatProjectSession(string projectId, string sessionId)

Formats the IDs into the string representation of this SessionName with pattern projects/{project}/agent/sessions/{session}.

Parameters
Name Description
projectId String

The Project 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}/agent/sessions/{session}.

FromProjectEnvironmentUserSession(String, String, String, String)

public static SessionName FromProjectEnvironmentUserSession(string projectId, string environmentId, string userId, string sessionId)

Creates a SessionName with the pattern projects/{project}/agent/environments/{environment}/users/{user}/sessions/{session}.

Parameters
Name Description
projectId String

The Project ID. Must not be null or empty.
environmentId String

The Environment ID. Must not be null or empty.
userId String

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

FromProjectLocationEnvironmentUserSession(String, String, String, String, String)

public static SessionName FromProjectLocationEnvironmentUserSession(string projectId, string locationId, string environmentId, string userId, string sessionId)

Creates a SessionName with the pattern projects/{project}/locations/{location}/agent/environments/{environment}/users/{user}/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.
environmentId String

The Environment ID. Must not be null or empty.
userId String

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

FromProjectLocationSession(String, String, String)

public static SessionName FromProjectLocationSession(string projectId, string locationId, string sessionId)

Creates a SessionName with the pattern projects/{project}/locations/{location}/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.
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.

FromProjectSession(String, String)

public static SessionName FromProjectSession(string projectId, string sessionId)

Creates a SessionName with the pattern projects/{project}/agent/sessions/{session}.

Parameters
Name Description
projectId String

The Project 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
Int32
Overrides

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}/agent/sessions/{session}
  • projects/{project}/agent/environments/{environment}/users/{user}/sessions/{session}
  • projects/{project}/locations/{location}/agent/sessions/{session}
  • projects/{project}/locations/{location}/agent/environments/{environment}/users/{user}/sessions/{session}

Parse(String, Boolean)

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 Boolean

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}/agent/sessions/{session}
  • projects/{project}/agent/environments/{environment}/users/{user}/sessions/{session}
  • projects/{project}/locations/{location}/agent/sessions/{session}
  • projects/{project}/locations/{location}/agent/environments/{environment}/users/{user}/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

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
Boolean

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}/agent/sessions/{session}
  • projects/{project}/agent/environments/{environment}/users/{user}/sessions/{session}
  • projects/{project}/locations/{location}/agent/sessions/{session}
  • projects/{project}/locations/{location}/agent/environments/{environment}/users/{user}/sessions/{session}

TryParse(String, Boolean, 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 Boolean

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
Boolean

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}/agent/sessions/{session}
  • projects/{project}/agent/environments/{environment}/users/{user}/sessions/{session}
  • projects/{project}/locations/{location}/agent/sessions/{session}
  • projects/{project}/locations/{location}/agent/environments/{environment}/users/{user}/sessions/{session}
Or may be in any format if allowUnparsed is true.

Operators

Equality(SessionName, SessionName)

public static bool operator ==(SessionName a, SessionName b)
Parameters
Name Description
a SessionName
b SessionName
Returns
Type Description
Boolean

Inequality(SessionName, SessionName)

public static bool operator !=(SessionName a, SessionName b)
Parameters
Name Description
a SessionName
b SessionName
Returns
Type Description
Boolean