Copyright	(c) 2025
License	MIT
Maintainer
Stability	experimental
Safe Haskell	Safe-Inferred
Language	Haskell2010

Google.Cloud.Compute.Disk

Description

This module provides a Haskell client for Google Cloud Compute Engine Disk operations.

Synopsis

listDisks :: String -> String -> Maybe ListDisksQuery -> IO (Either String DiskResponse)
insertDisk :: String -> String -> InsertDiskOps -> Maybe InsertDiskQuery -> IO (Either String InsertDiskResponse)
data DiskResponse = DiskResponse {
- kind :: Maybe String
- id :: Maybe String
- items :: Maybe [DiskItem]
- nextPageToken :: Maybe String
- selfLink :: Maybe String
- warning :: Maybe Warning
}
data InsertDiskOps = InsertDiskOps {
- name :: String
- sizeGb :: String
- description :: Maybe String
- type_ :: Maybe String
- sourceImage :: Maybe String
- sourceSnapshot :: Maybe String
- labels :: Maybe (Map String String)
- guestOsFeatures :: Maybe [GuestOsFeature]
- diskEncryptionKey :: Maybe EncryptionKey
}
type InsertDiskResponse = Operation
data Operation = Operation {
- id :: Maybe String
- name :: Maybe String
- zone :: Maybe String
- operationType :: Maybe String
- targetLink :: Maybe String
- status :: Maybe String
- progress :: Maybe Int
- insertTime :: Maybe String
- startTime :: Maybe String
- endTime :: Maybe String
- error :: Maybe OperationError
- warnings :: Maybe [Warning]
- selfLink :: Maybe String
}
deleteDisk :: String -> String -> String -> Maybe DeleteDiskQuery -> IO (Either String Operation)
createDiskSnapshot :: String -> String -> String -> CreateSnapshotOps -> Maybe CreateSnapshotQuery -> IO (Either String CreateSnapshotResp)
type CreateSnapshotResp = Operation
data CreateSnapshotOps = CreateSnapshotOps {
- name :: String
- description :: Maybe String
- labels :: Maybe (Map String String)
- storageLocations :: Maybe [String]
- snapshotEncryptionKey :: Maybe EncryptionKey
}
data Warning = Warning {
- code :: String
- message :: String
- data_ :: Maybe [WarningData]
}
data WarningData = WarningData {
- key :: String
- value :: String
}
defaultCreateSnapshotOps :: String -> CreateSnapshotOps
defaultInsertOps :: String -> String -> InsertDiskOps

Documentation

listDisks Source #

Arguments

:: String	GCP Project ID
-> String	Zone name
-> Maybe ListDisksQuery	Optional query parameters
-> IO (Either String DiskResponse)	List result or error}

List disks in a zone

Example:

listDisks "my-project" "us-central1-a" Nothing

insertDisk Source #

Arguments

:: String	GCP Project ID
-> String	Zone name
-> InsertDiskOps	Disk configuration
-> Maybe InsertDiskQuery	Optional query parameters
-> IO (Either String InsertDiskResponse)	Operation or error}

Create a new persistent disk

Example:

insertDisk "my-project" "us-central1-a" (defaultInsertOps "disk1" "100") Nothing

data DiskResponse Source #

Response format for disk listing operations

Constructors

DiskResponse
Fields kind :: Maybe String Type identifier ("compute#diskList") id :: Maybe String Unique identifier for the resource items :: Maybe [DiskItem] List of disks in the project/zone nextPageToken :: Maybe String Pagination token for next page selfLink :: Maybe String Server-defined URL for the resource warning :: Maybe Warning Any warnings about the result

Instances

Instances details

FromJSON DiskResponse Source #
Instance details Defined in Google.Cloud.Compute.Disk Methods parseJSON :: Value -> Parser DiskResponse # parseJSONList :: Value -> Parser [DiskResponse] # omittedField :: Maybe DiskResponse #
ToJSON DiskResponse Source #
Instance details Defined in Google.Cloud.Compute.Disk Methods toJSON :: DiskResponse -> Value # toEncoding :: DiskResponse -> Encoding # toJSONList :: [DiskResponse] -> Value # toEncodingList :: [DiskResponse] -> Encoding # omitField :: DiskResponse -> Bool #
Show DiskResponse Source #
Instance details Defined in Google.Cloud.Compute.Disk Methods showsPrec :: Int -> DiskResponse -> ShowS # show :: DiskResponse -> String # showList :: [DiskResponse] -> ShowS #
Eq DiskResponse Source #
Instance details Defined in Google.Cloud.Compute.Disk Methods (==) :: DiskResponse -> DiskResponse -> Bool # (/=) :: DiskResponse -> DiskResponse -> Bool #

data InsertDiskOps Source #

Disk creation options

Constructors

InsertDiskOps

Fields

name :: String
Required disk name
sizeGb :: String
Required size in gigabytes
description :: Maybe String
Optional description
type_ :: Maybe String
Disk type (default: pd-standard)
sourceImage :: Maybe String
Source image URL for disk creation
sourceSnapshot :: Maybe String
Source snapshot URL for disk creation
labels :: Maybe (Map String String)
Initial labels
guestOsFeatures :: Maybe [GuestOsFeature]
OS features to enable
diskEncryptionKey :: Maybe EncryptionKey
Encryption configuration

Instances

Instances details

ToJSON InsertDiskOps Source #
Instance details Defined in Google.Cloud.Compute.Disk Methods toJSON :: InsertDiskOps -> Value # toEncoding :: InsertDiskOps -> Encoding # toJSONList :: [InsertDiskOps] -> Value # toEncodingList :: [InsertDiskOps] -> Encoding # omitField :: InsertDiskOps -> Bool #
Show InsertDiskOps Source #
Instance details Defined in Google.Cloud.Compute.Disk Methods showsPrec :: Int -> InsertDiskOps -> ShowS # show :: InsertDiskOps -> String # showList :: [InsertDiskOps] -> ShowS #
Eq InsertDiskOps Source #
Instance details Defined in Google.Cloud.Compute.Disk Methods (==) :: InsertDiskOps -> InsertDiskOps -> Bool # (/=) :: InsertDiskOps -> InsertDiskOps -> Bool #

type InsertDiskResponse = Operation Source #

Alias for operation response from disk insertion

data Operation Source #

Long-running operation resource

Constructors

Operation

Fields

id :: Maybe String
Unique operation ID
name :: Maybe String
Operation name
zone :: Maybe String
Zone where operation is executed
operationType :: Maybe String
Operation type (insert, delete, etc.)
targetLink :: Maybe String
URL of resource being modified
status :: Maybe String
Current status (DONE, RUNNING, etc.)
progress :: Maybe Int
Operation progress (0-100)
insertTime :: Maybe String
ISO 8601 creation timestamp
startTime :: Maybe String
ISO 8601 start timestamp
endTime :: Maybe String
ISO 8601 completion timestamp
error :: Maybe OperationError
Error details if failed
warnings :: Maybe [Warning]
Warnings during operation
selfLink :: Maybe String
Server-defined URL for the operation

Instances

Instances details

FromJSON Operation Source #
Instance details Defined in Google.Cloud.Compute.Disk Methods parseJSON :: Value -> Parser Operation # parseJSONList :: Value -> Parser [Operation] # omittedField :: Maybe Operation #
ToJSON Operation Source #
Instance details Defined in Google.Cloud.Compute.Disk Methods toJSON :: Operation -> Value # toEncoding :: Operation -> Encoding # toJSONList :: [Operation] -> Value # toEncodingList :: [Operation] -> Encoding # omitField :: Operation -> Bool #
Show Operation Source #
Instance details Defined in Google.Cloud.Compute.Disk Methods showsPrec :: Int -> Operation -> ShowS # show :: Operation -> String # showList :: [Operation] -> ShowS #
Eq Operation Source #
Instance details Defined in Google.Cloud.Compute.Disk Methods (==) :: Operation -> Operation -> Bool # (/=) :: Operation -> Operation -> Bool #

deleteDisk Source #

Arguments

:: String	GCP Project ID
-> String	Zone name
-> String	Disk name to delete
-> Maybe DeleteDiskQuery	Optional force deletion
-> IO (Either String Operation)	Operation or error

Deletes a disk with optional query parameters

Delete a persistent disk

Example:

deleteDisk "my-project" "us-central1-a" "old-disk" (Just DeleteDiskQuery { force = True })

createDiskSnapshot Source #

Arguments

:: String	GCP Project ID
-> String	Zone name
-> String	Source disk name
-> CreateSnapshotOps	Snapshot configuration
-> Maybe CreateSnapshotQuery	Optional guest flush
-> IO (Either String CreateSnapshotResp)	Operation or error

Creates a snapshot of a disk with optional query parameters | Create disk snapshot

Example:

createDiskSnapshot "my-project" "us-central1-a" "source-disk" 
  (defaultCreateSnapshotOps "daily-backup") Nothing

type CreateSnapshotResp = Operation Source #

Alias for operation response from snapshot creation

data CreateSnapshotOps Source #

Snapshot creation options

Constructors

CreateSnapshotOps
Fields name :: String Required snapshot name description :: Maybe String Optional description labels :: Maybe (Map String String) Labels for the snapshot storageLocations :: Maybe [String] Preferred storage locations snapshotEncryptionKey :: Maybe EncryptionKey Snapshot encryption

Instances

Instances details

ToJSON CreateSnapshotOps Source #
Instance details Defined in Google.Cloud.Compute.Disk Methods toJSON :: CreateSnapshotOps -> Value # toEncoding :: CreateSnapshotOps -> Encoding # toJSONList :: [CreateSnapshotOps] -> Value # toEncodingList :: [CreateSnapshotOps] -> Encoding # omitField :: CreateSnapshotOps -> Bool #
Show CreateSnapshotOps Source #
Instance details Defined in Google.Cloud.Compute.Disk Methods showsPrec :: Int -> CreateSnapshotOps -> ShowS # show :: CreateSnapshotOps -> String # showList :: [CreateSnapshotOps] -> ShowS #
Eq CreateSnapshotOps Source #
Instance details Defined in Google.Cloud.Compute.Disk Methods (==) :: CreateSnapshotOps -> CreateSnapshotOps -> Bool # (/=) :: CreateSnapshotOps -> CreateSnapshotOps -> Bool #

data Warning Source #

Represents a warning object returned by Google Cloud API operations

Constructors

Warning
Fields code :: String Warning type identifier message :: String Human-readable warning message data_ :: Maybe [WarningData] Optional metadata about the warning

Instances

Instances details

FromJSON Warning Source #
Instance details Defined in Google.Cloud.Compute.Disk Methods parseJSON :: Value -> Parser Warning # parseJSONList :: Value -> Parser [Warning] # omittedField :: Maybe Warning #
ToJSON Warning Source #
Instance details Defined in Google.Cloud.Compute.Disk Methods toJSON :: Warning -> Value # toEncoding :: Warning -> Encoding # toJSONList :: [Warning] -> Value # toEncodingList :: [Warning] -> Encoding # omitField :: Warning -> Bool #
Show Warning Source #
Instance details Defined in Google.Cloud.Compute.Disk Methods showsPrec :: Int -> Warning -> ShowS # show :: Warning -> String # showList :: [Warning] -> ShowS #
Eq Warning Source #
Instance details Defined in Google.Cloud.Compute.Disk Methods (==) :: Warning -> Warning -> Bool # (/=) :: Warning -> Warning -> Bool #

data WarningData Source #

Key-value pair providing additional context for warnings

Constructors

WarningData
Fields key :: String Metadata key describing the warning aspect value :: String Metadata value associated with the key

Instances

Instances details

FromJSON WarningData Source #
Instance details Defined in Google.Cloud.Compute.Disk Methods parseJSON :: Value -> Parser WarningData # parseJSONList :: Value -> Parser [WarningData] # omittedField :: Maybe WarningData #
ToJSON WarningData Source #
Instance details Defined in Google.Cloud.Compute.Disk Methods toJSON :: WarningData -> Value # toEncoding :: WarningData -> Encoding # toJSONList :: [WarningData] -> Value # toEncodingList :: [WarningData] -> Encoding # omitField :: WarningData -> Bool #
Show WarningData Source #
Instance details Defined in Google.Cloud.Compute.Disk Methods showsPrec :: Int -> WarningData -> ShowS # show :: WarningData -> String # showList :: [WarningData] -> ShowS #
Eq WarningData Source #
Instance details Defined in Google.Cloud.Compute.Disk Methods (==) :: WarningData -> WarningData -> Bool # (/=) :: WarningData -> WarningData -> Bool #

defaultCreateSnapshotOps :: String -> CreateSnapshotOps Source #

Default snapshot creation options

Creates minimal valid configuration with required snapshot name. Additional fields can be added using record update syntax:

defaultCreateSnapshotOps "backup" { description = Just "Daily backup" }

defaultInsertOps :: String -> String -> InsertDiskOps Source #

Default disk creation options

Creates minimal valid configuration with required name and size. Other fields can be added using record update syntax:

defaultInsertOps "new-disk" "50" { type_ = Just "pd-ssd" }