Google Cloud Dialogflow v2 API - Class SessionEntityTypeName (4.23.0) 

public sealed class SessionEntityTypeName : IResourceName, IEquatable<SessionEntityTypeName>

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

Resource name for the SessionEntityType resource.

Inheritance

object > SessionEntityTypeName

Namespace

Google.Cloud.Dialogflow.V2

Assembly

Google.Cloud.Dialogflow.V2.dll

Constructors

SessionEntityTypeName(string, string, string)

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

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

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.
entityTypeId string

The EntityType ID. Must not be null or empty.

Properties

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

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

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

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.
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}/agent/sessions/{session}/entityTypes/{entity_type}.

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

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

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

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

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

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

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

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

FormatProjectLocationSessionEntityType(string, string, string, string)

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

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

FormatProjectSessionEntityType(string, string, string)

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

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

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.
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}/agent/sessions/{session}/entityTypes/{entity_type}.

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

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

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

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

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

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

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

FromProjectLocationSessionEntityType(string, string, string, string)

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

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

FromProjectSessionEntityType(string, string, string)

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

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

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

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}/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)

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}/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()

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 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}/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)

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}/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)

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.