Cloud AI Platform v1beta1 API - Class ModelName (1.0.0-beta09) 

public sealed class ModelName : IResourceName, IEquatable<ModelName>

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

Resource name for the Model resource.

Inheritance

object > ModelName

Namespace

Google.Cloud.AIPlatform.V1Beta1

Assembly

Google.Cloud.AIPlatform.V1Beta1.dll

Constructors

ModelName(string, string, string)

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

Constructs a new instance of a ModelName 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 ModelName.ResourceNameType Type { get; }

The ModelName.ResourceNameType of the contained resource name.

Property Value
Type Description
ModelNameResourceNameType

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 ModelName 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 ModelName 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 ModelName 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 ModelName with pattern projects/{project}/locations/{location}/models/{model}.

FromProjectLocationModel(string, string, string)

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

Creates a ModelName 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
ModelName

A new instance of ModelName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static ModelName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a ModelName containing an unparsed resource name.

Parameter
Name Description
unparsedResourceName UnparsedResourceName

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

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

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

Parameter
Name Description
modelName string

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

The parsed ModelName 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 ModelName Parse(string modelName, bool allowUnparsed)

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

Parameters
Name Description
modelName 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
ModelName

The parsed ModelName 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 ModelName)

public static bool TryParse(string modelName, out ModelName result)

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

Parameters
Name Description
modelName string

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

When this method returns, the parsed ModelName, 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 ModelName)

public static bool TryParse(string modelName, bool allowUnparsed, out ModelName result)

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

Parameters
Name Description
modelName 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 ModelName

When this method returns, the parsed ModelName, 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 ==(ModelName, ModelName)

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

Determines whether two specified resource names have the same value.

Parameters
Name Description
a ModelName

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

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

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

Determines whether two specified resource names have different values.

Parameters
Name Description
a ModelName

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

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.