Vertex AI v1beta1 API - Class ModelMonitorName (1.0.0-beta61) 

public sealed class ModelMonitorName : IResourceName, IEquatable<ModelMonitorName>

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

Resource name for the ModelMonitor resource.

Inheritance

object > ModelMonitorName

Namespace

Google.Cloud.AIPlatform.V1Beta1

Assembly

Google.Cloud.AIPlatform.V1Beta1.dll

Constructors

ModelMonitorName(string, string, string)

public ModelMonitorName(string projectId, string locationId, string modelMonitorId)

Constructs a new instance of a ModelMonitorName class from the component parts of pattern projects/{project}/locations/{location}/modelMonitors/{model_monitor}

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.

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

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 ModelMonitorName.ResourceNameType Type { get; }

The ModelMonitorName.ResourceNameType of the contained resource name.

Property Value
Type Description
ModelMonitorNameResourceNameType

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

Formats the IDs into the string representation of this ModelMonitorName with pattern projects/{project}/locations/{location}/modelMonitors/{model_monitor}.

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

The string representation of this ModelMonitorName with pattern projects/{project}/locations/{location}/modelMonitors/{model_monitor}.

FormatProjectLocationModelMonitor(string, string, string)

public static string FormatProjectLocationModelMonitor(string projectId, string locationId, string modelMonitorId)

Formats the IDs into the string representation of this ModelMonitorName with pattern projects/{project}/locations/{location}/modelMonitors/{model_monitor}.

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

The string representation of this ModelMonitorName with pattern projects/{project}/locations/{location}/modelMonitors/{model_monitor}.

FromProjectLocationModelMonitor(string, string, string)

public static ModelMonitorName FromProjectLocationModelMonitor(string projectId, string locationId, string modelMonitorId)

Creates a ModelMonitorName with the pattern projects/{project}/locations/{location}/modelMonitors/{model_monitor}.

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

A new instance of ModelMonitorName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static ModelMonitorName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a ModelMonitorName containing an unparsed resource name.

Parameter
Name Description
unparsedResourceName UnparsedResourceName

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

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

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

Parameter
Name Description
modelMonitorName string

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

The parsed ModelMonitorName if successful.
Remarks

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

  • projects/{project}/locations/{location}/modelMonitors/{model_monitor}

Parse(string, bool)

public static ModelMonitorName Parse(string modelMonitorName, bool allowUnparsed)

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

Parameters
Name Description
modelMonitorName 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
ModelMonitorName

The parsed ModelMonitorName if successful.
Remarks

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

  • projects/{project}/locations/{location}/modelMonitors/{model_monitor}
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 ModelMonitorName)

public static bool TryParse(string modelMonitorName, out ModelMonitorName result)

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

Parameters
Name Description
modelMonitorName string

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

When this method returns, the parsed ModelMonitorName, 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}

TryParse(string, bool, out ModelMonitorName)

public static bool TryParse(string modelMonitorName, bool allowUnparsed, out ModelMonitorName result)

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

Parameters
Name Description
modelMonitorName 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 ModelMonitorName

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

Operators

operator ==(ModelMonitorName, ModelMonitorName)

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

Determines whether two specified resource names have the same value.

Parameters
Name Description
a ModelMonitorName

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

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

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

Determines whether two specified resource names have different values.

Parameters
Name Description
a ModelMonitorName

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

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.