Google Cloud Dialogflow v2 API - Class ContextName (4.2.0)

public sealed class ContextName : IResourceName, IEquatable<ContextName>

Reference documentation and code samples for the Google Cloud Dialogflow v2 API class ContextName.

Resource name for the Context resource.

Inheritance

Object > ContextName

Implements

IResourceName, IEquatable<ContextName>

Inherited Members

Object.GetType()

Object.MemberwiseClone()

Namespace

Google.Cloud.Dialogflow.V2

Assembly

Google.Cloud.Dialogflow.V2.dll

Constructors

ContextName(String, String, String)

public ContextName(string projectId, string sessionId, string contextId)

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

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.
`contextId`	`String` The `Context` ID. Must not be `null` or empty.

Properties

ContextId

public string ContextId { get; }

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

The ContextName.ResourceNameType of the contained resource name.

Property Value
Type	Description
`ContextName.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, String)

public static string Format(string projectId, string sessionId, string contextId)

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

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.
`contextId`	`String` The `Context` ID. Must not be `null` or empty.

Returns
Type	Description
`String`	The string representation of this ContextName with pattern `projects/{project}/agent/sessions/{session}/contexts/{context}`.

FormatProjectEnvironmentUserSessionContext(String, String, String, String, String)

public static string FormatProjectEnvironmentUserSessionContext(string projectId, string environmentId, string userId, string sessionId, string contextId)

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

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.
`contextId`	`String` The `Context` ID. Must not be `null` or empty.

Returns
Type	Description
`String`	The string representation of this ContextName with pattern `projects/{project}/agent/environments/{environment}/users/{user}/sessions/{session}/contexts/{context}` .

FormatProjectLocationEnvironmentUserSessionContext(String, String, String, String, String, String)

public static string FormatProjectLocationEnvironmentUserSessionContext(string projectId, string locationId, string environmentId, string userId, string sessionId, string contextId)

Formats the IDs into the string representation of this ContextName with pattern projects/{project}/locations/{location}/agent/environments/{environment}/users/{user}/sessions/{session}/contexts/{context} .

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.
`contextId`	`String` The `Context` ID. Must not be `null` or empty.

Returns
Type	Description
`String`	The string representation of this ContextName with pattern `projects/{project}/locations/{location}/agent/environments/{environment}/users/{user}/sessions/{session}/contexts/{context}` .

FormatProjectLocationSessionContext(String, String, String, String)

public static string FormatProjectLocationSessionContext(string projectId, string locationId, string sessionId, string contextId)

Formats the IDs into the string representation of this ContextName with pattern projects/{project}/locations/{location}/agent/sessions/{session}/contexts/{context}.

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.
`contextId`	`String` The `Context` ID. Must not be `null` or empty.

Returns
Type	Description
`String`	The string representation of this ContextName with pattern `projects/{project}/locations/{location}/agent/sessions/{session}/contexts/{context}`.

FormatProjectSessionContext(String, String, String)

public static string FormatProjectSessionContext(string projectId, string sessionId, string contextId)

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

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.
`contextId`	`String` The `Context` ID. Must not be `null` or empty.

Returns
Type	Description
`String`	The string representation of this ContextName with pattern `projects/{project}/agent/sessions/{session}/contexts/{context}`.

FromProjectEnvironmentUserSessionContext(String, String, String, String, String)

public static ContextName FromProjectEnvironmentUserSessionContext(string projectId, string environmentId, string userId, string sessionId, string contextId)

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

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.
`contextId`	`String` The `Context` ID. Must not be `null` or empty.

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

FromProjectLocationEnvironmentUserSessionContext(String, String, String, String, String, String)

public static ContextName FromProjectLocationEnvironmentUserSessionContext(string projectId, string locationId, string environmentId, string userId, string sessionId, string contextId)

Creates a ContextName with the pattern projects/{project}/locations/{location}/agent/environments/{environment}/users/{user}/sessions/{session}/contexts/{context} .

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.
`contextId`	`String` The `Context` ID. Must not be `null` or empty.

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

FromProjectLocationSessionContext(String, String, String, String)

public static ContextName FromProjectLocationSessionContext(string projectId, string locationId, string sessionId, string contextId)

Creates a ContextName with the pattern projects/{project}/locations/{location}/agent/sessions/{session}/contexts/{context}.

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.
`contextId`	`String` The `Context` ID. Must not be `null` or empty.

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

FromProjectSessionContext(String, String, String)

public static ContextName FromProjectSessionContext(string projectId, string sessionId, string contextId)

Creates a ContextName with the pattern projects/{project}/agent/sessions/{session}/contexts/{context}.

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.
`contextId`	`String` The `Context` ID. Must not be `null` or empty.

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

FromUnparsed(UnparsedResourceName)

public static ContextName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a ContextName containing an unparsed resource name.

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

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

GetHashCode()

public override int GetHashCode()

Returns a hash code for this resource name.

Returns
Type	Description
`Int32`

Overrides

Object.GetHashCode()

Parse(String)

public static ContextName Parse(string contextName)

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

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

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

Remarks

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

projects/{project}/agent/sessions/{session}/contexts/{context}
projects/{project}/agent/environments/{environment}/users/{user}/sessions/{session}/contexts/{context}
projects/{project}/locations/{location}/agent/sessions/{session}/contexts/{context}
projects/{project}/locations/{location}/agent/environments/{environment}/users/{user}/sessions/{session}/contexts/{context}

Parse(String, Boolean)

public static ContextName Parse(string contextName, bool allowUnparsed)

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

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

Remarks

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

projects/{project}/agent/sessions/{session}/contexts/{context}
projects/{project}/agent/environments/{environment}/users/{user}/sessions/{session}/contexts/{context}
projects/{project}/locations/{location}/agent/sessions/{session}/contexts/{context}
projects/{project}/locations/{location}/agent/environments/{environment}/users/{user}/sessions/{session}/contexts/{context}

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 ContextName)

public static bool TryParse(string contextName, out ContextName result)

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

Parameters
Name	Description
`contextName`	`String` The resource name in string form. Must not be `null`.
`result`	`ContextName` When this method returns, the parsed ContextName, 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}/contexts/{context}
projects/{project}/agent/environments/{environment}/users/{user}/sessions/{session}/contexts/{context}
projects/{project}/locations/{location}/agent/sessions/{session}/contexts/{context}
projects/{project}/locations/{location}/agent/environments/{environment}/users/{user}/sessions/{session}/contexts/{context}

TryParse(String, Boolean, out ContextName)

public static bool TryParse(string contextName, bool allowUnparsed, out ContextName result)

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

Parameters
Name	Description
`contextName`	`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`	`ContextName` When this method returns, the parsed ContextName, 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}/contexts/{context}
projects/{project}/agent/environments/{environment}/users/{user}/sessions/{session}/contexts/{context}
projects/{project}/locations/{location}/agent/sessions/{session}/contexts/{context}
projects/{project}/locations/{location}/agent/environments/{environment}/users/{user}/sessions/{session}/contexts/{context}

Or may be in any format if allowUnparsed is true.

Operators

Equality(ContextName, ContextName)

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

Parameters
Name	Description
`a`	`ContextName`
`b`	`ContextName`

Returns
Type	Description
`Boolean`

Inequality(ContextName, ContextName)

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

Parameters
Name	Description
`a`	`ContextName`
`b`	`ContextName`

Returns
Type	Description
`Boolean`