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

Namespace

Google.Cloud.ArtifactRegistry.V1

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

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

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

The RepositoryName.ResourceNameType of the contained resource name.

Property Value
TypeDescription
RepositoryNameResourceNameType

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)

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

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

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

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

The unparsed resource name. Must not be null.

Returns
TypeDescription
RepositoryName

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

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

Parameter
NameDescription
repositoryNamestring

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

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

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

The string representation of the resource name.

Overrides

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

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

resultRepositoryName

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

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

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.

resultRepositoryName

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

Operators

operator ==(RepositoryName, RepositoryName)

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

Determines whether two specified resource names have the same value.

Parameters
NameDescription
aRepositoryName

The first resource name to compare, or null.

bRepositoryName

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 !=(RepositoryName, RepositoryName)

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

Determines whether two specified resource names have different values.

Parameters
NameDescription
aRepositoryName

The first resource name to compare, or null.

bRepositoryName

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.