01README
Google Cloud gkebackup infrastructure models
02Models
@swamp/gcp/gkebackup/backupchannelsv2026.04.23.1backupchannels.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| description? | string | Optional. User specified descriptive string for this BackupChannel. |
| destinationProject? | string | Required. Immutable. The project where Backups are allowed to be stored. The format is `projects/{projectId}` or `projects/{projectNumber}`. |
| labels? | record | Optional. A set of custom labels supplied by user. |
| name? | string | Identifier. The fully qualified name of the BackupChannel. `projects/*/locations/*/backupChannels/*` |
| backupChannelId? | string | Optional. The client-provided short name for the BackupChannel resource. This name must: - be between 1 and 63 characters long (inclusive) - consist of only lower-case ASCII letters, numbers, and dashes - start with a lower-case letter - end with a lower-case letter or number - be unique within the set of BackupChannels in this location If the user does not provide a name, a uuid will be used as the name. |
| location? | string | The location for this resource (e.g., 'us', 'us-central1', 'europe-west1') |
fn create()
Create a backupChannels
fn get(identifier: string)
Get a backupChannels
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the backupChannels |
fn update()
Update backupChannels attributes
fn delete(identifier: string)
Delete the backupChannels
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the backupChannels |
fn sync()
Sync backupChannels state from GCP
Resources
state(infinite)— A BackupChannel imposes constraints on where clusters can be backed up. The B...
@swamp/gcp/gkebackup/backupchannels-backupplanbindingsv2026.04.23.1backupchannels_backupplanbindings.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| location? | string | The location for this resource (e.g., 'us', 'us-central1', 'europe-west1') |
fn get(identifier: string)
Get a backupPlanBindings
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the backupPlanBindings |
fn sync()
Sync backupPlanBindings state from GCP
Resources
state(infinite)— A BackupPlanBinding binds a BackupPlan with a BackupChannel. This resource is...
@swamp/gcp/gkebackup/backupplansv2026.04.23.1backupplans.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| backupConfig? | object | BackupConfig defines the configuration of Backups created via this BackupPlan. |
| backupSchedule? | object | Defines scheduling parameters for automatically creating Backups via this BackupPlan. |
| cluster? | string | Required. Immutable. The source cluster from which Backups will be created via this BackupPlan. Valid formats: - `projects/*/locations/*/clusters/*` - `projects/*/zones/*/clusters/*` |
| deactivated? | boolean | Optional. This flag indicates whether this BackupPlan has been deactivated. Setting this field to True locks the BackupPlan such that no further updates will be allowed (except deletes), including the deactivated field itself. It also prevents any new Backups from being created via this BackupPlan (including scheduled Backups). Default: False |
| description? | string | Optional. User specified descriptive string for this BackupPlan. |
| labels? | record | Optional. A set of custom labels supplied by user. |
| retentionPolicy? | object | RetentionPolicy defines a Backup retention policy for a BackupPlan. |
| backupPlanId? | string | Required. The client-provided short name for the BackupPlan resource. This name must: - be between 1 and 63 characters long (inclusive) - consist of only lower-case ASCII letters, numbers, and dashes - start with a lower-case letter - end with a lower-case letter or number - be unique within the set of BackupPlans in this location |
| location? | string | The location for this resource (e.g., 'us', 'us-central1', 'europe-west1') |
fn create(waitForReady?: boolean)
Create a backupPlans
| Argument | Type | Description |
|---|---|---|
| waitForReady? | boolean | Wait for the resource to reach a ready state after creation (default: true) |
fn get(identifier: string)
Get a backupPlans
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the backupPlans |
fn update(waitForReady?: boolean)
Update backupPlans attributes
| Argument | Type | Description |
|---|---|---|
| waitForReady? | boolean | Wait for the resource to reach a ready state after update (default: true) |
fn delete(identifier: string)
Delete the backupPlans
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the backupPlans |
fn sync()
Sync backupPlans state from GCP
fn get_tags()
get tags
fn set_tags(etag?: any, name?: any, requestId?: any, tags?: any)
set tags
| Argument | Type | Description |
|---|---|---|
| etag? | any | |
| name? | any | |
| requestId? | any | |
| tags? | any |
Resources
state(infinite)— Defines the configuration and scheduling for a "line" of Backups.
@swamp/gcp/gkebackup/backupplans-backupsv2026.04.23.1backupplans_backups.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| clusterMetadata? | object | Information about the GKE cluster from which this Backup was created. |
| deleteLockDays? | number | Optional. Minimum age for this Backup (in days). If this field is set to a non-zero value, the Backup will be "locked" against deletion (either manual or automatic deletion) for the number of days provided (measured from the creation time of the Backup). MUST be an integer value between 0-90 (inclusive). Defaults to parent BackupPlan\ |
| description? | string | Optional. User specified descriptive string for this Backup. |
| encryptionKey? | object | Defined a customer managed encryption key that will be used to encrypt Backup artifacts. |
| labels? | record | Optional. A set of custom labels supplied by user. |
| retainDays? | number | Optional. The age (in days) after which this Backup will be automatically deleted. Must be an integer value >= 0: - If 0, no automatic deletion will occur for this Backup. - If not 0, this must be >= delete_lock_days and <= 365. Once a Backup is created, this value may only be increased. Defaults to the parent BackupPlan's backup_retain_days value. |
| selectedApplications? | object | A list of namespaced Kubernetes resources. |
| selectedNamespaceLabels? | object | A list of Kubernetes labels. |
| selectedNamespaces? | object | A list of Kubernetes Namespaces. |
| troubleshootingInfo? | object | Stores information about troubleshooting doc for debugging a particular state of an operation (eg - backup/restore). This will be used by the end user to debug their operation failure scenario easily. |
| backupId? | string | Optional. The client-provided short name for the Backup resource. This name must: - be between 1 and 63 characters long (inclusive) - consist of only lower-case ASCII letters, numbers, and dashes - start with a lower-case letter - end with a lower-case letter or number - be unique within the set of Backups in this BackupPlan |
| location? | string | The location for this resource (e.g., 'us', 'us-central1', 'europe-west1') |
fn create(waitForReady?: boolean)
Create a backups
| Argument | Type | Description |
|---|---|---|
| waitForReady? | boolean | Wait for the resource to reach a ready state after creation (default: true) |
fn get(identifier: string)
Get a backups
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the backups |
fn update(waitForReady?: boolean)
Update backups attributes
| Argument | Type | Description |
|---|---|---|
| waitForReady? | boolean | Wait for the resource to reach a ready state after update (default: true) |
fn delete(identifier: string)
Delete the backups
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the backups |
fn sync()
Sync backups state from GCP
fn get_backup_index_download_url()
get backup index download url
Resources
state(infinite)— Represents a request to perform a single point-in-time capture of some portio...
@swamp/gcp/gkebackup/backupplans-backups-volumebackupsv2026.04.23.1backupplans_backups_volumebackups.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| location? | string | The location for this resource (e.g., 'us', 'us-central1', 'europe-west1') |
fn get(identifier: string)
Get a volumeBackups
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the volumeBackups |
fn sync()
Sync volumeBackups state from GCP
Resources
state(infinite)— Represents the backup of a specific persistent volume as a component of a Bac...
@swamp/gcp/gkebackup/locationsv2026.04.23.1locations.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
fn get(identifier: string)
Get a locations
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the locations |
fn sync()
Sync locations state from GCP
Resources
state(infinite)— A resource that represents a Google Cloud location.
@swamp/gcp/gkebackup/restorechannelsv2026.04.23.1restorechannels.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| description? | string | Optional. User specified descriptive string for this RestoreChannel. |
| destinationProject? | string | Required. Immutable. The project into which the backups will be restored. The format is `projects/{projectId}` or `projects/{projectNumber}`. |
| labels? | record | Optional. A set of custom labels supplied by user. |
| name? | string | Identifier. The fully qualified name of the RestoreChannel. `projects/*/locations/*/restoreChannels/*` |
| restoreChannelId? | string | Optional. The client-provided short name for the RestoreChannel resource. This name must: - be between 1 and 63 characters long (inclusive) - consist of only lower-case ASCII letters, numbers, and dashes - start with a lower-case letter - end with a lower-case letter or number - be unique within the set of RestoreChannels in this location If the user does not provide a name, a uuid will be used as the name. |
| location? | string | The location for this resource (e.g., 'us', 'us-central1', 'europe-west1') |
fn create()
Create a restoreChannels
fn get(identifier: string)
Get a restoreChannels
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the restoreChannels |
fn update()
Update restoreChannels attributes
fn delete(identifier: string)
Delete the restoreChannels
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the restoreChannels |
fn sync()
Sync restoreChannels state from GCP
Resources
state(infinite)— A RestoreChannel imposes constraints on where backups can be restored. The Re...
@swamp/gcp/gkebackup/restorechannels-restoreplanbindingsv2026.04.23.1restorechannels_restoreplanbindings.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| location? | string | The location for this resource (e.g., 'us', 'us-central1', 'europe-west1') |
fn get(identifier: string)
Get a restorePlanBindings
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the restorePlanBindings |
fn sync()
Sync restorePlanBindings state from GCP
Resources
state(infinite)— A RestorePlanBinding binds a RestorePlan with a RestoreChannel. This resource...
@swamp/gcp/gkebackup/restoreplansv2026.04.23.1restoreplans.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| backupPlan? | string | Required. Immutable. A reference to the BackupPlan from which Backups may be used as the source for Restores created via this RestorePlan. Format: `projects/*/locations/*/backupPlans/*`. |
| cluster? | string | Required. Immutable. The target cluster into which Restores created via this RestorePlan will restore data. NOTE: the cluster's region must be the same as the RestorePlan. Valid formats: - `projects/*/locations/*/clusters/*` - `projects/*/zones/*/clusters/*` |
| description? | string | Optional. User specified descriptive string for this RestorePlan. |
| labels? | record | Optional. A set of custom labels supplied by user. |
| restoreConfig? | object | Configuration of a restore. |
| restorePlanId? | string | Required. The client-provided short name for the RestorePlan resource. This name must: - be between 1 and 63 characters long (inclusive) - consist of only lower-case ASCII letters, numbers, and dashes - start with a lower-case letter - end with a lower-case letter or number - be unique within the set of RestorePlans in this location |
| location? | string | The location for this resource (e.g., 'us', 'us-central1', 'europe-west1') |
fn create(waitForReady?: boolean)
Create a restorePlans
| Argument | Type | Description |
|---|---|---|
| waitForReady? | boolean | Wait for the resource to reach a ready state after creation (default: true) |
fn get(identifier: string)
Get a restorePlans
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the restorePlans |
fn update(waitForReady?: boolean)
Update restorePlans attributes
| Argument | Type | Description |
|---|---|---|
| waitForReady? | boolean | Wait for the resource to reach a ready state after update (default: true) |
fn delete(identifier: string)
Delete the restorePlans
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the restorePlans |
fn sync()
Sync restorePlans state from GCP
fn get_tags()
get tags
fn set_tags(etag?: any, name?: any, requestId?: any, tags?: any)
set tags
| Argument | Type | Description |
|---|---|---|
| etag? | any | |
| name? | any | |
| requestId? | any | |
| tags? | any |
Resources
state(infinite)— The configuration of a potential series of Restore operations to be performed...
@swamp/gcp/gkebackup/restoreplans-restoresv2026.04.23.1restoreplans_restores.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| backup? | string | Required. Immutable. A reference to the Backup used as the source from which this Restore will restore. Note that this Backup must be a sub-resource of the RestorePlan's backup_plan. Format: `projects/*/locations/*/backupPlans/*/backups/*`. |
| description? | string | Optional. User specified descriptive string for this Restore. |
| filter? | object | Defines the filter for `Restore`. This filter can be used to further refine the resource selection of the `Restore` beyond the coarse-grained scope defined in the `RestorePlan`. `exclusion_filters` take precedence over `inclusion_filters`. If a resource matches both `inclusion_filters` and `exclusion_filters`, it will not be restored. |
| labels? | record | A set of custom labels supplied by user. |
| restoreConfig? | object | Configuration of a restore. |
| troubleshootingInfo? | object | Stores information about troubleshooting doc for debugging a particular state of an operation (eg - backup/restore). This will be used by the end user to debug their operation failure scenario easily. |
| volumeDataRestorePolicyOverrides? | array | Optional. Immutable. Overrides the volume data restore policies selected in the Restore Config for override-scoped resources. |
| restoreId? | string | Required. The client-provided short name for the Restore resource. This name must: - be between 1 and 63 characters long (inclusive) - consist of only lower-case ASCII letters, numbers, and dashes - start with a lower-case letter - end with a lower-case letter or number - be unique within the set of Restores in this RestorePlan. |
| location? | string | The location for this resource (e.g., 'us', 'us-central1', 'europe-west1') |
fn create(waitForReady?: boolean)
Create a restores
| Argument | Type | Description |
|---|---|---|
| waitForReady? | boolean | Wait for the resource to reach a ready state after creation (default: true) |
fn get(identifier: string)
Get a restores
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the restores |
fn update(waitForReady?: boolean)
Update restores attributes
| Argument | Type | Description |
|---|---|---|
| waitForReady? | boolean | Wait for the resource to reach a ready state after update (default: true) |
fn delete(identifier: string)
Delete the restores
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the restores |
fn sync()
Sync restores state from GCP
Resources
state(infinite)— Represents both a request to Restore some portion of a Backup into a target G...
@swamp/gcp/gkebackup/restoreplans-restores-volumerestoresv2026.04.23.1restoreplans_restores_volumerestores.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| location? | string | The location for this resource (e.g., 'us', 'us-central1', 'europe-west1') |
fn get(identifier: string)
Get a volumeRestores
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the volumeRestores |
fn sync()
Sync volumeRestores state from GCP
Resources
state(infinite)— Represents the operation of restoring a volume from a VolumeBackup.
03Previous Versions
2026.04.04.1Apr 4, 2026
- Updated: backupchannels_backupplanbindings, backupplans, restoreplans, restoreplans_restores
2026.04.03.3Apr 3, 2026
- Updated: locations, backupchannels, backupchannels_backupplanbindings, backupplans, backupplans_backups, backupplans_backups_volumebackups, restorechannels, restorechannels_restoreplanbindings, restoreplans, restoreplans_restores, restoreplans_restores_volumerestores
2026.04.03.1Apr 3, 2026
- Updated: locations, backupchannels, backupchannels_backupplanbindings, backupplans, backupplans_backups, backupplans_backups_volumebackups, restorechannels, restorechannels_restoreplanbindings, restoreplans, restoreplans_restores, restoreplans_restores_volumerestores
2026.04.02.2Apr 2, 2026
2026.03.27.1Mar 27, 2026
- Added: locations, backupchannels, backupchannels_backupplanbindings, backupplans, backupplans_backups, backupplans_backups_volumebackups, restorechannels, restorechannels_restoreplanbindings, restoreplans, restoreplans_restores, restoreplans_restores_volumerestores
04Stats
A
100 / 100
Downloads
0
Archive size
72.0 KB
Verified by Swamp
- Has README or module doc2/2earned
- README has a code example1/1earned
- README is substantive1/1earned
- Most symbols documented1/1earned
- No slow types1/1earned
- Has description1/1earned
- At least one platform tag (or universal)1/1earned
- Two or more platform tags (or universal)1/1earned
- License declared1/1earned
- Verified public repository2/2earned
05Platforms
06Labels