Artifact Registry v1 API - Class DockerImageName (2.2.0)

Version 2.2.0

• 2.9.0 (latest)
• 2.8.0
• 2.7.0
• 2.6.0
• 2.5.0
• 2.4.0
• 2.3.0
• 2.2.0
• 2.1.0
• 2.0.0
• 1.1.0
• 1.0.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

Implements

IResourceName, IEquatableDockerImageName

Inherited Members

object.GetType()

object.MemberwiseClone()

Namespace

GoogleCloudGoogle.Cloud.ArtifactRegistryV1

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
Name	Description
projectId	string The Project ID. Must not be null or empty.
locationId	string The Location ID. Must not be null or empty.
repositoryId	string The Repository ID. Must not be null or empty.
dockerImageId	string 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
Type	Description
string

IsKnownPattern

public bool IsKnownPattern { get; }

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

Property Value
Type	Description
bool

LocationId

public string LocationId { get; }

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

Property Value
Type	Description
string

ProjectId

public string ProjectId { get; }

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

Property Value
Type	Description
string

RepositoryId

public string RepositoryId { get; }

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

Property Value
Type	Description
string

Type

public DockerImageName.ResourceNameType Type { get; }

The DockerImageName.ResourceNameType of the contained resource name.

Property Value
Type	Description
DockerImageNameResourceNameType

UnparsedResource

public UnparsedResourceName UnparsedResource { get; }

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

Property Value
Type	Description
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
Name	Description
projectId	string The Project ID. Must not be null or empty.
locationId	string The Location ID. Must not be null or empty.
repositoryId	string The Repository ID. Must not be null or empty.
dockerImageId	string The DockerImage ID. Must not be null or empty.

Returns
Type	Description
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
Name	Description
projectId	string The Project ID. Must not be null or empty.
locationId	string The Location ID. Must not be null or empty.
repositoryId	string The Repository ID. Must not be null or empty.
dockerImageId	string The DockerImage ID. Must not be null or empty.

Returns
Type	Description
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
Name	Description
projectId	string The Project ID. Must not be null or empty.
locationId	string The Location ID. Must not be null or empty.
repositoryId	string The Repository ID. Must not be null or empty.
dockerImageId	string The DockerImage ID. Must not be null or empty.

Returns
Type	Description
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
Name	Description
unparsedResourceName	UnparsedResourceName The unparsed resource name. Must not be null.

Returns
Type	Description
DockerImageName	A new instance of DockerImageName containing the provided unparsedResourceName.

GetHashCode()

public override int GetHashCode()

Returns a hash code for this resource name.

Returns
Type	Description
int

Overrides

Object.GetHashCode()

Parse(string)

public static DockerImageName Parse(string dockerImageName)

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

Parameter
Name	Description
dockerImageName	string The resource name in string form. Must not be null.

Returns
Type	Description
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
Name	Description
dockerImageName	string The resource name in string form. Must not be null.
allowUnparsed	bool 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
Type	Description
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
Type	Description
string	The string representation of the resource name.

Overrides

Object.ToString()

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
Name	Description
dockerImageName	string The resource name in string form. Must not be null.
result	DockerImageName When this method returns, the parsed DockerImageName, or null if parsing failed.

Returns
Type	Description
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
Name	Description
dockerImageName	string The resource name in string form. Must not be null.
allowUnparsed	bool 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.
result	DockerImageName When this method returns, the parsed DockerImageName, or null if parsing failed.

Returns
Type	Description
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
Name	Description
a	DockerImageName
b	DockerImageName

Returns
Type	Description
bool

operator !=(DockerImageName, DockerImageName)

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

Parameters
Name	Description
a	DockerImageName
b	DockerImageName

Returns
Type	Description
bool