Cloud AI Platform v1 API - Class FeatureOnlineStoreName (2.25.0)

public sealed class FeatureOnlineStoreName : IResourceName, IEquatable<FeatureOnlineStoreName>

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

Resource name for the FeatureOnlineStore resource.

Inheritance

object > FeatureOnlineStoreName

Namespace

Google.Cloud.AIPlatform.V1

Assembly

Google.Cloud.AIPlatform.V1.dll

Constructors

FeatureOnlineStoreName(string, string, string)

public FeatureOnlineStoreName(string projectId, string locationId, string featureOnlineStoreId)

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

Parameters
NameDescription
projectIdstring

The Project ID. Must not be null or empty.

locationIdstring

The Location ID. Must not be null or empty.

featureOnlineStoreIdstring

The FeatureOnlineStore 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
TypeDescription
string

IsKnownPattern

public bool IsKnownPattern { get; }

Whether this instance contains a resource name with a known pattern.

Property Value
TypeDescription
bool

LocationId

public string LocationId { get; }

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

Property Value
TypeDescription
string

ProjectId

public string ProjectId { get; }

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

Property Value
TypeDescription
string

Type

public FeatureOnlineStoreName.ResourceNameType Type { get; }

The FeatureOnlineStoreName.ResourceNameType of the contained resource name.

Property Value
TypeDescription
FeatureOnlineStoreNameResourceNameType

UnparsedResource

public UnparsedResourceName UnparsedResource { get; }

The contained UnparsedResourceName. Only non-null if this instance contains an unparsed resource name.

Property Value
TypeDescription
UnparsedResourceName

Methods

Format(string, string, string)

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

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

Parameters
NameDescription
projectIdstring

The Project ID. Must not be null or empty.

locationIdstring

The Location ID. Must not be null or empty.

featureOnlineStoreIdstring

The FeatureOnlineStore ID. Must not be null or empty.

Returns
TypeDescription
string

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

FormatProjectLocationFeatureOnlineStore(string, string, string)

public static string FormatProjectLocationFeatureOnlineStore(string projectId, string locationId, string featureOnlineStoreId)

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

Parameters
NameDescription
projectIdstring

The Project ID. Must not be null or empty.

locationIdstring

The Location ID. Must not be null or empty.

featureOnlineStoreIdstring

The FeatureOnlineStore ID. Must not be null or empty.

Returns
TypeDescription
string

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

FromProjectLocationFeatureOnlineStore(string, string, string)

public static FeatureOnlineStoreName FromProjectLocationFeatureOnlineStore(string projectId, string locationId, string featureOnlineStoreId)

Creates a FeatureOnlineStoreName with the pattern projects/{project}/locations/{location}/featureOnlineStores/{feature_online_store}.

Parameters
NameDescription
projectIdstring

The Project ID. Must not be null or empty.

locationIdstring

The Location ID. Must not be null or empty.

featureOnlineStoreIdstring

The FeatureOnlineStore ID. Must not be null or empty.

Returns
TypeDescription
FeatureOnlineStoreName

A new instance of FeatureOnlineStoreName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static FeatureOnlineStoreName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a FeatureOnlineStoreName containing an unparsed resource name.

Parameter
NameDescription
unparsedResourceNameUnparsedResourceName

The unparsed resource name. Must not be null.

Returns
TypeDescription
FeatureOnlineStoreName

A new instance of FeatureOnlineStoreName containing the provided unparsedResourceName.

GetHashCode()

public override int GetHashCode()

Returns a hash code for this resource name.

Returns
TypeDescription
int
Overrides

Parse(string)

public static FeatureOnlineStoreName Parse(string featureOnlineStoreName)

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

Parameter
NameDescription
featureOnlineStoreNamestring

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

Returns
TypeDescription
FeatureOnlineStoreName

The parsed FeatureOnlineStoreName 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}

Parse(string, bool)

public static FeatureOnlineStoreName Parse(string featureOnlineStoreName, bool allowUnparsed)

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

Parameters
NameDescription
featureOnlineStoreNamestring

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

allowUnparsedbool

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
TypeDescription
FeatureOnlineStoreName

The parsed FeatureOnlineStoreName 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}
Or may be in any format if allowUnparsed is true.

ToString()

public override string ToString()

The string representation of the resource name.

Returns
TypeDescription
string

The string representation of the resource name.

Overrides

TryParse(string, out FeatureOnlineStoreName)

public static bool TryParse(string featureOnlineStoreName, out FeatureOnlineStoreName result)

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

Parameters
NameDescription
featureOnlineStoreNamestring

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

resultFeatureOnlineStoreName

When this method returns, the parsed FeatureOnlineStoreName, or null if parsing failed.

Returns
TypeDescription
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}

TryParse(string, bool, out FeatureOnlineStoreName)

public static bool TryParse(string featureOnlineStoreName, bool allowUnparsed, out FeatureOnlineStoreName result)

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

Parameters
NameDescription
featureOnlineStoreNamestring

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

allowUnparsedbool

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.

resultFeatureOnlineStoreName

When this method returns, the parsed FeatureOnlineStoreName, or null if parsing failed.

Returns
TypeDescription
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}
Or may be in any format if allowUnparsed is true.

Operators

operator ==(FeatureOnlineStoreName, FeatureOnlineStoreName)

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

Determines whether two specified resource names have the same value.

Parameters
NameDescription
aFeatureOnlineStoreName

The first resource name to compare, or null.

bFeatureOnlineStoreName

The second resource name to compare, or null.

Returns
TypeDescription
bool

true if the value of a is the same as the value of b; otherwise, false.

operator !=(FeatureOnlineStoreName, FeatureOnlineStoreName)

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

Determines whether two specified resource names have different values.

Parameters
NameDescription
aFeatureOnlineStoreName

The first resource name to compare, or null.

bFeatureOnlineStoreName

The second resource name to compare, or null.

Returns
TypeDescription
bool

true if the value of a is different from the value of b; otherwise, false.