Artifact Registry v1 API - Class PythonPackageName (2.4.0)

public sealed class PythonPackageName : IResourceName, IEquatable<PythonPackageName>

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

Resource name for the PythonPackage resource.

Inheritance

object > PythonPackageName

Implements

IResourceName, IEquatable PythonPackageName

Inherited Members

object.GetType()

Namespace

Google.Cloud.ArtifactRegistry.V1

Assembly

Google.Cloud.ArtifactRegistry.V1.dll

Constructors

PythonPackageName(string, string, string, string)

public PythonPackageName(string projectId, string locationId, string repositoryId, string pythonPackageId)

Constructs a new instance of a PythonPackageName class from the component parts of pattern projects/{project}/locations/{location}/repositories/{repository}/pythonPackages/{python_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.
`pythonPackageId`	`string` The `PythonPackage` 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`

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`

PythonPackageId

public string PythonPackageId { get; }

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

The PythonPackageName.ResourceNameType of the contained resource name.

Property Value
Type	Description
`PythonPackageNameResourceNameType`

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

Formats the IDs into the string representation of this PythonPackageName with pattern projects/{project}/locations/{location}/repositories/{repository}/pythonPackages/{python_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.
`pythonPackageId`	`string` The `PythonPackage` ID. Must not be `null` or empty.

Returns
Type	Description
`string`	The string representation of this PythonPackageName with pattern `projects/{project}/locations/{location}/repositories/{repository}/pythonPackages/{python_package}`.

FormatProjectLocationRepositoryPythonPackage(string, string, string, string)

public static string FormatProjectLocationRepositoryPythonPackage(string projectId, string locationId, string repositoryId, string pythonPackageId)

Formats the IDs into the string representation of this PythonPackageName with pattern projects/{project}/locations/{location}/repositories/{repository}/pythonPackages/{python_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.
`pythonPackageId`	`string` The `PythonPackage` ID. Must not be `null` or empty.

Returns
Type	Description
`string`	The string representation of this PythonPackageName with pattern `projects/{project}/locations/{location}/repositories/{repository}/pythonPackages/{python_package}`.

FromProjectLocationRepositoryPythonPackage(string, string, string, string)

public static PythonPackageName FromProjectLocationRepositoryPythonPackage(string projectId, string locationId, string repositoryId, string pythonPackageId)

Creates a PythonPackageName with the pattern projects/{project}/locations/{location}/repositories/{repository}/pythonPackages/{python_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.
`pythonPackageId`	`string` The `PythonPackage` ID. Must not be `null` or empty.

Returns
Type	Description
`PythonPackageName`	A new instance of PythonPackageName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static PythonPackageName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a PythonPackageName containing an unparsed resource name.

Parameter
Name	Description
`unparsedResourceName`	`UnparsedResourceName` The unparsed resource name. Must not be `null`.

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

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

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

Returns
Type	Description
`PythonPackageName`	The parsed PythonPackageName if successful.

Remarks

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

projects/{project}/locations/{location}/repositories/{repository}/pythonPackages/{python_package}

Parse(string, bool)

public static PythonPackageName Parse(string pythonPackageName, bool allowUnparsed)

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

Parameters
Name	Description
`pythonPackageName`	`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
`PythonPackageName`	The parsed PythonPackageName if successful.

Remarks

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

projects/{project}/locations/{location}/repositories/{repository}/pythonPackages/{python_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 PythonPackageName)

public static bool TryParse(string pythonPackageName, out PythonPackageName result)

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

Parameters
Name	Description
`pythonPackageName`	`string` The resource name in string form. Must not be `null`.
`result`	`PythonPackageName` When this method returns, the parsed PythonPackageName, 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}/pythonPackages/{python_package}

TryParse(string, bool, out PythonPackageName)

public static bool TryParse(string pythonPackageName, bool allowUnparsed, out PythonPackageName result)

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

Parameters
Name	Description
`pythonPackageName`	`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`	`PythonPackageName` When this method returns, the parsed PythonPackageName, 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}/pythonPackages/{python_package}

Or may be in any format if allowUnparsed is true.

Operators

operator ==(PythonPackageName, PythonPackageName)

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

Parameters
Name	Description
`a`	`PythonPackageName`
`b`	`PythonPackageName`

Returns
Type	Description
`bool`

operator !=(PythonPackageName, PythonPackageName)

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

Parameters
Name	Description
`a`	`PythonPackageName`
`b`	`PythonPackageName`

Returns
Type	Description
`bool`