Dialogflow v3 API - Class SessionEntityTypeName (2.20.0)

public sealed class SessionEntityTypeName : IResourceName, IEquatable<SessionEntityTypeName>

Reference documentation and code samples for the Dialogflow v3 API class SessionEntityTypeName.

Resource name for the SessionEntityType resource.

Inheritance

object > SessionEntityTypeName

Implements

IResourceName, IEquatable SessionEntityTypeName

Inherited Members

object.GetType()

Namespace

Google.Cloud.Dialogflow.Cx.V3

Assembly

Google.Cloud.Dialogflow.Cx.V3.dll

Constructors

SessionEntityTypeName(string, string, string, string, string)

public SessionEntityTypeName(string projectId, string locationId, string agentId, string sessionId, string entityTypeId)

Constructs a new instance of a SessionEntityTypeName class from the component parts of pattern projects/{project}/locations/{location}/agents/{agent}/sessions/{session}/entityTypes/{entity_type}

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.
`entityTypeId`	`string` The `EntityType` 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`

EntityTypeId

public string EntityTypeId { get; }

The EntityType 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 SessionEntityTypeName.ResourceNameType Type { get; }

The SessionEntityTypeName.ResourceNameType of the contained resource name.

Property Value
Type	Description
`SessionEntityTypeNameResourceNameType`

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

public static string Format(string projectId, string locationId, string agentId, string sessionId, string entityTypeId)

Formats the IDs into the string representation of this SessionEntityTypeName with pattern projects/{project}/locations/{location}/agents/{agent}/sessions/{session}/entityTypes/{entity_type}.

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.
`entityTypeId`	`string` The `EntityType` ID. Must not be `null` or empty.

Returns
Type	Description
`string`	The string representation of this SessionEntityTypeName with pattern `projects/{project}/locations/{location}/agents/{agent}/sessions/{session}/entityTypes/{entity_type}`.

FormatProjectLocationAgentEnvironmentSessionEntityType(string, string, string, string, string, string)

public static string FormatProjectLocationAgentEnvironmentSessionEntityType(string projectId, string locationId, string agentId, string environmentId, string sessionId, string entityTypeId)

Formats the IDs into the string representation of this SessionEntityTypeName with pattern projects/{project}/locations/{location}/agents/{agent}/environments/{environment}/sessions/{session}/entityTypes/{entity_type} .

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.
`entityTypeId`	`string` The `EntityType` ID. Must not be `null` or empty.

Returns
Type	Description
`string`	The string representation of this SessionEntityTypeName with pattern `projects/{project}/locations/{location}/agents/{agent}/environments/{environment}/sessions/{session}/entityTypes/{entity_type}` .

FormatProjectLocationAgentSessionEntityType(string, string, string, string, string)

public static string FormatProjectLocationAgentSessionEntityType(string projectId, string locationId, string agentId, string sessionId, string entityTypeId)

Formats the IDs into the string representation of this SessionEntityTypeName with pattern projects/{project}/locations/{location}/agents/{agent}/sessions/{session}/entityTypes/{entity_type}.

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.
`entityTypeId`	`string` The `EntityType` ID. Must not be `null` or empty.

Returns
Type	Description
`string`	The string representation of this SessionEntityTypeName with pattern `projects/{project}/locations/{location}/agents/{agent}/sessions/{session}/entityTypes/{entity_type}`.

FromProjectLocationAgentEnvironmentSessionEntityType(string, string, string, string, string, string)

public static SessionEntityTypeName FromProjectLocationAgentEnvironmentSessionEntityType(string projectId, string locationId, string agentId, string environmentId, string sessionId, string entityTypeId)

Creates a SessionEntityTypeName with the pattern projects/{project}/locations/{location}/agents/{agent}/environments/{environment}/sessions/{session}/entityTypes/{entity_type} .

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.
`entityTypeId`	`string` The `EntityType` ID. Must not be `null` or empty.

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

FromProjectLocationAgentSessionEntityType(string, string, string, string, string)

public static SessionEntityTypeName FromProjectLocationAgentSessionEntityType(string projectId, string locationId, string agentId, string sessionId, string entityTypeId)

Creates a SessionEntityTypeName with the pattern projects/{project}/locations/{location}/agents/{agent}/sessions/{session}/entityTypes/{entity_type}.

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.
`entityTypeId`	`string` The `EntityType` ID. Must not be `null` or empty.

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

FromUnparsed(UnparsedResourceName)

public static SessionEntityTypeName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a SessionEntityTypeName containing an unparsed resource name.

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

Returns
Type	Description
`SessionEntityTypeName`	A new instance of SessionEntityTypeName 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 SessionEntityTypeName Parse(string sessionEntityTypeName)

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

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

Returns
Type	Description
`SessionEntityTypeName`	The parsed SessionEntityTypeName 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}/entityTypes/{entity_type}
projects/{project}/locations/{location}/agents/{agent}/environments/{environment}/sessions/{session}/entityTypes/{entity_type}

Parse(string, bool)

public static SessionEntityTypeName Parse(string sessionEntityTypeName, bool allowUnparsed)

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

Parameters
Name	Description
`sessionEntityTypeName`	`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
`SessionEntityTypeName`	The parsed SessionEntityTypeName 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}/entityTypes/{entity_type}
projects/{project}/locations/{location}/agents/{agent}/environments/{environment}/sessions/{session}/entityTypes/{entity_type}

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

public static bool TryParse(string sessionEntityTypeName, out SessionEntityTypeName result)

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

Parameters
Name	Description
`sessionEntityTypeName`	`string` The resource name in string form. Must not be `null`.
`result`	`SessionEntityTypeName` When this method returns, the parsed SessionEntityTypeName, 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}/entityTypes/{entity_type}
projects/{project}/locations/{location}/agents/{agent}/environments/{environment}/sessions/{session}/entityTypes/{entity_type}

TryParse(string, bool, out SessionEntityTypeName)

public static bool TryParse(string sessionEntityTypeName, bool allowUnparsed, out SessionEntityTypeName result)

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

Parameters
Name	Description
`sessionEntityTypeName`	`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`	`SessionEntityTypeName` When this method returns, the parsed SessionEntityTypeName, 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}/entityTypes/{entity_type}
projects/{project}/locations/{location}/agents/{agent}/environments/{environment}/sessions/{session}/entityTypes/{entity_type}

Or may be in any format if allowUnparsed is true.

Operators

operator ==(SessionEntityTypeName, SessionEntityTypeName)

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

Determines whether two specified resource names have the same value.

Parameters
Name	Description
`a`	`SessionEntityTypeName` The first resource name to compare, or null.
`b`	`SessionEntityTypeName` 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 !=(SessionEntityTypeName, SessionEntityTypeName)

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

Determines whether two specified resource names have different values.

Parameters
Name	Description
`a`	`SessionEntityTypeName` The first resource name to compare, or null.
`b`	`SessionEntityTypeName` 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.