Cloud AI Platform v1 API - Class FeatureViewName (3.13.0) 

public sealed class FeatureViewName : IResourceName, IEquatable<FeatureViewName>

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

Resource name for the FeatureView resource.

Inheritance

object > FeatureViewName

Namespace

Google.Cloud.AIPlatform.V1

Assembly

Google.Cloud.AIPlatform.V1.dll

Constructors

FeatureViewName(string, string, string, string)

public FeatureViewName(string projectId, string locationId, string featureOnlineStoreId, string featureViewId)

Constructs a new instance of a FeatureViewName class from the component parts of pattern projects/{project}/locations/{location}/featureOnlineStores/{feature_online_store}/featureViews/{feature_view}

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

The FeatureOnlineStore ID. Must not be null or empty.
featureViewId string

The FeatureView ID. Must not be null or empty.

Properties

FeatureOnlineStoreId

public string FeatureOnlineStoreId { get; }

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

Property Value
Type Description
string

FeatureViewId

public string FeatureViewId { get; }

The FeatureView 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 FeatureViewName.ResourceNameType Type { get; }

The FeatureViewName.ResourceNameType of the contained resource name.

Property Value
Type Description
FeatureViewNameResourceNameType

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 featureOnlineStoreId, string featureViewId)

Formats the IDs into the string representation of this FeatureViewName with pattern projects/{project}/locations/{location}/featureOnlineStores/{feature_online_store}/featureViews/{feature_view} .

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

The FeatureOnlineStore ID. Must not be null or empty.
featureViewId string

The FeatureView ID. Must not be null or empty.
Returns
Type Description
string

The string representation of this FeatureViewName with pattern projects/{project}/locations/{location}/featureOnlineStores/{feature_online_store}/featureViews/{feature_view} .

FormatProjectLocationFeatureOnlineStoreFeatureView(string, string, string, string)

public static string FormatProjectLocationFeatureOnlineStoreFeatureView(string projectId, string locationId, string featureOnlineStoreId, string featureViewId)

Formats the IDs into the string representation of this FeatureViewName with pattern projects/{project}/locations/{location}/featureOnlineStores/{feature_online_store}/featureViews/{feature_view} .

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

The FeatureOnlineStore ID. Must not be null or empty.
featureViewId string

The FeatureView ID. Must not be null or empty.
Returns
Type Description
string

The string representation of this FeatureViewName with pattern projects/{project}/locations/{location}/featureOnlineStores/{feature_online_store}/featureViews/{feature_view} .

FromProjectLocationFeatureOnlineStoreFeatureView(string, string, string, string)

public static FeatureViewName FromProjectLocationFeatureOnlineStoreFeatureView(string projectId, string locationId, string featureOnlineStoreId, string featureViewId)

Creates a FeatureViewName with the pattern projects/{project}/locations/{location}/featureOnlineStores/{feature_online_store}/featureViews/{feature_view} .

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

The FeatureOnlineStore ID. Must not be null or empty.
featureViewId string

The FeatureView ID. Must not be null or empty.
Returns
Type Description
FeatureViewName

A new instance of FeatureViewName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static FeatureViewName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a FeatureViewName containing an unparsed resource name.

Parameter
Name Description
unparsedResourceName UnparsedResourceName

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

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

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

Parameter
Name Description
featureViewName string

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

The parsed FeatureViewName if successful.
Remarks

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

  • projects/{project}/locations/{location}/featureOnlineStores/{feature_online_store}/featureViews/{feature_view}

Parse(string, bool)

public static FeatureViewName Parse(string featureViewName, bool allowUnparsed)

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

Parameters
Name Description
featureViewName 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
FeatureViewName

The parsed FeatureViewName if successful.
Remarks

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

  • projects/{project}/locations/{location}/featureOnlineStores/{feature_online_store}/featureViews/{feature_view}
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 FeatureViewName)

public static bool TryParse(string featureViewName, out FeatureViewName result)

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

Parameters
Name Description
featureViewName string

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

When this method returns, the parsed FeatureViewName, 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}/featureOnlineStores/{feature_online_store}/featureViews/{feature_view}

TryParse(string, bool, out FeatureViewName)

public static bool TryParse(string featureViewName, bool allowUnparsed, out FeatureViewName result)

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

Parameters
Name Description
featureViewName 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 FeatureViewName

When this method returns, the parsed FeatureViewName, 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}/featureOnlineStores/{feature_online_store}/featureViews/{feature_view}
Or may be in any format if allowUnparsed is true.

Operators

operator ==(FeatureViewName, FeatureViewName)

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

Determines whether two specified resource names have the same value.

Parameters
Name Description
a FeatureViewName

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

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

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

Determines whether two specified resource names have different values.

Parameters
Name Description
a FeatureViewName

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

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.