Reference documentation and code samples for the Google Cloud Artifact Registry V1 Client class DockerImage.
DockerImage represents a docker artifact.
The following fields are returned as untyped metadata in the Version
resource, using camelcase keys (i.e. metadata.imageSizeBytes):
imageSizeBytes
mediaType
buildTime
Generated from protobuf messagegoogle.devtools.artifactregistry.v1.DockerImage
Namespace
Google \ Cloud \ ArtifactRegistry \ V1
Methods
__construct
Constructor.
Parameters
Name
Description
data
array
Optional. Data for populating the Message object.
↳ name
string
Required. registry_location, project_id, repository_name and image id forms a unique image name:projects/<project_id>/locations/<location>/repository/<repository_name>/dockerImages/<docker_image>. For example, "projects/test-project/locations/us-west4/repositories/test-repo/dockerImages/ nginx@sha256:e9954c1fc875017be1c3e36eca16be2d9e9bccc4bf072163515467d6a823c7cf", where "us-west4" is the registry_location, "test-project" is the project_id, "test-repo" is the repository_name and "nginx@sha256:e9954c1fc875017be1c3e36eca16be2d9e9bccc4bf072163515467d6a823c7cf" is the image's digest.
↳ uri
string
Required. URL to access the image. Example: us-west4-docker.pkg.dev/test-project/test-repo/nginx@sha256:e9954c1fc875017be1c3e36eca16be2d9e9bccc4bf072163515467d6a823c7cf
↳ tags
array
Tags attached to this image.
↳ image_size_bytes
int|string
Calculated size of the image. This field is returned as the 'metadata.imageSizeBytes' field in the Version resource.
Media type of this image, e.g. "application/vnd.docker.distribution.manifest.v2+json". This field is returned as the 'metadata.mediaType' field in the Version resource.
The time this image was built. This field is returned as the 'metadata.buildTime' field in the Version resource. The build time is returned to the client as an RFC 3339 string, which can be easily used with the JavaScript Date constructor.
Output only. The time when the docker image was last updated.
getName
Required. registry_location, project_id, repository_name and image id forms
a unique image
name:projects/<project_id>/locations/<location>/repository/<repository_name>/dockerImages/<docker_image>.
For example,
"projects/test-project/locations/us-west4/repositories/test-repo/dockerImages/
nginx@sha256:e9954c1fc875017be1c3e36eca16be2d9e9bccc4bf072163515467d6a823c7cf",
where "us-west4" is the registry_location, "test-project" is the
project_id, "test-repo" is the repository_name and
"nginx@sha256:e9954c1fc875017be1c3e36eca16be2d9e9bccc4bf072163515467d6a823c7cf"
is the image's digest.
Returns
Type
Description
string
setName
Required. registry_location, project_id, repository_name and image id forms
a unique image
name:projects/<project_id>/locations/<location>/repository/<repository_name>/dockerImages/<docker_image>.
For example,
"projects/test-project/locations/us-west4/repositories/test-repo/dockerImages/
nginx@sha256:e9954c1fc875017be1c3e36eca16be2d9e9bccc4bf072163515467d6a823c7cf",
where "us-west4" is the registry_location, "test-project" is the
project_id, "test-repo" is the repository_name and
"nginx@sha256:e9954c1fc875017be1c3e36eca16be2d9e9bccc4bf072163515467d6a823c7cf"
is the image's digest.
"application/vnd.docker.distribution.manifest.v2+json".
This field is returned as the 'metadata.mediaType' field in the
Version resource.
Returns
Type
Description
string
setMediaType
Media type of this image, e.g.
"application/vnd.docker.distribution.manifest.v2+json".
This field is returned as the 'metadata.mediaType' field in the
Version resource.
Parameter
Name
Description
var
string
Returns
Type
Description
$this
getBuildTime
The time this image was built.
This field is returned as the 'metadata.buildTime' field in the
Version resource.
The build time is returned to the client as an RFC 3339 string, which can
be easily used with the JavaScript Date constructor.
This field is returned as the 'metadata.buildTime' field in the
Version resource.
The build time is returned to the client as an RFC 3339 string, which can
be easily used with the JavaScript Date constructor.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-09-04 UTC."],[],[],null,["# Google Cloud Artifact Registry V1 Client - Class DockerImage (1.2.1)\n\nVersion latestkeyboard_arrow_down\n\n- [1.2.1 (latest)](/php/docs/reference/cloud-artifact-registry/latest/V1.DockerImage)\n- [1.2.0](/php/docs/reference/cloud-artifact-registry/1.2.0/V1.DockerImage)\n- [1.1.3](/php/docs/reference/cloud-artifact-registry/1.1.3/V1.DockerImage)\n- [1.0.0](/php/docs/reference/cloud-artifact-registry/1.0.0/V1.DockerImage)\n- [0.6.5](/php/docs/reference/cloud-artifact-registry/0.6.5/V1.DockerImage)\n- [0.5.1](/php/docs/reference/cloud-artifact-registry/0.5.1/V1.DockerImage)\n- [0.4.4](/php/docs/reference/cloud-artifact-registry/0.4.4/V1.DockerImage)\n- [0.3.13](/php/docs/reference/cloud-artifact-registry/0.3.13/V1.DockerImage) \nReference documentation and code samples for the Google Cloud Artifact Registry V1 Client class DockerImage.\n\nDockerImage represents a docker artifact.\n\nThe following fields are returned as untyped metadata in the Version\nresource, using camelcase keys (i.e. metadata.imageSizeBytes):\n\n- imageSizeBytes\n- mediaType\n- buildTime\n\nGenerated from protobuf message `google.devtools.artifactregistry.v1.DockerImage`\n\nNamespace\n---------\n\nGoogle \\\\ Cloud \\\\ ArtifactRegistry \\\\ V1\n\nMethods\n-------\n\n### __construct\n\nConstructor.\n\n### getName\n\nRequired. registry_location, project_id, repository_name and image id forms\na unique image\nname:`projects/\u003cproject_id\u003e/locations/\u003clocation\u003e/repository/\u003crepository_name\u003e/dockerImages/\u003cdocker_image\u003e`.\n\nFor example,\n\"projects/test-project/locations/us-west4/repositories/test-repo/dockerImages/\nnginx@sha256:e9954c1fc875017be1c3e36eca16be2d9e9bccc4bf072163515467d6a823c7cf\",\nwhere \"us-west4\" is the registry_location, \"test-project\" is the\nproject_id, \"test-repo\" is the repository_name and\n\"nginx@sha256:e9954c1fc875017be1c3e36eca16be2d9e9bccc4bf072163515467d6a823c7cf\"\nis the image's digest.\n\n### setName\n\nRequired. registry_location, project_id, repository_name and image id forms\na unique image\nname:`projects/\u003cproject_id\u003e/locations/\u003clocation\u003e/repository/\u003crepository_name\u003e/dockerImages/\u003cdocker_image\u003e`.\n\nFor example,\n\"projects/test-project/locations/us-west4/repositories/test-repo/dockerImages/\nnginx@sha256:e9954c1fc875017be1c3e36eca16be2d9e9bccc4bf072163515467d6a823c7cf\",\nwhere \"us-west4\" is the registry_location, \"test-project\" is the\nproject_id, \"test-repo\" is the repository_name and\n\"nginx@sha256:e9954c1fc875017be1c3e36eca16be2d9e9bccc4bf072163515467d6a823c7cf\"\nis the image's digest.\n\n### getUri\n\nRequired. URL to access the image.\n\nExample:\nus-west4-docker.pkg.dev/test-project/test-repo/nginx@sha256:e9954c1fc875017be1c3e36eca16be2d9e9bccc4bf072163515467d6a823c7cf\n\n### setUri\n\nRequired. URL to access the image.\n\nExample:\nus-west4-docker.pkg.dev/test-project/test-repo/nginx@sha256:e9954c1fc875017be1c3e36eca16be2d9e9bccc4bf072163515467d6a823c7cf\n\n### getTags\n\nTags attached to this image.\n\n### setTags\n\nTags attached to this image.\n\n### getImageSizeBytes\n\nCalculated size of the image.\n\nThis field is returned as the 'metadata.imageSizeBytes' field in the\nVersion resource.\n\n### setImageSizeBytes\n\nCalculated size of the image.\n\nThis field is returned as the 'metadata.imageSizeBytes' field in the\nVersion resource.\n\n### getUploadTime\n\nTime the image was uploaded.\n\n### hasUploadTime\n\n### clearUploadTime\n\n### setUploadTime\n\nTime the image was uploaded.\n\n### getMediaType\n\nMedia type of this image, e.g.\n\n\"application/vnd.docker.distribution.manifest.v2+json\".\nThis field is returned as the 'metadata.mediaType' field in the\nVersion resource.\n\n### setMediaType\n\nMedia type of this image, e.g.\n\n\"application/vnd.docker.distribution.manifest.v2+json\".\nThis field is returned as the 'metadata.mediaType' field in the\nVersion resource.\n\n### getBuildTime\n\nThe time this image was built.\n\nThis field is returned as the 'metadata.buildTime' field in the\nVersion resource.\nThe build time is returned to the client as an RFC 3339 string, which can\nbe easily used with the JavaScript Date constructor.\n\n### hasBuildTime\n\n### clearBuildTime\n\n### setBuildTime\n\nThe time this image was built.\n\nThis field is returned as the 'metadata.buildTime' field in the\nVersion resource.\nThe build time is returned to the client as an RFC 3339 string, which can\nbe easily used with the JavaScript Date constructor.\n\n### getUpdateTime\n\nOutput only. The time when the docker image was last updated.\n\n### hasUpdateTime\n\n### clearUpdateTime\n\n### setUpdateTime\n\nOutput only. The time when the docker image was last updated."]]
