Artifact Registry v1 API - Class YumArtifactName (2.1.0)

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

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

Resource name for the YumArtifact resource.

Inheritance

Object > YumArtifactName

Namespace

Google.Cloud.ArtifactRegistry.V1

Assembly

Google.Cloud.ArtifactRegistry.V1.dll

Constructors

YumArtifactName(String, String, String, String)

public YumArtifactName(string projectId, string locationId, string repositoryId, string yumArtifactId)

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

yumArtifactIdString

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

The YumArtifactName.ResourceNameType of the contained resource name.

Property Value
TypeDescription
YumArtifactName.ResourceNameType

UnparsedResource

public UnparsedResourceName UnparsedResource { get; }

The contained UnparsedResourceName. Only non-null if this instance contains an unparsed resource name.

Property Value
TypeDescription
UnparsedResourceName

YumArtifactId

public string YumArtifactId { get; }

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

Property Value
TypeDescription
String

Methods

Format(String, String, String, String)

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

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

yumArtifactIdString

The YumArtifact ID. Must not be null or empty.

Returns
TypeDescription
String

The string representation of this YumArtifactName with pattern projects/{project}/locations/{location}/repositories/{repository}/yumArtifacts/{yum_artifact}.

FormatProjectLocationRepositoryYumArtifact(String, String, String, String)

public static string FormatProjectLocationRepositoryYumArtifact(string projectId, string locationId, string repositoryId, string yumArtifactId)

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

yumArtifactIdString

The YumArtifact ID. Must not be null or empty.

Returns
TypeDescription
String

The string representation of this YumArtifactName with pattern projects/{project}/locations/{location}/repositories/{repository}/yumArtifacts/{yum_artifact}.

FromProjectLocationRepositoryYumArtifact(String, String, String, String)

public static YumArtifactName FromProjectLocationRepositoryYumArtifact(string projectId, string locationId, string repositoryId, string yumArtifactId)

Creates a YumArtifactName with the pattern projects/{project}/locations/{location}/repositories/{repository}/yumArtifacts/{yum_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.

yumArtifactIdString

The YumArtifact ID. Must not be null or empty.

Returns
TypeDescription
YumArtifactName

A new instance of YumArtifactName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static YumArtifactName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a YumArtifactName containing an unparsed resource name.

Parameter
NameDescription
unparsedResourceNameUnparsedResourceName

The unparsed resource name. Must not be null.

Returns
TypeDescription
YumArtifactName

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

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

Parameter
NameDescription
yumArtifactNameString

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

Returns
TypeDescription
YumArtifactName

The parsed YumArtifactName if successful.

Remarks

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

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

Parse(String, Boolean)

public static YumArtifactName Parse(string yumArtifactName, bool allowUnparsed)

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

Parameters
NameDescription
yumArtifactNameString

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
YumArtifactName

The parsed YumArtifactName if successful.

Remarks

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

  • projects/{project}/locations/{location}/repositories/{repository}/yumArtifacts/{yum_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 YumArtifactName)

public static bool TryParse(string yumArtifactName, out YumArtifactName result)

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

Parameters
NameDescription
yumArtifactNameString

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

resultYumArtifactName

When this method returns, the parsed YumArtifactName, 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}/yumArtifacts/{yum_artifact}

TryParse(String, Boolean, out YumArtifactName)

public static bool TryParse(string yumArtifactName, bool allowUnparsed, out YumArtifactName result)

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

Parameters
NameDescription
yumArtifactNameString

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.

resultYumArtifactName

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

Operators

Equality(YumArtifactName, YumArtifactName)

public static bool operator ==(YumArtifactName a, YumArtifactName b)
Parameters
NameDescription
aYumArtifactName
bYumArtifactName
Returns
TypeDescription
Boolean

Inequality(YumArtifactName, YumArtifactName)

public static bool operator !=(YumArtifactName a, YumArtifactName b)
Parameters
NameDescription
aYumArtifactName
bYumArtifactName
Returns
TypeDescription
Boolean