Class API

constructor

• new API(client: Client): Registry.v1.API

• Parameters

  • client: Client

  Returns Registry.v1.API

Static ReadonlyLOCALITIES

createNamespace

• createNamespace(
      request: Readonly<Registry.v1.CreateNamespaceRequest>,
  ): Promise<Registry.v1.Namespace>

• Create a namespace. Create a new Container Registry namespace. You must specify the namespace name and region in which you want it to be created. Optionally, you can specify the project_id and is_public in the request payload.

  Parameters

  • request: Readonly<Registry.v1.CreateNamespaceRequest>

    The request CreateNamespaceRequest

  Returns Promise<Registry.v1.Namespace>

  A Promise of Namespace

deleteImage

• deleteImage(
      request: Readonly<Registry.v1.DeleteImageRequest>,
  ): Promise<Registry.v1.Image>

• Delete an image. Delete a given image. You must specify, in the endpoint, the region and image_id parameters of the image you want to delete.

  Parameters

  • request: Readonly<Registry.v1.DeleteImageRequest>

    The request DeleteImageRequest

  Returns Promise<Registry.v1.Image>

  A Promise of Image

deleteNamespace

• deleteNamespace(
      request: Readonly<Registry.v1.DeleteNamespaceRequest>,
  ): Promise<Registry.v1.Namespace>

• Delete a namespace. Delete a given namespace. You must specify, in the endpoint, the region and namespace_id parameters of the namespace you want to delete.

  Parameters

  • request: Readonly<Registry.v1.DeleteNamespaceRequest>

    The request DeleteNamespaceRequest

  Returns Promise<Registry.v1.Namespace>

  A Promise of Namespace

deleteTag

• deleteTag(request: Readonly<DeleteTagRequest>): Promise<Tag>

• Delete a tag. Delete a given image tag. You must specify, in the endpoint, the region and tag_id parameters of the tag you want to delete.

  Parameters

  • request: Readonly<DeleteTagRequest>

    The request DeleteTagRequest

  Returns Promise<Tag>

  A Promise of Tag

getImage

• getImage(
      request: Readonly<Registry.v1.GetImageRequest>,
  ): Promise<Registry.v1.Image>

• Get an image. Retrieve information about a given container image, specified by its image_id and region. Full details about the image, such as name, namespace_id, status, visibility, and size are returned in the response.

  Parameters

  • request: Readonly<Registry.v1.GetImageRequest>

    The request GetImageRequest

  Returns Promise<Registry.v1.Image>

  A Promise of Image

getNamespace

• getNamespace(
      request: Readonly<Registry.v1.GetNamespaceRequest>,
  ): Promise<Registry.v1.Namespace>

• Get a namespace. Retrieve information about a given namespace, specified by its namespace_id and region. Full details about the namespace, such as description, project_id, status, endpoint, is_public, size, and image_count are returned in the response.

  Parameters

  • request: Readonly<Registry.v1.GetNamespaceRequest>

    The request GetNamespaceRequest

  Returns Promise<Registry.v1.Namespace>

  A Promise of Namespace

getTag

• getTag(request: Readonly<GetTagRequest>): Promise<Tag>

• Get a tag. Retrieve information about a given image tag, specified by its tag_id and region. Full details about the tag, such as name, image_id, status, and digest are returned in the response.

  Parameters

  • request: Readonly<GetTagRequest>

    The request GetTagRequest

  Returns Promise<Tag>

  A Promise of Tag

listImages

• listImages(
      request?: Readonly<Registry.v1.ListImagesRequest>,
  ): Promise<Registry.v1.ListImagesResponse> & {
      "[asyncIterator]": () => AsyncGenerator<Registry.v1.Image[], void, void>;
      all: () => Promise<Registry.v1.Image[]>;
  }

• List images. List all images in a specified region. By default, the images listed are ordered by creation date in ascending order. This can be modified via the order_by field. You can also define additional parameters for your query, such as the namespace_id and project_id parameters.

  Parameters

  • request: Readonly<Registry.v1.ListImagesRequest> = {}

    The request ListImagesRequest

  Returns Promise<Registry.v1.ListImagesResponse> & {
      "[asyncIterator]": () => AsyncGenerator<Registry.v1.Image[], void, void>;
      all: () => Promise<Registry.v1.Image[]>;
  }

  A Promise of ListImagesResponse

listNamespaces

• listNamespaces(
      request?: Readonly<Registry.v1.ListNamespacesRequest>,
  ): Promise<Registry.v1.ListNamespacesResponse> & {
      "[asyncIterator]": () => AsyncGenerator<
          Registry.v1.Namespace[],
          void,
          void,
      >;
      all: () => Promise<Registry.v1.Namespace[]>;
  }

• List namespaces. List all namespaces in a specified region. By default, the namespaces listed are ordered by creation date in ascending order. This can be modified via the order_by field. You can also define additional parameters for your query, such as the instance_id and project_id parameters.

  Parameters

  • request: Readonly<Registry.v1.ListNamespacesRequest> = {}

    The request ListNamespacesRequest

  Returns Promise<Registry.v1.ListNamespacesResponse> & {
      "[asyncIterator]": () => AsyncGenerator<
          Registry.v1.Namespace[],
          void,
          void,
      >;
      all: () => Promise<Registry.v1.Namespace[]>;
  }

  A Promise of ListNamespacesResponse

listTags

• listTags(
      request: Readonly<Registry.v1.ListTagsRequest>,
  ): Promise<Registry.v1.ListTagsResponse> & {
      "[asyncIterator]": () => AsyncGenerator<Tag[], void, void>;
      all: () => Promise<Tag[]>;
  }

• List tags. List all tags for a given image, specified by region. By default, the tags listed are ordered by creation date in ascending order. This can be modified via the order_by field. You can also define additional parameters for your query, such as the name.

  Parameters

  • request: Readonly<Registry.v1.ListTagsRequest>

    The request ListTagsRequest

  Returns Promise<Registry.v1.ListTagsResponse> & {
      "[asyncIterator]": () => AsyncGenerator<Tag[], void, void>;
      all: () => Promise<Tag[]>;
  }

  A Promise of ListTagsResponse

updateImage

• updateImage(
      request: Readonly<Registry.v1.UpdateImageRequest>,
  ): Promise<Registry.v1.Image>

• Update an image. Update the parameters of a given image, specified by its image_id and region. You can update the visibility parameter.

  Parameters

  • request: Readonly<Registry.v1.UpdateImageRequest>

    The request UpdateImageRequest

  Returns Promise<Registry.v1.Image>

  A Promise of Image

updateNamespace

• updateNamespace(
      request: Readonly<Registry.v1.UpdateNamespaceRequest>,
  ): Promise<Registry.v1.Namespace>

• Update a namespace. Update the parameters of a given namespace, specified by its namespace_id and region. You can update the description and is_public parameters.

  Parameters

  • request: Readonly<Registry.v1.UpdateNamespaceRequest>

    The request UpdateNamespaceRequest

  Returns Promise<Registry.v1.Namespace>

  A Promise of Namespace

waitForImage

• waitForImage(
      request: Readonly<Registry.v1.GetImageRequest>,
      options?: Readonly<WaitForOptions<Registry.v1.Image>>,
  ): Promise<Registry.v1.Image>

• Waits for Image to be in a final state.

  Parameters

  • request: Readonly<Registry.v1.GetImageRequest>

    The request GetImageRequest
  • Optionaloptions: Readonly<WaitForOptions<Registry.v1.Image>>

    The waiting options

  Returns Promise<Registry.v1.Image>

  A Promise of Image

waitForNamespace

• waitForNamespace(
      request: Readonly<Registry.v1.GetNamespaceRequest>,
      options?: Readonly<WaitForOptions<Registry.v1.Namespace>>,
  ): Promise<Registry.v1.Namespace>

• Waits for Namespace to be in a final state.

  Parameters

  • request: Readonly<Registry.v1.GetNamespaceRequest>

    The request GetNamespaceRequest
  • Optionaloptions: Readonly<WaitForOptions<Registry.v1.Namespace>>

    The waiting options

  Returns Promise<Registry.v1.Namespace>

  A Promise of Namespace

waitForTag

• waitForTag(
      request: Readonly<GetTagRequest>,
      options?: Readonly<WaitForOptions<Tag>>,
  ): Promise<Tag>

• Waits for Tag to be in a final state.

  Parameters

  • request: Readonly<GetTagRequest>

    The request GetTagRequest
  • Optionaloptions: Readonly<WaitForOptions<Tag>>

    The waiting options

  Returns Promise<Tag>

  A Promise of Tag