Artifact Registry v1 API - Class GenericArtifactName (2.10.0) 

public sealed class GenericArtifactName : IResourceName, IEquatable<GenericArtifactName>

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

Resource name for the GenericArtifact resource.

Inheritance

object > GenericArtifactName

Namespace

Google.Cloud.ArtifactRegistry.V1

Assembly

Google.Cloud.ArtifactRegistry.V1.dll

Constructors

GenericArtifactName(string, string, string, string)

public GenericArtifactName(string projectId, string locationId, string repositoryId, string genericArtifactId)

Constructs a new instance of a GenericArtifactName class from the component parts of pattern projects/{project}/locations/{location}/repositories/{repository}/genericArtifacts/{generic_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.
genericArtifactId string

The GenericArtifact ID. Must not be null or empty.

Properties

GenericArtifactId

public string GenericArtifactId { get; }

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

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

The GenericArtifactName.ResourceNameType of the contained resource name.

Property Value
Type Description
GenericArtifactNameResourceNameType

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

Formats the IDs into the string representation of this GenericArtifactName with pattern projects/{project}/locations/{location}/repositories/{repository}/genericArtifacts/{generic_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.
genericArtifactId string

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

The string representation of this GenericArtifactName with pattern projects/{project}/locations/{location}/repositories/{repository}/genericArtifacts/{generic_artifact} .

FormatProjectLocationRepositoryGenericArtifact(string, string, string, string)

public static string FormatProjectLocationRepositoryGenericArtifact(string projectId, string locationId, string repositoryId, string genericArtifactId)

Formats the IDs into the string representation of this GenericArtifactName with pattern projects/{project}/locations/{location}/repositories/{repository}/genericArtifacts/{generic_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.
genericArtifactId string

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

The string representation of this GenericArtifactName with pattern projects/{project}/locations/{location}/repositories/{repository}/genericArtifacts/{generic_artifact} .

FromProjectLocationRepositoryGenericArtifact(string, string, string, string)

public static GenericArtifactName FromProjectLocationRepositoryGenericArtifact(string projectId, string locationId, string repositoryId, string genericArtifactId)

Creates a GenericArtifactName with the pattern projects/{project}/locations/{location}/repositories/{repository}/genericArtifacts/{generic_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.
genericArtifactId string

The GenericArtifact ID. Must not be null or empty.
Returns
Type Description
GenericArtifactName

A new instance of GenericArtifactName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static GenericArtifactName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a GenericArtifactName containing an unparsed resource name.

Parameter
Name Description
unparsedResourceName UnparsedResourceName

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

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

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

Parameter
Name Description
genericArtifactName string

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

The parsed GenericArtifactName if successful.
Remarks

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

  • projects/{project}/locations/{location}/repositories/{repository}/genericArtifacts/{generic_artifact}

Parse(string, bool)

public static GenericArtifactName Parse(string genericArtifactName, bool allowUnparsed)

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

Parameters
Name Description
genericArtifactName 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
GenericArtifactName

The parsed GenericArtifactName if successful.
Remarks

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

  • projects/{project}/locations/{location}/repositories/{repository}/genericArtifacts/{generic_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 GenericArtifactName)

public static bool TryParse(string genericArtifactName, out GenericArtifactName result)

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

Parameters
Name Description
genericArtifactName string

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

When this method returns, the parsed GenericArtifactName, 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}/genericArtifacts/{generic_artifact}

TryParse(string, bool, out GenericArtifactName)

public static bool TryParse(string genericArtifactName, bool allowUnparsed, out GenericArtifactName result)

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

Parameters
Name Description
genericArtifactName 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 GenericArtifactName

When this method returns, the parsed GenericArtifactName, 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}/genericArtifacts/{generic_artifact}
Or may be in any format if allowUnparsed is true.

Operators

operator ==(GenericArtifactName, GenericArtifactName)

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

Determines whether two specified resource names have the same value.

Parameters
Name Description
a GenericArtifactName

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

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

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

Determines whether two specified resource names have different values.

Parameters
Name Description
a GenericArtifactName

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

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.