Artifact Registry v1 API - Class RepositoryName (2.2.0)

Version 2.2.0

• 2.9.0 (latest)
• 2.8.0
• 2.7.0
• 2.6.0
• 2.5.0
• 2.4.0
• 2.3.0
• 2.2.0
• 2.1.0
• 2.0.0
• 1.1.0
• 1.0.0

public sealed class RepositoryName : IResourceName, IEquatable<RepositoryName>

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

Resource name for the Repository resource.

Inheritance

object > RepositoryName

Implements

IResourceName, IEquatableRepositoryName

Inherited Members

object.GetType()

object.MemberwiseClone()

Namespace

GoogleCloudGoogle.Cloud.ArtifactRegistryV1

Assembly

Google.Cloud.ArtifactRegistry.V1.dll

Constructors

RepositoryName(string, string, string)

public RepositoryName(string projectId, string locationId, string repositoryId)

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

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.

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

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 RepositoryName.ResourceNameType Type { get; }

The RepositoryName.ResourceNameType of the contained resource name.

Property Value
Type	Description
RepositoryNameResourceNameType

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)

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

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

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.

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

FormatProjectLocationRepository(string, string, string)

public static string FormatProjectLocationRepository(string projectId, string locationId, string repositoryId)

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

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.

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

FromProjectLocationRepository(string, string, string)

public static RepositoryName FromProjectLocationRepository(string projectId, string locationId, string repositoryId)

Creates a RepositoryName with the pattern projects/{project}/locations/{location}/repositories/{repository}.

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.

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

FromUnparsed(UnparsedResourceName)

public static RepositoryName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a RepositoryName containing an unparsed resource name.

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

Returns
Type	Description
RepositoryName	A new instance of RepositoryName 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 RepositoryName Parse(string repositoryName)

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

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

Returns
Type	Description
RepositoryName	The parsed RepositoryName if successful.

Remarks

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

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

Parse(string, bool)

public static RepositoryName Parse(string repositoryName, bool allowUnparsed)

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

Parameters
Name	Description
repositoryName	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
RepositoryName	The parsed RepositoryName if successful.

Remarks

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

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

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

public static bool TryParse(string repositoryName, out RepositoryName result)

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

Parameters
Name	Description
repositoryName	string The resource name in string form. Must not be null.
result	RepositoryName When this method returns, the parsed RepositoryName, 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}

TryParse(string, bool, out RepositoryName)

public static bool TryParse(string repositoryName, bool allowUnparsed, out RepositoryName result)

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

Parameters
Name	Description
repositoryName	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	RepositoryName When this method returns, the parsed RepositoryName, 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}

Or may be in any format if allowUnparsed is true.

Operators

operator ==(RepositoryName, RepositoryName)

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

Parameters
Name	Description
a	RepositoryName
b	RepositoryName

Returns
Type	Description
bool

operator !=(RepositoryName, RepositoryName)

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

Parameters
Name	Description
a	RepositoryName
b	RepositoryName

Returns
Type	Description
bool