Class EntityTypeName

Resource name for the EntityType resource.

Inheritance

object

EntityTypeName

Implements

IResourceName

IEquatable<EntityTypeName>

Inherited Members

object.GetType()

Namespace: Google.Cloud.Dialogflow.V2

Assembly: Google.Cloud.Dialogflow.V2.dll

Syntax

public sealed class EntityTypeName : IResourceName, IEquatable<EntityTypeName>

Constructors

EntityTypeName(string, string)

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

Declaration

public EntityTypeName(string projectId, string entityTypeId)

Parameters

Type	Name	Description
string	projectId	The Project 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

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

Type

The EntityTypeName.ResourceNameType of the contained resource name.

Declaration

public EntityTypeName.ResourceNameType Type { get; }

Property Value

Type	Description
EntityTypeName.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

Methods

Format(string, string)

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

Declaration

public static string Format(string projectId, string entityTypeId)

Parameters

Type	Name	Description
string	projectId	The Project 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 EntityTypeName with pattern projects/{project}/agent/entityTypes/{entity_type}.

FormatProjectEntityType(string, string)

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

Declaration

public static string FormatProjectEntityType(string projectId, string entityTypeId)

Parameters

Type	Name	Description
string	projectId	The Project 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 EntityTypeName with pattern projects/{project}/agent/entityTypes/{entity_type}.

FormatProjectLocationEntityType(string, string, string)

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

Declaration

public static string FormatProjectLocationEntityType(string projectId, string locationId, 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	entityTypeId	The EntityType ID. Must not be null or empty.

Returns

Type	Description
string	The string representation of this EntityTypeName with pattern projects/{project}/locations/{location}/agent/entityTypes/{entity_type}.

FromProjectEntityType(string, string)

Creates a EntityTypeName with the pattern projects/{project}/agent/entityTypes/{entity_type}.

Declaration

public static EntityTypeName FromProjectEntityType(string projectId, string entityTypeId)

Parameters

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

Returns

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

FromProjectLocationEntityType(string, string, string)

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

Declaration

public static EntityTypeName FromProjectLocationEntityType(string projectId, string locationId, 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	entityTypeId	The EntityType ID. Must not be null or empty.

Returns

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

FromUnparsed(UnparsedResourceName)

Creates a EntityTypeName containing an unparsed resource name.

Declaration

public static EntityTypeName FromUnparsed(UnparsedResourceName unparsedResourceName)

Parameters

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

Returns

Type	Description
EntityTypeName	A new instance of EntityTypeName 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 EntityTypeName instance.

Declaration

public static EntityTypeName Parse(string entityTypeName)

Parameters

Type	Name	Description
string	entityTypeName	The resource name in string form. Must not be null.

Returns

Type	Description
EntityTypeName	The parsed EntityTypeName if successful.

Remarks

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

• projects/{project}/agent/entityTypes/{entity_type}
• projects/{project}/locations/{location}/agent/entityTypes/{entity_type}

Parse(string, bool)

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

Declaration

public static EntityTypeName Parse(string entityTypeName, bool allowUnparsed)

Parameters

Type	Name	Description
string	entityTypeName	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
EntityTypeName	The parsed EntityTypeName if successful.

Remarks

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

• projects/{project}/agent/entityTypes/{entity_type}
• projects/{project}/locations/{location}/agent/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 EntityTypeName)

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

Declaration

public static bool TryParse(string entityTypeName, out EntityTypeName result)

Parameters

Type	Name	Description
string	entityTypeName	The resource name in string form. Must not be null.
EntityTypeName	result	When this method returns, the parsed EntityTypeName, 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/entityTypes/{entity_type}
• projects/{project}/locations/{location}/agent/entityTypes/{entity_type}

TryParse(string, bool, out EntityTypeName)

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

Declaration

public static bool TryParse(string entityTypeName, bool allowUnparsed, out EntityTypeName result)

Parameters

Type	Name	Description
string	entityTypeName	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.
EntityTypeName	result	When this method returns, the parsed EntityTypeName, 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/entityTypes/{entity_type}
• projects/{project}/locations/{location}/agent/entityTypes/{entity_type}

Or may be in any format if allowUnparsed is true.

Operators

operator ==(EntityTypeName, EntityTypeName)

Determines whether two specified resource names have the same value.

Declaration

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

Parameters

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

Determines whether two specified resource names have different values.

Declaration

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

Parameters

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