Class AptArtifactName (2.0.0)

Stay organized with collections Save and categorize content based on your preferences.
public sealed class AptArtifactName : IResourceName, IEquatable<AptArtifactName>

Resource name for the AptArtifact resource.

Inheritance

Object > AptArtifactName

Namespace

Google.Cloud.ArtifactRegistry.V1

Assembly

Google.Cloud.ArtifactRegistry.V1.dll

Constructors

AptArtifactName(String, String, String, String)

public AptArtifactName(string projectId, string locationId, string repositoryId, string aptArtifactId)

Constructs a new instance of a AptArtifactName class from the component parts of pattern projects/{project}/locations/{location}/repositories/{repository}/aptArtifacts/{apt_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.

aptArtifactIdString

The AptArtifact ID. Must not be null or empty.

Properties

AptArtifactId

public string AptArtifactId { get; }

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

Property Value
TypeDescription
String

IsKnownPattern

public bool IsKnownPattern { get; }

Whether this instance contains a resource name with a known pattern.

Property Value
TypeDescription
Boolean

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

The AptArtifactName.ResourceNameType of the contained resource name.

Property Value
TypeDescription
AptArtifactName.ResourceNameType

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

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

aptArtifactIdString

The AptArtifact ID. Must not be null or empty.

Returns
TypeDescription
String

The string representation of this AptArtifactName with pattern projects/{project}/locations/{location}/repositories/{repository}/aptArtifacts/{apt_artifact}.

FormatProjectLocationRepositoryAptArtifact(String, String, String, String)

public static string FormatProjectLocationRepositoryAptArtifact(string projectId, string locationId, string repositoryId, string aptArtifactId)

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

aptArtifactIdString

The AptArtifact ID. Must not be null or empty.

Returns
TypeDescription
String

The string representation of this AptArtifactName with pattern projects/{project}/locations/{location}/repositories/{repository}/aptArtifacts/{apt_artifact}.

FromProjectLocationRepositoryAptArtifact(String, String, String, String)

public static AptArtifactName FromProjectLocationRepositoryAptArtifact(string projectId, string locationId, string repositoryId, string aptArtifactId)

Creates a AptArtifactName with the pattern projects/{project}/locations/{location}/repositories/{repository}/aptArtifacts/{apt_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.

aptArtifactIdString

The AptArtifact ID. Must not be null or empty.

Returns
TypeDescription
AptArtifactName

A new instance of AptArtifactName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static AptArtifactName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a AptArtifactName containing an unparsed resource name.

Parameter
NameDescription
unparsedResourceNameUnparsedResourceName

The unparsed resource name. Must not be null.

Returns
TypeDescription
AptArtifactName

A new instance of AptArtifactName containing the provided unparsedResourceName.

GetHashCode()

public override int GetHashCode()

Returns a hash code for this resource name.

Returns
TypeDescription
Int32
Overrides

Parse(String)

public static AptArtifactName Parse(string aptArtifactName)

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

Parameter
NameDescription
aptArtifactNameString

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

Returns
TypeDescription
AptArtifactName

The parsed AptArtifactName if successful.

Remarks

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

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

Parse(String, Boolean)

public static AptArtifactName Parse(string aptArtifactName, bool allowUnparsed)

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

Parameters
NameDescription
aptArtifactNameString

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

allowUnparsedBoolean

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
AptArtifactName

The parsed AptArtifactName if successful.

Remarks

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

  • projects/{project}/locations/{location}/repositories/{repository}/aptArtifacts/{apt_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 AptArtifactName)

public static bool TryParse(string aptArtifactName, out AptArtifactName result)

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

Parameters
NameDescription
aptArtifactNameString

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

resultAptArtifactName

When this method returns, the parsed AptArtifactName, or null if parsing failed.

Returns
TypeDescription
Boolean

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}/aptArtifacts/{apt_artifact}

TryParse(String, Boolean, out AptArtifactName)

public static bool TryParse(string aptArtifactName, bool allowUnparsed, out AptArtifactName result)

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

Parameters
NameDescription
aptArtifactNameString

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

allowUnparsedBoolean

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.

resultAptArtifactName

When this method returns, the parsed AptArtifactName, or null if parsing failed.

Returns
TypeDescription
Boolean

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}/aptArtifacts/{apt_artifact}
Or may be in any format if allowUnparsed is true.

Operators

Equality(AptArtifactName, AptArtifactName)

public static bool operator ==(AptArtifactName a, AptArtifactName b)
Parameters
NameDescription
aAptArtifactName
bAptArtifactName
Returns
TypeDescription
Boolean

Inequality(AptArtifactName, AptArtifactName)

public static bool operator !=(AptArtifactName a, AptArtifactName b)
Parameters
NameDescription
aAptArtifactName
bAptArtifactName
Returns
TypeDescription
Boolean