Cloud AI Platform v1 API - Class EntityTypeName (3.4.0) 

public sealed class EntityTypeName : IResourceName, IEquatable<EntityTypeName>

Reference documentation and code samples for the Cloud AI Platform v1 API class EntityTypeName.

Resource name for the EntityType resource.

Inheritance

object > EntityTypeName

Namespace

Google.Cloud.AIPlatform.V1

Assembly

Google.Cloud.AIPlatform.V1.dll

Constructors

EntityTypeName(string, string, string, string)

public EntityTypeName(string projectId, string locationId, string featurestoreId, string entityTypeId)

Constructs a new instance of a EntityTypeName class from the component parts of pattern projects/{project}/locations/{location}/featurestores/{featurestore}/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.
featurestoreId string

The Featurestore 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. Will not be null, unless this instance contains an unparsed resource name.

Property Value
Type Description
string

FeaturestoreId

public string FeaturestoreId { get; }

The Featurestore ID. Will not be null, unless this instance contains an unparsed resource name.

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. Will not be null, unless this instance contains an unparsed resource name.

Property Value
Type Description
string

ProjectId

public string ProjectId { get; }

The Project ID. Will not be null, unless this instance contains an unparsed resource name.

Property Value
Type Description
string

Type

public EntityTypeName.ResourceNameType Type { get; }

The EntityTypeName.ResourceNameType of the contained resource name.

Property Value
Type Description
EntityTypeNameResourceNameType

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)

public static string Format(string projectId, string locationId, string featurestoreId, string entityTypeId)

Formats the IDs into the string representation of this EntityTypeName with pattern projects/{project}/locations/{location}/featurestores/{featurestore}/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.
featurestoreId string

The Featurestore 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 EntityTypeName with pattern projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}.

FormatProjectLocationFeaturestoreEntityType(string, string, string, string)

public static string FormatProjectLocationFeaturestoreEntityType(string projectId, string locationId, string featurestoreId, string entityTypeId)

Formats the IDs into the string representation of this EntityTypeName with pattern projects/{project}/locations/{location}/featurestores/{featurestore}/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.
featurestoreId string

The Featurestore 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 EntityTypeName with pattern projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}.

FromProjectLocationFeaturestoreEntityType(string, string, string, string)

public static EntityTypeName FromProjectLocationFeaturestoreEntityType(string projectId, string locationId, string featurestoreId, string entityTypeId)

Creates a EntityTypeName with the pattern projects/{project}/locations/{location}/featurestores/{featurestore}/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.
featurestoreId string

The Featurestore ID. Must not be null or empty.
entityTypeId string

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)

public static EntityTypeName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a EntityTypeName containing an unparsed resource name.

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

public override int GetHashCode()

Returns a hash code for this resource name.

Returns
Type Description
int
Overrides

Parse(string)

public static EntityTypeName Parse(string entityTypeName)

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

Parameter
Name Description
entityTypeName string

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}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}

Parse(string, bool)

public static EntityTypeName Parse(string entityTypeName, bool allowUnparsed)

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

Parameters
Name Description
entityTypeName 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
EntityTypeName

The parsed EntityTypeName if successful.
Remarks

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

  • projects/{project}/locations/{location}/featurestores/{featurestore}/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 EntityTypeName)

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

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

Parameters
Name Description
entityTypeName string

The resource name in string form. Must not be null.
result EntityTypeName

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}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}

TryParse(string, bool, out EntityTypeName)

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

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

Parameters
Name Description
entityTypeName 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 EntityTypeName

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}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}
Or may be in any format if allowUnparsed is true.

Operators

operator ==(EntityTypeName, EntityTypeName)

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

Determines whether two specified resource names have the same value.

Parameters
Name Description
a EntityTypeName

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

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)

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

Determines whether two specified resource names have different values.

Parameters
Name Description
a EntityTypeName

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

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.