Cloud AI Platform v1 API - Class FeatureName (3.1.0)

public sealed class FeatureName : IResourceName, IEquatable<FeatureName>

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

Resource name for the Feature resource.

Inheritance

object > FeatureName

Implements

IResourceName, IEquatable FeatureName

Inherited Members

object.GetType()

Namespace

Google.Cloud.AIPlatform.V1

Assembly

Google.Cloud.AIPlatform.V1.dll

Constructors

FeatureName(string, string, string, string, string)

public FeatureName(string projectId, string locationId, string featurestoreId, string entityTypeId, string featureId)

Constructs a new instance of a FeatureName class from the component parts of pattern projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}/features/{feature}

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.
`featureId`	`string` The `Feature` 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`

FeatureGroupId

public string FeatureGroupId { get; }

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

Property Value
Type	Description
`string`

FeatureId

public string FeatureId { get; }

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

Property Value
Type	Description
`string`

FeaturestoreId

public string FeaturestoreId { get; }

The Featurestore 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`

Type

public FeatureName.ResourceNameType Type { get; }

The FeatureName.ResourceNameType of the contained resource name.

Property Value
Type	Description
`FeatureNameResourceNameType`

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 featurestoreId, string entityTypeId, string featureId)

Formats the IDs into the string representation of this FeatureName with pattern projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}/features/{feature} .

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

Returns
Type	Description
`string`	The string representation of this FeatureName with pattern `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}/features/{feature}` .

FormatProjectLocationFeatureGroupFeature(string, string, string, string)

public static string FormatProjectLocationFeatureGroupFeature(string projectId, string locationId, string featureGroupId, string featureId)

Formats the IDs into the string representation of this FeatureName with pattern projects/{project}/locations/{location}/featureGroups/{feature_group}/features/{feature}.

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.
`featureGroupId`	`string` The `FeatureGroup` ID. Must not be `null` or empty.
`featureId`	`string` The `Feature` ID. Must not be `null` or empty.

Returns
Type	Description
`string`	The string representation of this FeatureName with pattern `projects/{project}/locations/{location}/featureGroups/{feature_group}/features/{feature}`.

FormatProjectLocationFeaturestoreEntityTypeFeature(string, string, string, string, string)

public static string FormatProjectLocationFeaturestoreEntityTypeFeature(string projectId, string locationId, string featurestoreId, string entityTypeId, string featureId)

Formats the IDs into the string representation of this FeatureName with pattern projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}/features/{feature} .

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

Returns
Type	Description
`string`	The string representation of this FeatureName with pattern `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}/features/{feature}` .

FromProjectLocationFeatureGroupFeature(string, string, string, string)

public static FeatureName FromProjectLocationFeatureGroupFeature(string projectId, string locationId, string featureGroupId, string featureId)

Creates a FeatureName with the pattern projects/{project}/locations/{location}/featureGroups/{feature_group}/features/{feature}.

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.
`featureGroupId`	`string` The `FeatureGroup` ID. Must not be `null` or empty.
`featureId`	`string` The `Feature` ID. Must not be `null` or empty.

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

FromProjectLocationFeaturestoreEntityTypeFeature(string, string, string, string, string)

public static FeatureName FromProjectLocationFeaturestoreEntityTypeFeature(string projectId, string locationId, string featurestoreId, string entityTypeId, string featureId)

Creates a FeatureName with the pattern projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}/features/{feature} .

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

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

FromUnparsed(UnparsedResourceName)

public static FeatureName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a FeatureName containing an unparsed resource name.

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

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

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

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

Returns
Type	Description
`FeatureName`	The parsed FeatureName 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}/features/{feature}
projects/{project}/locations/{location}/featureGroups/{feature_group}/features/{feature}

Parse(string, bool)

public static FeatureName Parse(string featureName, bool allowUnparsed)

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

Parameters
Name	Description
`featureName`	`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
`FeatureName`	The parsed FeatureName 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}/features/{feature}
projects/{project}/locations/{location}/featureGroups/{feature_group}/features/{feature}

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

public static bool TryParse(string featureName, out FeatureName result)

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

Parameters
Name	Description
`featureName`	`string` The resource name in string form. Must not be `null`.
`result`	`FeatureName` When this method returns, the parsed FeatureName, 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}/features/{feature}
projects/{project}/locations/{location}/featureGroups/{feature_group}/features/{feature}

TryParse(string, bool, out FeatureName)

public static bool TryParse(string featureName, bool allowUnparsed, out FeatureName result)

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

Parameters
Name	Description
`featureName`	`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`	`FeatureName` When this method returns, the parsed FeatureName, 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}/features/{feature}
projects/{project}/locations/{location}/featureGroups/{feature_group}/features/{feature}

Or may be in any format if allowUnparsed is true.

Operators

operator ==(FeatureName, FeatureName)

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

Determines whether two specified resource names have the same value.

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

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

Determines whether two specified resource names have different values.

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