Artifact Registry v1 API - Class KfpArtifactName (2.10.0) 

public sealed class KfpArtifactName : IResourceName, IEquatable<KfpArtifactName>

Reference documentation and code samples for the Artifact Registry v1 API class KfpArtifactName.

Resource name for the KfpArtifact resource.

Inheritance

object > KfpArtifactName

Namespace

Google.Cloud.ArtifactRegistry.V1

Assembly

Google.Cloud.ArtifactRegistry.V1.dll

Constructors

KfpArtifactName(string, string, string, string)

public KfpArtifactName(string projectId, string locationId, string repositoryId, string kfpArtifactId)

Constructs a new instance of a KfpArtifactName class from the component parts of pattern projects/{project}/locations/{location}/repositories/{repository}/kfpArtifacts/{kfp_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.
repositoryId string

The Repository ID. Must not be null or empty.
kfpArtifactId string

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

KfpArtifactId

public string KfpArtifactId { get; }

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

Property Value
Type Description
string

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

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

RepositoryId

public string RepositoryId { get; }

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

Property Value
Type Description
string

Type

public KfpArtifactName.ResourceNameType Type { get; }

The KfpArtifactName.ResourceNameType of the contained resource name.

Property Value
Type Description
KfpArtifactNameResourceNameType

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 repositoryId, string kfpArtifactId)

Formats the IDs into the string representation of this KfpArtifactName with pattern projects/{project}/locations/{location}/repositories/{repository}/kfpArtifacts/{kfp_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.
repositoryId string

The Repository ID. Must not be null or empty.
kfpArtifactId string

The KfpArtifact ID. Must not be null or empty.
Returns
Type Description
string

The string representation of this KfpArtifactName with pattern projects/{project}/locations/{location}/repositories/{repository}/kfpArtifacts/{kfp_artifact}.

FormatProjectLocationRepositoryKfpArtifact(string, string, string, string)

public static string FormatProjectLocationRepositoryKfpArtifact(string projectId, string locationId, string repositoryId, string kfpArtifactId)

Formats the IDs into the string representation of this KfpArtifactName with pattern projects/{project}/locations/{location}/repositories/{repository}/kfpArtifacts/{kfp_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.
repositoryId string

The Repository ID. Must not be null or empty.
kfpArtifactId string

The KfpArtifact ID. Must not be null or empty.
Returns
Type Description
string

The string representation of this KfpArtifactName with pattern projects/{project}/locations/{location}/repositories/{repository}/kfpArtifacts/{kfp_artifact}.

FromProjectLocationRepositoryKfpArtifact(string, string, string, string)

public static KfpArtifactName FromProjectLocationRepositoryKfpArtifact(string projectId, string locationId, string repositoryId, string kfpArtifactId)

Creates a KfpArtifactName with the pattern projects/{project}/locations/{location}/repositories/{repository}/kfpArtifacts/{kfp_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.
repositoryId string

The Repository ID. Must not be null or empty.
kfpArtifactId string

The KfpArtifact ID. Must not be null or empty.
Returns
Type Description
KfpArtifactName

A new instance of KfpArtifactName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static KfpArtifactName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a KfpArtifactName containing an unparsed resource name.

Parameter
Name Description
unparsedResourceName UnparsedResourceName

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

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

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

Parameter
Name Description
kfpArtifactName string

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

The parsed KfpArtifactName if successful.
Remarks

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

  • projects/{project}/locations/{location}/repositories/{repository}/kfpArtifacts/{kfp_artifact}

Parse(string, bool)

public static KfpArtifactName Parse(string kfpArtifactName, bool allowUnparsed)

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

Parameters
Name Description
kfpArtifactName 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
KfpArtifactName

The parsed KfpArtifactName if successful.
Remarks

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

  • projects/{project}/locations/{location}/repositories/{repository}/kfpArtifacts/{kfp_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

TryParse(string, out KfpArtifactName)

public static bool TryParse(string kfpArtifactName, out KfpArtifactName result)

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

Parameters
Name Description
kfpArtifactName string

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

When this method returns, the parsed KfpArtifactName, 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}/repositories/{repository}/kfpArtifacts/{kfp_artifact}

TryParse(string, bool, out KfpArtifactName)

public static bool TryParse(string kfpArtifactName, bool allowUnparsed, out KfpArtifactName result)

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

Parameters
Name Description
kfpArtifactName 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 KfpArtifactName

When this method returns, the parsed KfpArtifactName, 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}/repositories/{repository}/kfpArtifacts/{kfp_artifact}
Or may be in any format if allowUnparsed is true.

Operators

operator ==(KfpArtifactName, KfpArtifactName)

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

Determines whether two specified resource names have the same value.

Parameters
Name Description
a KfpArtifactName

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

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

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

Determines whether two specified resource names have different values.

Parameters
Name Description
a KfpArtifactName

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

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.