Artifact Registry v1 API - Class PythonPackageName (2.5.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

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
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.

pythonPackageIdstring

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

ProjectId

public string ProjectId { get; }

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

Property Value
TypeDescription
string

PythonPackageId

public string PythonPackageId { get; }

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

The PythonPackageName.ResourceNameType of the contained resource name.

Property Value
TypeDescription
PythonPackageNameResourceNameType

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

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

pythonPackageIdstring

The PythonPackage ID. Must not be null or empty.

Returns
TypeDescription
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
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.

pythonPackageIdstring

The PythonPackage ID. Must not be null or empty.

Returns
TypeDescription
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
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.

pythonPackageIdstring

The PythonPackage ID. Must not be null or empty.

Returns
TypeDescription
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
NameDescription
unparsedResourceNameUnparsedResourceName

The unparsed resource name. Must not be null.

Returns
TypeDescription
PythonPackageName

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

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

Parameter
NameDescription
pythonPackageNamestring

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

Returns
TypeDescription
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
NameDescription
pythonPackageNamestring

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

The string representation of the resource name.

Overrides

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
NameDescription
pythonPackageNamestring

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

resultPythonPackageName

When this method returns, the parsed PythonPackageName, 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}/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
NameDescription
pythonPackageNamestring

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.

resultPythonPackageName

When this method returns, the parsed PythonPackageName, 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}/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)

Determines whether two specified resource names have the same value.

Parameters
NameDescription
aPythonPackageName

The first resource name to compare, or null.

bPythonPackageName

The second resource name to compare, or null.

Returns
TypeDescription
bool

true if the value of a is the same as the value of b; otherwise, false.

operator !=(PythonPackageName, PythonPackageName)

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

Determines whether two specified resource names have different values.

Parameters
NameDescription
aPythonPackageName

The first resource name to compare, or null.

bPythonPackageName

The second resource name to compare, or null.

Returns
TypeDescription
bool

true if the value of a is different from the value of b; otherwise, false.