Cloud AI Platform v1 API - Class FeaturestoreName (3.11.0) 

public sealed class FeaturestoreName : IResourceName, IEquatable<FeaturestoreName>

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

Resource name for the Featurestore resource.

Inheritance

object > FeaturestoreName

Namespace

Google.Cloud.AIPlatform.V1

Assembly

Google.Cloud.AIPlatform.V1.dll

Constructors

FeaturestoreName(string, string, string)

public FeaturestoreName(string projectId, string locationId, string featurestoreId)

Constructs a new instance of a FeaturestoreName class from the component parts of pattern projects/{project}/locations/{location}/featurestores/{featurestore}

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.

Properties

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 FeaturestoreName.ResourceNameType Type { get; }

The FeaturestoreName.ResourceNameType of the contained resource name.

Property Value
Type Description
FeaturestoreNameResourceNameType

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)

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

Formats the IDs into the string representation of this FeaturestoreName with pattern projects/{project}/locations/{location}/featurestores/{featurestore}.

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.
Returns
Type Description
string

The string representation of this FeaturestoreName with pattern projects/{project}/locations/{location}/featurestores/{featurestore}.

FormatProjectLocationFeaturestore(string, string, string)

public static string FormatProjectLocationFeaturestore(string projectId, string locationId, string featurestoreId)

Formats the IDs into the string representation of this FeaturestoreName with pattern projects/{project}/locations/{location}/featurestores/{featurestore}.

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.
Returns
Type Description
string

The string representation of this FeaturestoreName with pattern projects/{project}/locations/{location}/featurestores/{featurestore}.

FromProjectLocationFeaturestore(string, string, string)

public static FeaturestoreName FromProjectLocationFeaturestore(string projectId, string locationId, string featurestoreId)

Creates a FeaturestoreName with the pattern projects/{project}/locations/{location}/featurestores/{featurestore}.

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.
Returns
Type Description
FeaturestoreName

A new instance of FeaturestoreName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static FeaturestoreName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a FeaturestoreName containing an unparsed resource name.

Parameter
Name Description
unparsedResourceName UnparsedResourceName

The unparsed resource name. Must not be null.
Returns
Type Description
FeaturestoreName

A new instance of FeaturestoreName 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 FeaturestoreName Parse(string featurestoreName)

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

Parameter
Name Description
featurestoreName string

The resource name in string form. Must not be null.
Returns
Type Description
FeaturestoreName

The parsed FeaturestoreName if successful.
Remarks

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

  • projects/{project}/locations/{location}/featurestores/{featurestore}

Parse(string, bool)

public static FeaturestoreName Parse(string featurestoreName, bool allowUnparsed)

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

Parameters
Name Description
featurestoreName 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
FeaturestoreName

The parsed FeaturestoreName if successful.
Remarks

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

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

public static bool TryParse(string featurestoreName, out FeaturestoreName result)

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

Parameters
Name Description
featurestoreName string

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

When this method returns, the parsed FeaturestoreName, 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}

TryParse(string, bool, out FeaturestoreName)

public static bool TryParse(string featurestoreName, bool allowUnparsed, out FeaturestoreName result)

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

Parameters
Name Description
featurestoreName 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 FeaturestoreName

When this method returns, the parsed FeaturestoreName, 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}
Or may be in any format if allowUnparsed is true.

Operators

operator ==(FeaturestoreName, FeaturestoreName)

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

Determines whether two specified resource names have the same value.

Parameters
Name Description
a FeaturestoreName

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

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 !=(FeaturestoreName, FeaturestoreName)

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

Determines whether two specified resource names have different values.

Parameters
Name Description
a FeaturestoreName

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

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.