Artifact Registry v1 API - Class MavenArtifactName (2.3.0)

public sealed class MavenArtifactName : IResourceName, IEquatable<MavenArtifactName>

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

Resource name for the MavenArtifact resource.

Inheritance

object > MavenArtifactName

Namespace

Google.Cloud.ArtifactRegistry.V1

Assembly

Google.Cloud.ArtifactRegistry.V1.dll

Constructors

MavenArtifactName(string, string, string, string)

public MavenArtifactName(string projectId, string locationId, string repositoryId, string mavenArtifactId)

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

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.

mavenArtifactIdstring

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

MavenArtifactId

public string MavenArtifactId { get; }

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

The MavenArtifactName.ResourceNameType of the contained resource name.

Property Value
TypeDescription
MavenArtifactNameResourceNameType

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

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

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.

mavenArtifactIdstring

The MavenArtifact ID. Must not be null or empty.

Returns
TypeDescription
string

The string representation of this MavenArtifactName with pattern projects/{project}/locations/{location}/repositories/{repository}/mavenArtifacts/{maven_artifact}.

FormatProjectLocationRepositoryMavenArtifact(string, string, string, string)

public static string FormatProjectLocationRepositoryMavenArtifact(string projectId, string locationId, string repositoryId, string mavenArtifactId)

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

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.

mavenArtifactIdstring

The MavenArtifact ID. Must not be null or empty.

Returns
TypeDescription
string

The string representation of this MavenArtifactName with pattern projects/{project}/locations/{location}/repositories/{repository}/mavenArtifacts/{maven_artifact}.

FromProjectLocationRepositoryMavenArtifact(string, string, string, string)

public static MavenArtifactName FromProjectLocationRepositoryMavenArtifact(string projectId, string locationId, string repositoryId, string mavenArtifactId)

Creates a MavenArtifactName with the pattern projects/{project}/locations/{location}/repositories/{repository}/mavenArtifacts/{maven_artifact}.

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.

mavenArtifactIdstring

The MavenArtifact ID. Must not be null or empty.

Returns
TypeDescription
MavenArtifactName

A new instance of MavenArtifactName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static MavenArtifactName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a MavenArtifactName containing an unparsed resource name.

Parameter
NameDescription
unparsedResourceNameUnparsedResourceName

The unparsed resource name. Must not be null.

Returns
TypeDescription
MavenArtifactName

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

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

Parameter
NameDescription
mavenArtifactNamestring

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

Returns
TypeDescription
MavenArtifactName

The parsed MavenArtifactName if successful.

Remarks

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

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

Parse(string, bool)

public static MavenArtifactName Parse(string mavenArtifactName, bool allowUnparsed)

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

Parameters
NameDescription
mavenArtifactNamestring

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
MavenArtifactName

The parsed MavenArtifactName if successful.

Remarks

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

  • projects/{project}/locations/{location}/repositories/{repository}/mavenArtifacts/{maven_artifact}
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 MavenArtifactName)

public static bool TryParse(string mavenArtifactName, out MavenArtifactName result)

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

Parameters
NameDescription
mavenArtifactNamestring

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

resultMavenArtifactName

When this method returns, the parsed MavenArtifactName, 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}/mavenArtifacts/{maven_artifact}

TryParse(string, bool, out MavenArtifactName)

public static bool TryParse(string mavenArtifactName, bool allowUnparsed, out MavenArtifactName result)

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

Parameters
NameDescription
mavenArtifactNamestring

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.

resultMavenArtifactName

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

Operators

operator ==(MavenArtifactName, MavenArtifactName)

public static bool operator ==(MavenArtifactName a, MavenArtifactName b)
Parameters
NameDescription
aMavenArtifactName
bMavenArtifactName
Returns
TypeDescription
bool

operator !=(MavenArtifactName, MavenArtifactName)

public static bool operator !=(MavenArtifactName a, MavenArtifactName b)
Parameters
NameDescription
aMavenArtifactName
bMavenArtifactName
Returns
TypeDescription
bool