Class ImageService

constructor

• new ImageService(sdk: SDKInterface): ImageService

  Parameters

  • sdk: SDKInterface

  Returns ImageService

$type

create

• create(
      request: CreateImageRequest,
  ): Request<CreateImageRequest, Operation<GetOperationRequest>>

  Creates a new image resource.

  Parameters

  • request: CreateImageRequest

  Returns Request<CreateImageRequest, Operation<GetOperationRequest>>

• create(
      request: CreateImageRequest,
      metadata: Metadata,
  ): Request<CreateImageRequest, Operation<GetOperationRequest>>

  Parameters

  • request: CreateImageRequest
  • metadata: Metadata

  Returns Request<CreateImageRequest, Operation<GetOperationRequest>>

• create(
      request: CreateImageRequest,
      metadata: Metadata,
      options: Partial<CallOptions> & RetryOptions,
  ): Request<CreateImageRequest, Operation<GetOperationRequest>>

  Parameters

  • request: CreateImageRequest
  • metadata: Metadata
  • options: Partial<CallOptions> & RetryOptions

  Returns Request<CreateImageRequest, Operation<GetOperationRequest>>

• create(
      request: CreateImageRequest,
  ): Request<CreateImageRequest, Operation<GetOperationRequest>>

  Creates a new image resource.

  Parameters

  • request: CreateImageRequest

  Returns Request<CreateImageRequest, Operation<GetOperationRequest>>

• create(
      request: CreateImageRequest,
      metadata: Metadata,
  ): Request<CreateImageRequest, Operation<GetOperationRequest>>

  Creates a new image resource.

  Parameters

  • request: CreateImageRequest
  • metadata: Metadata

  Returns Request<CreateImageRequest, Operation<GetOperationRequest>>

• create(
      request: CreateImageRequest,
      metadata: Metadata,
      options: Partial<CallOptions> & RetryOptions,
  ): Request<CreateImageRequest, Operation<GetOperationRequest>>

  Creates a new image resource.

  Parameters

  • request: CreateImageRequest
  • metadata: Metadata
  • options: Partial<CallOptions> & RetryOptions

  Returns Request<CreateImageRequest, Operation<GetOperationRequest>>

delete

• delete(
      request: DeleteImageRequest,
  ): Request<DeleteImageRequest, Operation<GetOperationRequest>>

  Deletes an existing image resource by its ID.

  Parameters

  • request: DeleteImageRequest

  Returns Request<DeleteImageRequest, Operation<GetOperationRequest>>

• delete(
      request: DeleteImageRequest,
      metadata: Metadata,
  ): Request<DeleteImageRequest, Operation<GetOperationRequest>>

  Parameters

  • request: DeleteImageRequest
  • metadata: Metadata

  Returns Request<DeleteImageRequest, Operation<GetOperationRequest>>

• delete(
      request: DeleteImageRequest,
      metadata: Metadata,
      options: Partial<CallOptions> & RetryOptions,
  ): Request<DeleteImageRequest, Operation<GetOperationRequest>>

  Parameters

  • request: DeleteImageRequest
  • metadata: Metadata
  • options: Partial<CallOptions> & RetryOptions

  Returns Request<DeleteImageRequest, Operation<GetOperationRequest>>

• delete(
      request: DeleteImageRequest,
  ): Request<DeleteImageRequest, Operation<GetOperationRequest>>

  Deletes an existing image resource by its ID.

  Parameters

  • request: DeleteImageRequest

  Returns Request<DeleteImageRequest, Operation<GetOperationRequest>>

• delete(
      request: DeleteImageRequest,
      metadata: Metadata,
  ): Request<DeleteImageRequest, Operation<GetOperationRequest>>

  Deletes an existing image resource by its ID.

  Parameters

  • request: DeleteImageRequest
  • metadata: Metadata

  Returns Request<DeleteImageRequest, Operation<GetOperationRequest>>

• delete(
      request: DeleteImageRequest,
      metadata: Metadata,
      options: Partial<CallOptions> & RetryOptions,
  ): Request<DeleteImageRequest, Operation<GetOperationRequest>>

  Deletes an existing image resource by its ID.

  Parameters

  • request: DeleteImageRequest
  • metadata: Metadata
  • options: Partial<CallOptions> & RetryOptions

  Returns Request<DeleteImageRequest, Operation<GetOperationRequest>>

get

• get(request: GetImageRequest): Request<GetImageRequest, Image>

  Retrieves detailed information about a specific image by its ID.

  Parameters

  • request: GetImageRequest

  Returns Request<GetImageRequest, Image>

• get(
      request: GetImageRequest,
      metadata: Metadata,
  ): Request<GetImageRequest, Image>

  Parameters

  • request: GetImageRequest
  • metadata: Metadata

  Returns Request<GetImageRequest, Image>

• get(
      request: GetImageRequest,
      metadata: Metadata,
      options: Partial<CallOptions> & RetryOptions,
  ): Request<GetImageRequest, Image>

  Parameters

  • request: GetImageRequest
  • metadata: Metadata
  • options: Partial<CallOptions> & RetryOptions

  Returns Request<GetImageRequest, Image>

• get(request: GetImageRequest): Request<GetImageRequest, Image>

  Retrieves detailed information about a specific image by its ID.

  Parameters

  • request: GetImageRequest

  Returns Request<GetImageRequest, Image>

• get(
      request: GetImageRequest,
      metadata: Metadata,
  ): Request<GetImageRequest, Image>

  Retrieves detailed information about a specific image by its ID.

  Parameters

  • request: GetImageRequest
  • metadata: Metadata

  Returns Request<GetImageRequest, Image>

• get(
      request: GetImageRequest,
      metadata: Metadata,
      options: Partial<CallOptions> & RetryOptions,
  ): Request<GetImageRequest, Image>

  Retrieves detailed information about a specific image by its ID.

  Parameters

  • request: GetImageRequest
  • metadata: Metadata
  • options: Partial<CallOptions> & RetryOptions

  Returns Request<GetImageRequest, Image>

getByName

• getByName(request: GetByNameRequest): Request<GetByNameRequest, Image>

  Retrieves detailed information about a specific image by its parent and name.

  Parameters

  • request: GetByNameRequest

  Returns Request<GetByNameRequest, Image>

• getByName(
      request: GetByNameRequest,
      metadata: Metadata,
  ): Request<GetByNameRequest, Image>

  Parameters

  • request: GetByNameRequest
  • metadata: Metadata

  Returns Request<GetByNameRequest, Image>

• getByName(
      request: GetByNameRequest,
      metadata: Metadata,
      options: Partial<CallOptions> & RetryOptions,
  ): Request<GetByNameRequest, Image>

  Parameters

  • request: GetByNameRequest
  • metadata: Metadata
  • options: Partial<CallOptions> & RetryOptions

  Returns Request<GetByNameRequest, Image>

• getByName(request: GetByNameRequest): Request<GetByNameRequest, Image>

  Retrieves detailed information about a specific image by its parent and name.

  Parameters

  • request: GetByNameRequest

  Returns Request<GetByNameRequest, Image>

• getByName(
      request: GetByNameRequest,
      metadata: Metadata,
  ): Request<GetByNameRequest, Image>

  Retrieves detailed information about a specific image by its parent and name.

  Parameters

  • request: GetByNameRequest
  • metadata: Metadata

  Returns Request<GetByNameRequest, Image>

• getByName(
      request: GetByNameRequest,
      metadata: Metadata,
      options: Partial<CallOptions> & RetryOptions,
  ): Request<GetByNameRequest, Image>

  Retrieves detailed information about a specific image by its parent and name.

  Parameters

  • request: GetByNameRequest
  • metadata: Metadata
  • options: Partial<CallOptions> & RetryOptions

  Returns Request<GetByNameRequest, Image>

getLatestByFamily

• getLatestByFamily(
      request: GetImageLatestByFamilyRequest,
  ): Request<GetImageLatestByFamilyRequest, Image>

  Retrieves the most recent image from a specified family. Image families are used to organize related images and ensure easy access to the latest version.

  Parameters

  • request: GetImageLatestByFamilyRequest

  Returns Request<GetImageLatestByFamilyRequest, Image>

• getLatestByFamily(
      request: GetImageLatestByFamilyRequest,
      metadata: Metadata,
  ): Request<GetImageLatestByFamilyRequest, Image>

  Parameters

  • request: GetImageLatestByFamilyRequest
  • metadata: Metadata

  Returns Request<GetImageLatestByFamilyRequest, Image>

• getLatestByFamily(
      request: GetImageLatestByFamilyRequest,
      metadata: Metadata,
      options: Partial<CallOptions> & RetryOptions,
  ): Request<GetImageLatestByFamilyRequest, Image>

  Parameters

  • request: GetImageLatestByFamilyRequest
  • metadata: Metadata
  • options: Partial<CallOptions> & RetryOptions

  Returns Request<GetImageLatestByFamilyRequest, Image>

• getLatestByFamily(
      request: GetImageLatestByFamilyRequest,
  ): Request<GetImageLatestByFamilyRequest, Image>

  Retrieves the most recent image from a specified family. Image families are used to organize related images and ensure easy access to the latest version.

  Parameters

  • request: GetImageLatestByFamilyRequest

  Returns Request<GetImageLatestByFamilyRequest, Image>

• getLatestByFamily(
      request: GetImageLatestByFamilyRequest,
      metadata: Metadata,
  ): Request<GetImageLatestByFamilyRequest, Image>

  Retrieves the most recent image from a specified family. Image families are used to organize related images and ensure easy access to the latest version.

  Parameters

  • request: GetImageLatestByFamilyRequest
  • metadata: Metadata

  Returns Request<GetImageLatestByFamilyRequest, Image>

• getLatestByFamily(
      request: GetImageLatestByFamilyRequest,
      metadata: Metadata,
      options: Partial<CallOptions> & RetryOptions,
  ): Request<GetImageLatestByFamilyRequest, Image>

  Retrieves the most recent image from a specified family. Image families are used to organize related images and ensure easy access to the latest version.

  Parameters

  • request: GetImageLatestByFamilyRequest
  • metadata: Metadata
  • options: Partial<CallOptions> & RetryOptions

  Returns Request<GetImageLatestByFamilyRequest, Image>

getOperationService

• getOperationService(): OperationService

  Returns OperationService

list

• list(request: ListImagesRequest): Request<ListImagesRequest, ListImagesResponse>

  Lists all images in a specific parent resource.

  Parameters

  • request: ListImagesRequest

  Returns Request<ListImagesRequest, ListImagesResponse>

• list(
      request: ListImagesRequest,
      metadata: Metadata,
  ): Request<ListImagesRequest, ListImagesResponse>

  Parameters

  • request: ListImagesRequest
  • metadata: Metadata

  Returns Request<ListImagesRequest, ListImagesResponse>

• list(
      request: ListImagesRequest,
      metadata: Metadata,
      options: Partial<CallOptions> & RetryOptions,
  ): Request<ListImagesRequest, ListImagesResponse>

  Parameters

  • request: ListImagesRequest
  • metadata: Metadata
  • options: Partial<CallOptions> & RetryOptions

  Returns Request<ListImagesRequest, ListImagesResponse>

• list(request: ListImagesRequest): Request<ListImagesRequest, ListImagesResponse>

  Lists all images in a specific parent resource.

  Parameters

  • request: ListImagesRequest

  Returns Request<ListImagesRequest, ListImagesResponse>

• list(
      request: ListImagesRequest,
      metadata: Metadata,
  ): Request<ListImagesRequest, ListImagesResponse>

  Lists all images in a specific parent resource.

  Parameters

  • request: ListImagesRequest
  • metadata: Metadata

  Returns Request<ListImagesRequest, ListImagesResponse>

• list(
      request: ListImagesRequest,
      metadata: Metadata,
      options: Partial<CallOptions> & RetryOptions,
  ): Request<ListImagesRequest, ListImagesResponse>

  Lists all images in a specific parent resource.

  Parameters

  • request: ListImagesRequest
  • metadata: Metadata
  • options: Partial<CallOptions> & RetryOptions

  Returns Request<ListImagesRequest, ListImagesResponse>

listOperationsByParent

• listOperationsByParent(
      request: ListOperationsByParentRequest,
  ): Request<ListOperationsByParentRequest, ListOperationsResponse>

  Lists all operations that were performed within a specific parent resource.

  Parameters

  • request: ListOperationsByParentRequest

  Returns Request<ListOperationsByParentRequest, ListOperationsResponse>

• listOperationsByParent(
      request: ListOperationsByParentRequest,
      metadata: Metadata,
  ): Request<ListOperationsByParentRequest, ListOperationsResponse>

  Parameters

  • request: ListOperationsByParentRequest
  • metadata: Metadata

  Returns Request<ListOperationsByParentRequest, ListOperationsResponse>

• listOperationsByParent(
      request: ListOperationsByParentRequest,
      metadata: Metadata,
      options: Partial<CallOptions> & RetryOptions,
  ): Request<ListOperationsByParentRequest, ListOperationsResponse>

  Parameters

  • request: ListOperationsByParentRequest
  • metadata: Metadata
  • options: Partial<CallOptions> & RetryOptions

  Returns Request<ListOperationsByParentRequest, ListOperationsResponse>

• listOperationsByParent(
      request: ListOperationsByParentRequest,
  ): Request<ListOperationsByParentRequest, ListOperationsResponse>

  Lists all operations that were performed within a specific parent resource.

  Parameters

  • request: ListOperationsByParentRequest

  Returns Request<ListOperationsByParentRequest, ListOperationsResponse>

• listOperationsByParent(
      request: ListOperationsByParentRequest,
      metadata: Metadata,
  ): Request<ListOperationsByParentRequest, ListOperationsResponse>

  Lists all operations that were performed within a specific parent resource.

  Parameters

  • request: ListOperationsByParentRequest
  • metadata: Metadata

  Returns Request<ListOperationsByParentRequest, ListOperationsResponse>

• listOperationsByParent(
      request: ListOperationsByParentRequest,
      metadata: Metadata,
      options: Partial<CallOptions> & RetryOptions,
  ): Request<ListOperationsByParentRequest, ListOperationsResponse>

  Lists all operations that were performed within a specific parent resource.

  Parameters

  • request: ListOperationsByParentRequest
  • metadata: Metadata
  • options: Partial<CallOptions> & RetryOptions

  Returns Request<ListOperationsByParentRequest, ListOperationsResponse>

listPublic

• listPublic(
      request: ListPublicRequest,
  ): Request<ListPublicRequest, ListImagesResponse>

  Lists all public images available in a specific region. Regions doc https://docs.nebius.com/overview/regions Public images can contain specific labels in metadata like: "os_name: Ubuntu", "os_version: 22.04 LTS", "linux_kernel: 5.15", "cuda_toolkit: 13.0" "nvidia_gpu_drivers: 550", "networking_package: OFED 23.10"

  Parameters

  • request: ListPublicRequest

  Returns Request<ListPublicRequest, ListImagesResponse>

• listPublic(
      request: ListPublicRequest,
      metadata: Metadata,
  ): Request<ListPublicRequest, ListImagesResponse>

  Parameters

  • request: ListPublicRequest
  • metadata: Metadata

  Returns Request<ListPublicRequest, ListImagesResponse>

• listPublic(
      request: ListPublicRequest,
      metadata: Metadata,
      options: Partial<CallOptions> & RetryOptions,
  ): Request<ListPublicRequest, ListImagesResponse>

  Parameters

  • request: ListPublicRequest
  • metadata: Metadata
  • options: Partial<CallOptions> & RetryOptions

  Returns Request<ListPublicRequest, ListImagesResponse>

• listPublic(
      request: ListPublicRequest,
  ): Request<ListPublicRequest, ListImagesResponse>

  Lists all public images available in a specific region. Regions doc https://docs.nebius.com/overview/regions Public images can contain specific labels in metadata like: "os_name: Ubuntu", "os_version: 22.04 LTS", "linux_kernel: 5.15", "cuda_toolkit: 13.0" "nvidia_gpu_drivers: 550", "networking_package: OFED 23.10"

  Parameters

  • request: ListPublicRequest

  Returns Request<ListPublicRequest, ListImagesResponse>

• listPublic(
      request: ListPublicRequest,
      metadata: Metadata,
  ): Request<ListPublicRequest, ListImagesResponse>

  Lists all public images available in a specific region. Regions doc https://docs.nebius.com/overview/regions Public images can contain specific labels in metadata like: "os_name: Ubuntu", "os_version: 22.04 LTS", "linux_kernel: 5.15", "cuda_toolkit: 13.0" "nvidia_gpu_drivers: 550", "networking_package: OFED 23.10"

  Parameters

  • request: ListPublicRequest
  • metadata: Metadata

  Returns Request<ListPublicRequest, ListImagesResponse>

• listPublic(
      request: ListPublicRequest,
      metadata: Metadata,
      options: Partial<CallOptions> & RetryOptions,
  ): Request<ListPublicRequest, ListImagesResponse>

  Lists all public images available in a specific region. Regions doc https://docs.nebius.com/overview/regions Public images can contain specific labels in metadata like: "os_name: Ubuntu", "os_version: 22.04 LTS", "linux_kernel: 5.15", "cuda_toolkit: 13.0" "nvidia_gpu_drivers: 550", "networking_package: OFED 23.10"

  Parameters

  • request: ListPublicRequest
  • metadata: Metadata
  • options: Partial<CallOptions> & RetryOptions

  Returns Request<ListPublicRequest, ListImagesResponse>

update

• update(
      request: UpdateImageRequest,
  ): Request<UpdateImageRequest, Operation<GetOperationRequest>>

  Updates an existing image resource. Only specific fields can be updated, such as labels and name.

  Parameters

  • request: UpdateImageRequest

  Returns Request<UpdateImageRequest, Operation<GetOperationRequest>>

• update(
      request: UpdateImageRequest,
      metadata: Metadata,
  ): Request<UpdateImageRequest, Operation<GetOperationRequest>>

  Parameters

  • request: UpdateImageRequest
  • metadata: Metadata

  Returns Request<UpdateImageRequest, Operation<GetOperationRequest>>

• update(
      request: UpdateImageRequest,
      metadata: Metadata,
      options: Partial<CallOptions> & RetryOptions,
  ): Request<UpdateImageRequest, Operation<GetOperationRequest>>

  Parameters

  • request: UpdateImageRequest
  • metadata: Metadata
  • options: Partial<CallOptions> & RetryOptions

  Returns Request<UpdateImageRequest, Operation<GetOperationRequest>>

• update(
      request: UpdateImageRequest,
  ): Request<UpdateImageRequest, Operation<GetOperationRequest>>

  Updates an existing image resource. Only specific fields can be updated, such as labels and name.

  Parameters

  • request: UpdateImageRequest

  Returns Request<UpdateImageRequest, Operation<GetOperationRequest>>

• update(
      request: UpdateImageRequest,
      metadata: Metadata,
  ): Request<UpdateImageRequest, Operation<GetOperationRequest>>

  Updates an existing image resource. Only specific fields can be updated, such as labels and name.

  Parameters

  • request: UpdateImageRequest
  • metadata: Metadata

  Returns Request<UpdateImageRequest, Operation<GetOperationRequest>>

• update(
      request: UpdateImageRequest,
      metadata: Metadata,
      options: Partial<CallOptions> & RetryOptions,
  ): Request<UpdateImageRequest, Operation<GetOperationRequest>>

  Updates an existing image resource. Only specific fields can be updated, such as labels and name.

  Parameters

  • request: UpdateImageRequest
  • metadata: Metadata
  • options: Partial<CallOptions> & RetryOptions

  Returns Request<UpdateImageRequest, Operation<GetOperationRequest>>