Artifact Registry v1 API - Class NpmPackageName (2.3.0)

public sealed class NpmPackageName : IResourceName, IEquatable<NpmPackageName>

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

Resource name for the NpmPackage resource.

Inheritance

object > NpmPackageName

Namespace

Google.Cloud.ArtifactRegistry.V1

Assembly

Google.Cloud.ArtifactRegistry.V1.dll

Constructors

NpmPackageName(string, string, string, string)

public NpmPackageName(string projectId, string locationId, string repositoryId, string npmPackageId)

Constructs a new instance of a NpmPackageName class from the component parts of pattern projects/{project}/locations/{location}/repositories/{repository}/npmPackages/{npm_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.

npmPackageIdstring

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

NpmPackageId

public string NpmPackageId { get; }

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

The NpmPackageName.ResourceNameType of the contained resource name.

Property Value
TypeDescription
NpmPackageNameResourceNameType

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

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

npmPackageIdstring

The NpmPackage ID. Must not be null or empty.

Returns
TypeDescription
string

The string representation of this NpmPackageName with pattern projects/{project}/locations/{location}/repositories/{repository}/npmPackages/{npm_package}.

FormatProjectLocationRepositoryNpmPackage(string, string, string, string)

public static string FormatProjectLocationRepositoryNpmPackage(string projectId, string locationId, string repositoryId, string npmPackageId)

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

npmPackageIdstring

The NpmPackage ID. Must not be null or empty.

Returns
TypeDescription
string

The string representation of this NpmPackageName with pattern projects/{project}/locations/{location}/repositories/{repository}/npmPackages/{npm_package}.

FromProjectLocationRepositoryNpmPackage(string, string, string, string)

public static NpmPackageName FromProjectLocationRepositoryNpmPackage(string projectId, string locationId, string repositoryId, string npmPackageId)

Creates a NpmPackageName with the pattern projects/{project}/locations/{location}/repositories/{repository}/npmPackages/{npm_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.

npmPackageIdstring

The NpmPackage ID. Must not be null or empty.

Returns
TypeDescription
NpmPackageName

A new instance of NpmPackageName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static NpmPackageName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a NpmPackageName containing an unparsed resource name.

Parameter
NameDescription
unparsedResourceNameUnparsedResourceName

The unparsed resource name. Must not be null.

Returns
TypeDescription
NpmPackageName

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

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

Parameter
NameDescription
npmPackageNamestring

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

Returns
TypeDescription
NpmPackageName

The parsed NpmPackageName if successful.

Remarks

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

  • projects/{project}/locations/{location}/repositories/{repository}/npmPackages/{npm_package}

Parse(string, bool)

public static NpmPackageName Parse(string npmPackageName, bool allowUnparsed)

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

Parameters
NameDescription
npmPackageNamestring

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
NpmPackageName

The parsed NpmPackageName if successful.

Remarks

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

  • projects/{project}/locations/{location}/repositories/{repository}/npmPackages/{npm_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 NpmPackageName)

public static bool TryParse(string npmPackageName, out NpmPackageName result)

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

Parameters
NameDescription
npmPackageNamestring

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

resultNpmPackageName

When this method returns, the parsed NpmPackageName, 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}/npmPackages/{npm_package}

TryParse(string, bool, out NpmPackageName)

public static bool TryParse(string npmPackageName, bool allowUnparsed, out NpmPackageName result)

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

Parameters
NameDescription
npmPackageNamestring

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.

resultNpmPackageName

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

Operators

operator ==(NpmPackageName, NpmPackageName)

public static bool operator ==(NpmPackageName a, NpmPackageName b)
Parameters
NameDescription
aNpmPackageName
bNpmPackageName
Returns
TypeDescription
bool

operator !=(NpmPackageName, NpmPackageName)

public static bool operator !=(NpmPackageName a, NpmPackageName b)
Parameters
NameDescription
aNpmPackageName
bNpmPackageName
Returns
TypeDescription
bool