Google Cloud Dialogflow v2 API - Class ContextName (4.21.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

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

The ContextName.ResourceNameType of the contained resource name.

Property Value
Type Description
ContextNameResourceNameType

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
int
Overrides

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, bool)

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

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
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}/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, bool, 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 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 ContextName

When this method returns, the parsed ContextName, 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}/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

operator ==(ContextName, ContextName)

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

Determines whether two specified resource names have the same value.

Parameters
Name Description
a ContextName

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

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

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

Determines whether two specified resource names have different values.

Parameters
Name Description
a ContextName

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

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.