R/disks.R

In cloudyr/googleComputeEngineR: R Interface with Google Compute Engine

#' AttachedDisk Object
#' 
#' @details 
#' An instance-attached disk resource.
#' 
#' @param autoDelete Specifies whether the disk will be auto-deleted when the instance is deleted (but not when the disk is detached from the instance)
#' @param boot Indicates that this is a boot disk
#' @param deviceName Specifies a unique device name of your choice that is reflected into the /dev/disk/by-id/google-* tree of a Linux operating system running within the instance
#' @param diskEncryptionKey Encrypts or decrypts a disk using a customer-supplied encryption key
#' @param index Assigns a zero-based index to this disk, where 0 is reserved for the boot disk
#' @param initializeParams A \link{gce_make_boot_disk} object for creating boot disks. Cannot be used with \code{source} also defined.
#' @param interface Specifies the disk interface to use for attaching this disk, which is either SCSI or NVME
#' @param licenses [Output Only] Any valid publicly visible licenses
#' @param mode The mode in which to attach this disk, either READ_WRITE or READ_ONLY
#' @param source Specifies a valid partial or full URL to an existing Persistent Disk resource
#' @param type Specifies the type of the disk, either SCRATCH or PERSISTENT
#' 
#' @return AttachedDisk object
#' 
#' @family AttachedDisk functions
#' @keywords internal
AttachedDisk <- function(autoDelete = NULL, 
                         boot = NULL, 
                         deviceName = NULL, 
                         diskEncryptionKey = NULL, 
                         index = NULL, 
                         initializeParams = NULL, 
                         interface = NULL, 
                         licenses = NULL, 
                         mode = NULL, 
                         source = NULL, 
                         type = NULL) {
  
  structure(list(autoDelete = autoDelete, 
                 boot = boot, 
                 deviceName = deviceName, 
                 diskEncryptionKey = diskEncryptionKey, 
                 index = index, 
                 initializeParams = initializeParams, 
                 interface = interface, 
                 licenses = licenses, 
                 mode = mode, 
                 source = source, 
                 type = type), class = "gar_AttachedDisk")
}

#' Make a boot disk for attachment to an instance
#' 
#' @details 
#' Specifies the parameters for a new disk that will be created alongside the new instance. 
#' 
#' Use initialization parameters to create boot disks or local SSDs attached to the new instance.
#' 
#' This property is mutually exclusive with the source property; you can only define one or the other, but not both.
#' 
#' @param diskName Specifies the disk name
#' @param diskSizeGb Specifies the size of the disk in base-2 GB
#' @param diskType Specifies the disk type to use to create the instance
#' @param sourceImage The source image used to create this disk
#' @param sourceImageEncryptionKey The customer-supplied encryption key of the source image
#' 
#' @return AttachedDiskInitializeParams object
#' 
#' @family AttachedDiskInitializeParams functions
#' @export
gce_make_boot_disk <- function(diskName = NULL, 
                               diskSizeGb = NULL, 
                               diskType = NULL, 
                               sourceImage = NULL, 
                               sourceImageEncryptionKey = NULL) {
  
  structure(list(diskName = diskName, diskSizeGb = diskSizeGb, diskType = diskType, 
                 sourceImage = sourceImage, sourceImageEncryptionKey = sourceImageEncryptionKey), 
            class = "gar_AttachedDiskInitializeParams")
}

#' Attaches a Disk resource to an instance.
#' 
#' 
#' @seealso \href{https://cloud.google.com/compute/docs/reference/latest/disks}{Google Documentation}
#' 
#' @details 
#' Authentication scopes used by this function are:
#' \itemize{
#'   \item https://www.googleapis.com/auth/cloud-platform
#' \item https://www.googleapis.com/auth/compute
#' }
#' 
#' @inheritParams AttachedDisk
#' @param project Project ID for this request
#' @param zone The name of the zone for this request
#' @param instance The instance name for this request
#' @importFrom googleAuthR gar_api_generator
#' @family AttachedDisk functions
#' @export
gce_attach_disk <- function(instance,
                            source = NULL, 
                            autoDelete = NULL, 
                            boot = NULL, 
                            deviceName = NULL, 
                            diskEncryptionKey = NULL, 
                            index = NULL, 
                            initializeParams = NULL, 
                            interface = NULL, 
                            licenses = NULL, 
                            mode = NULL, 
                            type = NULL, 
                            project = gce_get_global_project(), 
                            zone = gce_get_global_zone()) {
  
  url <- sprintf("https://www.googleapis.com/compute/v1/projects/%s/zones/%s/instances/%s/attachDisk", 
                 project, zone, instance)
  
  # compute.instances.attachDisk
  f <- gar_api_generator(url, "POST", data_parse_function = function(x) x)
  
  attach_me <- AttachedDisk(autoDelete = autoDelete, 
                            boot = boot, 
                            deviceName = deviceName, 
                            diskEncryptionKey = diskEncryptionKey, 
                            index = index, 
                            initializeParams = initializeParams, 
                            interface = interface, 
                            licenses = licenses, 
                            mode = mode, 
                            source = source, 
                            type = type)
  stopifnot(inherits(attach_me, "gar_AttachedDisk"))
  
  out <- f(the_body = attach_me)
  
  as.zone_operation(out)
}



#' Disk Object
#' 
#' @details 
#' A Disk resource.
#' 
#' @param description An optional description of this resource
#' @param diskEncryptionKey Encrypts the disk using a customer-supplied encryption key
#' @param licenses Any applicable publicly visible licenses
#' @param name Name of the resource
#' @param sizeGb Size of the persistent disk, specified in GB
#' @param sourceImage The source image used to create this disk
#' @param sourceImageEncryptionKey The customer-supplied encryption key of the source image
#' @param sourceSnapshot The source snapshot used to create this disk
#' @param sourceSnapshotEncryptionKey The customer-supplied encryption key of the source snapshot
#' @param type URL of the disk type resource describing which disk type to use to create the disk
#' 
#' @return Disk object
#' 
#' @family Disk functions
#' @keywords internal
Disk <- function(name = NULL, 
                 sourceImage = NULL, 
                 sizeGb = NULL, 
                 description = NULL, 
                 diskEncryptionKey = NULL, 
                 licenses = NULL, 
                 sourceImageEncryptionKey = NULL, 
                 sourceSnapshot = NULL, 
                 sourceSnapshotEncryptionKey = NULL, 
                 type = NULL) {
  
  structure(list(description = description, 
                 diskEncryptionKey = diskEncryptionKey,
                 licenses = licenses, 
                 sourceImage = sourceImage,
                 name = name, 
                 sizeGb = sizeGb, 
                 sourceImageEncryptionKey = sourceImageEncryptionKey, 
                 sourceSnapshot = sourceSnapshot, 
                 sourceSnapshotEncryptionKey = sourceSnapshotEncryptionKey, 
                 type = type), class = c("list","gar_Disk"))
}

#' Creates a persistent disk in the specified project using the data in the request. 
#' 
#' You can create a disk with a sourceImage, a sourceSnapshot, or create an empty 500 GB data disk by omitting all properties. 
#' 
#' You can also create a disk that is larger than the default size by specifying the sizeGb property.
#' 
#' 
#' @seealso \href{https://developers.google.com/compute/docs/reference/latest/}{Google Documentation}
#' 
#' @details 
#' Authentication scopes used by this function are:
#' \itemize{
#'   \item https://www.googleapis.com/auth/cloud-platform
#' \item https://www.googleapis.com/auth/compute
#' }
#' 
#' 
#' @inheritParams Disk
#' @param project Project ID for this request
#' @param zone The name of the zone for this request
#' 
#' @importFrom googleAuthR gar_api_generator
#' 
#' @return a zone operation
#' 
#' @export
gce_make_disk <- function(name, 
                          sourceImage = NULL, 
                          sizeGb = NULL, 
                          description = NULL, 
                          diskEncryptionKey = NULL, 
                          licenses = NULL, 
                          sourceSnapshot = NULL, 
                          sourceImageEncryptionKey = NULL, 
                          sourceSnapshotEncryptionKey = NULL, 
                          type = NULL, 
                          project = gce_get_global_project(), 
                          zone = gce_get_global_zone()) {
  
  check <- gce_list_disks(project = project, zone = zone)
  
  if(name %in% check$items$name){
    myMessage("Disk of that name already exists", level = 3)
    return(gce_get_disk(name, project = project, zone = zone))
  }
  
  url <- sprintf("https://www.googleapis.com/compute/v1/projects/%s/zones/%s/disks", 
                 project, zone)
  
  a_disk <- Disk(name = name, 
                 sourceImage = sourceImage, 
                 sizeGb = sizeGb, 
                 description = description, 
                 diskEncryptionKey = diskEncryptionKey, 
                 licenses = licenses, 
                 sourceImageEncryptionKey = sourceImageEncryptionKey, 
                 sourceSnapshot = sourceSnapshot, 
                 sourceSnapshotEncryptionKey = sourceImageEncryptionKey, 
                 type = type)
  
  # compute.disks.insert
  f <- gar_api_generator(url, 
                         "POST", 
                         data_parse_function = function(x) x)
  
  out <- f(the_body = a_disk)
  
  as.zone_operation(out)
}


#' Retrieves an aggregated list of persistent disks across all zones.
#'
#'
#' @seealso \href{https://developers.google.com/compute/docs/reference/latest/}{Google Documentation}
#'
#' @details
#' Authentication scopes used by this function are:
#' \itemize{
#'   \item https://www.googleapis.com/auth/cloud-platform
#' \item https://www.googleapis.com/auth/compute
#' \item https://www.googleapis.com/auth/compute.readonly
#' }
#'
#'
#' @param project Project ID for this request
#' @param filter Sets a filter expression for filtering listed resources, in the form filter={expression}
#' @param maxResults The maximum number of results per page that should be returned
#' @param pageToken Specifies a page token to use
#' @importFrom googleAuthR gar_api_generator
#' @export
gce_list_disks_all <- function(filter = NULL, 
                               maxResults = NULL, 
                               pageToken = NULL, 
                               project = gce_get_global_project()) {
  
  url <- sprintf("https://www.googleapis.com/compute/v1/projects/%s/aggregated/disks",
                 project)
  pars <- list(filter = filter, maxResults = maxResults,
               pageToken = pageToken)
  pars <- rmNullObs(pars)
  # compute.disks.aggregatedList
  f <- gar_api_generator(url, 
                         "GET", 
                         pars_args = pars, 
                         data_parse_function = function(x) x)
  f()

}
# 
# #' Creates a snapshot of a specified persistent disk.
# #'
# #' Autogenerated via \code{\link[googleAuthR]{gar_create_api_skeleton}}
# #'
# #' @seealso \href{https://developers.google.com/compute/docs/reference/latest/}{Google Documentation}
# #'
# #' @details
# #' Authentication scopes used by this function are:
# #' \itemize{
# #'   \item https://www.googleapis.com/auth/cloud-platform
# #' \item https://www.googleapis.com/auth/compute
# #' }
# #'
# #' Set \code{options(googleAuthR.scopes.selected = c(https://www.googleapis.com/auth/cloud-platform, https://www.googleapis.com/auth/compute)}
# #' Then run \code{googleAuthR::gar_auth()} to authenticate.
# #' See \code{\link[googleAuthR]{gar_auth}} for details.
# #'
# #' @param Snapshot The \link{Snapshot} object to pass to this method
# #' @param project Project ID for this request
# #' @param zone The name of the zone for this request
# #' @param disk Name of the persistent disk to snapshot
# #' @importFrom googleAuthR gar_api_generator
# #' @family Snapshot functions
# #' @export
# disks.createSnapshot <- function(Snapshot, project, zone, disk) {
#   url <- sprintf("https://www.googleapis.com/compute/v1/projects/%s/zones/%s/disks/%s/createSnapshot",
#                  disk, project, zone)
#   # compute.disks.createSnapshot
#   f <- gar_api_generator(url, "POST", data_parse_function = function(x) x)
#   stopifnot(inherits(Snapshot, "gar_Snapshot"))
# 
#   f(the_body = Snapshot)
# 
# }

#' Deletes the specified persistent disk. 
#' 
#' Deleting a disk removes its data permanently and is irreversible. 
#' 
#' However, deleting a disk does not delete any snapshots previously made from the disk. 
#' You must separately delete snapshots.
#'
#'
#' @seealso \href{https://developers.google.com/compute/docs/reference/latest/}{Google Documentation}
#'
#' @details
#' Authentication scopes used by this function are:
#' \itemize{
#'   \item https://www.googleapis.com/auth/cloud-platform
#' \item https://www.googleapis.com/auth/compute
#' }
#'
#'
#' @param project Project ID for this request
#' @param zone The name of the zone for this request
#' @param disk Name of the persistent disk to delete
#' @importFrom googleAuthR gar_api_generator
#' @export
gce_delete_disk <- function(disk, 
                            project = gce_get_global_project(), 
                            zone = gce_get_global_zone()) {
  
  url <- sprintf("https://www.googleapis.com/compute/v1/projects/%s/zones/%s/disks/%s",
                 project, zone, disk)
  
  # compute.disks.delete
  f <- gar_api_generator(url, 
                         "DELETE", 
                         data_parse_function = function(x) x)
  suppressWarnings(f())

}

#' Returns a specified persistent disk.
#'
#'
#' @seealso \href{https://developers.google.com/compute/docs/reference/latest/}{Google Documentation}
#'
#' @details
#' Authentication scopes used by this function are:
#' \itemize{
#'   \item https://www.googleapis.com/auth/cloud-platform
#' \item https://www.googleapis.com/auth/compute
#' \item https://www.googleapis.com/auth/compute.readonly
#' }
#'
#'
#' @param project Project ID for this request
#' @param zone The name of the zone for this request
#' @param disk Name of the persistent disk to return
#' @importFrom googleAuthR gar_api_generator
#' @export
gce_get_disk <- function(disk, 
                         project = gce_get_global_project(), 
                         zone = gce_get_global_zone()) {
  
  url <- sprintf("https://www.googleapis.com/compute/v1/projects/%s/zones/%s/disks/%s",
                 project, zone, disk)
  
  # compute.disks.get
  f <- gar_api_generator(url, 
                         "GET", 
                         data_parse_function = function(x) x)
  f()

}



#' Retrieves a list of persistent disks contained within the specified zone.
#'
#'
#' @seealso \href{https://developers.google.com/compute/docs/reference/latest/}{Google Documentation}
#'
#' @details
#' Authentication scopes used by this function are:
#' \itemize{
#'   \item https://www.googleapis.com/auth/cloud-platform
#' \item https://www.googleapis.com/auth/compute
#' \item https://www.googleapis.com/auth/compute.readonly
#' }
#'
#'
#' @param project Project ID for this request
#' @param zone The name of the zone for this request
#' @param filter Sets a filter expression for filtering listed resources, in the form filter={expression}
#' @param maxResults The maximum number of results per page that should be returned
#' @param pageToken Specifies a page token to use
#' @importFrom googleAuthR gar_api_generator
#' @export
gce_list_disks <- function(filter = NULL, 
                           maxResults = NULL, 
                           pageToken = NULL, 
                           project = gce_get_global_project(), 
                           zone = gce_get_global_zone()) {
  
  url <- sprintf("https://www.googleapis.com/compute/v1/projects/%s/zones/%s/disks",
                 project, zone)
  
  pars <- list(filter = filter, maxResults = maxResults,
               pageToken = pageToken)
  pars <- rmNullObs(pars)
  # compute.disks.list
  f <- gar_api_generator(url, 
                         "GET", 
                         pars_args = pars, 
                         data_parse_function = function(x) x)
  f()

}
# 
# #' Resizes the specified persistent disk.
# #'
# #' Autogenerated via \code{\link[googleAuthR]{gar_create_api_skeleton}}
# #'
# #' @seealso \href{https://developers.google.com/compute/docs/reference/latest/}{Google Documentation}
# #'
# #' @details
# #' Authentication scopes used by this function are:
# #' \itemize{
# #'   \item https://www.googleapis.com/auth/cloud-platform
# #' \item https://www.googleapis.com/auth/compute
# #' }
# #'
# #' Set \code{options(googleAuthR.scopes.selected = c(https://www.googleapis.com/auth/cloud-platform, https://www.googleapis.com/auth/compute)}
# #' Then run \code{googleAuthR::gar_auth()} to authenticate.
# #' See \code{\link[googleAuthR]{gar_auth}} for details.
# #'
# #' @param DisksResizeRequest The \link{DisksResizeRequest} object to pass to this method
# #' @param project Project ID for this request
# #' @param zone The name of the zone for this request
# #' @param disk The name of the persistent disk
# #' @importFrom googleAuthR gar_api_generator
# #' @family DisksResizeRequest functions
# #' @export
# disks.resize <- function(DisksResizeRequest, project, zone, disk) {
#   url <- sprintf("https://www.googleapis.com/compute/v1/projects/%s/zones/%s/disks/%s/resize",
#                  disk, project, zone)
#   # compute.disks.resize
#   f <- gar_api_generator(url, "POST", data_parse_function = function(x) x)
#   stopifnot(inherits(DisksResizeRequest, "gar_DisksResizeRequest"))
# 
#   f(the_body = DisksResizeRequest)
# 
# }