Cloud AI Platform v1 API - Class VersionName (2.27.0)

public sealed class VersionName : IResourceName, IEquatable<VersionName>

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

Resource name for the Version resource.

Inheritance

object > VersionName

Implements

IResourceName, IEquatable VersionName

Inherited Members

object.GetType()

Namespace

Google.Cloud.AIPlatform.V1

Assembly

Google.Cloud.AIPlatform.V1.dll

Constructors

VersionName(string, string, string)

public VersionName(string projectId, string modelId, string versionId)

Constructs a new instance of a VersionName class from the component parts of pattern projects/{project}/models/{model}/versions/{version}

Parameters
Name	Description
`projectId`	`string` The `Project` ID. Must not be `null` or empty.
`modelId`	`string` The `Model` ID. Must not be `null` or empty.
`versionId`	`string` The `Version` 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`

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

The VersionName.ResourceNameType of the contained resource name.

Property Value
Type	Description
`VersionNameResourceNameType`

UnparsedResource

public UnparsedResourceName UnparsedResource { get; }

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

Property Value
Type	Description
`UnparsedResourceName`

VersionId

public string VersionId { get; }

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

Property Value
Type	Description
`string`

Methods

Format(string, string, string)

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

Formats the IDs into the string representation of this VersionName with pattern projects/{project}/models/{model}/versions/{version}.

Parameters
Name	Description
`projectId`	`string` The `Project` ID. Must not be `null` or empty.
`modelId`	`string` The `Model` ID. Must not be `null` or empty.
`versionId`	`string` The `Version` ID. Must not be `null` or empty.

Returns
Type	Description
`string`	The string representation of this VersionName with pattern `projects/{project}/models/{model}/versions/{version}`.

FormatProjectModelVersion(string, string, string)

public static string FormatProjectModelVersion(string projectId, string modelId, string versionId)

Formats the IDs into the string representation of this VersionName with pattern projects/{project}/models/{model}/versions/{version}.

Parameters
Name	Description
`projectId`	`string` The `Project` ID. Must not be `null` or empty.
`modelId`	`string` The `Model` ID. Must not be `null` or empty.
`versionId`	`string` The `Version` ID. Must not be `null` or empty.

Returns
Type	Description
`string`	The string representation of this VersionName with pattern `projects/{project}/models/{model}/versions/{version}`.

FromProjectModelVersion(string, string, string)

public static VersionName FromProjectModelVersion(string projectId, string modelId, string versionId)

Creates a VersionName with the pattern projects/{project}/models/{model}/versions/{version} .

Parameters
Name	Description
`projectId`	`string` The `Project` ID. Must not be `null` or empty.
`modelId`	`string` The `Model` ID. Must not be `null` or empty.
`versionId`	`string` The `Version` ID. Must not be `null` or empty.

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

FromUnparsed(UnparsedResourceName)

public static VersionName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a VersionName containing an unparsed resource name.

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

Returns
Type	Description
`VersionName`	A new instance of VersionName 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 VersionName Parse(string versionName)

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

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

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

Remarks

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

projects/{project}/models/{model}/versions/{version}

Parse(string, bool)

public static VersionName Parse(string versionName, bool allowUnparsed)

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

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

Remarks

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

projects/{project}/models/{model}/versions/{version}

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

public static bool TryParse(string versionName, out VersionName result)

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

Parameters
Name	Description
`versionName`	`string` The resource name in string form. Must not be `null`.
`result`	`VersionName` When this method returns, the parsed VersionName, 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}/models/{model}/versions/{version}

TryParse(string, bool, out VersionName)

public static bool TryParse(string versionName, bool allowUnparsed, out VersionName result)

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

Parameters
Name	Description
`versionName`	`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`	`VersionName` When this method returns, the parsed VersionName, 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}/models/{model}/versions/{version}

Or may be in any format if allowUnparsed is true.

Operators

operator ==(VersionName, VersionName)

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

Determines whether two specified resource names have the same value.

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

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

Determines whether two specified resource names have different values.

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