Vertex AI v1beta1 API - Class FeatureMonitorJobName (1.0.0-beta55) 

public sealed class FeatureMonitorJobName : IResourceName, IEquatable<FeatureMonitorJobName>

Reference documentation and code samples for the Vertex AI v1beta1 API class FeatureMonitorJobName.

Resource name for the FeatureMonitorJob resource.

Inheritance

object > FeatureMonitorJobName

Namespace

Google.Cloud.AIPlatform.V1Beta1

Assembly

Google.Cloud.AIPlatform.V1Beta1.dll

Constructors

FeatureMonitorJobName(string, string, string, string, string)

public FeatureMonitorJobName(string projectId, string locationId, string featureGroupId, string featureMonitorId, string featureMonitorJobId)

Constructs a new instance of a FeatureMonitorJobName class from the component parts of pattern

projects/{project}/locations/{location}/featureGroups/{feature_group}/featureMonitors/{feature_monitor}/featureMonitorJobs/{feature_monitor_job}

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

The FeatureMonitor ID. Must not be null or empty.
featureMonitorJobId string

The FeatureMonitorJob 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

FeatureMonitorId

public string FeatureMonitorId { get; }

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

Property Value
Type Description
string

FeatureMonitorJobId

public string FeatureMonitorJobId { get; }

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

The FeatureMonitorJobName.ResourceNameType of the contained resource name.

Property Value
Type Description
FeatureMonitorJobNameResourceNameType

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 featureGroupId, string featureMonitorId, string featureMonitorJobId)

Formats the IDs into the string representation of this FeatureMonitorJobName with pattern projects/{project}/locations/{location}/featureGroups/{feature_group}/featureMonitors/{feature_monitor}/featureMonitorJobs/{feature_monitor_job} .

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

The FeatureMonitor ID. Must not be null or empty.
featureMonitorJobId string

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

The string representation of this FeatureMonitorJobName with pattern projects/{project}/locations/{location}/featureGroups/{feature_group}/featureMonitors/{feature_monitor}/featureMonitorJobs/{feature_monitor_job} .

FormatProjectLocationFeatureGroupFeatureMonitorFeatureMonitorJob(string, string, string, string, string)

public static string FormatProjectLocationFeatureGroupFeatureMonitorFeatureMonitorJob(string projectId, string locationId, string featureGroupId, string featureMonitorId, string featureMonitorJobId)

Formats the IDs into the string representation of this FeatureMonitorJobName with pattern projects/{project}/locations/{location}/featureGroups/{feature_group}/featureMonitors/{feature_monitor}/featureMonitorJobs/{feature_monitor_job} .

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

The FeatureMonitor ID. Must not be null or empty.
featureMonitorJobId string

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

The string representation of this FeatureMonitorJobName with pattern projects/{project}/locations/{location}/featureGroups/{feature_group}/featureMonitors/{feature_monitor}/featureMonitorJobs/{feature_monitor_job} .

FromProjectLocationFeatureGroupFeatureMonitorFeatureMonitorJob(string, string, string, string, string)

public static FeatureMonitorJobName FromProjectLocationFeatureGroupFeatureMonitorFeatureMonitorJob(string projectId, string locationId, string featureGroupId, string featureMonitorId, string featureMonitorJobId)

Creates a FeatureMonitorJobName with the pattern projects/{project}/locations/{location}/featureGroups/{feature_group}/featureMonitors/{feature_monitor}/featureMonitorJobs/{feature_monitor_job} .

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

The FeatureMonitor ID. Must not be null or empty.
featureMonitorJobId string

The FeatureMonitorJob ID. Must not be null or empty.
Returns
Type Description
FeatureMonitorJobName

A new instance of FeatureMonitorJobName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static FeatureMonitorJobName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a FeatureMonitorJobName containing an unparsed resource name.

Parameter
Name Description
unparsedResourceName UnparsedResourceName

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

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

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

Parameter
Name Description
featureMonitorJobName string

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

The parsed FeatureMonitorJobName if successful.
Remarks

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

  • projects/{project}/locations/{location}/featureGroups/{feature_group}/featureMonitors/{feature_monitor}/featureMonitorJobs/{feature_monitor_job}

Parse(string, bool)

public static FeatureMonitorJobName Parse(string featureMonitorJobName, bool allowUnparsed)

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

Parameters
Name Description
featureMonitorJobName 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
FeatureMonitorJobName

The parsed FeatureMonitorJobName if successful.
Remarks

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

  • projects/{project}/locations/{location}/featureGroups/{feature_group}/featureMonitors/{feature_monitor}/featureMonitorJobs/{feature_monitor_job}
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 FeatureMonitorJobName)

public static bool TryParse(string featureMonitorJobName, out FeatureMonitorJobName result)

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

Parameters
Name Description
featureMonitorJobName string

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

When this method returns, the parsed FeatureMonitorJobName, 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}/featureMonitors/{feature_monitor}/featureMonitorJobs/{feature_monitor_job}

TryParse(string, bool, out FeatureMonitorJobName)

public static bool TryParse(string featureMonitorJobName, bool allowUnparsed, out FeatureMonitorJobName result)

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

Parameters
Name Description
featureMonitorJobName 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 FeatureMonitorJobName

When this method returns, the parsed FeatureMonitorJobName, 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}/featureMonitors/{feature_monitor}/featureMonitorJobs/{feature_monitor_job}
Or may be in any format if allowUnparsed is true.

Operators

operator ==(FeatureMonitorJobName, FeatureMonitorJobName)

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

Determines whether two specified resource names have the same value.

Parameters
Name Description
a FeatureMonitorJobName

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

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

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

Determines whether two specified resource names have different values.

Parameters
Name Description
a FeatureMonitorJobName

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

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.