Cloud AI Platform v1 API - Class ArtifactName (2.26.0)

Version 2.26.0

• 3.13.0 (latest)
• 3.12.0
• 3.11.0
• 3.10.0
• 3.9.0
• 3.8.0
• 3.7.0
• 3.6.0
• 3.5.0
• 3.4.0
• 3.3.0
• 3.2.0
• 3.1.0
• 3.0.0
• 2.28.0
• 2.27.0
• 2.26.0
• 2.25.0
• 2.24.0
• 2.23.0
• 2.22.0
• 2.21.0
• 2.20.0
• 2.19.0
• 2.18.0
• 2.17.0
• 2.16.0
• 2.15.0
• 2.14.0
• 2.13.0
• 2.12.0
• 2.11.0
• 2.10.0
• 2.9.0
• 2.8.0
• 2.7.0
• 2.6.0
• 2.5.0
• 2.4.0
• 2.3.0
• 2.2.0
• 2.1.0
• 2.0.0
• 1.8.0
• 1.7.0
• 1.6.0
• 1.5.0
• 1.4.0
• 1.3.0
• 1.2.0
• 1.1.0
• 1.0.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, IEquatableArtifactName

Inherited Members

object.GetType()

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

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
ArtifactNameResourceNameType

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
int

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

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	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
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
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}/metadataStores/{metadata_store}/artifacts/{artifact}

TryParse(string, bool, 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	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	ArtifactName When this method returns, the parsed ArtifactName, 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}/metadataStores/{metadata_store}/artifacts/{artifact}

Or may be in any format if allowUnparsed is true.

Operators

operator ==(ArtifactName, ArtifactName)

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

Determines whether two specified resource names have the same value.

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

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

Determines whether two specified resource names have different values.

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