Cloud AI Platform v1beta1 API - Class ModelMonitoringJobName (1.0.0-beta05)

public sealed class ModelMonitoringJobName : IResourceName, IEquatable<ModelMonitoringJobName>

Reference documentation and code samples for the Cloud AI Platform v1beta1 API class ModelMonitoringJobName.

Resource name for the ModelMonitoringJob resource.

Inheritance

object > ModelMonitoringJobName

Implements

IResourceName, IEquatable ModelMonitoringJobName

Inherited Members

object.GetType()

Namespace

Google.Cloud.AIPlatform.V1Beta1

Assembly

Google.Cloud.AIPlatform.V1Beta1.dll

Constructors

ModelMonitoringJobName(string, string, string, string)

public ModelMonitoringJobName(string projectId, string locationId, string modelMonitorId, string modelMonitoringJobId)

Constructs a new instance of a ModelMonitoringJobName class from the component parts of pattern projects/{project}/locations/{location}/modelMonitors/{model_monitor}/modelMonitoringJobs/{model_monitoring_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.
`modelMonitorId`	`string` The `ModelMonitor` ID. Must not be `null` or empty.
`modelMonitoringJobId`	`string` The `ModelMonitoringJob` ID. Must not be `null` or empty.

Properties

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`

ModelMonitorId

public string ModelMonitorId { get; }

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

Property Value
Type	Description
`string`

ModelMonitoringJobId

public string ModelMonitoringJobId { get; }

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

The ModelMonitoringJobName.ResourceNameType of the contained resource name.

Property Value
Type	Description
`ModelMonitoringJobNameResourceNameType`

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 modelMonitorId, string modelMonitoringJobId)

Formats the IDs into the string representation of this ModelMonitoringJobName with pattern projects/{project}/locations/{location}/modelMonitors/{model_monitor}/modelMonitoringJobs/{model_monitoring_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.
`modelMonitorId`	`string` The `ModelMonitor` ID. Must not be `null` or empty.
`modelMonitoringJobId`	`string` The `ModelMonitoringJob` ID. Must not be `null` or empty.

Returns
Type	Description
`string`	The string representation of this ModelMonitoringJobName with pattern `projects/{project}/locations/{location}/modelMonitors/{model_monitor}/modelMonitoringJobs/{model_monitoring_job}` .

FormatProjectLocationModelMonitorModelMonitoringJob(string, string, string, string)

public static string FormatProjectLocationModelMonitorModelMonitoringJob(string projectId, string locationId, string modelMonitorId, string modelMonitoringJobId)

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.
`modelMonitorId`	`string` The `ModelMonitor` ID. Must not be `null` or empty.
`modelMonitoringJobId`	`string` The `ModelMonitoringJob` ID. Must not be `null` or empty.

Returns
Type	Description
`string`	The string representation of this ModelMonitoringJobName with pattern `projects/{project}/locations/{location}/modelMonitors/{model_monitor}/modelMonitoringJobs/{model_monitoring_job}` .

FromProjectLocationModelMonitorModelMonitoringJob(string, string, string, string)

public static ModelMonitoringJobName FromProjectLocationModelMonitorModelMonitoringJob(string projectId, string locationId, string modelMonitorId, string modelMonitoringJobId)

Creates a ModelMonitoringJobName with the pattern projects/{project}/locations/{location}/modelMonitors/{model_monitor}/modelMonitoringJobs/{model_monitoring_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.
`modelMonitorId`	`string` The `ModelMonitor` ID. Must not be `null` or empty.
`modelMonitoringJobId`	`string` The `ModelMonitoringJob` ID. Must not be `null` or empty.

Returns
Type	Description
`ModelMonitoringJobName`	A new instance of ModelMonitoringJobName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static ModelMonitoringJobName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a ModelMonitoringJobName containing an unparsed resource name.

Parameter
Name	Description
`unparsedResourceName`	`UnparsedResourceName` The unparsed resource name. Must not be `null`.

Returns
Type	Description
`ModelMonitoringJobName`	A new instance of ModelMonitoringJobName containing the provided `unparsedResourceName`.

GetHashCode()

public override int GetHashCode()

Returns a hash code for this resource name.

Returns
Type	Description
`int`

Overrides

object.GetHashCode()

Parse(string)

public static ModelMonitoringJobName Parse(string modelMonitoringJobName)

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

Parameter
Name	Description
`modelMonitoringJobName`	`string` The resource name in string form. Must not be `null`.

Returns
Type	Description
`ModelMonitoringJobName`	The parsed ModelMonitoringJobName if successful.

Remarks

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

projects/{project}/locations/{location}/modelMonitors/{model_monitor}/modelMonitoringJobs/{model_monitoring_job}

Parse(string, bool)

public static ModelMonitoringJobName Parse(string modelMonitoringJobName, bool allowUnparsed)

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

Parameters
Name	Description
`modelMonitoringJobName`	`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
`ModelMonitoringJobName`	The parsed ModelMonitoringJobName if successful.

Remarks

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

projects/{project}/locations/{location}/modelMonitors/{model_monitor}/modelMonitoringJobs/{model_monitoring_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

object.ToString()

TryParse(string, out ModelMonitoringJobName)

public static bool TryParse(string modelMonitoringJobName, out ModelMonitoringJobName result)

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

Parameters
Name	Description
`modelMonitoringJobName`	`string` The resource name in string form. Must not be `null`.
`result`	`ModelMonitoringJobName` When this method returns, the parsed ModelMonitoringJobName, 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}/modelMonitors/{model_monitor}/modelMonitoringJobs/{model_monitoring_job}

TryParse(string, bool, out ModelMonitoringJobName)

public static bool TryParse(string modelMonitoringJobName, bool allowUnparsed, out ModelMonitoringJobName result)

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

Parameters
Name	Description
`modelMonitoringJobName`	`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`	`ModelMonitoringJobName` When this method returns, the parsed ModelMonitoringJobName, 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}/modelMonitors/{model_monitor}/modelMonitoringJobs/{model_monitoring_job}

Or may be in any format if allowUnparsed is true.

Operators

operator ==(ModelMonitoringJobName, ModelMonitoringJobName)

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

Determines whether two specified resource names have the same value.

Parameters
Name	Description
`a`	`ModelMonitoringJobName` The first resource name to compare, or null.
`b`	`ModelMonitoringJobName` 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 !=(ModelMonitoringJobName, ModelMonitoringJobName)

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

Determines whether two specified resource names have different values.

Parameters
Name	Description
`a`	`ModelMonitoringJobName` The first resource name to compare, or null.
`b`	`ModelMonitoringJobName` 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.