Cloud AI Platform v1 API - Class FeatureGroupName (3.13.0) 

public sealed class FeatureGroupName : IResourceName, IEquatable<FeatureGroupName>

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

Resource name for the FeatureGroup resource.

Inheritance

object > FeatureGroupName

Namespace

Google.Cloud.AIPlatform.V1

Assembly

Google.Cloud.AIPlatform.V1.dll

Constructors

FeatureGroupName(string, string, string)

public FeatureGroupName(string projectId, string locationId, string featureGroupId)

Constructs a new instance of a FeatureGroupName class from the component parts of pattern projects/{project}/locations/{location}/featureGroups/{feature_group}

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.

Properties

FeatureGroupId

public string FeatureGroupId { get; }

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

The FeatureGroupName.ResourceNameType of the contained resource name.

Property Value
Type Description
FeatureGroupNameResourceNameType

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

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

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

The string representation of this FeatureGroupName with pattern projects/{project}/locations/{location}/featureGroups/{feature_group}.

FormatProjectLocationFeatureGroup(string, string, string)

public static string FormatProjectLocationFeatureGroup(string projectId, string locationId, string featureGroupId)

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

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

The string representation of this FeatureGroupName with pattern projects/{project}/locations/{location}/featureGroups/{feature_group}.

FromProjectLocationFeatureGroup(string, string, string)

public static FeatureGroupName FromProjectLocationFeatureGroup(string projectId, string locationId, string featureGroupId)

Creates a FeatureGroupName with the pattern projects/{project}/locations/{location}/featureGroups/{feature_group}.

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

A new instance of FeatureGroupName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static FeatureGroupName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a FeatureGroupName containing an unparsed resource name.

Parameter
Name Description
unparsedResourceName UnparsedResourceName

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

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

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

Parameter
Name Description
featureGroupName string

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

The parsed FeatureGroupName if successful.
Remarks

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

  • projects/{project}/locations/{location}/featureGroups/{feature_group}

Parse(string, bool)

public static FeatureGroupName Parse(string featureGroupName, bool allowUnparsed)

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

Parameters
Name Description
featureGroupName 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
FeatureGroupName

The parsed FeatureGroupName if successful.
Remarks

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

  • projects/{project}/locations/{location}/featureGroups/{feature_group}
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 FeatureGroupName)

public static bool TryParse(string featureGroupName, out FeatureGroupName result)

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

Parameters
Name Description
featureGroupName string

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

When this method returns, the parsed FeatureGroupName, 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}/featureGroups/{feature_group}

TryParse(string, bool, out FeatureGroupName)

public static bool TryParse(string featureGroupName, bool allowUnparsed, out FeatureGroupName result)

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

Parameters
Name Description
featureGroupName 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 FeatureGroupName

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

Operators

operator ==(FeatureGroupName, FeatureGroupName)

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

Determines whether two specified resource names have the same value.

Parameters
Name Description
a FeatureGroupName

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

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

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

Determines whether two specified resource names have different values.

Parameters
Name Description
a FeatureGroupName

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

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.