Artifact Registry v1 API - Class DockerImageName (2.3.0)

public sealed class DockerImageName : IResourceName, IEquatable<DockerImageName>

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

Resource name for the DockerImage resource.

Inheritance

object > DockerImageName

Namespace

Google.Cloud.ArtifactRegistry.V1

Assembly

Google.Cloud.ArtifactRegistry.V1.dll

Constructors

DockerImageName(string, string, string, string)

public DockerImageName(string projectId, string locationId, string repositoryId, string dockerImageId)

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

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.

dockerImageIdstring

The DockerImage ID. Must not be null or empty.

Properties

DockerImageId

public string DockerImageId { get; }

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

The DockerImageName.ResourceNameType of the contained resource name.

Property Value
TypeDescription
DockerImageNameResourceNameType

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

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

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.

dockerImageIdstring

The DockerImage ID. Must not be null or empty.

Returns
TypeDescription
string

The string representation of this DockerImageName with pattern projects/{project}/locations/{location}/repositories/{repository}/dockerImages/{docker_image}.

FormatProjectLocationRepositoryDockerImage(string, string, string, string)

public static string FormatProjectLocationRepositoryDockerImage(string projectId, string locationId, string repositoryId, string dockerImageId)

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

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.

dockerImageIdstring

The DockerImage ID. Must not be null or empty.

Returns
TypeDescription
string

The string representation of this DockerImageName with pattern projects/{project}/locations/{location}/repositories/{repository}/dockerImages/{docker_image}.

FromProjectLocationRepositoryDockerImage(string, string, string, string)

public static DockerImageName FromProjectLocationRepositoryDockerImage(string projectId, string locationId, string repositoryId, string dockerImageId)

Creates a DockerImageName with the pattern projects/{project}/locations/{location}/repositories/{repository}/dockerImages/{docker_image}.

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.

dockerImageIdstring

The DockerImage ID. Must not be null or empty.

Returns
TypeDescription
DockerImageName

A new instance of DockerImageName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static DockerImageName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a DockerImageName containing an unparsed resource name.

Parameter
NameDescription
unparsedResourceNameUnparsedResourceName

The unparsed resource name. Must not be null.

Returns
TypeDescription
DockerImageName

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

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

Parameter
NameDescription
dockerImageNamestring

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

Returns
TypeDescription
DockerImageName

The parsed DockerImageName if successful.

Remarks

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

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

Parse(string, bool)

public static DockerImageName Parse(string dockerImageName, bool allowUnparsed)

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

Parameters
NameDescription
dockerImageNamestring

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
DockerImageName

The parsed DockerImageName if successful.

Remarks

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

  • projects/{project}/locations/{location}/repositories/{repository}/dockerImages/{docker_image}
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 DockerImageName)

public static bool TryParse(string dockerImageName, out DockerImageName result)

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

Parameters
NameDescription
dockerImageNamestring

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

resultDockerImageName

When this method returns, the parsed DockerImageName, 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}/dockerImages/{docker_image}

TryParse(string, bool, out DockerImageName)

public static bool TryParse(string dockerImageName, bool allowUnparsed, out DockerImageName result)

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

Parameters
NameDescription
dockerImageNamestring

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.

resultDockerImageName

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

Operators

operator ==(DockerImageName, DockerImageName)

public static bool operator ==(DockerImageName a, DockerImageName b)
Parameters
NameDescription
aDockerImageName
bDockerImageName
Returns
TypeDescription
bool

operator !=(DockerImageName, DockerImageName)

public static bool operator !=(DockerImageName a, DockerImageName b)
Parameters
NameDescription
aDockerImageName
bDockerImageName
Returns
TypeDescription
bool