Artifact Registry v1 API - Class PackageName (2.4.0)

public sealed class PackageName : IResourceName, IEquatable<PackageName>

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

Resource name for the Package resource.

Inheritance

object > PackageName

Namespace

Google.Cloud.ArtifactRegistry.V1

Assembly

Google.Cloud.ArtifactRegistry.V1.dll

Constructors

PackageName(string, string, string, string)

public PackageName(string projectId, string locationId, string repositoryId, string packageId)

Constructs a new instance of a PackageName class from the component parts of pattern projects/{project}/locations/{location}/repositories/{repository}/packages/{package}

Parameters
NameDescription
projectIdstring

The Project ID. Must not be null or empty.

locationIdstring

The Location ID. Must not be null or empty.

repositoryIdstring

The Repository ID. Must not be null or empty.

packageIdstring

The Package 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
TypeDescription
bool

LocationId

public string LocationId { get; }

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

Property Value
TypeDescription
string

PackageId

public string PackageId { get; }

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

Property Value
TypeDescription
string

ProjectId

public string ProjectId { get; }

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

Property Value
TypeDescription
string

RepositoryId

public string RepositoryId { get; }

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

Property Value
TypeDescription
string

Type

public PackageName.ResourceNameType Type { get; }

The PackageName.ResourceNameType of the contained resource name.

Property Value
TypeDescription
PackageNameResourceNameType

UnparsedResource

public UnparsedResourceName UnparsedResource { get; }

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

Property Value
TypeDescription
UnparsedResourceName

Methods

Format(string, string, string, string)

public static string Format(string projectId, string locationId, string repositoryId, string packageId)

Formats the IDs into the string representation of this PackageName with pattern projects/{project}/locations/{location}/repositories/{repository}/packages/{package}.

Parameters
NameDescription
projectIdstring

The Project ID. Must not be null or empty.

locationIdstring

The Location ID. Must not be null or empty.

repositoryIdstring

The Repository ID. Must not be null or empty.

packageIdstring

The Package ID. Must not be null or empty.

Returns
TypeDescription
string

The string representation of this PackageName with pattern projects/{project}/locations/{location}/repositories/{repository}/packages/{package}.

FormatProjectLocationRepositoryPackage(string, string, string, string)

public static string FormatProjectLocationRepositoryPackage(string projectId, string locationId, string repositoryId, string packageId)

Formats the IDs into the string representation of this PackageName with pattern projects/{project}/locations/{location}/repositories/{repository}/packages/{package}.

Parameters
NameDescription
projectIdstring

The Project ID. Must not be null or empty.

locationIdstring

The Location ID. Must not be null or empty.

repositoryIdstring

The Repository ID. Must not be null or empty.

packageIdstring

The Package ID. Must not be null or empty.

Returns
TypeDescription
string

The string representation of this PackageName with pattern projects/{project}/locations/{location}/repositories/{repository}/packages/{package}.

FromProjectLocationRepositoryPackage(string, string, string, string)

public static PackageName FromProjectLocationRepositoryPackage(string projectId, string locationId, string repositoryId, string packageId)

Creates a PackageName with the pattern projects/{project}/locations/{location}/repositories/{repository}/packages/{package}.

Parameters
NameDescription
projectIdstring

The Project ID. Must not be null or empty.

locationIdstring

The Location ID. Must not be null or empty.

repositoryIdstring

The Repository ID. Must not be null or empty.

packageIdstring

The Package ID. Must not be null or empty.

Returns
TypeDescription
PackageName

A new instance of PackageName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static PackageName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a PackageName containing an unparsed resource name.

Parameter
NameDescription
unparsedResourceNameUnparsedResourceName

The unparsed resource name. Must not be null.

Returns
TypeDescription
PackageName

A new instance of PackageName containing the provided unparsedResourceName.

GetHashCode()

public override int GetHashCode()

Returns a hash code for this resource name.

Returns
TypeDescription
int
Overrides

Parse(string)

public static PackageName Parse(string packageName)

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

Parameter
NameDescription
packageNamestring

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

Returns
TypeDescription
PackageName

The parsed PackageName if successful.

Remarks

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

  • projects/{project}/locations/{location}/repositories/{repository}/packages/{package}

Parse(string, bool)

public static PackageName Parse(string packageName, bool allowUnparsed)

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

Parameters
NameDescription
packageNamestring

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

allowUnparsedbool

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

The parsed PackageName if successful.

Remarks

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

  • projects/{project}/locations/{location}/repositories/{repository}/packages/{package}
Or may be in any format if allowUnparsed is true.

ToString()

public override string ToString()

The string representation of the resource name.

Returns
TypeDescription
string

The string representation of the resource name.

Overrides

TryParse(string, out PackageName)

public static bool TryParse(string packageName, out PackageName result)

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

Parameters
NameDescription
packageNamestring

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

resultPackageName

When this method returns, the parsed PackageName, or null if parsing failed.

Returns
TypeDescription
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}/packages/{package}

TryParse(string, bool, out PackageName)

public static bool TryParse(string packageName, bool allowUnparsed, out PackageName result)

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

Parameters
NameDescription
packageNamestring

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

allowUnparsedbool

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.

resultPackageName

When this method returns, the parsed PackageName, or null if parsing failed.

Returns
TypeDescription
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}/packages/{package}
Or may be in any format if allowUnparsed is true.

Operators

operator ==(PackageName, PackageName)

public static bool operator ==(PackageName a, PackageName b)
Parameters
NameDescription
aPackageName
bPackageName
Returns
TypeDescription
bool

operator !=(PackageName, PackageName)

public static bool operator !=(PackageName a, PackageName b)
Parameters
NameDescription
aPackageName
bPackageName
Returns
TypeDescription
bool