Artifact Registry v1 API - Class NpmPackageName (2.4.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

Implements

IResourceName, IEquatable NpmPackageName

Inherited Members

object.GetType()

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
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.
`npmPackageId`	`string` 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
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`

NpmPackageId

public string NpmPackageId { get; }

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

The NpmPackageName.ResourceNameType of the contained resource name.

Property Value
Type	Description
`NpmPackageNameResourceNameType`

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

Formats the IDs into the string representation of this NpmPackageName with pattern projects/{project}/locations/{location}/repositories/{repository}/npmPackages/{npm_package}.

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.
`npmPackageId`	`string` The `NpmPackage` ID. Must not be `null` or empty.

Returns
Type	Description
`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
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.
`npmPackageId`	`string` The `NpmPackage` ID. Must not be `null` or empty.

Returns
Type	Description
`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
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.
`npmPackageId`	`string` The `NpmPackage` ID. Must not be `null` or empty.

Returns
Type	Description
`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
Name	Description
`unparsedResourceName`	`UnparsedResourceName` The unparsed resource name. Must not be `null`.

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

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

Parameter
Name	Description
`npmPackageName`	`string` The resource name in string form. Must not be `null`.

Returns
Type	Description
`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
Name	Description
`npmPackageName`	`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
`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
Type	Description
`string`	The string representation of the resource name.

Overrides

object.ToString()

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
Name	Description
`npmPackageName`	`string` The resource name in string form. Must not be `null`.
`result`	`NpmPackageName` When this method returns, the parsed NpmPackageName, 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}/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
Name	Description
`npmPackageName`	`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`	`NpmPackageName` When this method returns, the parsed NpmPackageName, 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}/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
Name	Description
`a`	`NpmPackageName`
`b`	`NpmPackageName`

Returns
Type	Description
`bool`

operator !=(NpmPackageName, NpmPackageName)

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

Parameters
Name	Description
`a`	`NpmPackageName`
`b`	`NpmPackageName`

Returns
Type	Description
`bool`