Class ModelName

Resource name for the Model resource.

Inheritance

System.Object

ModelName

Implements

IResourceName

System.IEquatable<ModelName>

Inherited Members

System.Object.GetType()

System.Object.MemberwiseClone()

Namespace: Google.Cloud.AutoML.V1

Assembly: Google.Cloud.AutoML.V1.dll

Syntax

public sealed class ModelName : IResourceName, IEquatable<ModelName>

Constructors

ModelName(String, String, String)

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

Declaration

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

Parameters

Type	Name	Description
System.String	projectId	The Project ID. Must not be null or empty.
System.String	locationId	The Location ID. Must not be null or empty.
System.String	modelId	The Model ID. Must not be null or empty.

Properties

IsKnownPattern

Whether this instance contains a resource name with a known pattern.

Declaration

public bool IsKnownPattern { get; }

Property Value

Type	Description
System.Boolean

Implements

IResourceName.IsKnownPattern

LocationId

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

Declaration

public string LocationId { get; }

Property Value

Type	Description
System.String

ModelId

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

Declaration

public string ModelId { get; }

Property Value

Type	Description
System.String

ProjectId

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

Declaration

public string ProjectId { get; }

Property Value

Type	Description
System.String

Type

The ModelName.ResourceNameType of the contained resource name.

Declaration

public ModelName.ResourceNameType Type { get; }

Property Value

Type	Description
ModelName.ResourceNameType

UnparsedResource

The contained UnparsedResourceName. Only non-null if this instance contains an unparsed resource name.

Declaration

public UnparsedResourceName UnparsedResource { get; }

Property Value

Type	Description
UnparsedResourceName

Methods

Format(String, String, String)

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

Declaration

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

Parameters

Type	Name	Description
System.String	projectId	The Project ID. Must not be null or empty.
System.String	locationId	The Location ID. Must not be null or empty.
System.String	modelId	The Model ID. Must not be null or empty.

Returns

Type	Description
System.String	The string representation of this ModelName with pattern projects/{project}/locations/{location}/models/{model}.

FormatProjectLocationModel(String, String, String)

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

Declaration

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

Parameters

Type	Name	Description
System.String	projectId	The Project ID. Must not be null or empty.
System.String	locationId	The Location ID. Must not be null or empty.
System.String	modelId	The Model ID. Must not be null or empty.

Returns

Type	Description
System.String	The string representation of this ModelName with pattern projects/{project}/locations/{location}/models/{model}.

FromProjectLocationModel(String, String, String)

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

Declaration

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

Parameters

Type	Name	Description
System.String	projectId	The Project ID. Must not be null or empty.
System.String	locationId	The Location ID. Must not be null or empty.
System.String	modelId	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)

Creates a ModelName containing an unparsed resource name.

Declaration

public static ModelName FromUnparsed(UnparsedResourceName unparsedResourceName)

Parameters

Type	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()

Returns a hash code for this resource name.

Declaration

public override int GetHashCode()

Returns

Type	Description
System.Int32

Overrides

System.Object.GetHashCode()

Parse(String)

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

Declaration

public static ModelName Parse(string modelName)

Parameters

Type	Name	Description
System.String	modelName	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, Boolean)

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

Declaration

public static ModelName Parse(string modelName, bool allowUnparsed)

Parameters

Type	Name	Description
System.String	modelName	The resource name in string form. Must not be null.
System.Boolean	allowUnparsed	If true will successfully store an unparseable resource name into the UnparsedResource property; otherwise will throw an System.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()

The string representation of the resource name.

Declaration

public override string ToString()

Returns

Type	Description
System.String	The string representation of the resource name.

Overrides

System.Object.ToString()

Implements

IResourceName.ToString()

TryParse(String, out ModelName)

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

Declaration

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

Parameters

Type	Name	Description
System.String	modelName	The resource name in string form. Must not be null.
ModelName	result	When this method returns, the parsed ModelName, or null if parsing failed.

Returns

Type	Description
System.Boolean	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, Boolean, out ModelName)

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

Declaration

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

Parameters

Type	Name	Description
System.String	modelName	The resource name in string form. Must not be null.
System.Boolean	allowUnparsed	If true will successfully store an unparseable resource name into the UnparsedResource property; otherwise will throw an System.ArgumentException if an unparseable resource name is specified.
ModelName	result	When this method returns, the parsed ModelName, or null if parsing failed.

Returns

Type	Description
System.Boolean	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

Equality(ModelName, ModelName)

Declaration

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

Parameters

Type	Name	Description
ModelName	a
ModelName	b

Returns

Type	Description
System.Boolean

Inequality(ModelName, ModelName)

Declaration

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

Parameters

Type	Name	Description
ModelName	a
ModelName	b

Returns

Type	Description
System.Boolean