Class SessionEntityTypeName

Resource name for the SessionEntityType resource.

Inheritance

object

SessionEntityTypeName

Implements

IResourceName

IEquatable<SessionEntityTypeName>

Inherited Members

object.GetType()

Namespace: Google.Cloud.Dialogflow.V2

Assembly: Google.Cloud.Dialogflow.V2.dll

Syntax

public sealed class SessionEntityTypeName : IResourceName, IEquatable<SessionEntityTypeName>

Constructors

SessionEntityTypeName(string, string, string)

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

Declaration

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

Parameters

Type	Name	Description
string	projectId	The `Project` ID. Must not be `null` or empty.
string	sessionId	The `Session` ID. Must not be `null` or empty.
string	entityTypeId	The `EntityType` ID. Must not be `null` or empty.

Properties

EntityTypeId

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

Declaration

public string EntityTypeId { get; }

Property Value

Type	Description
string

EnvironmentId

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

Declaration

public string EnvironmentId { get; }

Property Value

Type	Description
string

IsKnownPattern

Whether this instance contains a resource name with a known pattern.

Declaration

public bool IsKnownPattern { get; }

Property Value

Type	Description
bool

Implements

IResourceName.IsKnownPattern

LocationId

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

Declaration

public string LocationId { get; }

Property Value

Type	Description
string

ProjectId

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

Declaration

public string ProjectId { get; }

Property Value

Type	Description
string

SessionId

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

Declaration

public string SessionId { get; }

Property Value

Type	Description
string

Type

The SessionEntityTypeName.ResourceNameType of the contained resource name.

Declaration

public SessionEntityTypeName.ResourceNameType Type { get; }

Property Value

Type	Description
SessionEntityTypeName.ResourceNameType

UnparsedResource

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

Declaration

public UnparsedResourceName UnparsedResource { get; }

Property Value

Type	Description
UnparsedResourceName

UserId

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

Declaration

public string UserId { get; }

Property Value

Type	Description
string

Methods

Format(string, string, string)

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

Declaration

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

Parameters

Type	Name	Description
string	projectId	The `Project` ID. Must not be `null` or empty.
string	sessionId	The `Session` ID. Must not be `null` or empty.
string	entityTypeId	The `EntityType` ID. Must not be `null` or empty.

Returns

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

FormatProjectEnvironmentUserSessionEntityType(string, string, string, string, string)

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

Declaration

public static string FormatProjectEnvironmentUserSessionEntityType(string projectId, string environmentId, string userId, string sessionId, string entityTypeId)

Parameters

Type	Name	Description
string	projectId	The `Project` ID. Must not be `null` or empty.
string	environmentId	The `Environment` ID. Must not be `null` or empty.
string	userId	The `User` ID. Must not be `null` or empty.
string	sessionId	The `Session` ID. Must not be `null` or empty.
string	entityTypeId	The `EntityType` ID. Must not be `null` or empty.

Returns

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

FormatProjectLocationEnvironmentUserSessionEntityType(string, string, string, string, string, string)

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

Declaration

public static string FormatProjectLocationEnvironmentUserSessionEntityType(string projectId, string locationId, string environmentId, string userId, string sessionId, string entityTypeId)

Parameters

Type	Name	Description
string	projectId	The `Project` ID. Must not be `null` or empty.
string	locationId	The `Location` ID. Must not be `null` or empty.
string	environmentId	The `Environment` ID. Must not be `null` or empty.
string	userId	The `User` ID. Must not be `null` or empty.
string	sessionId	The `Session` ID. Must not be `null` or empty.
string	entityTypeId	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}/agent/environments/{environment}/users/{user}/sessions/{session}/entityTypes/{entity_type}` .

FormatProjectLocationSessionEntityType(string, string, string, string)

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

Declaration

public static string FormatProjectLocationSessionEntityType(string projectId, string locationId, string sessionId, string entityTypeId)

Parameters

Type	Name	Description
string	projectId	The `Project` ID. Must not be `null` or empty.
string	locationId	The `Location` ID. Must not be `null` or empty.
string	sessionId	The `Session` ID. Must not be `null` or empty.
string	entityTypeId	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}/agent/sessions/{session}/entityTypes/{entity_type}`.

FormatProjectSessionEntityType(string, string, string)

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

Declaration

public static string FormatProjectSessionEntityType(string projectId, string sessionId, string entityTypeId)

Parameters

Type	Name	Description
string	projectId	The `Project` ID. Must not be `null` or empty.
string	sessionId	The `Session` ID. Must not be `null` or empty.
string	entityTypeId	The `EntityType` ID. Must not be `null` or empty.

Returns

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

FromProjectEnvironmentUserSessionEntityType(string, string, string, string, string)

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

Declaration

public static SessionEntityTypeName FromProjectEnvironmentUserSessionEntityType(string projectId, string environmentId, string userId, string sessionId, string entityTypeId)

Parameters

Type	Name	Description
string	projectId	The `Project` ID. Must not be `null` or empty.
string	environmentId	The `Environment` ID. Must not be `null` or empty.
string	userId	The `User` ID. Must not be `null` or empty.
string	sessionId	The `Session` ID. Must not be `null` or empty.
string	entityTypeId	The `EntityType` ID. Must not be `null` or empty.

Returns

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

FromProjectLocationEnvironmentUserSessionEntityType(string, string, string, string, string, string)

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

Declaration

public static SessionEntityTypeName FromProjectLocationEnvironmentUserSessionEntityType(string projectId, string locationId, string environmentId, string userId, string sessionId, string entityTypeId)

Parameters

Type	Name	Description
string	projectId	The `Project` ID. Must not be `null` or empty.
string	locationId	The `Location` ID. Must not be `null` or empty.
string	environmentId	The `Environment` ID. Must not be `null` or empty.
string	userId	The `User` ID. Must not be `null` or empty.
string	sessionId	The `Session` ID. Must not be `null` or empty.
string	entityTypeId	The `EntityType` ID. Must not be `null` or empty.

Returns

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

FromProjectLocationSessionEntityType(string, string, string, string)

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

Declaration

public static SessionEntityTypeName FromProjectLocationSessionEntityType(string projectId, string locationId, string sessionId, string entityTypeId)

Parameters

Type	Name	Description
string	projectId	The `Project` ID. Must not be `null` or empty.
string	locationId	The `Location` ID. Must not be `null` or empty.
string	sessionId	The `Session` ID. Must not be `null` or empty.
string	entityTypeId	The `EntityType` ID. Must not be `null` or empty.

Returns

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

FromProjectSessionEntityType(string, string, string)

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

Declaration

public static SessionEntityTypeName FromProjectSessionEntityType(string projectId, string sessionId, string entityTypeId)

Parameters

Type	Name	Description
string	projectId	The `Project` ID. Must not be `null` or empty.
string	sessionId	The `Session` ID. Must not be `null` or empty.
string	entityTypeId	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)

Creates a SessionEntityTypeName containing an unparsed resource name.

Declaration

public static SessionEntityTypeName FromUnparsed(UnparsedResourceName unparsedResourceName)

Parameters

Type	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()

Returns a hash code for this resource name.

Declaration

public override int GetHashCode()

Returns

Type	Description
int

Overrides

object.GetHashCode()

Parse(string)

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

Declaration

public static SessionEntityTypeName Parse(string sessionEntityTypeName)

Parameters

Type	Name	Description
string	sessionEntityTypeName	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}/agent/sessions/{session}/entityTypes/{entity_type}
projects/{project}/agent/environments/{environment}/users/{user}/sessions/{session}/entityTypes/{entity_type}
projects/{project}/locations/{location}/agent/sessions/{session}/entityTypes/{entity_type}
projects/{project}/locations/{location}/agent/environments/{environment}/users/{user}/sessions/{session}/entityTypes/{entity_type}

Parse(string, bool)

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

Declaration

public static SessionEntityTypeName Parse(string sessionEntityTypeName, bool allowUnparsed)

Parameters

Type	Name	Description
string	sessionEntityTypeName	The resource name in string form. Must not be `null`.
bool	allowUnparsed	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}/agent/sessions/{session}/entityTypes/{entity_type}
projects/{project}/agent/environments/{environment}/users/{user}/sessions/{session}/entityTypes/{entity_type}
projects/{project}/locations/{location}/agent/sessions/{session}/entityTypes/{entity_type}
projects/{project}/locations/{location}/agent/environments/{environment}/users/{user}/sessions/{session}/entityTypes/{entity_type}

Or may be in any format if allowUnparsed is true.

ToString()

The string representation of the resource name.

Declaration

public override string ToString()

Returns

Type	Description
string	The string representation of the resource name.

Overrides

object.ToString()

Implements

IResourceName.ToString()

TryParse(string, out SessionEntityTypeName)

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

Declaration

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

Parameters

Type	Name	Description
string	sessionEntityTypeName	The resource name in string form. Must not be `null`.
SessionEntityTypeName	result	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}/agent/sessions/{session}/entityTypes/{entity_type}
projects/{project}/agent/environments/{environment}/users/{user}/sessions/{session}/entityTypes/{entity_type}
projects/{project}/locations/{location}/agent/sessions/{session}/entityTypes/{entity_type}
projects/{project}/locations/{location}/agent/environments/{environment}/users/{user}/sessions/{session}/entityTypes/{entity_type}

TryParse(string, bool, out SessionEntityTypeName)

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

Declaration

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

Parameters

Type	Name	Description
string	sessionEntityTypeName	The resource name in string form. Must not be `null`.
bool	allowUnparsed	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.
SessionEntityTypeName	result	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}/agent/sessions/{session}/entityTypes/{entity_type}
projects/{project}/agent/environments/{environment}/users/{user}/sessions/{session}/entityTypes/{entity_type}
projects/{project}/locations/{location}/agent/sessions/{session}/entityTypes/{entity_type}
projects/{project}/locations/{location}/agent/environments/{environment}/users/{user}/sessions/{session}/entityTypes/{entity_type}

Or may be in any format if allowUnparsed is true.

Operators

operator ==(SessionEntityTypeName, SessionEntityTypeName)

Determines whether two specified resource names have the same value.

Declaration

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

Parameters

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

Determines whether two specified resource names have different values.

Declaration

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

Parameters

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