Cloud AI Platform v1 API - Class ArtifactName (2.8.0)

public sealed class ArtifactName : IResourceName, IEquatable<ArtifactName>

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

Resource name for the Artifact resource.

Inheritance

Object > ArtifactName

Implements

IResourceName, IEquatable<ArtifactName>

Inherited Members

Object.GetType()

Object.MemberwiseClone()

Namespace

Google.Cloud.AIPlatform.V1

Assembly

Google.Cloud.AIPlatform.V1.dll

Constructors

ArtifactName(String, String, String, String)

public ArtifactName(string projectId, string locationId, string metadataStoreId, string artifactId)

Constructs a new instance of a ArtifactName class from the component parts of pattern projects/{project}/locations/{location}/metadataStores/{metadata_store}/artifacts/{artifact}

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.
`metadataStoreId`	`String` The `MetadataStore` ID. Must not be `null` or empty.
`artifactId`	`String` The `Artifact` ID. Must not be `null` or empty.

Properties

ArtifactId

public string ArtifactId { get; }

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

Property Value
Type	Description
`String`

IsKnownPattern

public bool IsKnownPattern { get; }

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

Property Value
Type	Description
`Boolean`

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`

MetadataStoreId

public string MetadataStoreId { get; }

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

The ArtifactName.ResourceNameType of the contained resource name.

Property Value
Type	Description
`ArtifactName.ResourceNameType`

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, String)

public static string Format(string projectId, string locationId, string metadataStoreId, string artifactId)

Formats the IDs into the string representation of this ArtifactName with pattern projects/{project}/locations/{location}/metadataStores/{metadata_store}/artifacts/{artifact}.

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.
`metadataStoreId`	`String` The `MetadataStore` ID. Must not be `null` or empty.
`artifactId`	`String` The `Artifact` ID. Must not be `null` or empty.

Returns
Type	Description
`String`	The string representation of this ArtifactName with pattern `projects/{project}/locations/{location}/metadataStores/{metadata_store}/artifacts/{artifact}`.

FormatProjectLocationMetadataStoreArtifact(String, String, String, String)

public static string FormatProjectLocationMetadataStoreArtifact(string projectId, string locationId, string metadataStoreId, string artifactId)

Formats the IDs into the string representation of this ArtifactName with pattern projects/{project}/locations/{location}/metadataStores/{metadata_store}/artifacts/{artifact}.

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.
`metadataStoreId`	`String` The `MetadataStore` ID. Must not be `null` or empty.
`artifactId`	`String` The `Artifact` ID. Must not be `null` or empty.

Returns
Type	Description
`String`	The string representation of this ArtifactName with pattern `projects/{project}/locations/{location}/metadataStores/{metadata_store}/artifacts/{artifact}`.

FromProjectLocationMetadataStoreArtifact(String, String, String, String)

public static ArtifactName FromProjectLocationMetadataStoreArtifact(string projectId, string locationId, string metadataStoreId, string artifactId)

Creates a ArtifactName with the pattern projects/{project}/locations/{location}/metadataStores/{metadata_store}/artifacts/{artifact}.

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.
`metadataStoreId`	`String` The `MetadataStore` ID. Must not be `null` or empty.
`artifactId`	`String` The `Artifact` ID. Must not be `null` or empty.

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

FromUnparsed(UnparsedResourceName)

public static ArtifactName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a ArtifactName containing an unparsed resource name.

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

Returns
Type	Description
`ArtifactName`	A new instance of ArtifactName containing the provided `unparsedResourceName` .

GetHashCode()

public override int GetHashCode()

Returns a hash code for this resource name.

Returns
Type	Description
`Int32`

Overrides

Object.GetHashCode()

Parse(String)

public static ArtifactName Parse(string artifactName)

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

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

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

Remarks

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

projects/{project}/locations/{location}/metadataStores/{metadata_store}/artifacts/{artifact}

Parse(String, Boolean)

public static ArtifactName Parse(string artifactName, bool allowUnparsed)

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

Parameters
Name	Description
`artifactName`	`String` The resource name in string form. Must not be `null`.
`allowUnparsed`	`Boolean` 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
`ArtifactName`	The parsed ArtifactName if successful.

Remarks

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

projects/{project}/locations/{location}/metadataStores/{metadata_store}/artifacts/{artifact}

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

public static bool TryParse(string artifactName, out ArtifactName result)

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

Parameters
Name	Description
`artifactName`	`String` The resource name in string form. Must not be `null`.
`result`	`ArtifactName` When this method returns, the parsed ArtifactName, or `null` if parsing failed.

Returns
Type	Description
`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}/metadataStores/{metadata_store}/artifacts/{artifact}

TryParse(String, Boolean, out ArtifactName)

public static bool TryParse(string artifactName, bool allowUnparsed, out ArtifactName result)

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

Parameters
Name	Description
`artifactName`	`String` The resource name in string form. Must not be `null`.
`allowUnparsed`	`Boolean` 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`	`ArtifactName` When this method returns, the parsed ArtifactName, or `null` if parsing failed.

Returns
Type	Description
`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}/metadataStores/{metadata_store}/artifacts/{artifact}

Or may be in any format if allowUnparsed is true.

Operators

Equality(ArtifactName, ArtifactName)

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

Parameters
Name	Description
`a`	`ArtifactName`
`b`	`ArtifactName`

Returns
Type	Description
`Boolean`

Inequality(ArtifactName, ArtifactName)

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

Parameters
Name	Description
`a`	`ArtifactName`
`b`	`ArtifactName`

Returns
Type	Description
`Boolean`