Cloud AI Platform v1 API - Class AutoMLModelName (2.28.0) 

public sealed class AutoMLModelName : IResourceName, IEquatable<AutoMLModelName>

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

Resource name for the AutoMLModel resource.

Inheritance

object > AutoMLModelName

Namespace

Google.Cloud.AIPlatform.V1

Assembly

Google.Cloud.AIPlatform.V1.dll

Constructors

AutoMLModelName(string, string, string)

public AutoMLModelName(string projectId, string locationId, string modelId)

Constructs a new instance of a AutoMLModelName class from the component parts of pattern projects/{project}/locations/{location}/models/{model}

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

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

ModelId

public string ModelId { get; }

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

The AutoMLModelName.ResourceNameType of the contained resource name.

Property Value
Type Description
AutoMLModelNameResourceNameType

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

Formats the IDs into the string representation of this AutoMLModelName with pattern projects/{project}/locations/{location}/models/{model}.

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

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

The string representation of this AutoMLModelName with pattern projects/{project}/locations/{location}/models/{model}.

FormatProjectLocationModel(string, string, string)

public static string FormatProjectLocationModel(string projectId, string locationId, string modelId)

Formats the IDs into the string representation of this AutoMLModelName with pattern projects/{project}/locations/{location}/models/{model}.

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

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

The string representation of this AutoMLModelName with pattern projects/{project}/locations/{location}/models/{model}.

FromProjectLocationModel(string, string, string)

public static AutoMLModelName FromProjectLocationModel(string projectId, string locationId, string modelId)

Creates a AutoMLModelName with the pattern projects/{project}/locations/{location}/models/{model}.

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

The Model ID. Must not be null or empty.
Returns
Type Description
AutoMLModelName

A new instance of AutoMLModelName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static AutoMLModelName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a AutoMLModelName containing an unparsed resource name.

Parameter
Name Description
unparsedResourceName UnparsedResourceName

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

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

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

Parameter
Name Description
autoMLModelName string

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

The parsed AutoMLModelName if successful.
Remarks

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

  • projects/{project}/locations/{location}/models/{model}

Parse(string, bool)

public static AutoMLModelName Parse(string autoMLModelName, bool allowUnparsed)

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

Parameters
Name Description
autoMLModelName 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
AutoMLModelName

The parsed AutoMLModelName if successful.
Remarks

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

  • projects/{project}/locations/{location}/models/{model}
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 AutoMLModelName)

public static bool TryParse(string autoMLModelName, out AutoMLModelName result)

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

Parameters
Name Description
autoMLModelName string

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

When this method returns, the parsed AutoMLModelName, 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}/models/{model}

TryParse(string, bool, out AutoMLModelName)

public static bool TryParse(string autoMLModelName, bool allowUnparsed, out AutoMLModelName result)

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

Parameters
Name Description
autoMLModelName 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 AutoMLModelName

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

Operators

operator ==(AutoMLModelName, AutoMLModelName)

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

Determines whether two specified resource names have the same value.

Parameters
Name Description
a AutoMLModelName

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

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

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

Determines whether two specified resource names have different values.

Parameters
Name Description
a AutoMLModelName

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

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.