Movatterモバイル変換


[0]ホーム

URL:


gkebackup

package
v0.257.0Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Dec 2, 2025 License:BSD-3-ClauseImports:18Imported by:0

Details

Repository

github.com/googleapis/google-api-go-client

Links

Documentation

Overview

Package gkebackup provides access to the Backup for GKE API.

For product documentation, see:https://cloud.google.com/kubernetes-engine/docs/add-on/backup-for-gke

Library status

These client libraries are officially supported by Google. However, thislibrary is considered complete and is in maintenance mode. This meansthat we will address critical bugs and security issues but will not addany new features.

When possible, we recommend using our newer[Cloud Client Libraries for Go](https://pkg.go.dev/cloud.google.com/go)that are still actively being worked and iterated on.

Creating a client

Usage example:

import "google.golang.org/api/gkebackup/v1"...ctx := context.Background()gkebackupService, err := gkebackup.NewService(ctx)

In this example, Google Application Default Credentials are used forauthentication. For information on how to create and obtain ApplicationDefault Credentials, seehttps://developers.google.com/identity/protocols/application-default-credentials.

Other authentication options

To use an API key for authentication (note: some APIs do not support APIkeys), usegoogle.golang.org/api/option.WithAPIKey:

gkebackupService, err := gkebackup.NewService(ctx, option.WithAPIKey("AIza..."))

To use an OAuth token (e.g., a user token obtained via a three-legged OAuthflow, usegoogle.golang.org/api/option.WithTokenSource:

config := &oauth2.Config{...}// ...token, err := config.Exchange(ctx, ...)gkebackupService, err := gkebackup.NewService(ctx, option.WithTokenSource(config.TokenSource(ctx, token)))

Seegoogle.golang.org/api/option.ClientOption for details on options.

Index

Constants

View Source
const (// See, edit, configure, and delete your Google Cloud data and see the email// address for your Google Account.CloudPlatformScope = "https://www.googleapis.com/auth/cloud-platform")

OAuth2 scopes used by this API.

Variables

This section is empty.

Functions

This section is empty.

Types

typeAuditConfig

type AuditConfig struct {// AuditLogConfigs: The configuration for logging of each type of permission.AuditLogConfigs []*AuditLogConfig `json:"auditLogConfigs,omitempty"`// Service: Specifies a service that will be enabled for audit logging. For// example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices`// is a special value that covers all services.Servicestring `json:"service,omitempty"`// ForceSendFields is a list of field names (e.g. "AuditLogConfigs") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "AuditLogConfigs") to include in// API requests with the JSON null value. By default, fields with empty values// are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

AuditConfig: Specifies the audit configuration for a service. Theconfiguration determines which permission types are logged, and whatidentities, if any, are exempted from logging. An AuditConfig must have oneor more AuditLogConfigs. If there are AuditConfigs for both `allServices`and a specific service, the union of the two AuditConfigs is used for thatservice: the log_types specified in each AuditConfig are enabled, and theexempted_members in each AuditLogConfig are exempted. Example Policy withmultiple AuditConfigs: { "audit_configs": [ { "service": "allServices","audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": ["user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type":"ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com","audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type":"DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } Forsampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READlogging. It also exempts `jose@example.com` from DATA_READ logging, and`aliya@example.com` from DATA_WRITE logging.

func (AuditConfig)MarshalJSON

func (sAuditConfig) MarshalJSON() ([]byte,error)

typeAuditLogConfig

type AuditLogConfig struct {// ExemptedMembers: Specifies the identities that do not cause logging for this// type of permission. Follows the same format of Binding.members.ExemptedMembers []string `json:"exemptedMembers,omitempty"`// LogType: The log type that this config enables.//// Possible values://   "LOG_TYPE_UNSPECIFIED" - Default case. Should never be this.//   "ADMIN_READ" - Admin reads. Example: CloudIAM getIamPolicy//   "DATA_WRITE" - Data writes. Example: CloudSQL Users create//   "DATA_READ" - Data reads. Example: CloudSQL Users listLogTypestring `json:"logType,omitempty"`// ForceSendFields is a list of field names (e.g. "ExemptedMembers") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "ExemptedMembers") to include in// API requests with the JSON null value. By default, fields with empty values// are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

AuditLogConfig: Provides the configuration for logging a type ofpermissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ","exempted_members": [ "user:jose@example.com" ] }, { "log_type":"DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, whileexempting jose@example.com from DATA_READ logging.

func (AuditLogConfig)MarshalJSON

func (sAuditLogConfig) MarshalJSON() ([]byte,error)

typeBackup

type Backup struct {// AllNamespaces: Output only. If True, all namespaces were included in the// Backup.AllNamespacesbool `json:"allNamespaces,omitempty"`// ClusterMetadata: Output only. Information about the GKE cluster from which// this Backup was created.ClusterMetadata *ClusterMetadata `json:"clusterMetadata,omitempty"`// CompleteTime: Output only. Completion time of the BackupCompleteTimestring `json:"completeTime,omitempty"`// ConfigBackupSizeBytes: Output only. The size of the config backup in bytes.ConfigBackupSizeBytesint64 `json:"configBackupSizeBytes,omitempty,string"`// ContainsSecrets: Output only. Whether or not the Backup contains Kubernetes// Secrets. Controlled by the parent BackupPlan's include_secrets value.ContainsSecretsbool `json:"containsSecrets,omitempty"`// ContainsVolumeData: Output only. Whether or not the Backup contains volume// data. Controlled by the parent BackupPlan's include_volume_data value.ContainsVolumeDatabool `json:"containsVolumeData,omitempty"`// CreateTime: Output only. The timestamp when this Backup resource was// created.CreateTimestring `json:"createTime,omitempty"`// DeleteLockDays: 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's// backup_delete_lock_days setting and may only be increased (either at// creation time or in a subsequent update).DeleteLockDaysint64 `json:"deleteLockDays,omitempty"`// DeleteLockExpireTime: Output only. The time at which an existing delete lock// will expire for this backup (calculated from create_time +// delete_lock_days).DeleteLockExpireTimestring `json:"deleteLockExpireTime,omitempty"`// Description: Optional. User specified descriptive string for this Backup.Descriptionstring `json:"description,omitempty"`// EncryptionKey: Output only. The customer managed encryption key that was// used to encrypt the Backup's artifacts. Inherited from the parent// BackupPlan's encryption_key value.EncryptionKey *EncryptionKey `json:"encryptionKey,omitempty"`// Etag: Output only. `etag` is used for optimistic concurrency control as a// way to help prevent simultaneous updates of a backup from overwriting each// other. It is strongly suggested that systems make use of the `etag` in the// read-modify-write cycle to perform backup updates in order to avoid race// conditions: An `etag` is returned in the response to `GetBackup`, and// systems are expected to put that etag in the request to `UpdateBackup` or// `DeleteBackup` to ensure that their change will be applied to the same// version of the resource.Etagstring `json:"etag,omitempty"`// Labels: Optional. A set of custom labels supplied by user.Labels map[string]string `json:"labels,omitempty"`// Manual: Output only. This flag indicates whether this Backup resource was// created manually by a user or via a schedule in the BackupPlan. A value of// True means that the Backup was created manually.Manualbool `json:"manual,omitempty"`// Name: Output only. Identifier. The fully qualified name of the Backup.// `projects/*/locations/*/backupPlans/*/backups/*`Namestring `json:"name,omitempty"`// PermissiveMode: Output only. If false, Backup will fail when Backup for GKE// detects Kubernetes configuration that is non-standard or requires additional// setup to restore. Inherited from the parent BackupPlan's permissive_mode// value.PermissiveModebool `json:"permissiveMode,omitempty"`// PodCount: Output only. The total number of Kubernetes Pods contained in the// Backup.PodCountint64 `json:"podCount,omitempty"`// ResourceCount: Output only. The total number of Kubernetes resources// included in the Backup.ResourceCountint64 `json:"resourceCount,omitempty"`// RetainDays: 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.RetainDaysint64 `json:"retainDays,omitempty"`// RetainExpireTime: Output only. The time at which this Backup will be// automatically deleted (calculated from create_time + retain_days).RetainExpireTimestring `json:"retainExpireTime,omitempty"`// SatisfiesPzi: Output only. [Output Only] Reserved for future use.SatisfiesPzibool `json:"satisfiesPzi,omitempty"`// SatisfiesPzs: Output only. [Output Only] Reserved for future use.SatisfiesPzsbool `json:"satisfiesPzs,omitempty"`// SelectedApplications: Output only. If set, the list of ProtectedApplications// whose resources were included in the Backup.SelectedApplications *NamespacedNames `json:"selectedApplications,omitempty"`// SelectedNamespaceLabels: Output only. If set, the list of labels whose// constituent namespaces were included in the Backup.SelectedNamespaceLabels *ResourceLabels `json:"selectedNamespaceLabels,omitempty"`// SelectedNamespaces: Output only. If set, the list of namespaces that were// included in the Backup.SelectedNamespaces *Namespaces `json:"selectedNamespaces,omitempty"`// SizeBytes: Output only. The total size of the Backup in bytes = config// backup size + sum(volume backup sizes)SizeBytesint64 `json:"sizeBytes,omitempty,string"`// State: Output only. Current state of the Backup//// Possible values://   "STATE_UNSPECIFIED" - The Backup resource is in the process of being// created.//   "CREATING" - The Backup resource has been created and the associated// BackupJob Kubernetes resource has been injected into the source cluster.//   "IN_PROGRESS" - The gkebackup agent in the cluster has begun executing the// backup operation.//   "SUCCEEDED" - The backup operation has completed successfully.//   "FAILED" - The backup operation has failed.//   "DELETING" - This Backup resource (and its associated artifacts) is in the// process of being deleted.Statestring `json:"state,omitempty"`// StateReason: Output only. Human-readable description of why the backup is in// the current `state`. This field is only meant for human readability and// should not be used programmatically as this field is not guaranteed to be// consistent.StateReasonstring `json:"stateReason,omitempty"`// TroubleshootingInfo: Output only. Information about the troubleshooting// steps which will provide debugging information to the end users.TroubleshootingInfo *TroubleshootingInfo `json:"troubleshootingInfo,omitempty"`// Uid: Output only. Server generated global unique identifier of UUID4// (https://en.wikipedia.org/wiki/Universally_unique_identifier)Uidstring `json:"uid,omitempty"`// UpdateTime: Output only. The timestamp when this Backup resource was last// updated.UpdateTimestring `json:"updateTime,omitempty"`// VolumeCount: Output only. The total number of volume backups contained in// the Backup.VolumeCountint64 `json:"volumeCount,omitempty"`// ServerResponse contains the HTTP response code and headers from the server.googleapi.ServerResponse `json:"-"`// ForceSendFields is a list of field names (e.g. "AllNamespaces") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "AllNamespaces") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

Backup: Represents a request to perform a single point-in-time capture ofsome portion of the state of a GKE cluster, the record of the backupoperation itself, and an anchor for the underlying artifacts that comprisethe Backup (the config backup and VolumeBackups).

func (Backup)MarshalJSON

func (sBackup) MarshalJSON() ([]byte,error)

typeBackupChanneladded inv0.230.0

type BackupChannel struct {// CreateTime: Output only. The timestamp when this BackupChannel resource was// created.CreateTimestring `json:"createTime,omitempty"`// Description: Optional. User specified descriptive string for this// BackupChannel.Descriptionstring `json:"description,omitempty"`// DestinationProject: Required. Immutable. The project where Backups are// allowed to be stored. The format is `projects/{projectId}` or// `projects/{projectNumber}`.DestinationProjectstring `json:"destinationProject,omitempty"`// DestinationProjectId: Output only. The project_id where Backups are allowed// to be stored. Example Project ID: "my-project-id". This will be an// OUTPUT_ONLY field to return the project_id of the destination project.DestinationProjectIdstring `json:"destinationProjectId,omitempty"`// Etag: Output only. `etag` is used for optimistic concurrency control as a// way to help prevent simultaneous updates of a BackupChannel from overwriting// each other. It is strongly suggested that systems make use of the 'etag' in// the read-modify-write cycle to perform BackupChannel updates in order to// avoid race conditions: An `etag` is returned in the response to// `GetBackupChannel`, and systems are expected to put that etag in the request// to `UpdateBackupChannel` or `DeleteBackupChannel` to ensure that their// change will be applied to the same version of the resource.Etagstring `json:"etag,omitempty"`// Labels: Optional. A set of custom labels supplied by user.Labels map[string]string `json:"labels,omitempty"`// Name: Identifier. The fully qualified name of the BackupChannel.// `projects/*/locations/*/backupChannels/*`Namestring `json:"name,omitempty"`// Uid: Output only. Server generated global unique identifier of UUID// (https://en.wikipedia.org/wiki/Universally_unique_identifier) format.Uidstring `json:"uid,omitempty"`// UpdateTime: Output only. The timestamp when this BackupChannel resource was// last updated.UpdateTimestring `json:"updateTime,omitempty"`// ServerResponse contains the HTTP response code and headers from the server.googleapi.ServerResponse `json:"-"`// ForceSendFields is a list of field names (e.g. "CreateTime") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "CreateTime") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

BackupChannel: A BackupChannel imposes constraints on where clusters can bebacked up. The BackupChannel should be in the same project and region as thecluster being backed up. The backup can be created only indestination_project.

func (BackupChannel)MarshalJSONadded inv0.230.0

func (sBackupChannel) MarshalJSON() ([]byte,error)

typeBackupConfig

type BackupConfig struct {// AllNamespaces: If True, include all namespaced resourcesAllNamespacesbool `json:"allNamespaces,omitempty"`// EncryptionKey: Optional. This defines a customer managed encryption key that// will be used to encrypt the "config" portion (the Kubernetes resources) of// Backups created via this plan. Default (empty): Config backup artifacts will// not be encrypted.EncryptionKey *EncryptionKey `json:"encryptionKey,omitempty"`// IncludeSecrets: Optional. This flag specifies whether Kubernetes Secret// resources should be included when they fall into the scope of Backups.// Default: FalseIncludeSecretsbool `json:"includeSecrets,omitempty"`// IncludeVolumeData: Optional. This flag specifies whether volume data should// be backed up when PVCs are included in the scope of a Backup. Default: FalseIncludeVolumeDatabool `json:"includeVolumeData,omitempty"`// PermissiveMode: Optional. If false, Backups will fail when Backup for GKE// detects Kubernetes configuration that is non-standard or requires additional// setup to restore. Default: FalsePermissiveModebool `json:"permissiveMode,omitempty"`// SelectedApplications: If set, include just the resources referenced by the// listed ProtectedApplications.SelectedApplications *NamespacedNames `json:"selectedApplications,omitempty"`// SelectedNamespaceLabels: If set, the list of labels whose constituent// namespaces were included in the Backup.SelectedNamespaceLabels *ResourceLabels `json:"selectedNamespaceLabels,omitempty"`// SelectedNamespaces: If set, include just the resources in the listed// namespaces.SelectedNamespaces *Namespaces `json:"selectedNamespaces,omitempty"`// ForceSendFields is a list of field names (e.g. "AllNamespaces") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "AllNamespaces") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

BackupConfig: BackupConfig defines the configuration of Backups created viathis BackupPlan.

func (BackupConfig)MarshalJSON

func (sBackupConfig) MarshalJSON() ([]byte,error)

typeBackupConfigDetailsadded inv0.234.0

type BackupConfigDetails struct {// AllNamespaces: Output only. If True, include all namespaced resourcesAllNamespacesbool `json:"allNamespaces,omitempty"`// EncryptionKey: Output only. This defines a customer managed encryption key// that will be used to encrypt the "config" portion (the Kubernetes resources)// of Backups created via this plan. Default (empty): Config backup artifacts// will not be encrypted.EncryptionKey *EncryptionKey `json:"encryptionKey,omitempty"`// IncludeSecrets: Output only. This flag specifies whether Kubernetes Secret// resources should be included when they fall into the scope of Backups.// Default: FalseIncludeSecretsbool `json:"includeSecrets,omitempty"`// IncludeVolumeData: Output only. This flag specifies whether volume data// should be backed up when PVCs are included in the scope of a Backup.// Default: FalseIncludeVolumeDatabool `json:"includeVolumeData,omitempty"`// SelectedApplications: Output only. If set, include just the resources// referenced by the listed ProtectedApplications.SelectedApplications *NamespacedNames `json:"selectedApplications,omitempty"`// SelectedNamespaces: Output only. If set, include just the resources in the// listed namespaces.SelectedNamespaces *Namespaces `json:"selectedNamespaces,omitempty"`// ForceSendFields is a list of field names (e.g. "AllNamespaces") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "AllNamespaces") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

BackupConfigDetails: BackupConfigDetails defines the configuration ofBackups created via this BackupPlan.

func (BackupConfigDetails)MarshalJSONadded inv0.234.0

func (sBackupConfigDetails) MarshalJSON() ([]byte,error)

typeBackupPlan

type BackupPlan struct {// BackupChannel: Output only. The fully qualified name of the BackupChannel to// be used to create a backup. This field is set only if the cluster being// backed up is in a different project.// `projects/*/locations/*/backupChannels/*`BackupChannelstring `json:"backupChannel,omitempty"`// BackupConfig: Optional. Defines the configuration of Backups created via// this BackupPlan.BackupConfig *BackupConfig `json:"backupConfig,omitempty"`// BackupSchedule: Optional. Defines a schedule for automatic Backup creation// via this BackupPlan.BackupSchedule *Schedule `json:"backupSchedule,omitempty"`// Cluster: Required. Immutable. The source cluster from which Backups will be// created via this BackupPlan. Valid formats: -// `projects/*/locations/*/clusters/*` - `projects/*/zones/*/clusters/*`Clusterstring `json:"cluster,omitempty"`// CreateTime: Output only. The timestamp when this BackupPlan resource was// created.CreateTimestring `json:"createTime,omitempty"`// Deactivated: 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: FalseDeactivatedbool `json:"deactivated,omitempty"`// Description: Optional. User specified descriptive string for this// BackupPlan.Descriptionstring `json:"description,omitempty"`// Etag: Output only. `etag` is used for optimistic concurrency control as a// way to help prevent simultaneous updates of a backup plan from overwriting// each other. It is strongly suggested that systems make use of the 'etag' in// the read-modify-write cycle to perform BackupPlan updates in order to avoid// race conditions: An `etag` is returned in the response to `GetBackupPlan`,// and systems are expected to put that etag in the request to// `UpdateBackupPlan` or `DeleteBackupPlan` to ensure that their change will be// applied to the same version of the resource.Etagstring `json:"etag,omitempty"`// Labels: Optional. A set of custom labels supplied by user.Labels map[string]string `json:"labels,omitempty"`// LastSuccessfulBackupTime: Output only. Completion time of the last// successful Backup. This is sourced from a successful Backup's complete_time// field. This field is added to maintain consistency with BackupPlanBinding to// display last successful backup time.LastSuccessfulBackupTimestring `json:"lastSuccessfulBackupTime,omitempty"`// Name: Output only. Identifier. The full name of the BackupPlan resource.// Format: `projects/*/locations/*/backupPlans/*`Namestring `json:"name,omitempty"`// ProtectedPodCount: Output only. The number of Kubernetes Pods backed up in// the last successful Backup created via this BackupPlan.ProtectedPodCountint64 `json:"protectedPodCount,omitempty"`// RetentionPolicy: Optional. RetentionPolicy governs lifecycle of Backups// created under this plan.RetentionPolicy *RetentionPolicy `json:"retentionPolicy,omitempty"`// RpoRiskLevel: Output only. A number that represents the current risk level// of this BackupPlan from RPO perspective with 1 being no risk and 5 being// highest risk.RpoRiskLevelint64 `json:"rpoRiskLevel,omitempty"`// RpoRiskReason: Output only. Human-readable description of why the BackupPlan// is in the current rpo_risk_level and action items if any.RpoRiskReasonstring `json:"rpoRiskReason,omitempty"`// State: Output only. State of the BackupPlan. This State field reflects the// various stages a BackupPlan can be in during the Create operation. It will// be set to "DEACTIVATED" if the BackupPlan is deactivated on an Update//// Possible values://   "STATE_UNSPECIFIED" - Default first value for Enums.//   "CLUSTER_PENDING" - Waiting for cluster state to be RUNNING.//   "PROVISIONING" - The BackupPlan is in the process of being created.//   "READY" - The BackupPlan has successfully been created and is ready for// Backups.//   "FAILED" - BackupPlan creation has failed.//   "DEACTIVATED" - The BackupPlan has been deactivated.//   "DELETING" - The BackupPlan is in the process of being deleted.Statestring `json:"state,omitempty"`// StateReason: Output only. Human-readable description of why BackupPlan is in// the current `state`. This field is only meant for human readability and// should not be used programmatically as this field is not guaranteed to be// consistent.StateReasonstring `json:"stateReason,omitempty"`// Uid: Output only. Server generated global unique identifier of UUID// (https://en.wikipedia.org/wiki/Universally_unique_identifier) format.Uidstring `json:"uid,omitempty"`// UpdateTime: Output only. The timestamp when this BackupPlan resource was// last updated.UpdateTimestring `json:"updateTime,omitempty"`// ServerResponse contains the HTTP response code and headers from the server.googleapi.ServerResponse `json:"-"`// ForceSendFields is a list of field names (e.g. "BackupChannel") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "BackupChannel") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

BackupPlan: Defines the configuration and scheduling for a "line" ofBackups.

func (BackupPlan)MarshalJSON

func (sBackupPlan) MarshalJSON() ([]byte,error)

typeBackupPlanBindingadded inv0.230.0

type BackupPlanBinding struct {// BackupPlan: Output only. Immutable. The fully qualified name of the// BackupPlan bound with the parent BackupChannel.// `projects/*/locations/*/backupPlans/{backup_plan}`BackupPlanstring `json:"backupPlan,omitempty"`// BackupPlanDetails: Output only. Contains details about the backup// plan/backup.BackupPlanDetails *BackupPlanDetails `json:"backupPlanDetails,omitempty"`// Cluster: Output only. Immutable. The fully qualified name of the cluster// that is being backed up Valid formats: - `projects/*/locations/*/clusters/*`// - `projects/*/zones/*/clusters/*`Clusterstring `json:"cluster,omitempty"`// CreateTime: Output only. The timestamp when this binding was created.CreateTimestring `json:"createTime,omitempty"`// Etag: Output only. `etag` is used for optimistic concurrency control as a// way to help prevent simultaneous updates of a BackupPlanBinding from// overwriting each other. It is strongly suggested that systems make use of// the 'etag' in the read-modify-write cycle to perform BackupPlanBinding// updates in order to avoid race conditions: An `etag` is returned in the// response to `GetBackupPlanBinding`, and systems are expected to put that// etag in the request to `UpdateBackupPlanBinding` or// `DeleteBackupPlanBinding` to ensure that their change will be applied to the// same version of the resource.Etagstring `json:"etag,omitempty"`// Name: Identifier. The fully qualified name of the BackupPlanBinding.// `projects/*/locations/*/backupChannels/*/backupPlanBindings/*`Namestring `json:"name,omitempty"`// Uid: Output only. Server generated global unique identifier of UUID4// (https://en.wikipedia.org/wiki/Universally_unique_identifier)Uidstring `json:"uid,omitempty"`// UpdateTime: Output only. The timestamp when this binding was created.UpdateTimestring `json:"updateTime,omitempty"`// ServerResponse contains the HTTP response code and headers from the server.googleapi.ServerResponse `json:"-"`// ForceSendFields is a list of field names (e.g. "BackupPlan") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "BackupPlan") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

BackupPlanBinding: A BackupPlanBinding binds a BackupPlan with aBackupChannel. This resource is created automatically when a BackupPlan iscreated using a BackupChannel. This also serves as a holder forcross-project fields that need to be displayed in the current project.

func (BackupPlanBinding)MarshalJSONadded inv0.230.0

func (sBackupPlanBinding) MarshalJSON() ([]byte,error)

typeBackupPlanDetailsadded inv0.230.0

type BackupPlanDetails struct {// BackupConfigDetails: Output only. Contains details about the BackupConfig of// Backups created via this BackupPlan.BackupConfigDetails *BackupConfigDetails `json:"backupConfigDetails,omitempty"`// LastSuccessfulBackup: Output only. The fully qualified name of the last// successful Backup created under this BackupPlan.// `projects/*/locations/*/backupPlans/*/backups/*`LastSuccessfulBackupstring `json:"lastSuccessfulBackup,omitempty"`// LastSuccessfulBackupTime: Output only. Completion time of the last// successful Backup. This is sourced from a successful Backup's complete_time// field.LastSuccessfulBackupTimestring `json:"lastSuccessfulBackupTime,omitempty"`// NextScheduledBackupTime: Output only. Start time of next scheduled backup// under this BackupPlan by either cron_schedule or rpo config. This is sourced// from BackupPlan.NextScheduledBackupTimestring `json:"nextScheduledBackupTime,omitempty"`// ProtectedPodCount: Output only. The number of Kubernetes Pods backed up in// the last successful Backup created via this BackupPlan.ProtectedPodCountint64 `json:"protectedPodCount,omitempty"`// RetentionPolicyDetails: Output only. Contains details about the// RetentionPolicy of Backups created via this BackupPlan.RetentionPolicyDetails *RetentionPolicyDetails `json:"retentionPolicyDetails,omitempty"`// RpoRiskLevel: Output only. A number that represents the current risk level// of this BackupPlan from RPO perspective with 1 being no risk and 5 being// highest risk.RpoRiskLevelint64 `json:"rpoRiskLevel,omitempty"`// State: Output only. State of the BackupPlan.//// Possible values://   "STATE_UNSPECIFIED" - Default first value for Enums.//   "CLUSTER_PENDING" - Waiting for cluster state to be RUNNING.//   "PROVISIONING" - The BackupPlan is in the process of being created.//   "READY" - The BackupPlan has successfully been created and is ready for// Backups.//   "FAILED" - BackupPlan creation has failed.//   "DEACTIVATED" - The BackupPlan has been deactivated.//   "DELETING" - The BackupPlan is in the process of being deleted.Statestring `json:"state,omitempty"`// ForceSendFields is a list of field names (e.g. "BackupConfigDetails") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "BackupConfigDetails") to include// in API requests with the JSON null value. By default, fields with empty// values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

BackupPlanDetails: Contains metadata about the backup plan/backup.

func (BackupPlanDetails)MarshalJSONadded inv0.230.0

func (sBackupPlanDetails) MarshalJSON() ([]byte,error)

typeBinding

type Binding struct {// Condition: The condition that is associated with this binding. If the// condition evaluates to `true`, then this binding applies to the current// request. If the condition evaluates to `false`, then this binding does not// apply to the current request. However, a different role binding might grant// the same role to one or more of the principals in this binding. To learn// which resources support conditions in their IAM policies, see the IAM// documentation// (https://cloud.google.com/iam/help/conditions/resource-policies).Condition *Expr `json:"condition,omitempty"`// Members: Specifies the principals requesting access for a Google Cloud// resource. `members` can have the following values: * `allUsers`: A special// identifier that represents anyone who is on the internet; with or without a// Google account. * `allAuthenticatedUsers`: A special identifier that// represents anyone who is authenticated with a Google account or a service// account. Does not include identities that come from external identity// providers (IdPs) through identity federation. * `user:{emailid}`: An email// address that represents a specific Google account. For example,// `alice@example.com` . * `serviceAccount:{emailid}`: An email address that// represents a Google service account. For example,// `my-other-app@appspot.gserviceaccount.com`. *// `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An// identifier for a Kubernetes service account// (https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts).// For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`. *// `group:{emailid}`: An email address that represents a Google group. For// example, `admins@example.com`. * `domain:{domain}`: The G Suite domain// (primary) that represents all the users of that domain. For example,// `google.com` or `example.com`. *// `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/sub// ject/{subject_attribute_value}`: A single identity in a workforce identity// pool. *// `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/// group/{group_id}`: All workforce identities in a group. *// `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/// attribute.{attribute_name}/{attribute_value}`: All workforce identities with// a specific attribute value. *// `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/// *`: All identities in a workforce identity pool. *// `principal://iam.googleapis.com/projects/{project_number}/locations/global/wo// rkloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`: A single// identity in a workload identity pool. *// `principalSet://iam.googleapis.com/projects/{project_number}/locations/global// /workloadIdentityPools/{pool_id}/group/{group_id}`: A workload identity pool// group. *// `principalSet://iam.googleapis.com/projects/{project_number}/locations/global// /workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}// `: All identities in a workload identity pool with a certain attribute. *// `principalSet://iam.googleapis.com/projects/{project_number}/locations/global// /workloadIdentityPools/{pool_id}/*`: All identities in a workload identity// pool. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus// unique identifier) representing a user that has been recently deleted. For// example, `alice@example.com?uid=123456789012345678901`. If the user is// recovered, this value reverts to `user:{emailid}` and the recovered user// retains the role in the binding. *// `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus// unique identifier) representing a service account that has been recently// deleted. For example,// `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the// service account is undeleted, this value reverts to// `serviceAccount:{emailid}` and the undeleted service account retains the// role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email// address (plus unique identifier) representing a Google group that has been// recently deleted. For example,// `admins@example.com?uid=123456789012345678901`. If the group is recovered,// this value reverts to `group:{emailid}` and the recovered group retains the// role in the binding. *// `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool// _id}/subject/{subject_attribute_value}`: Deleted single identity in a// workforce identity pool. For example,// `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-po// ol-id/subject/my-subject-attribute-value`.Members []string `json:"members,omitempty"`// Role: Role that is assigned to the list of `members`, or principals. For// example, `roles/viewer`, `roles/editor`, or `roles/owner`. For an overview// of the IAM roles and permissions, see the IAM documentation// (https://cloud.google.com/iam/docs/roles-overview). For a list of the// available pre-defined roles, see here// (https://cloud.google.com/iam/docs/understanding-roles).Rolestring `json:"role,omitempty"`// ForceSendFields is a list of field names (e.g. "Condition") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Condition") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

Binding: Associates `members`, or principals, with a `role`.

func (Binding)MarshalJSON

func (sBinding) MarshalJSON() ([]byte,error)

typeClusterMetadata

type ClusterMetadata struct {// AnthosVersion: Output only. Anthos versionAnthosVersionstring `json:"anthosVersion,omitempty"`// BackupCrdVersions: Output only. A list of the Backup for GKE CRD versions// found in the cluster.BackupCrdVersions map[string]string `json:"backupCrdVersions,omitempty"`// Cluster: Output only. The source cluster from which this Backup was created.// Valid formats: - `projects/*/locations/*/clusters/*` -// `projects/*/zones/*/clusters/*` This is inherited from the parent// BackupPlan's cluster field.Clusterstring `json:"cluster,omitempty"`// GkeVersion: Output only. GKE versionGkeVersionstring `json:"gkeVersion,omitempty"`// K8sVersion: Output only. The Kubernetes server version of the source// cluster.K8sVersionstring `json:"k8sVersion,omitempty"`// ForceSendFields is a list of field names (e.g. "AnthosVersion") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "AnthosVersion") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

ClusterMetadata: Information about the GKE cluster from which this Backupwas created.

func (ClusterMetadata)MarshalJSON

func (sClusterMetadata) MarshalJSON() ([]byte,error)

typeClusterResourceRestoreScope

type ClusterResourceRestoreScope struct {// AllGroupKinds: Optional. If True, all valid cluster-scoped resources will be// restored. Mutually exclusive to any other field in the message.AllGroupKindsbool `json:"allGroupKinds,omitempty"`// ExcludedGroupKinds: Optional. A list of cluster-scoped resource group kinds// to NOT restore from the backup. If specified, all valid cluster-scoped// resources will be restored except for those specified in the list. Mutually// exclusive to any other field in the message.ExcludedGroupKinds []*GroupKind `json:"excludedGroupKinds,omitempty"`// NoGroupKinds: Optional. If True, no cluster-scoped resources will be// restored. This has the same restore scope as if the message is not defined.// Mutually exclusive to any other field in the message.NoGroupKindsbool `json:"noGroupKinds,omitempty"`// SelectedGroupKinds: Optional. A list of cluster-scoped resource group kinds// to restore from the backup. If specified, only the selected resources will// be restored. Mutually exclusive to any other field in the message.SelectedGroupKinds []*GroupKind `json:"selectedGroupKinds,omitempty"`// ForceSendFields is a list of field names (e.g. "AllGroupKinds") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "AllGroupKinds") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

ClusterResourceRestoreScope: Defines the scope of cluster-scoped resourcesto restore. Some group kinds are not reasonable choices for a restore, andwill cause an error if selected here. Any scope selection that would restore"all valid" resources automatically excludes these group kinds. - Node -ComponentStatus - gkebackup.gke.io/BackupJob - gkebackup.gke.io/RestoreJob -metrics.k8s.io/NodeMetrics - migration.k8s.io/StorageState -migration.k8s.io/StorageVersionMigration -snapshot.storage.k8s.io/VolumeSnapshotContent - storage.k8s.io/CSINode -storage.k8s.io/VolumeAttachment Some group kinds are driven by restoreconfiguration elsewhere, and will cause an error if selected here. -Namespace - PersistentVolume

func (ClusterResourceRestoreScope)MarshalJSON

func (sClusterResourceRestoreScope) MarshalJSON() ([]byte,error)

typeDateadded inv0.173.0

type Date struct {// Day: Day of a month. Must be from 1 to 31 and valid for the year and month,// or 0 to specify a year by itself or a year and month where the day isn't// significant.Dayint64 `json:"day,omitempty"`// Month: Month of a year. Must be from 1 to 12, or 0 to specify a year without// a month and day.Monthint64 `json:"month,omitempty"`// Year: Year of the date. Must be from 1 to 9999, or 0 to specify a date// without a year.Yearint64 `json:"year,omitempty"`// ForceSendFields is a list of field names (e.g. "Day") to unconditionally// include in API requests. By default, fields with empty or default values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Day") to include in API requests// with the JSON null value. By default, fields with empty values are omitted// from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

Date: Represents a whole or partial calendar date, such as a birthday. Thetime of day and time zone are either specified elsewhere or areinsignificant. The date is relative to the Gregorian Calendar. This canrepresent one of the following: * A full date, with non-zero year, month,and day values. * A month and day, with a zero year (for example, ananniversary). * A year on its own, with a zero month and a zero day. * Ayear and month, with a zero day (for example, a credit card expirationdate). Related types: * google.type.TimeOfDay * google.type.DateTime *google.protobuf.Timestamp

func (Date)MarshalJSONadded inv0.173.0

func (sDate) MarshalJSON() ([]byte,error)

typeDayOfWeekListadded inv0.173.0

type DayOfWeekList struct {// DaysOfWeek: Optional. A list of days of week.//// Possible values://   "DAY_OF_WEEK_UNSPECIFIED" - The day of the week is unspecified.//   "MONDAY" - Monday//   "TUESDAY" - Tuesday//   "WEDNESDAY" - Wednesday//   "THURSDAY" - Thursday//   "FRIDAY" - Friday//   "SATURDAY" - Saturday//   "SUNDAY" - SundayDaysOfWeek []string `json:"daysOfWeek,omitempty"`// ForceSendFields is a list of field names (e.g. "DaysOfWeek") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "DaysOfWeek") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

DayOfWeekList: Holds repeated DaysOfWeek values as a container.

func (DayOfWeekList)MarshalJSONadded inv0.173.0

func (sDayOfWeekList) MarshalJSON() ([]byte,error)

typeEmpty

type Empty struct {// ServerResponse contains the HTTP response code and headers from the server.googleapi.ServerResponse `json:"-"`}

Empty: A generic empty message that you can re-use to avoid definingduplicated empty messages in your APIs. A typical example is to use it asthe request or the response type of an API method. For instance: service Foo{ rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }

typeEncryptionKey

type EncryptionKey struct {// GcpKmsEncryptionKey: Optional. Google Cloud KMS encryption key. Format:// `projects/*/locations/*/keyRings/*/cryptoKeys/*`GcpKmsEncryptionKeystring `json:"gcpKmsEncryptionKey,omitempty"`// ForceSendFields is a list of field names (e.g. "GcpKmsEncryptionKey") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "GcpKmsEncryptionKey") to include// in API requests with the JSON null value. By default, fields with empty// values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

EncryptionKey: Defined a customer managed encryption key that will be usedto encrypt Backup artifacts.

func (EncryptionKey)MarshalJSON

func (sEncryptionKey) MarshalJSON() ([]byte,error)

typeExclusionWindowadded inv0.173.0

type ExclusionWindow struct {// Daily: The exclusion window occurs every day if set to "True". Specifying// this field to "False" is an error.Dailybool `json:"daily,omitempty"`// DaysOfWeek: The exclusion window occurs on these days of each week in UTC.DaysOfWeek *DayOfWeekList `json:"daysOfWeek,omitempty"`// Duration: Required. Specifies duration of the window. Duration must be >= 5// minutes and < (target RPO - 20 minutes). Additional restrictions based on// the recurrence type to allow some time for backup to happen: -// single_occurrence_date: no restriction, but UI may warn about this when// duration >= target RPO - daily window: duration < 24 hours - weekly window:// - days of week includes all seven days of a week: duration < 24 hours - all// other weekly window: duration < 168 hours (i.e., 24 * 7 hours)Durationstring `json:"duration,omitempty"`// SingleOccurrenceDate: No recurrence. The exclusion window occurs only once// and on this date in UTC.SingleOccurrenceDate *Date `json:"singleOccurrenceDate,omitempty"`// StartTime: Optional. Specifies the start time of the window using time of// the day in UTC.StartTime *TimeOfDay `json:"startTime,omitempty"`// ForceSendFields is a list of field names (e.g. "Daily") to unconditionally// include in API requests. By default, fields with empty or default values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Daily") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

ExclusionWindow: Defines a time window during which no backup should happen.All time and date are in UTC.

func (ExclusionWindow)MarshalJSONadded inv0.173.0

func (sExclusionWindow) MarshalJSON() ([]byte,error)

typeExpr

type Expr struct {// Description: Optional. Description of the expression. This is a longer text// which describes the expression, e.g. when hovered over it in a UI.Descriptionstring `json:"description,omitempty"`// Expression: Textual representation of an expression in Common Expression// Language syntax.Expressionstring `json:"expression,omitempty"`// Location: Optional. String indicating the location of the expression for// error reporting, e.g. a file name and a position in the file.Locationstring `json:"location,omitempty"`// Title: Optional. Title for the expression, i.e. a short string describing// its purpose. This can be used e.g. in UIs which allow to enter the// expression.Titlestring `json:"title,omitempty"`// ForceSendFields is a list of field names (e.g. "Description") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Description") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

Expr: Represents a textual expression in the Common Expression Language(CEL) syntax. CEL is a C-like expression language. The syntax and semanticsof CEL are documented athttps://github.com/google/cel-spec. Example(Comparison): title: "Summary size limit" description: "Determines if asummary is less than 100 chars" expression: "document.summary.size() < 100"Example (Equality): title: "Requestor is owner" description: "Determines ifrequestor is the document owner" expression: "document.owner ==request.auth.claims.email" Example (Logic): title: "Public documents"description: "Determine whether the document should be publicly visible"expression: "document.type != 'private' && document.type != 'internal'"Example (Data Manipulation): title: "Notification string" description:"Create a notification string with a timestamp." expression: "'New messagereceived at ' + string(document.create_time)" The exact variables andfunctions that may be referenced within an expression are determined by theservice that evaluates it. See the service documentation for additionalinformation.

func (Expr)MarshalJSON

func (sExpr) MarshalJSON() ([]byte,error)

typeFilteradded inv0.182.0

type Filter struct {// ExclusionFilters: Optional. Excludes resources from restoration. If// specified, a resource will not be restored if it matches any// `ResourceSelector` of the `exclusion_filters`.ExclusionFilters []*ResourceSelector `json:"exclusionFilters,omitempty"`// InclusionFilters: Optional. Selects resources for restoration. If specified,// only resources which match `inclusion_filters` will be selected for// restoration. A resource will be selected if it matches any// `ResourceSelector` of the `inclusion_filters`.InclusionFilters []*ResourceSelector `json:"inclusionFilters,omitempty"`// ForceSendFields is a list of field names (e.g. "ExclusionFilters") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "ExclusionFilters") to include in// API requests with the JSON null value. By default, fields with empty values// are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

Filter: Defines the filter for `Restore`. This filter can be used to furtherrefine the resource selection of the `Restore` beyond the coarse-grainedscope 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.

func (Filter)MarshalJSONadded inv0.182.0

func (sFilter) MarshalJSON() ([]byte,error)

typeGetBackupIndexDownloadUrlResponseadded inv0.173.0

type GetBackupIndexDownloadUrlResponse struct {// SignedUrl: Required. The signed URL for downloading the backup index.SignedUrlstring `json:"signedUrl,omitempty"`// ServerResponse contains the HTTP response code and headers from the server.googleapi.ServerResponse `json:"-"`// ForceSendFields is a list of field names (e.g. "SignedUrl") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "SignedUrl") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GetBackupIndexDownloadUrlResponse: Response message forGetBackupIndexDownloadUrl.

func (GetBackupIndexDownloadUrlResponse)MarshalJSONadded inv0.173.0

func (sGetBackupIndexDownloadUrlResponse) MarshalJSON() ([]byte,error)

typeGetTagsResponseadded inv0.257.0

type GetTagsResponse struct {// Etag: A checksum based on the current bindings. This field is always set in// server responses.Etagstring `json:"etag,omitempty"`// Name: Required. The full resource name of the service resource.Namestring `json:"name,omitempty"`// Tags: Required. Tag keys/values directly bound to this resource. Each item// in the map must be expressed as " : ". For example: "123/environment" :// "production", "123/costCenter" : "marketing"Tags map[string]string `json:"tags,omitempty"`// ServerResponse contains the HTTP response code and headers from the server.googleapi.ServerResponse `json:"-"`// ForceSendFields is a list of field names (e.g. "Etag") to unconditionally// include in API requests. By default, fields with empty or default values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Etag") to include in API requests// with the JSON null value. By default, fields with empty values are omitted// from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GetTagsResponse: Response message for GetTags.

func (GetTagsResponse)MarshalJSONadded inv0.257.0

func (sGetTagsResponse) MarshalJSON() ([]byte,error)

typeGoogleLongrunningCancelOperationRequest

type GoogleLongrunningCancelOperationRequest struct {}

GoogleLongrunningCancelOperationRequest: The request message forOperations.CancelOperation.

typeGoogleLongrunningListOperationsResponse

type GoogleLongrunningListOperationsResponse struct {// NextPageToken: The standard List next-page token.NextPageTokenstring `json:"nextPageToken,omitempty"`// Operations: A list of operations that matches the specified filter in the// request.Operations []*GoogleLongrunningOperation `json:"operations,omitempty"`// Unreachable: Unordered list. Unreachable resources. Populated when the// request sets `ListOperationsRequest.return_partial_success` and reads across// collections. For example, when attempting to list all resources across all// supported locations.Unreachable []string `json:"unreachable,omitempty"`// ServerResponse contains the HTTP response code and headers from the server.googleapi.ServerResponse `json:"-"`// ForceSendFields is a list of field names (e.g. "NextPageToken") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "NextPageToken") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleLongrunningListOperationsResponse: The response message forOperations.ListOperations.

func (GoogleLongrunningListOperationsResponse)MarshalJSON

typeGoogleLongrunningOperation

type GoogleLongrunningOperation struct {// Done: If the value is `false`, it means the operation is still in progress.// If `true`, the operation is completed, and either `error` or `response` is// available.Donebool `json:"done,omitempty"`// Error: The error result of the operation in case of failure or cancellation.Error *GoogleRpcStatus `json:"error,omitempty"`// Metadata: Service-specific metadata associated with the operation. It// typically contains progress information and common metadata such as create// time. Some services might not provide such metadata. Any method that returns// a long-running operation should document the metadata type, if any.Metadatagoogleapi.RawMessage `json:"metadata,omitempty"`// Name: The server-assigned name, which is only unique within the same service// that originally returns it. If you use the default HTTP mapping, the `name`// should be a resource name ending with `operations/{unique_id}`.Namestring `json:"name,omitempty"`// Response: The normal, successful response of the operation. If the original// method returns no data on success, such as `Delete`, the response is// `google.protobuf.Empty`. If the original method is standard// `Get`/`Create`/`Update`, the response should be the resource. For other// methods, the response should have the type `XxxResponse`, where `Xxx` is the// original method name. For example, if the original method name is// `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.Responsegoogleapi.RawMessage `json:"response,omitempty"`// ServerResponse contains the HTTP response code and headers from the server.googleapi.ServerResponse `json:"-"`// ForceSendFields is a list of field names (e.g. "Done") to unconditionally// include in API requests. By default, fields with empty or default values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Done") to include in API requests// with the JSON null value. By default, fields with empty values are omitted// from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleLongrunningOperation: This resource represents a long-runningoperation that is the result of a network API call.

func (GoogleLongrunningOperation)MarshalJSON

func (sGoogleLongrunningOperation) MarshalJSON() ([]byte,error)

typeGoogleRpcStatus

type GoogleRpcStatus struct {// Code: The status code, which should be an enum value of google.rpc.Code.Codeint64 `json:"code,omitempty"`// Details: A list of messages that carry the error details. There is a common// set of message types for APIs to use.Details []googleapi.RawMessage `json:"details,omitempty"`// Message: A developer-facing error message, which should be in English. Any// user-facing error message should be localized and sent in the// google.rpc.Status.details field, or localized by the client.Messagestring `json:"message,omitempty"`// ForceSendFields is a list of field names (e.g. "Code") to unconditionally// include in API requests. By default, fields with empty or default values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Code") to include in API requests// with the JSON null value. By default, fields with empty values are omitted// from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleRpcStatus: The `Status` type defines a logical error model that issuitable for different programming environments, including REST APIs and RPCAPIs. It is used by gRPC (https://github.com/grpc). Each `Status` messagecontains three pieces of data: error code, error message, and error details.You can find out more about this error model and how to work with it in theAPI Design Guide (https://cloud.google.com/apis/design/errors).

func (GoogleRpcStatus)MarshalJSON

func (sGoogleRpcStatus) MarshalJSON() ([]byte,error)

typeGroupKind

type GroupKind struct {// ResourceGroup: Optional. API group string of a Kubernetes resource, e.g.// "apiextensions.k8s.io", "storage.k8s.io", etc. Note: use empty string for// core API group.ResourceGroupstring `json:"resourceGroup,omitempty"`// ResourceKind: Optional. Kind of a Kubernetes resource, must be in// UpperCamelCase (PascalCase) and singular form. E.g.// "CustomResourceDefinition", "StorageClass", etc.ResourceKindstring `json:"resourceKind,omitempty"`// ForceSendFields is a list of field names (e.g. "ResourceGroup") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "ResourceGroup") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GroupKind: This is a direct map to the Kubernetes GroupKind type GroupKind(https://godoc.org/k8s.io/apimachinery/pkg/runtime/schema#GroupKind) and isused for identifying specific "types" of resources to restore.

func (GroupKind)MarshalJSON

func (sGroupKind) MarshalJSON() ([]byte,error)

typeGroupKindDependencyadded inv0.182.0

type GroupKindDependency struct {// Requiring: Required. The requiring group kind requires that the other group// kind be restored first.Requiring *GroupKind `json:"requiring,omitempty"`// Satisfying: Required. The satisfying group kind must be restored first in// order to satisfy the dependency.Satisfying *GroupKind `json:"satisfying,omitempty"`// ForceSendFields is a list of field names (e.g. "Requiring") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Requiring") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GroupKindDependency: Defines a dependency between two group kinds.

func (GroupKindDependency)MarshalJSONadded inv0.182.0

func (sGroupKindDependency) MarshalJSON() ([]byte,error)

typeLabeladded inv0.237.0

type Label struct {// Key: Optional. The key/name of the label.Keystring `json:"key,omitempty"`// Value: Optional. The value of the label.Valuestring `json:"value,omitempty"`// ForceSendFields is a list of field names (e.g. "Key") to unconditionally// include in API requests. By default, fields with empty or default values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Key") to include in API requests// with the JSON null value. By default, fields with empty values are omitted// from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

Label: A single Kubernetes label-value pair.

func (Label)MarshalJSONadded inv0.237.0

func (sLabel) MarshalJSON() ([]byte,error)

typeListBackupChannelsResponseadded inv0.230.0

type ListBackupChannelsResponse struct {// BackupChannels: The list of BackupChannels matching the given criteria.BackupChannels []*BackupChannel `json:"backupChannels,omitempty"`// NextPageToken: A token which may be sent as page_token in a subsequent// `ListBackupChannels` call to retrieve the next page of results. If this// field is omitted or empty, then there are no more results to return.NextPageTokenstring `json:"nextPageToken,omitempty"`// Unreachable: Locations that could not be reached.Unreachable []string `json:"unreachable,omitempty"`// ServerResponse contains the HTTP response code and headers from the server.googleapi.ServerResponse `json:"-"`// ForceSendFields is a list of field names (e.g. "BackupChannels") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "BackupChannels") to include in// API requests with the JSON null value. By default, fields with empty values// are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

ListBackupChannelsResponse: Response message for ListBackupChannels.

func (ListBackupChannelsResponse)MarshalJSONadded inv0.230.0

func (sListBackupChannelsResponse) MarshalJSON() ([]byte,error)

typeListBackupPlanBindingsResponseadded inv0.230.0

type ListBackupPlanBindingsResponse struct {// BackupPlanBindings: The list of BackupPlanBindings matching the given// criteria.BackupPlanBindings []*BackupPlanBinding `json:"backupPlanBindings,omitempty"`// NextPageToken: A token which may be sent as page_token in a subsequent// `ListBackupPlanBindingss` call to retrieve the next page of results. If this// field is omitted or empty, then there are no more results to return.NextPageTokenstring `json:"nextPageToken,omitempty"`// Unreachable: Locations that could not be reached.Unreachable []string `json:"unreachable,omitempty"`// ServerResponse contains the HTTP response code and headers from the server.googleapi.ServerResponse `json:"-"`// ForceSendFields is a list of field names (e.g. "BackupPlanBindings") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "BackupPlanBindings") to include// in API requests with the JSON null value. By default, fields with empty// values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

ListBackupPlanBindingsResponse: Response message for ListBackupPlanBindings.

func (ListBackupPlanBindingsResponse)MarshalJSONadded inv0.230.0

func (sListBackupPlanBindingsResponse) MarshalJSON() ([]byte,error)

typeListBackupPlansResponse

type ListBackupPlansResponse struct {// BackupPlans: The list of BackupPlans matching the given criteria.BackupPlans []*BackupPlan `json:"backupPlans,omitempty"`// NextPageToken: A token which may be sent as page_token in a subsequent// `ListBackupPlans` call to retrieve the next page of results. If this field// is omitted or empty, then there are no more results to return.NextPageTokenstring `json:"nextPageToken,omitempty"`// Unreachable: Locations that could not be reached.Unreachable []string `json:"unreachable,omitempty"`// ServerResponse contains the HTTP response code and headers from the server.googleapi.ServerResponse `json:"-"`// ForceSendFields is a list of field names (e.g. "BackupPlans") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "BackupPlans") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

ListBackupPlansResponse: Response message for ListBackupPlans.

func (ListBackupPlansResponse)MarshalJSON

func (sListBackupPlansResponse) MarshalJSON() ([]byte,error)

typeListBackupsResponse

type ListBackupsResponse struct {// Backups: The list of Backups matching the given criteria.Backups []*Backup `json:"backups,omitempty"`// NextPageToken: A token which may be sent as page_token in a subsequent// `ListBackups` call to retrieve the next page of results. If this field is// omitted or empty, then there are no more results to return.NextPageTokenstring `json:"nextPageToken,omitempty"`// Unreachable: Locations that could not be reached.Unreachable []string `json:"unreachable,omitempty"`// ServerResponse contains the HTTP response code and headers from the server.googleapi.ServerResponse `json:"-"`// ForceSendFields is a list of field names (e.g. "Backups") to unconditionally// include in API requests. By default, fields with empty or default values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Backups") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

ListBackupsResponse: Response message for ListBackups.

func (ListBackupsResponse)MarshalJSON

func (sListBackupsResponse) MarshalJSON() ([]byte,error)

typeListLocationsResponse

type ListLocationsResponse struct {// Locations: A list of locations that matches the specified filter in the// request.Locations []*Location `json:"locations,omitempty"`// NextPageToken: The standard List next-page token.NextPageTokenstring `json:"nextPageToken,omitempty"`// ServerResponse contains the HTTP response code and headers from the server.googleapi.ServerResponse `json:"-"`// ForceSendFields is a list of field names (e.g. "Locations") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Locations") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

ListLocationsResponse: The response message for Locations.ListLocations.

func (ListLocationsResponse)MarshalJSON

func (sListLocationsResponse) MarshalJSON() ([]byte,error)

typeListRestoreChannelsResponseadded inv0.230.0

type ListRestoreChannelsResponse struct {// NextPageToken: A token which may be sent as page_token in a subsequent// `ListRestoreChannels` call to retrieve the next page of results. If this// field is omitted or empty, then there are no more results to return.NextPageTokenstring `json:"nextPageToken,omitempty"`// RestoreChannels: The list of RestoreChannels matching the given criteria.RestoreChannels []*RestoreChannel `json:"restoreChannels,omitempty"`// Unreachable: Locations that could not be reached.Unreachable []string `json:"unreachable,omitempty"`// ServerResponse contains the HTTP response code and headers from the server.googleapi.ServerResponse `json:"-"`// ForceSendFields is a list of field names (e.g. "NextPageToken") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "NextPageToken") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

ListRestoreChannelsResponse: Response message for ListRestoreChannels.

func (ListRestoreChannelsResponse)MarshalJSONadded inv0.230.0

func (sListRestoreChannelsResponse) MarshalJSON() ([]byte,error)

typeListRestorePlanBindingsResponseadded inv0.230.0

type ListRestorePlanBindingsResponse struct {// NextPageToken: A token which may be sent as page_token in a subsequent// `ListRestorePlanBindings` call to retrieve the next page of results. If this// field is omitted or empty, then there are no more results to return.NextPageTokenstring `json:"nextPageToken,omitempty"`// RestorePlanBindings: The list of RestorePlanBindings matching the given// criteria.RestorePlanBindings []*RestorePlanBinding `json:"restorePlanBindings,omitempty"`// Unreachable: Unordered list. Locations that could not be reached.Unreachable []string `json:"unreachable,omitempty"`// ServerResponse contains the HTTP response code and headers from the server.googleapi.ServerResponse `json:"-"`// ForceSendFields is a list of field names (e.g. "NextPageToken") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "NextPageToken") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

ListRestorePlanBindingsResponse: Response message forListRestorePlanBindings.

func (ListRestorePlanBindingsResponse)MarshalJSONadded inv0.230.0

func (sListRestorePlanBindingsResponse) MarshalJSON() ([]byte,error)

typeListRestorePlansResponse

type ListRestorePlansResponse struct {// NextPageToken: A token which may be sent as page_token in a subsequent// `ListRestorePlans` call to retrieve the next page of results. If this field// is omitted or empty, then there are no more results to return.NextPageTokenstring `json:"nextPageToken,omitempty"`// RestorePlans: The list of RestorePlans matching the given criteria.RestorePlans []*RestorePlan `json:"restorePlans,omitempty"`// Unreachable: Locations that could not be reached.Unreachable []string `json:"unreachable,omitempty"`// ServerResponse contains the HTTP response code and headers from the server.googleapi.ServerResponse `json:"-"`// ForceSendFields is a list of field names (e.g. "NextPageToken") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "NextPageToken") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

ListRestorePlansResponse: Response message for ListRestorePlans.

func (ListRestorePlansResponse)MarshalJSON

func (sListRestorePlansResponse) MarshalJSON() ([]byte,error)

typeListRestoresResponse

type ListRestoresResponse struct {// NextPageToken: A token which may be sent as page_token in a subsequent// `ListRestores` call to retrieve the next page of results. If this field is// omitted or empty, then there are no more results to return.NextPageTokenstring `json:"nextPageToken,omitempty"`// Restores: The list of Restores matching the given criteria.Restores []*Restore `json:"restores,omitempty"`// Unreachable: Locations that could not be reached.Unreachable []string `json:"unreachable,omitempty"`// ServerResponse contains the HTTP response code and headers from the server.googleapi.ServerResponse `json:"-"`// ForceSendFields is a list of field names (e.g. "NextPageToken") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "NextPageToken") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

ListRestoresResponse: Response message for ListRestores.

func (ListRestoresResponse)MarshalJSON

func (sListRestoresResponse) MarshalJSON() ([]byte,error)

typeListVolumeBackupsResponse

type ListVolumeBackupsResponse struct {// NextPageToken: A token which may be sent as page_token in a subsequent// `ListVolumeBackups` call to retrieve the next page of results. If this field// is omitted or empty, then there are no more results to return.NextPageTokenstring `json:"nextPageToken,omitempty"`// VolumeBackups: The list of VolumeBackups matching the given criteria.VolumeBackups []*VolumeBackup `json:"volumeBackups,omitempty"`// ServerResponse contains the HTTP response code and headers from the server.googleapi.ServerResponse `json:"-"`// ForceSendFields is a list of field names (e.g. "NextPageToken") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "NextPageToken") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

ListVolumeBackupsResponse: Response message for ListVolumeBackups.

func (ListVolumeBackupsResponse)MarshalJSON

func (sListVolumeBackupsResponse) MarshalJSON() ([]byte,error)

typeListVolumeRestoresResponse

type ListVolumeRestoresResponse struct {// NextPageToken: A token which may be sent as page_token in a subsequent// `ListVolumeRestores` call to retrieve the next page of results. If this// field is omitted or empty, then there are no more results to return.NextPageTokenstring `json:"nextPageToken,omitempty"`// VolumeRestores: The list of VolumeRestores matching the given criteria.VolumeRestores []*VolumeRestore `json:"volumeRestores,omitempty"`// ServerResponse contains the HTTP response code and headers from the server.googleapi.ServerResponse `json:"-"`// ForceSendFields is a list of field names (e.g. "NextPageToken") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "NextPageToken") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

ListVolumeRestoresResponse: Response message for ListVolumeRestores.

func (ListVolumeRestoresResponse)MarshalJSON

func (sListVolumeRestoresResponse) MarshalJSON() ([]byte,error)

typeLocation

type Location struct {// DisplayName: The friendly name for this location, typically a nearby city// name. For example, "Tokyo".DisplayNamestring `json:"displayName,omitempty"`// Labels: Cross-service attributes for the location. For example// {"cloud.googleapis.com/region": "us-east1"}Labels map[string]string `json:"labels,omitempty"`// LocationId: The canonical id for this location. For example: "us-east1".LocationIdstring `json:"locationId,omitempty"`// Metadata: Service-specific metadata. For example the available capacity at// the given location.Metadatagoogleapi.RawMessage `json:"metadata,omitempty"`// Name: Resource name for the location, which may vary between// implementations. For example:// "projects/example-project/locations/us-east1"Namestring `json:"name,omitempty"`// ServerResponse contains the HTTP response code and headers from the server.googleapi.ServerResponse `json:"-"`// ForceSendFields is a list of field names (e.g. "DisplayName") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "DisplayName") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

Location: A resource that represents a Google Cloud location.

func (Location)MarshalJSON

func (sLocation) MarshalJSON() ([]byte,error)

typeNamespacedName

type NamespacedName struct {// Name: Optional. The name of the Kubernetes resource.Namestring `json:"name,omitempty"`// Namespace: Optional. The Namespace of the Kubernetes resource.Namespacestring `json:"namespace,omitempty"`// ForceSendFields is a list of field names (e.g. "Name") to unconditionally// include in API requests. By default, fields with empty or default values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Name") to include in API requests// with the JSON null value. By default, fields with empty values are omitted// from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

NamespacedName: A reference to a namespaced resource in Kubernetes.

func (NamespacedName)MarshalJSON

func (sNamespacedName) MarshalJSON() ([]byte,error)

typeNamespacedNames

type NamespacedNames struct {// NamespacedNames: Optional. A list of namespaced Kubernetes resources.NamespacedNames []*NamespacedName `json:"namespacedNames,omitempty"`// ForceSendFields is a list of field names (e.g. "NamespacedNames") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "NamespacedNames") to include in// API requests with the JSON null value. By default, fields with empty values// are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

NamespacedNames: A list of namespaced Kubernetes resources.

func (NamespacedNames)MarshalJSON

func (sNamespacedNames) MarshalJSON() ([]byte,error)

typeNamespaces

type Namespaces struct {// Namespaces: Optional. A list of Kubernetes Namespaces.Namespaces []string `json:"namespaces,omitempty"`// ForceSendFields is a list of field names (e.g. "Namespaces") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Namespaces") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

Namespaces: A list of Kubernetes Namespaces.

func (Namespaces)MarshalJSON

func (sNamespaces) MarshalJSON() ([]byte,error)

typeOperationMetadata

type OperationMetadata struct {// ApiVersion: Output only. API version used to start the operation.ApiVersionstring `json:"apiVersion,omitempty"`// CreateTime: Output only. The time the operation was created.CreateTimestring `json:"createTime,omitempty"`// EndTime: Output only. The time the operation finished running.EndTimestring `json:"endTime,omitempty"`// RequestedCancellation: Output only. Identifies whether the user has// requested cancellation of the operation. Operations that have successfully// been cancelled have google.longrunning.Operation.error value with a// google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`.RequestedCancellationbool `json:"requestedCancellation,omitempty"`// StatusMessage: Output only. Human-readable status of the operation, if any.StatusMessagestring `json:"statusMessage,omitempty"`// Target: Output only. Server-defined resource path for the target of the// operation.Targetstring `json:"target,omitempty"`// Verb: Output only. Name of the verb executed by the operation.Verbstring `json:"verb,omitempty"`// ForceSendFields is a list of field names (e.g. "ApiVersion") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "ApiVersion") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

OperationMetadata: Represents the metadata of the long-running operation.

func (OperationMetadata)MarshalJSON

func (sOperationMetadata) MarshalJSON() ([]byte,error)

typePolicy

type Policy struct {// AuditConfigs: Specifies cloud audit logging configuration for this policy.AuditConfigs []*AuditConfig `json:"auditConfigs,omitempty"`// Bindings: Associates a list of `members`, or principals, with a `role`.// Optionally, may specify a `condition` that determines how and when the// `bindings` are applied. Each of the `bindings` must contain at least one// principal. The `bindings` in a `Policy` can refer to up to 1,500 principals;// up to 250 of these principals can be Google groups. Each occurrence of a// principal counts towards these limits. For example, if the `bindings` grant// 50 different roles to `user:alice@example.com`, and not to any other// principal, then you can add another 1,450 principals to the `bindings` in// the `Policy`.Bindings []*Binding `json:"bindings,omitempty"`// Etag: `etag` is used for optimistic concurrency control as a way to help// prevent simultaneous updates of a policy from overwriting each other. It is// strongly suggested that systems make use of the `etag` in the// read-modify-write cycle to perform policy updates in order to avoid race// conditions: An `etag` is returned in the response to `getIamPolicy`, and// systems are expected to put that etag in the request to `setIamPolicy` to// ensure that their change will be applied to the same version of the policy.// **Important:** If you use IAM Conditions, you must include the `etag` field// whenever you call `setIamPolicy`. If you omit this field, then IAM allows// you to overwrite a version `3` policy with a version `1` policy, and all of// the conditions in the version `3` policy are lost.Etagstring `json:"etag,omitempty"`// Version: Specifies the format of the policy. Valid values are `0`, `1`, and// `3`. Requests that specify an invalid value are rejected. Any operation that// affects conditional role bindings must specify version `3`. This requirement// applies to the following operations: * Getting a policy that includes a// conditional role binding * Adding a conditional role binding to a policy *// Changing a conditional role binding in a policy * Removing any role binding,// with or without a condition, from a policy that includes conditions// **Important:** If you use IAM Conditions, you must include the `etag` field// whenever you call `setIamPolicy`. If you omit this field, then IAM allows// you to overwrite a version `3` policy with a version `1` policy, and all of// the conditions in the version `3` policy are lost. If a policy does not// include any conditions, operations on that policy may specify any valid// version or leave the field unset. To learn which resources support// conditions in their IAM policies, see the IAM documentation// (https://cloud.google.com/iam/help/conditions/resource-policies).Versionint64 `json:"version,omitempty"`// ServerResponse contains the HTTP response code and headers from the server.googleapi.ServerResponse `json:"-"`// ForceSendFields is a list of field names (e.g. "AuditConfigs") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "AuditConfigs") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

Policy: An Identity and Access Management (IAM) policy, which specifiesaccess controls for Google Cloud resources. A `Policy` is a collection of`bindings`. A `binding` binds one or more `members`, or principals, to asingle `role`. Principals can be user accounts, service accounts, Googlegroups, and domains (such as G Suite). A `role` is a named list ofpermissions; each `role` can be an IAM predefined role or a user-createdcustom role. For some types of Google Cloud resources, a `binding` can alsospecify a `condition`, which is a logical expression that allows access to aresource only if the expression evaluates to `true`. A condition can addconstraints based on attributes of the request, the resource, or both. Tolearn which resources support conditions in their IAM policies, see the IAMdocumentation(https://cloud.google.com/iam/help/conditions/resource-policies). **JSONexample:** ``` { "bindings": [ { "role":"roles/resourcemanager.organizationAdmin", "members": ["user:mike@example.com", "group:admins@example.com", "domain:google.com","serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role":"roles/resourcemanager.organizationViewer", "members": ["user:eve@example.com" ], "condition": { "title": "expirable access","description": "Does not grant access after Sep 2020", "expression":"request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag":"BwWWja0YfJA=", "version": 3 } ``` **YAML example:** ``` bindings: -members: - user:mike@example.com - group:admins@example.com -domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.comrole: roles/resourcemanager.organizationAdmin - members: -user:eve@example.com role: roles/resourcemanager.organizationViewercondition: title: expirable access description: Does not grant access afterSep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z')etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features,see the IAM documentation (https://cloud.google.com/iam/docs/).

func (Policy)MarshalJSON

func (sPolicy) MarshalJSON() ([]byte,error)

typeProjectsLocationsBackupChannelsBackupPlanBindingsGetCalladded inv0.230.0

type ProjectsLocationsBackupChannelsBackupPlanBindingsGetCall struct {// contains filtered or unexported fields}

func (*ProjectsLocationsBackupChannelsBackupPlanBindingsGetCall)Contextadded inv0.230.0

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsBackupChannelsBackupPlanBindingsGetCall)Doadded inv0.230.0

Do executes the "gkebackup.projects.locations.backupChannels.backupPlanBindings.get" call.Any non-2xx status code is an error. Response headers are in either*BackupPlanBinding.ServerResponse.Header or (if a response was returned atall) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified tocheck whether the returned error was because http.StatusNotModified wasreturned.

func (*ProjectsLocationsBackupChannelsBackupPlanBindingsGetCall)Fieldsadded inv0.230.0

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ProjectsLocationsBackupChannelsBackupPlanBindingsGetCall)Headeradded inv0.230.0

Header returns a http.Header that can be modified by the caller to addheaders to the request.

func (*ProjectsLocationsBackupChannelsBackupPlanBindingsGetCall)IfNoneMatchadded inv0.230.0

IfNoneMatch sets an optional parameter which makes the operation fail if theobject's ETag matches the given value. This is useful for getting updatesonly after the object has changed since the last request.

typeProjectsLocationsBackupChannelsBackupPlanBindingsListCalladded inv0.230.0

type ProjectsLocationsBackupChannelsBackupPlanBindingsListCall struct {// contains filtered or unexported fields}

func (*ProjectsLocationsBackupChannelsBackupPlanBindingsListCall)Contextadded inv0.230.0

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsBackupChannelsBackupPlanBindingsListCall)Doadded inv0.230.0

Do executes the "gkebackup.projects.locations.backupChannels.backupPlanBindings.list" call.Any non-2xx status code is an error. Response headers are in either*ListBackupPlanBindingsResponse.ServerResponse.Header or (if a response wasreturned at all) in error.(*googleapi.Error).Header. Usegoogleapi.IsNotModified to check whether the returned error was becausehttp.StatusNotModified was returned.

func (*ProjectsLocationsBackupChannelsBackupPlanBindingsListCall)Fieldsadded inv0.230.0

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ProjectsLocationsBackupChannelsBackupPlanBindingsListCall)Filteradded inv0.230.0

Filter sets the optional parameter "filter": Field match expression used tofilter the results.

func (*ProjectsLocationsBackupChannelsBackupPlanBindingsListCall)Headeradded inv0.230.0

Header returns a http.Header that can be modified by the caller to addheaders to the request.

func (*ProjectsLocationsBackupChannelsBackupPlanBindingsListCall)IfNoneMatchadded inv0.230.0

IfNoneMatch sets an optional parameter which makes the operation fail if theobject's ETag matches the given value. This is useful for getting updatesonly after the object has changed since the last request.

func (*ProjectsLocationsBackupChannelsBackupPlanBindingsListCall)OrderByadded inv0.230.0

OrderBy sets the optional parameter "orderBy": Field by which to sort theresults.

func (*ProjectsLocationsBackupChannelsBackupPlanBindingsListCall)PageSizeadded inv0.230.0

PageSize sets the optional parameter "pageSize": The target number ofresults to return in a single response. If not specified, a default valuewill be chosen by the service. Note that the response may include a partiallist and a caller should only rely on the response's next_page_token todetermine if there are more instances left to be queried.

func (*ProjectsLocationsBackupChannelsBackupPlanBindingsListCall)PageTokenadded inv0.230.0

PageToken sets the optional parameter "pageToken": The value ofnext_page_token received from a previous `ListBackupPlanBindings` call.Provide this to retrieve the subsequent page in a multi-page list ofresults. When paginating, all other parameters provided to`ListBackupPlanBindings` must match the call that provided the page token.

func (*ProjectsLocationsBackupChannelsBackupPlanBindingsListCall)Pagesadded inv0.230.0

Pages invokes f for each page of results.A non-nil error returned from f will halt the iteration.The provided context supersedes any context provided to the Context method.

typeProjectsLocationsBackupChannelsBackupPlanBindingsServiceadded inv0.230.0

type ProjectsLocationsBackupChannelsBackupPlanBindingsService struct {// contains filtered or unexported fields}

funcNewProjectsLocationsBackupChannelsBackupPlanBindingsServiceadded inv0.230.0

func NewProjectsLocationsBackupChannelsBackupPlanBindingsService(s *Service) *ProjectsLocationsBackupChannelsBackupPlanBindingsService

func (*ProjectsLocationsBackupChannelsBackupPlanBindingsService)Getadded inv0.230.0

Get: Retrieve the details of a single BackupPlanBinding.

  • name: Fully qualified BackupPlanBinding name. Format:`projects/*/locations/*/backupChannels/*/backupPlanBindings/*`.

func (*ProjectsLocationsBackupChannelsBackupPlanBindingsService)Listadded inv0.230.0

List: Lists BackupPlanBindings in a given location.

  • parent: The BackupChannel that contains the BackupPlanBindings to list.Format: `projects/*/locations/*/backupChannels/*`.

typeProjectsLocationsBackupChannelsCreateCalladded inv0.230.0

type ProjectsLocationsBackupChannelsCreateCall struct {// contains filtered or unexported fields}

func (*ProjectsLocationsBackupChannelsCreateCall)BackupChannelIdadded inv0.230.0

BackupChannelId sets the optional parameter "backupChannelId": Theclient-provided short name for the BackupChannel resource. This name must: -be between 1 and 63 characters long (inclusive) - consist of only lower-caseASCII letters, numbers, and dashes - start with a lower-case letter - endwith a lower-case letter or number - be unique within the set ofBackupChannels in this location If the user does not provide a name, a uuidwill be used as the name.

func (*ProjectsLocationsBackupChannelsCreateCall)Contextadded inv0.230.0

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsBackupChannelsCreateCall)Doadded inv0.230.0

Do executes the "gkebackup.projects.locations.backupChannels.create" call.Any non-2xx status code is an error. Response headers are in either*GoogleLongrunningOperation.ServerResponse.Header or (if a response wasreturned at all) in error.(*googleapi.Error).Header. Usegoogleapi.IsNotModified to check whether the returned error was becausehttp.StatusNotModified was returned.

func (*ProjectsLocationsBackupChannelsCreateCall)Fieldsadded inv0.230.0

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ProjectsLocationsBackupChannelsCreateCall)Headeradded inv0.230.0

Header returns a http.Header that can be modified by the caller to addheaders to the request.

typeProjectsLocationsBackupChannelsDeleteCalladded inv0.230.0

type ProjectsLocationsBackupChannelsDeleteCall struct {// contains filtered or unexported fields}

func (*ProjectsLocationsBackupChannelsDeleteCall)Contextadded inv0.230.0

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsBackupChannelsDeleteCall)Doadded inv0.230.0

Do executes the "gkebackup.projects.locations.backupChannels.delete" call.Any non-2xx status code is an error. Response headers are in either*GoogleLongrunningOperation.ServerResponse.Header or (if a response wasreturned at all) in error.(*googleapi.Error).Header. Usegoogleapi.IsNotModified to check whether the returned error was becausehttp.StatusNotModified was returned.

func (*ProjectsLocationsBackupChannelsDeleteCall)Etagadded inv0.230.0

Etag sets the optional parameter "etag": If provided, this value must matchthe current value of the target BackupChannel's etag field or the request isrejected.

func (*ProjectsLocationsBackupChannelsDeleteCall)Fieldsadded inv0.230.0

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ProjectsLocationsBackupChannelsDeleteCall)Forceadded inv0.230.0

Force sets the optional parameter "force": If set to true, anyBackupPlanAssociations below this BackupChannel will also be deleted.Otherwise, the request will only succeed if the BackupChannel has noBackupPlanAssociations.

func (*ProjectsLocationsBackupChannelsDeleteCall)Headeradded inv0.230.0

Header returns a http.Header that can be modified by the caller to addheaders to the request.

typeProjectsLocationsBackupChannelsGetCalladded inv0.230.0

type ProjectsLocationsBackupChannelsGetCall struct {// contains filtered or unexported fields}

func (*ProjectsLocationsBackupChannelsGetCall)Contextadded inv0.230.0

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsBackupChannelsGetCall)Doadded inv0.230.0

Do executes the "gkebackup.projects.locations.backupChannels.get" call.Any non-2xx status code is an error. Response headers are in either*BackupChannel.ServerResponse.Header or (if a response was returned at all)in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to checkwhether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsBackupChannelsGetCall)Fieldsadded inv0.230.0

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ProjectsLocationsBackupChannelsGetCall)Headeradded inv0.230.0

Header returns a http.Header that can be modified by the caller to addheaders to the request.

func (*ProjectsLocationsBackupChannelsGetCall)IfNoneMatchadded inv0.230.0

IfNoneMatch sets an optional parameter which makes the operation fail if theobject's ETag matches the given value. This is useful for getting updatesonly after the object has changed since the last request.

typeProjectsLocationsBackupChannelsListCalladded inv0.230.0

type ProjectsLocationsBackupChannelsListCall struct {// contains filtered or unexported fields}

func (*ProjectsLocationsBackupChannelsListCall)Contextadded inv0.230.0

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsBackupChannelsListCall)Doadded inv0.230.0

Do executes the "gkebackup.projects.locations.backupChannels.list" call.Any non-2xx status code is an error. Response headers are in either*ListBackupChannelsResponse.ServerResponse.Header or (if a response wasreturned at all) in error.(*googleapi.Error).Header. Usegoogleapi.IsNotModified to check whether the returned error was becausehttp.StatusNotModified was returned.

func (*ProjectsLocationsBackupChannelsListCall)Fieldsadded inv0.230.0

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ProjectsLocationsBackupChannelsListCall)Filteradded inv0.230.0

Filter sets the optional parameter "filter": Field match expression used tofilter the results.

func (*ProjectsLocationsBackupChannelsListCall)Headeradded inv0.230.0

Header returns a http.Header that can be modified by the caller to addheaders to the request.

func (*ProjectsLocationsBackupChannelsListCall)IfNoneMatchadded inv0.230.0

IfNoneMatch sets an optional parameter which makes the operation fail if theobject's ETag matches the given value. This is useful for getting updatesonly after the object has changed since the last request.

func (*ProjectsLocationsBackupChannelsListCall)OrderByadded inv0.230.0

OrderBy sets the optional parameter "orderBy": Field by which to sort theresults.

func (*ProjectsLocationsBackupChannelsListCall)PageSizeadded inv0.230.0

PageSize sets the optional parameter "pageSize": The target number ofresults to return in a single response. If not specified, a default valuewill be chosen by the service. Note that the response may include a partiallist and a caller should only rely on the response's next_page_token todetermine if there are more instances left to be queried.

func (*ProjectsLocationsBackupChannelsListCall)PageTokenadded inv0.230.0

PageToken sets the optional parameter "pageToken": The value ofnext_page_token received from a previous `ListBackupChannels` call. Providethis to retrieve the subsequent page in a multi-page list of results. Whenpaginating, all other parameters provided to `ListBackupChannels` must matchthe call that provided the page token.

func (*ProjectsLocationsBackupChannelsListCall)Pagesadded inv0.230.0

Pages invokes f for each page of results.A non-nil error returned from f will halt the iteration.The provided context supersedes any context provided to the Context method.

typeProjectsLocationsBackupChannelsPatchCalladded inv0.230.0

type ProjectsLocationsBackupChannelsPatchCall struct {// contains filtered or unexported fields}

func (*ProjectsLocationsBackupChannelsPatchCall)Contextadded inv0.230.0

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsBackupChannelsPatchCall)Doadded inv0.230.0

Do executes the "gkebackup.projects.locations.backupChannels.patch" call.Any non-2xx status code is an error. Response headers are in either*GoogleLongrunningOperation.ServerResponse.Header or (if a response wasreturned at all) in error.(*googleapi.Error).Header. Usegoogleapi.IsNotModified to check whether the returned error was becausehttp.StatusNotModified was returned.

func (*ProjectsLocationsBackupChannelsPatchCall)Fieldsadded inv0.230.0

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ProjectsLocationsBackupChannelsPatchCall)Headeradded inv0.230.0

Header returns a http.Header that can be modified by the caller to addheaders to the request.

func (*ProjectsLocationsBackupChannelsPatchCall)UpdateMaskadded inv0.230.0

UpdateMask sets the optional parameter "updateMask": This is used to specifythe fields to be overwritten in the BackupChannel targeted for update. Thevalues for each of these updated fields will be taken from the`backup_channel` provided with this request. Field names are relative to theroot of the resource (e.g., `description`, `labels`, etc.) If no`update_mask` is provided, all fields in `backup_channel` will be written tothe target BackupChannel resource. Note that OUTPUT_ONLY and IMMUTABLEfields in `backup_channel` are ignored and are not used to update the targetBackupChannel.

typeProjectsLocationsBackupChannelsServiceadded inv0.230.0

type ProjectsLocationsBackupChannelsService struct {BackupPlanBindings *ProjectsLocationsBackupChannelsBackupPlanBindingsService// contains filtered or unexported fields}

funcNewProjectsLocationsBackupChannelsServiceadded inv0.230.0

func NewProjectsLocationsBackupChannelsService(s *Service) *ProjectsLocationsBackupChannelsService

func (*ProjectsLocationsBackupChannelsService)Createadded inv0.230.0

Create: Creates a new BackupChannel in a given location.

  • parent: The location within which to create the BackupChannel. Format:`projects/*/locations/*`.

func (*ProjectsLocationsBackupChannelsService)Deleteadded inv0.230.0

Delete: Deletes an existing BackupChannel.

  • name: Fully qualified BackupChannel name. Format:`projects/*/locations/*/backupChannels/*`.

func (*ProjectsLocationsBackupChannelsService)Getadded inv0.230.0

Get: Retrieve the details of a single BackupChannel.

  • name: Fully qualified BackupChannel name. Format:`projects/*/locations/*/backupChannels/*`.

func (*ProjectsLocationsBackupChannelsService)Listadded inv0.230.0

List: Lists BackupChannels in a given location.

  • parent: The location that contains the BackupChannels to list. Format:`projects/*/locations/*`.

func (*ProjectsLocationsBackupChannelsService)Patchadded inv0.230.0

Patch: Update a BackupChannel.

  • name: Identifier. The fully qualified name of the BackupChannel.`projects/*/locations/*/backupChannels/*`.

typeProjectsLocationsBackupPlansBackupsCreateCall

type ProjectsLocationsBackupPlansBackupsCreateCall struct {// contains filtered or unexported fields}

func (*ProjectsLocationsBackupPlansBackupsCreateCall)BackupId

BackupId sets the optional parameter "backupId": The client-provided shortname for the Backup resource. This name must: - be between 1 and 63characters long (inclusive) - consist of only lower-case ASCII letters,numbers, and dashes - start with a lower-case letter - end with a lower-caseletter or number - be unique within the set of Backups in this BackupPlan

func (*ProjectsLocationsBackupPlansBackupsCreateCall)Context

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsBackupPlansBackupsCreateCall)Do

Do executes the "gkebackup.projects.locations.backupPlans.backups.create" call.Any non-2xx status code is an error. Response headers are in either*GoogleLongrunningOperation.ServerResponse.Header or (if a response wasreturned at all) in error.(*googleapi.Error).Header. Usegoogleapi.IsNotModified to check whether the returned error was becausehttp.StatusNotModified was returned.

func (*ProjectsLocationsBackupPlansBackupsCreateCall)Fields

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ProjectsLocationsBackupPlansBackupsCreateCall)Header

Header returns a http.Header that can be modified by the caller to addheaders to the request.

typeProjectsLocationsBackupPlansBackupsDeleteCall

type ProjectsLocationsBackupPlansBackupsDeleteCall struct {// contains filtered or unexported fields}

func (*ProjectsLocationsBackupPlansBackupsDeleteCall)Context

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsBackupPlansBackupsDeleteCall)Do

Do executes the "gkebackup.projects.locations.backupPlans.backups.delete" call.Any non-2xx status code is an error. Response headers are in either*GoogleLongrunningOperation.ServerResponse.Header or (if a response wasreturned at all) in error.(*googleapi.Error).Header. Usegoogleapi.IsNotModified to check whether the returned error was becausehttp.StatusNotModified was returned.

func (*ProjectsLocationsBackupPlansBackupsDeleteCall)Etag

Etag sets the optional parameter "etag": If provided, this value must matchthe current value of the target Backup's etag field or the request isrejected.

func (*ProjectsLocationsBackupPlansBackupsDeleteCall)Fields

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ProjectsLocationsBackupPlansBackupsDeleteCall)Force

Force sets the optional parameter "force": If set to true, any VolumeBackupsbelow this Backup will also be deleted. Otherwise, the request will onlysucceed if the Backup has no VolumeBackups.

func (*ProjectsLocationsBackupPlansBackupsDeleteCall)Header

Header returns a http.Header that can be modified by the caller to addheaders to the request.

typeProjectsLocationsBackupPlansBackupsGetBackupIndexDownloadUrlCalladded inv0.173.0

type ProjectsLocationsBackupPlansBackupsGetBackupIndexDownloadUrlCall struct {// contains filtered or unexported fields}

func (*ProjectsLocationsBackupPlansBackupsGetBackupIndexDownloadUrlCall)Contextadded inv0.173.0

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsBackupPlansBackupsGetBackupIndexDownloadUrlCall)Doadded inv0.173.0

Do executes the "gkebackup.projects.locations.backupPlans.backups.getBackupIndexDownloadUrl" call.Any non-2xx status code is an error. Response headers are in either*GetBackupIndexDownloadUrlResponse.ServerResponse.Header or (if a responsewas returned at all) in error.(*googleapi.Error).Header. Usegoogleapi.IsNotModified to check whether the returned error was becausehttp.StatusNotModified was returned.

func (*ProjectsLocationsBackupPlansBackupsGetBackupIndexDownloadUrlCall)Fieldsadded inv0.173.0

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ProjectsLocationsBackupPlansBackupsGetBackupIndexDownloadUrlCall)Headeradded inv0.173.0

Header returns a http.Header that can be modified by the caller to addheaders to the request.

func (*ProjectsLocationsBackupPlansBackupsGetBackupIndexDownloadUrlCall)IfNoneMatchadded inv0.173.0

IfNoneMatch sets an optional parameter which makes the operation fail if theobject's ETag matches the given value. This is useful for getting updatesonly after the object has changed since the last request.

typeProjectsLocationsBackupPlansBackupsGetCall

type ProjectsLocationsBackupPlansBackupsGetCall struct {// contains filtered or unexported fields}

func (*ProjectsLocationsBackupPlansBackupsGetCall)Context

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsBackupPlansBackupsGetCall)Do

Do executes the "gkebackup.projects.locations.backupPlans.backups.get" call.Any non-2xx status code is an error. Response headers are in either*Backup.ServerResponse.Header or (if a response was returned at all) inerror.(*googleapi.Error).Header. Use googleapi.IsNotModified to checkwhether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsBackupPlansBackupsGetCall)Fields

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ProjectsLocationsBackupPlansBackupsGetCall)Header

Header returns a http.Header that can be modified by the caller to addheaders to the request.

func (*ProjectsLocationsBackupPlansBackupsGetCall)IfNoneMatch

IfNoneMatch sets an optional parameter which makes the operation fail if theobject's ETag matches the given value. This is useful for getting updatesonly after the object has changed since the last request.

typeProjectsLocationsBackupPlansBackupsGetIamPolicyCall

type ProjectsLocationsBackupPlansBackupsGetIamPolicyCall struct {// contains filtered or unexported fields}

func (*ProjectsLocationsBackupPlansBackupsGetIamPolicyCall)Context

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsBackupPlansBackupsGetIamPolicyCall)Do

Do executes the "gkebackup.projects.locations.backupPlans.backups.getIamPolicy" call.Any non-2xx status code is an error. Response headers are in either*Policy.ServerResponse.Header or (if a response was returned at all) inerror.(*googleapi.Error).Header. Use googleapi.IsNotModified to checkwhether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsBackupPlansBackupsGetIamPolicyCall)Fields

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ProjectsLocationsBackupPlansBackupsGetIamPolicyCall)Header

Header returns a http.Header that can be modified by the caller to addheaders to the request.

func (*ProjectsLocationsBackupPlansBackupsGetIamPolicyCall)IfNoneMatch

IfNoneMatch sets an optional parameter which makes the operation fail if theobject's ETag matches the given value. This is useful for getting updatesonly after the object has changed since the last request.

func (*ProjectsLocationsBackupPlansBackupsGetIamPolicyCall)OptionsRequestedPolicyVersion

func (c *ProjectsLocationsBackupPlansBackupsGetIamPolicyCall) OptionsRequestedPolicyVersion(optionsRequestedPolicyVersionint64) *ProjectsLocationsBackupPlansBackupsGetIamPolicyCall

OptionsRequestedPolicyVersion sets the optional parameter"options.requestedPolicyVersion": The maximum policy version that will beused to format the policy. Valid values are 0, 1, and 3. Requests specifyingan invalid value will be rejected. Requests for policies with anyconditional role bindings must specify version 3. Policies with noconditional role bindings may specify any valid value or leave the fieldunset. The policy in the response might use the policy version that youspecified, or it might use a lower policy version. For example, if youspecify version 3, but the policy has no conditional role bindings, theresponse uses version 1. To learn which resources support conditions intheir IAM policies, see the IAM documentation(https://cloud.google.com/iam/help/conditions/resource-policies).

typeProjectsLocationsBackupPlansBackupsListCall

type ProjectsLocationsBackupPlansBackupsListCall struct {// contains filtered or unexported fields}

func (*ProjectsLocationsBackupPlansBackupsListCall)Context

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsBackupPlansBackupsListCall)Do

Do executes the "gkebackup.projects.locations.backupPlans.backups.list" call.Any non-2xx status code is an error. Response headers are in either*ListBackupsResponse.ServerResponse.Header or (if a response was returned atall) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified tocheck whether the returned error was because http.StatusNotModified wasreturned.

func (*ProjectsLocationsBackupPlansBackupsListCall)Fields

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ProjectsLocationsBackupPlansBackupsListCall)Filter

Filter sets the optional parameter "filter": Field match expression used tofilter the results.

func (*ProjectsLocationsBackupPlansBackupsListCall)Header

Header returns a http.Header that can be modified by the caller to addheaders to the request.

func (*ProjectsLocationsBackupPlansBackupsListCall)IfNoneMatch

IfNoneMatch sets an optional parameter which makes the operation fail if theobject's ETag matches the given value. This is useful for getting updatesonly after the object has changed since the last request.

func (*ProjectsLocationsBackupPlansBackupsListCall)OrderBy

OrderBy sets the optional parameter "orderBy": Field by which to sort theresults.

func (*ProjectsLocationsBackupPlansBackupsListCall)PageSize

PageSize sets the optional parameter "pageSize": The target number ofresults to return in a single response. If not specified, a default valuewill be chosen by the service. Note that the response may include a partiallist and a caller should only rely on the response's next_page_token todetermine if there are more instances left to be queried.

func (*ProjectsLocationsBackupPlansBackupsListCall)PageToken

PageToken sets the optional parameter "pageToken": The value ofnext_page_token received from a previous `ListBackups` call. Provide this toretrieve the subsequent page in a multi-page list of results. Whenpaginating, all other parameters provided to `ListBackups` must match thecall that provided the page token.

func (*ProjectsLocationsBackupPlansBackupsListCall)Pages

Pages invokes f for each page of results.A non-nil error returned from f will halt the iteration.The provided context supersedes any context provided to the Context method.

func (*ProjectsLocationsBackupPlansBackupsListCall)ReturnPartialSuccessadded inv0.222.0

ReturnPartialSuccess sets the optional parameter "returnPartialSuccess": Ifset to true, the response will return partial results when some regions areunreachable and the unreachable field will be populated.

typeProjectsLocationsBackupPlansBackupsPatchCall

type ProjectsLocationsBackupPlansBackupsPatchCall struct {// contains filtered or unexported fields}

func (*ProjectsLocationsBackupPlansBackupsPatchCall)Context

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsBackupPlansBackupsPatchCall)Do

Do executes the "gkebackup.projects.locations.backupPlans.backups.patch" call.Any non-2xx status code is an error. Response headers are in either*GoogleLongrunningOperation.ServerResponse.Header or (if a response wasreturned at all) in error.(*googleapi.Error).Header. Usegoogleapi.IsNotModified to check whether the returned error was becausehttp.StatusNotModified was returned.

func (*ProjectsLocationsBackupPlansBackupsPatchCall)Fields

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ProjectsLocationsBackupPlansBackupsPatchCall)Header

Header returns a http.Header that can be modified by the caller to addheaders to the request.

func (*ProjectsLocationsBackupPlansBackupsPatchCall)UpdateMask

UpdateMask sets the optional parameter "updateMask": This is used to specifythe fields to be overwritten in the Backup targeted for update. The valuesfor each of these updated fields will be taken from the `backup_plan`provided with this request. Field names are relative to the root of theresource. If no `update_mask` is provided, all fields in `backup` will bewritten to the target Backup resource. Note that OUTPUT_ONLY and IMMUTABLEfields in `backup` are ignored and are not used to update the target Backup.

typeProjectsLocationsBackupPlansBackupsService

type ProjectsLocationsBackupPlansBackupsService struct {VolumeBackups *ProjectsLocationsBackupPlansBackupsVolumeBackupsService// contains filtered or unexported fields}

func (*ProjectsLocationsBackupPlansBackupsService)Create

Create: Creates a Backup for the given BackupPlan.

  • parent: The BackupPlan within which to create the Backup. Format:`projects/*/locations/*/backupPlans/*`.

func (*ProjectsLocationsBackupPlansBackupsService)Delete

Delete: Deletes an existing Backup.

  • name: Name of the Backup resource. Format:`projects/*/locations/*/backupPlans/*/backups/*`.

func (*ProjectsLocationsBackupPlansBackupsService)Get

Get: Retrieve the details of a single Backup.

  • name: Full name of the Backup resource. Format:`projects/*/locations/*/backupPlans/*/backups/*`.

func (*ProjectsLocationsBackupPlansBackupsService)GetBackupIndexDownloadUrladded inv0.173.0

GetBackupIndexDownloadUrl: Retrieve the link to the backupIndex.

  • backup: Full name of Backup resource. Format:projects/{project}/locations/{location}/backupPlans/{backup_plan}/backups/{backup}.

func (*ProjectsLocationsBackupPlansBackupsService)GetIamPolicy

GetIamPolicy: Gets the access control policy for a resource. Returns anempty policy if the resource exists and does not have a policy set.

func (*ProjectsLocationsBackupPlansBackupsService)List

List: Lists the Backups for a given BackupPlan.

  • parent: The BackupPlan that contains the Backups to list. Format:`projects/*/locations/*/backupPlans/*`.

func (*ProjectsLocationsBackupPlansBackupsService)Patch

Patch: Update a Backup.

  • name: Output only. Identifier. The fully qualified name of the Backup.`projects/*/locations/*/backupPlans/*/backups/*`.

func (*ProjectsLocationsBackupPlansBackupsService)SetIamPolicy

SetIamPolicy: Sets the access control policy on the specified resource.Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`,and `PERMISSION_DENIED` errors.

func (*ProjectsLocationsBackupPlansBackupsService)TestIamPermissions

TestIamPermissions: Returns permissions that a caller has on the specifiedresource. If the resource does not exist, this will return an empty set ofpermissions, not a `NOT_FOUND` error. Note: This operation is designed to beused for building permission-aware UIs and command-line tools, not forauthorization checking. This operation may "fail open" without warning.

typeProjectsLocationsBackupPlansBackupsSetIamPolicyCall

type ProjectsLocationsBackupPlansBackupsSetIamPolicyCall struct {// contains filtered or unexported fields}

func (*ProjectsLocationsBackupPlansBackupsSetIamPolicyCall)Context

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsBackupPlansBackupsSetIamPolicyCall)Do

Do executes the "gkebackup.projects.locations.backupPlans.backups.setIamPolicy" call.Any non-2xx status code is an error. Response headers are in either*Policy.ServerResponse.Header or (if a response was returned at all) inerror.(*googleapi.Error).Header. Use googleapi.IsNotModified to checkwhether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsBackupPlansBackupsSetIamPolicyCall)Fields

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ProjectsLocationsBackupPlansBackupsSetIamPolicyCall)Header

Header returns a http.Header that can be modified by the caller to addheaders to the request.

typeProjectsLocationsBackupPlansBackupsTestIamPermissionsCall

type ProjectsLocationsBackupPlansBackupsTestIamPermissionsCall struct {// contains filtered or unexported fields}

func (*ProjectsLocationsBackupPlansBackupsTestIamPermissionsCall)Context

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsBackupPlansBackupsTestIamPermissionsCall)Do

Do executes the "gkebackup.projects.locations.backupPlans.backups.testIamPermissions" call.Any non-2xx status code is an error. Response headers are in either*TestIamPermissionsResponse.ServerResponse.Header or (if a response wasreturned at all) in error.(*googleapi.Error).Header. Usegoogleapi.IsNotModified to check whether the returned error was becausehttp.StatusNotModified was returned.

func (*ProjectsLocationsBackupPlansBackupsTestIamPermissionsCall)Fields

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ProjectsLocationsBackupPlansBackupsTestIamPermissionsCall)Header

Header returns a http.Header that can be modified by the caller to addheaders to the request.

typeProjectsLocationsBackupPlansBackupsVolumeBackupsGetCall

type ProjectsLocationsBackupPlansBackupsVolumeBackupsGetCall struct {// contains filtered or unexported fields}

func (*ProjectsLocationsBackupPlansBackupsVolumeBackupsGetCall)Context

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsBackupPlansBackupsVolumeBackupsGetCall)Do

Do executes the "gkebackup.projects.locations.backupPlans.backups.volumeBackups.get" call.Any non-2xx status code is an error. Response headers are in either*VolumeBackup.ServerResponse.Header or (if a response was returned at all)in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to checkwhether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsBackupPlansBackupsVolumeBackupsGetCall)Fields

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ProjectsLocationsBackupPlansBackupsVolumeBackupsGetCall)Header

Header returns a http.Header that can be modified by the caller to addheaders to the request.

func (*ProjectsLocationsBackupPlansBackupsVolumeBackupsGetCall)IfNoneMatch

IfNoneMatch sets an optional parameter which makes the operation fail if theobject's ETag matches the given value. This is useful for getting updatesonly after the object has changed since the last request.

typeProjectsLocationsBackupPlansBackupsVolumeBackupsGetIamPolicyCall

type ProjectsLocationsBackupPlansBackupsVolumeBackupsGetIamPolicyCall struct {// contains filtered or unexported fields}

func (*ProjectsLocationsBackupPlansBackupsVolumeBackupsGetIamPolicyCall)Context

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsBackupPlansBackupsVolumeBackupsGetIamPolicyCall)Do

Do executes the "gkebackup.projects.locations.backupPlans.backups.volumeBackups.getIamPolicy" call.Any non-2xx status code is an error. Response headers are in either*Policy.ServerResponse.Header or (if a response was returned at all) inerror.(*googleapi.Error).Header. Use googleapi.IsNotModified to checkwhether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsBackupPlansBackupsVolumeBackupsGetIamPolicyCall)Fields

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ProjectsLocationsBackupPlansBackupsVolumeBackupsGetIamPolicyCall)Header

Header returns a http.Header that can be modified by the caller to addheaders to the request.

func (*ProjectsLocationsBackupPlansBackupsVolumeBackupsGetIamPolicyCall)IfNoneMatch

IfNoneMatch sets an optional parameter which makes the operation fail if theobject's ETag matches the given value. This is useful for getting updatesonly after the object has changed since the last request.

func (*ProjectsLocationsBackupPlansBackupsVolumeBackupsGetIamPolicyCall)OptionsRequestedPolicyVersion

OptionsRequestedPolicyVersion sets the optional parameter"options.requestedPolicyVersion": The maximum policy version that will beused to format the policy. Valid values are 0, 1, and 3. Requests specifyingan invalid value will be rejected. Requests for policies with anyconditional role bindings must specify version 3. Policies with noconditional role bindings may specify any valid value or leave the fieldunset. The policy in the response might use the policy version that youspecified, or it might use a lower policy version. For example, if youspecify version 3, but the policy has no conditional role bindings, theresponse uses version 1. To learn which resources support conditions intheir IAM policies, see the IAM documentation(https://cloud.google.com/iam/help/conditions/resource-policies).

typeProjectsLocationsBackupPlansBackupsVolumeBackupsListCall

type ProjectsLocationsBackupPlansBackupsVolumeBackupsListCall struct {// contains filtered or unexported fields}

func (*ProjectsLocationsBackupPlansBackupsVolumeBackupsListCall)Context

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsBackupPlansBackupsVolumeBackupsListCall)Do

Do executes the "gkebackup.projects.locations.backupPlans.backups.volumeBackups.list" call.Any non-2xx status code is an error. Response headers are in either*ListVolumeBackupsResponse.ServerResponse.Header or (if a response wasreturned at all) in error.(*googleapi.Error).Header. Usegoogleapi.IsNotModified to check whether the returned error was becausehttp.StatusNotModified was returned.

func (*ProjectsLocationsBackupPlansBackupsVolumeBackupsListCall)Fields

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ProjectsLocationsBackupPlansBackupsVolumeBackupsListCall)Filter

Filter sets the optional parameter "filter": Field match expression used tofilter the results.

func (*ProjectsLocationsBackupPlansBackupsVolumeBackupsListCall)Header

Header returns a http.Header that can be modified by the caller to addheaders to the request.

func (*ProjectsLocationsBackupPlansBackupsVolumeBackupsListCall)IfNoneMatch

IfNoneMatch sets an optional parameter which makes the operation fail if theobject's ETag matches the given value. This is useful for getting updatesonly after the object has changed since the last request.

func (*ProjectsLocationsBackupPlansBackupsVolumeBackupsListCall)OrderBy

OrderBy sets the optional parameter "orderBy": Field by which to sort theresults.

func (*ProjectsLocationsBackupPlansBackupsVolumeBackupsListCall)PageSize

PageSize sets the optional parameter "pageSize": The target number ofresults to return in a single response. If not specified, a default valuewill be chosen by the service. Note that the response may include a partiallist and a caller should only rely on the response's next_page_token todetermine if there are more instances left to be queried.

func (*ProjectsLocationsBackupPlansBackupsVolumeBackupsListCall)PageToken

PageToken sets the optional parameter "pageToken": The value ofnext_page_token received from a previous `ListVolumeBackups` call. Providethis to retrieve the subsequent page in a multi-page list of results. Whenpaginating, all other parameters provided to `ListVolumeBackups` must matchthe call that provided the page token.

func (*ProjectsLocationsBackupPlansBackupsVolumeBackupsListCall)Pages

Pages invokes f for each page of results.A non-nil error returned from f will halt the iteration.The provided context supersedes any context provided to the Context method.

typeProjectsLocationsBackupPlansBackupsVolumeBackupsService

type ProjectsLocationsBackupPlansBackupsVolumeBackupsService struct {// contains filtered or unexported fields}

func (*ProjectsLocationsBackupPlansBackupsVolumeBackupsService)Get

Get: Retrieve the details of a single VolumeBackup.

  • name: Full name of the VolumeBackup resource. Format:`projects/*/locations/*/backupPlans/*/backups/*/volumeBackups/*`.

func (*ProjectsLocationsBackupPlansBackupsVolumeBackupsService)GetIamPolicy

GetIamPolicy: Gets the access control policy for a resource. Returns anempty policy if the resource exists and does not have a policy set.

func (*ProjectsLocationsBackupPlansBackupsVolumeBackupsService)List

List: Lists the VolumeBackups for a given Backup.

  • parent: The Backup that contains the VolumeBackups to list. Format:`projects/*/locations/*/backupPlans/*/backups/*`.

func (*ProjectsLocationsBackupPlansBackupsVolumeBackupsService)SetIamPolicy

SetIamPolicy: Sets the access control policy on the specified resource.Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`,and `PERMISSION_DENIED` errors.

func (*ProjectsLocationsBackupPlansBackupsVolumeBackupsService)TestIamPermissions

TestIamPermissions: Returns permissions that a caller has on the specifiedresource. If the resource does not exist, this will return an empty set ofpermissions, not a `NOT_FOUND` error. Note: This operation is designed to beused for building permission-aware UIs and command-line tools, not forauthorization checking. This operation may "fail open" without warning.

typeProjectsLocationsBackupPlansBackupsVolumeBackupsSetIamPolicyCall

type ProjectsLocationsBackupPlansBackupsVolumeBackupsSetIamPolicyCall struct {// contains filtered or unexported fields}

func (*ProjectsLocationsBackupPlansBackupsVolumeBackupsSetIamPolicyCall)Context

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsBackupPlansBackupsVolumeBackupsSetIamPolicyCall)Do

Do executes the "gkebackup.projects.locations.backupPlans.backups.volumeBackups.setIamPolicy" call.Any non-2xx status code is an error. Response headers are in either*Policy.ServerResponse.Header or (if a response was returned at all) inerror.(*googleapi.Error).Header. Use googleapi.IsNotModified to checkwhether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsBackupPlansBackupsVolumeBackupsSetIamPolicyCall)Fields

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ProjectsLocationsBackupPlansBackupsVolumeBackupsSetIamPolicyCall)Header

Header returns a http.Header that can be modified by the caller to addheaders to the request.

typeProjectsLocationsBackupPlansBackupsVolumeBackupsTestIamPermissionsCall

type ProjectsLocationsBackupPlansBackupsVolumeBackupsTestIamPermissionsCall struct {// contains filtered or unexported fields}

func (*ProjectsLocationsBackupPlansBackupsVolumeBackupsTestIamPermissionsCall)Context

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsBackupPlansBackupsVolumeBackupsTestIamPermissionsCall)Do

Do executes the "gkebackup.projects.locations.backupPlans.backups.volumeBackups.testIamPermissions" call.Any non-2xx status code is an error. Response headers are in either*TestIamPermissionsResponse.ServerResponse.Header or (if a response wasreturned at all) in error.(*googleapi.Error).Header. Usegoogleapi.IsNotModified to check whether the returned error was becausehttp.StatusNotModified was returned.

func (*ProjectsLocationsBackupPlansBackupsVolumeBackupsTestIamPermissionsCall)Fields

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ProjectsLocationsBackupPlansBackupsVolumeBackupsTestIamPermissionsCall)Header

Header returns a http.Header that can be modified by the caller to addheaders to the request.

typeProjectsLocationsBackupPlansCreateCall

type ProjectsLocationsBackupPlansCreateCall struct {// contains filtered or unexported fields}

func (*ProjectsLocationsBackupPlansCreateCall)BackupPlanId

BackupPlanId sets the optional parameter "backupPlanId": Required. Theclient-provided short name for the BackupPlan resource. This name must: - bebetween 1 and 63 characters long (inclusive) - consist of only lower-caseASCII letters, numbers, and dashes - start with a lower-case letter - endwith a lower-case letter or number - be unique within the set of BackupPlansin this location

func (*ProjectsLocationsBackupPlansCreateCall)Context

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsBackupPlansCreateCall)Do

Do executes the "gkebackup.projects.locations.backupPlans.create" call.Any non-2xx status code is an error. Response headers are in either*GoogleLongrunningOperation.ServerResponse.Header or (if a response wasreturned at all) in error.(*googleapi.Error).Header. Usegoogleapi.IsNotModified to check whether the returned error was becausehttp.StatusNotModified was returned.

func (*ProjectsLocationsBackupPlansCreateCall)Fields

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ProjectsLocationsBackupPlansCreateCall)Header

Header returns a http.Header that can be modified by the caller to addheaders to the request.

typeProjectsLocationsBackupPlansDeleteCall

type ProjectsLocationsBackupPlansDeleteCall struct {// contains filtered or unexported fields}

func (*ProjectsLocationsBackupPlansDeleteCall)Context

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsBackupPlansDeleteCall)Do

Do executes the "gkebackup.projects.locations.backupPlans.delete" call.Any non-2xx status code is an error. Response headers are in either*GoogleLongrunningOperation.ServerResponse.Header or (if a response wasreturned at all) in error.(*googleapi.Error).Header. Usegoogleapi.IsNotModified to check whether the returned error was becausehttp.StatusNotModified was returned.

func (*ProjectsLocationsBackupPlansDeleteCall)Etag

Etag sets the optional parameter "etag": If provided, this value must matchthe current value of the target BackupPlan's etag field or the request isrejected.

func (*ProjectsLocationsBackupPlansDeleteCall)Fields

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ProjectsLocationsBackupPlansDeleteCall)Header

Header returns a http.Header that can be modified by the caller to addheaders to the request.

typeProjectsLocationsBackupPlansGetCall

type ProjectsLocationsBackupPlansGetCall struct {// contains filtered or unexported fields}

func (*ProjectsLocationsBackupPlansGetCall)Context

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsBackupPlansGetCall)Do

Do executes the "gkebackup.projects.locations.backupPlans.get" call.Any non-2xx status code is an error. Response headers are in either*BackupPlan.ServerResponse.Header or (if a response was returned at all) inerror.(*googleapi.Error).Header. Use googleapi.IsNotModified to checkwhether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsBackupPlansGetCall)Fields

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ProjectsLocationsBackupPlansGetCall)Header

Header returns a http.Header that can be modified by the caller to addheaders to the request.

func (*ProjectsLocationsBackupPlansGetCall)IfNoneMatch

IfNoneMatch sets an optional parameter which makes the operation fail if theobject's ETag matches the given value. This is useful for getting updatesonly after the object has changed since the last request.

typeProjectsLocationsBackupPlansGetIamPolicyCall

type ProjectsLocationsBackupPlansGetIamPolicyCall struct {// contains filtered or unexported fields}

func (*ProjectsLocationsBackupPlansGetIamPolicyCall)Context

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsBackupPlansGetIamPolicyCall)Do

Do executes the "gkebackup.projects.locations.backupPlans.getIamPolicy" call.Any non-2xx status code is an error. Response headers are in either*Policy.ServerResponse.Header or (if a response was returned at all) inerror.(*googleapi.Error).Header. Use googleapi.IsNotModified to checkwhether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsBackupPlansGetIamPolicyCall)Fields

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ProjectsLocationsBackupPlansGetIamPolicyCall)Header

Header returns a http.Header that can be modified by the caller to addheaders to the request.

func (*ProjectsLocationsBackupPlansGetIamPolicyCall)IfNoneMatch

IfNoneMatch sets an optional parameter which makes the operation fail if theobject's ETag matches the given value. This is useful for getting updatesonly after the object has changed since the last request.

func (*ProjectsLocationsBackupPlansGetIamPolicyCall)OptionsRequestedPolicyVersion

func (c *ProjectsLocationsBackupPlansGetIamPolicyCall) OptionsRequestedPolicyVersion(optionsRequestedPolicyVersionint64) *ProjectsLocationsBackupPlansGetIamPolicyCall

OptionsRequestedPolicyVersion sets the optional parameter"options.requestedPolicyVersion": The maximum policy version that will beused to format the policy. Valid values are 0, 1, and 3. Requests specifyingan invalid value will be rejected. Requests for policies with anyconditional role bindings must specify version 3. Policies with noconditional role bindings may specify any valid value or leave the fieldunset. The policy in the response might use the policy version that youspecified, or it might use a lower policy version. For example, if youspecify version 3, but the policy has no conditional role bindings, theresponse uses version 1. To learn which resources support conditions intheir IAM policies, see the IAM documentation(https://cloud.google.com/iam/help/conditions/resource-policies).

typeProjectsLocationsBackupPlansGetTagsCalladded inv0.257.0

type ProjectsLocationsBackupPlansGetTagsCall struct {// contains filtered or unexported fields}

func (*ProjectsLocationsBackupPlansGetTagsCall)Contextadded inv0.257.0

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsBackupPlansGetTagsCall)Doadded inv0.257.0

Do executes the "gkebackup.projects.locations.backupPlans.getTags" call.Any non-2xx status code is an error. Response headers are in either*GetTagsResponse.ServerResponse.Header or (if a response was returned atall) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified tocheck whether the returned error was because http.StatusNotModified wasreturned.

func (*ProjectsLocationsBackupPlansGetTagsCall)Fieldsadded inv0.257.0

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ProjectsLocationsBackupPlansGetTagsCall)Headeradded inv0.257.0

Header returns a http.Header that can be modified by the caller to addheaders to the request.

func (*ProjectsLocationsBackupPlansGetTagsCall)IfNoneMatchadded inv0.257.0

IfNoneMatch sets an optional parameter which makes the operation fail if theobject's ETag matches the given value. This is useful for getting updatesonly after the object has changed since the last request.

typeProjectsLocationsBackupPlansListCall

type ProjectsLocationsBackupPlansListCall struct {// contains filtered or unexported fields}

func (*ProjectsLocationsBackupPlansListCall)Context

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsBackupPlansListCall)Do

Do executes the "gkebackup.projects.locations.backupPlans.list" call.Any non-2xx status code is an error. Response headers are in either*ListBackupPlansResponse.ServerResponse.Header or (if a response wasreturned at all) in error.(*googleapi.Error).Header. Usegoogleapi.IsNotModified to check whether the returned error was becausehttp.StatusNotModified was returned.

func (*ProjectsLocationsBackupPlansListCall)Fields

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ProjectsLocationsBackupPlansListCall)Filter

Filter sets the optional parameter "filter": Field match expression used tofilter the results.

func (*ProjectsLocationsBackupPlansListCall)Header

Header returns a http.Header that can be modified by the caller to addheaders to the request.

func (*ProjectsLocationsBackupPlansListCall)IfNoneMatch

IfNoneMatch sets an optional parameter which makes the operation fail if theobject's ETag matches the given value. This is useful for getting updatesonly after the object has changed since the last request.

func (*ProjectsLocationsBackupPlansListCall)OrderBy

OrderBy sets the optional parameter "orderBy": Field by which to sort theresults.

func (*ProjectsLocationsBackupPlansListCall)PageSize

PageSize sets the optional parameter "pageSize": The target number ofresults to return in a single response. If not specified, a default valuewill be chosen by the service. Note that the response may include a partiallist and a caller should only rely on the response's next_page_token todetermine if there are more instances left to be queried.

func (*ProjectsLocationsBackupPlansListCall)PageToken

PageToken sets the optional parameter "pageToken": The value ofnext_page_token received from a previous `ListBackupPlans` call. Providethis to retrieve the subsequent page in a multi-page list of results. Whenpaginating, all other parameters provided to `ListBackupPlans` must matchthe call that provided the page token.

func (*ProjectsLocationsBackupPlansListCall)Pages

Pages invokes f for each page of results.A non-nil error returned from f will halt the iteration.The provided context supersedes any context provided to the Context method.

typeProjectsLocationsBackupPlansPatchCall

type ProjectsLocationsBackupPlansPatchCall struct {// contains filtered or unexported fields}

func (*ProjectsLocationsBackupPlansPatchCall)Context

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsBackupPlansPatchCall)Do

Do executes the "gkebackup.projects.locations.backupPlans.patch" call.Any non-2xx status code is an error. Response headers are in either*GoogleLongrunningOperation.ServerResponse.Header or (if a response wasreturned at all) in error.(*googleapi.Error).Header. Usegoogleapi.IsNotModified to check whether the returned error was becausehttp.StatusNotModified was returned.

func (*ProjectsLocationsBackupPlansPatchCall)Fields

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ProjectsLocationsBackupPlansPatchCall)Header

Header returns a http.Header that can be modified by the caller to addheaders to the request.

func (*ProjectsLocationsBackupPlansPatchCall)UpdateMask

UpdateMask sets the optional parameter "updateMask": This is used to specifythe fields to be overwritten in the BackupPlan targeted for update. Thevalues for each of these updated fields will be taken from the `backup_plan`provided with this request. Field names are relative to the root of theresource (e.g., `description`, `backup_config.include_volume_data`, etc.) Ifno `update_mask` is provided, all fields in `backup_plan` will be written tothe target BackupPlan resource. Note that OUTPUT_ONLY and IMMUTABLE fieldsin `backup_plan` are ignored and are not used to update the targetBackupPlan.

typeProjectsLocationsBackupPlansService

type ProjectsLocationsBackupPlansService struct {Backups *ProjectsLocationsBackupPlansBackupsService// contains filtered or unexported fields}

func (*ProjectsLocationsBackupPlansService)Create

Create: Creates a new BackupPlan in a given location.

  • parent: The location within which to create the BackupPlan. Format:`projects/*/locations/*`.

func (*ProjectsLocationsBackupPlansService)Delete

Delete: Deletes an existing BackupPlan.

  • name: Fully qualified BackupPlan name. Format:`projects/*/locations/*/backupPlans/*`.

func (*ProjectsLocationsBackupPlansService)Get

Get: Retrieve the details of a single BackupPlan.

  • name: Fully qualified BackupPlan name. Format:`projects/*/locations/*/backupPlans/*`.

func (*ProjectsLocationsBackupPlansService)GetIamPolicy

GetIamPolicy: Gets the access control policy for a resource. Returns anempty policy if the resource exists and does not have a policy set.

func (*ProjectsLocationsBackupPlansService)GetTagsadded inv0.257.0

GetTags: Returns tags directly bound to a GCP resource.

- name: The full resource name of the service resource.

func (*ProjectsLocationsBackupPlansService)List

List: Lists BackupPlans in a given location.

  • parent: The location that contains the BackupPlans to list. Format:`projects/*/locations/*`.

func (*ProjectsLocationsBackupPlansService)Patch

Patch: Update a BackupPlan.

  • name: Output only. Identifier. The full name of the BackupPlan resource.Format: `projects/*/locations/*/backupPlans/*`.

func (*ProjectsLocationsBackupPlansService)SetIamPolicy

SetIamPolicy: Sets the access control policy on the specified resource.Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`,and `PERMISSION_DENIED` errors.

func (*ProjectsLocationsBackupPlansService)SetTagsadded inv0.257.0

SetTags: Updates tags directly bound to a GCP resource.

- name: The full resource name of the service resource.

func (*ProjectsLocationsBackupPlansService)TestIamPermissions

TestIamPermissions: Returns permissions that a caller has on the specifiedresource. If the resource does not exist, this will return an empty set ofpermissions, not a `NOT_FOUND` error. Note: This operation is designed to beused for building permission-aware UIs and command-line tools, not forauthorization checking. This operation may "fail open" without warning.

typeProjectsLocationsBackupPlansSetIamPolicyCall

type ProjectsLocationsBackupPlansSetIamPolicyCall struct {// contains filtered or unexported fields}

func (*ProjectsLocationsBackupPlansSetIamPolicyCall)Context

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsBackupPlansSetIamPolicyCall)Do

Do executes the "gkebackup.projects.locations.backupPlans.setIamPolicy" call.Any non-2xx status code is an error. Response headers are in either*Policy.ServerResponse.Header or (if a response was returned at all) inerror.(*googleapi.Error).Header. Use googleapi.IsNotModified to checkwhether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsBackupPlansSetIamPolicyCall)Fields

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ProjectsLocationsBackupPlansSetIamPolicyCall)Header

Header returns a http.Header that can be modified by the caller to addheaders to the request.

typeProjectsLocationsBackupPlansSetTagsCalladded inv0.257.0

type ProjectsLocationsBackupPlansSetTagsCall struct {// contains filtered or unexported fields}

func (*ProjectsLocationsBackupPlansSetTagsCall)Contextadded inv0.257.0

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsBackupPlansSetTagsCall)Doadded inv0.257.0

Do executes the "gkebackup.projects.locations.backupPlans.setTags" call.Any non-2xx status code is an error. Response headers are in either*SetTagsResponse.ServerResponse.Header or (if a response was returned atall) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified tocheck whether the returned error was because http.StatusNotModified wasreturned.

func (*ProjectsLocationsBackupPlansSetTagsCall)Fieldsadded inv0.257.0

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ProjectsLocationsBackupPlansSetTagsCall)Headeradded inv0.257.0

Header returns a http.Header that can be modified by the caller to addheaders to the request.

typeProjectsLocationsBackupPlansTestIamPermissionsCall

type ProjectsLocationsBackupPlansTestIamPermissionsCall struct {// contains filtered or unexported fields}

func (*ProjectsLocationsBackupPlansTestIamPermissionsCall)Context

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsBackupPlansTestIamPermissionsCall)Do

Do executes the "gkebackup.projects.locations.backupPlans.testIamPermissions" call.Any non-2xx status code is an error. Response headers are in either*TestIamPermissionsResponse.ServerResponse.Header or (if a response wasreturned at all) in error.(*googleapi.Error).Header. Usegoogleapi.IsNotModified to check whether the returned error was becausehttp.StatusNotModified was returned.

func (*ProjectsLocationsBackupPlansTestIamPermissionsCall)Fields

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ProjectsLocationsBackupPlansTestIamPermissionsCall)Header

Header returns a http.Header that can be modified by the caller to addheaders to the request.

typeProjectsLocationsGetCall

type ProjectsLocationsGetCall struct {// contains filtered or unexported fields}

func (*ProjectsLocationsGetCall)Context

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsGetCall)Do

Do executes the "gkebackup.projects.locations.get" call.Any non-2xx status code is an error. Response headers are in either*Location.ServerResponse.Header or (if a response was returned at all) inerror.(*googleapi.Error).Header. Use googleapi.IsNotModified to checkwhether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsGetCall)Fields

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ProjectsLocationsGetCall)Header

Header returns a http.Header that can be modified by the caller to addheaders to the request.

func (*ProjectsLocationsGetCall)IfNoneMatch

IfNoneMatch sets an optional parameter which makes the operation fail if theobject's ETag matches the given value. This is useful for getting updatesonly after the object has changed since the last request.

typeProjectsLocationsListCall

type ProjectsLocationsListCall struct {// contains filtered or unexported fields}

func (*ProjectsLocationsListCall)Context

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsListCall)Do

Do executes the "gkebackup.projects.locations.list" call.Any non-2xx status code is an error. Response headers are in either*ListLocationsResponse.ServerResponse.Header or (if a response was returnedat all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified tocheck whether the returned error was because http.StatusNotModified wasreturned.

func (*ProjectsLocationsListCall)ExtraLocationTypesadded inv0.228.0

func (c *ProjectsLocationsListCall) ExtraLocationTypes(extraLocationTypes ...string) *ProjectsLocationsListCall

ExtraLocationTypes sets the optional parameter "extraLocationTypes": Do notuse this field. It is unsupported and is ignored unless explicitlydocumented otherwise. This is primarily for internal usage.

func (*ProjectsLocationsListCall)Fields

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ProjectsLocationsListCall)Filter

Filter sets the optional parameter "filter": A filter to narrow down resultsto a preferred subset. The filtering language accepts strings like"displayName=tokyo", and is documented in more detail in AIP-160(https://google.aip.dev/160).

func (*ProjectsLocationsListCall)Header

Header returns a http.Header that can be modified by the caller to addheaders to the request.

func (*ProjectsLocationsListCall)IfNoneMatch

IfNoneMatch sets an optional parameter which makes the operation fail if theobject's ETag matches the given value. This is useful for getting updatesonly after the object has changed since the last request.

func (*ProjectsLocationsListCall)PageSize

PageSize sets the optional parameter "pageSize": The maximum number ofresults to return. If not set, the service selects a default.

func (*ProjectsLocationsListCall)PageToken

PageToken sets the optional parameter "pageToken": A page token receivedfrom the `next_page_token` field in the response. Send that page token toreceive the subsequent page.

func (*ProjectsLocationsListCall)Pages

Pages invokes f for each page of results.A non-nil error returned from f will halt the iteration.The provided context supersedes any context provided to the Context method.

typeProjectsLocationsOperationsCancelCall

type ProjectsLocationsOperationsCancelCall struct {// contains filtered or unexported fields}

func (*ProjectsLocationsOperationsCancelCall)Context

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsOperationsCancelCall)Do

Do executes the "gkebackup.projects.locations.operations.cancel" call.Any non-2xx status code is an error. Response headers are in either*Empty.ServerResponse.Header or (if a response was returned at all) inerror.(*googleapi.Error).Header. Use googleapi.IsNotModified to checkwhether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsOperationsCancelCall)Fields

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ProjectsLocationsOperationsCancelCall)Header

Header returns a http.Header that can be modified by the caller to addheaders to the request.

typeProjectsLocationsOperationsDeleteCalladded inv0.144.0

type ProjectsLocationsOperationsDeleteCall struct {// contains filtered or unexported fields}

func (*ProjectsLocationsOperationsDeleteCall)Contextadded inv0.144.0

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsOperationsDeleteCall)Doadded inv0.144.0

Do executes the "gkebackup.projects.locations.operations.delete" call.Any non-2xx status code is an error. Response headers are in either*Empty.ServerResponse.Header or (if a response was returned at all) inerror.(*googleapi.Error).Header. Use googleapi.IsNotModified to checkwhether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsOperationsDeleteCall)Fieldsadded inv0.144.0

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ProjectsLocationsOperationsDeleteCall)Headeradded inv0.144.0

Header returns a http.Header that can be modified by the caller to addheaders to the request.

typeProjectsLocationsOperationsGetCall

type ProjectsLocationsOperationsGetCall struct {// contains filtered or unexported fields}

func (*ProjectsLocationsOperationsGetCall)Context

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsOperationsGetCall)Do

Do executes the "gkebackup.projects.locations.operations.get" call.Any non-2xx status code is an error. Response headers are in either*GoogleLongrunningOperation.ServerResponse.Header or (if a response wasreturned at all) in error.(*googleapi.Error).Header. Usegoogleapi.IsNotModified to check whether the returned error was becausehttp.StatusNotModified was returned.

func (*ProjectsLocationsOperationsGetCall)Fields

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ProjectsLocationsOperationsGetCall)Header

Header returns a http.Header that can be modified by the caller to addheaders to the request.

func (*ProjectsLocationsOperationsGetCall)IfNoneMatch

IfNoneMatch sets an optional parameter which makes the operation fail if theobject's ETag matches the given value. This is useful for getting updatesonly after the object has changed since the last request.

typeProjectsLocationsOperationsListCall

type ProjectsLocationsOperationsListCall struct {// contains filtered or unexported fields}

func (*ProjectsLocationsOperationsListCall)Context

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsOperationsListCall)Do

Do executes the "gkebackup.projects.locations.operations.list" call.Any non-2xx status code is an error. Response headers are in either*GoogleLongrunningListOperationsResponse.ServerResponse.Header or (if aresponse was returned at all) in error.(*googleapi.Error).Header. Usegoogleapi.IsNotModified to check whether the returned error was becausehttp.StatusNotModified was returned.

func (*ProjectsLocationsOperationsListCall)Fields

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ProjectsLocationsOperationsListCall)Filter

Filter sets the optional parameter "filter": The standard list filter.

func (*ProjectsLocationsOperationsListCall)Header

Header returns a http.Header that can be modified by the caller to addheaders to the request.

func (*ProjectsLocationsOperationsListCall)IfNoneMatch

IfNoneMatch sets an optional parameter which makes the operation fail if theobject's ETag matches the given value. This is useful for getting updatesonly after the object has changed since the last request.

func (*ProjectsLocationsOperationsListCall)PageSize

PageSize sets the optional parameter "pageSize": The standard list pagesize.

func (*ProjectsLocationsOperationsListCall)PageToken

PageToken sets the optional parameter "pageToken": The standard list pagetoken.

func (*ProjectsLocationsOperationsListCall)Pages

Pages invokes f for each page of results.A non-nil error returned from f will halt the iteration.The provided context supersedes any context provided to the Context method.

func (*ProjectsLocationsOperationsListCall)ReturnPartialSuccessadded inv0.253.0

func (c *ProjectsLocationsOperationsListCall) ReturnPartialSuccess(returnPartialSuccessbool) *ProjectsLocationsOperationsListCall

ReturnPartialSuccess sets the optional parameter "returnPartialSuccess":When set to `true`, operations that are reachable are returned as normal,and those that are unreachable are returned in theListOperationsResponse.unreachable field. This can only be `true` whenreading across collections. For example, when `parent` is set to"projects/example/locations/-". This field is not supported by default andwill result in an `UNIMPLEMENTED` error if set unless explicitly documentedotherwise in service or product specific documentation.

typeProjectsLocationsOperationsService

type ProjectsLocationsOperationsService struct {// contains filtered or unexported fields}

func (*ProjectsLocationsOperationsService)Cancel

Cancel: Starts asynchronous cancellation on a long-running operation. Theserver makes a best effort to cancel the operation, but success is notguaranteed. If the server doesn't support this method, it returns`google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation orother methods to check whether the cancellation succeeded or whether theoperation completed despite cancellation. On successful cancellation, theoperation is not deleted; instead, it becomes an operation with anOperation.error value with a google.rpc.Status.code of `1`, corresponding to`Code.CANCELLED`.

- name: The name of the operation resource to be cancelled.

func (*ProjectsLocationsOperationsService)Deleteadded inv0.144.0

Delete: Deletes a long-running operation. This method indicates that theclient is no longer interested in the operation result. It does not cancelthe operation. If the server doesn't support this method, it returns`google.rpc.Code.UNIMPLEMENTED`.

- name: The name of the operation resource to be deleted.

func (*ProjectsLocationsOperationsService)Get

Get: Gets the latest state of a long-running operation. Clients can use thismethod to poll the operation result at intervals as recommended by the APIservice.

- name: The name of the operation resource.

func (*ProjectsLocationsOperationsService)List

List: Lists operations that match the specified filter in the request. Ifthe server doesn't support this method, it returns `UNIMPLEMENTED`.

- name: The name of the operation's parent resource.

typeProjectsLocationsRestoreChannelsCreateCalladded inv0.230.0

type ProjectsLocationsRestoreChannelsCreateCall struct {// contains filtered or unexported fields}

func (*ProjectsLocationsRestoreChannelsCreateCall)Contextadded inv0.230.0

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsRestoreChannelsCreateCall)Doadded inv0.230.0

Do executes the "gkebackup.projects.locations.restoreChannels.create" call.Any non-2xx status code is an error. Response headers are in either*GoogleLongrunningOperation.ServerResponse.Header or (if a response wasreturned at all) in error.(*googleapi.Error).Header. Usegoogleapi.IsNotModified to check whether the returned error was becausehttp.StatusNotModified was returned.

func (*ProjectsLocationsRestoreChannelsCreateCall)Fieldsadded inv0.230.0

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ProjectsLocationsRestoreChannelsCreateCall)Headeradded inv0.230.0

Header returns a http.Header that can be modified by the caller to addheaders to the request.

func (*ProjectsLocationsRestoreChannelsCreateCall)RestoreChannelIdadded inv0.230.0

RestoreChannelId sets the optional parameter "restoreChannelId": Theclient-provided short name for the RestoreChannel resource. This name must:- be between 1 and 63 characters long (inclusive) - consist of onlylower-case ASCII letters, numbers, and dashes - start with a lower-caseletter - end with a lower-case letter or number - be unique within the setof RestoreChannels in this location If the user does not provide a name, auuid will be used as the name.

typeProjectsLocationsRestoreChannelsDeleteCalladded inv0.230.0

type ProjectsLocationsRestoreChannelsDeleteCall struct {// contains filtered or unexported fields}

func (*ProjectsLocationsRestoreChannelsDeleteCall)Contextadded inv0.230.0

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsRestoreChannelsDeleteCall)Doadded inv0.230.0

Do executes the "gkebackup.projects.locations.restoreChannels.delete" call.Any non-2xx status code is an error. Response headers are in either*GoogleLongrunningOperation.ServerResponse.Header or (if a response wasreturned at all) in error.(*googleapi.Error).Header. Usegoogleapi.IsNotModified to check whether the returned error was becausehttp.StatusNotModified was returned.

func (*ProjectsLocationsRestoreChannelsDeleteCall)Etagadded inv0.230.0

Etag sets the optional parameter "etag": If provided, this value must matchthe current value of the target RestoreChannel's etag field or the requestis rejected.

func (*ProjectsLocationsRestoreChannelsDeleteCall)Fieldsadded inv0.230.0

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ProjectsLocationsRestoreChannelsDeleteCall)Headeradded inv0.230.0

Header returns a http.Header that can be modified by the caller to addheaders to the request.

typeProjectsLocationsRestoreChannelsGetCalladded inv0.230.0

type ProjectsLocationsRestoreChannelsGetCall struct {// contains filtered or unexported fields}

func (*ProjectsLocationsRestoreChannelsGetCall)Contextadded inv0.230.0

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsRestoreChannelsGetCall)Doadded inv0.230.0

Do executes the "gkebackup.projects.locations.restoreChannels.get" call.Any non-2xx status code is an error. Response headers are in either*RestoreChannel.ServerResponse.Header or (if a response was returned at all)in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to checkwhether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsRestoreChannelsGetCall)Fieldsadded inv0.230.0

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ProjectsLocationsRestoreChannelsGetCall)Headeradded inv0.230.0

Header returns a http.Header that can be modified by the caller to addheaders to the request.

func (*ProjectsLocationsRestoreChannelsGetCall)IfNoneMatchadded inv0.230.0

IfNoneMatch sets an optional parameter which makes the operation fail if theobject's ETag matches the given value. This is useful for getting updatesonly after the object has changed since the last request.

typeProjectsLocationsRestoreChannelsListCalladded inv0.230.0

type ProjectsLocationsRestoreChannelsListCall struct {// contains filtered or unexported fields}

func (*ProjectsLocationsRestoreChannelsListCall)Contextadded inv0.230.0

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsRestoreChannelsListCall)Doadded inv0.230.0

Do executes the "gkebackup.projects.locations.restoreChannels.list" call.Any non-2xx status code is an error. Response headers are in either*ListRestoreChannelsResponse.ServerResponse.Header or (if a response wasreturned at all) in error.(*googleapi.Error).Header. Usegoogleapi.IsNotModified to check whether the returned error was becausehttp.StatusNotModified was returned.

func (*ProjectsLocationsRestoreChannelsListCall)Fieldsadded inv0.230.0

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ProjectsLocationsRestoreChannelsListCall)Filteradded inv0.230.0

Filter sets the optional parameter "filter": Field match expression used tofilter the results.

func (*ProjectsLocationsRestoreChannelsListCall)Headeradded inv0.230.0

Header returns a http.Header that can be modified by the caller to addheaders to the request.

func (*ProjectsLocationsRestoreChannelsListCall)IfNoneMatchadded inv0.230.0

IfNoneMatch sets an optional parameter which makes the operation fail if theobject's ETag matches the given value. This is useful for getting updatesonly after the object has changed since the last request.

func (*ProjectsLocationsRestoreChannelsListCall)OrderByadded inv0.230.0

OrderBy sets the optional parameter "orderBy": Field by which to sort theresults.

func (*ProjectsLocationsRestoreChannelsListCall)PageSizeadded inv0.230.0

PageSize sets the optional parameter "pageSize": The target number ofresults to return in a single response. If not specified, a default valuewill be chosen by the service. Note that the response may include a partiallist and a caller should only rely on the response's next_page_token todetermine if there are more instances left to be queried.

func (*ProjectsLocationsRestoreChannelsListCall)PageTokenadded inv0.230.0

PageToken sets the optional parameter "pageToken": The value ofnext_page_token received from a previous `ListRestoreChannels` call. Providethis to retrieve the subsequent page in a multi-page list of results. Whenpaginating, all other parameters provided to `ListRestoreChannels` mustmatch the call that provided the page token.

func (*ProjectsLocationsRestoreChannelsListCall)Pagesadded inv0.230.0

Pages invokes f for each page of results.A non-nil error returned from f will halt the iteration.The provided context supersedes any context provided to the Context method.

typeProjectsLocationsRestoreChannelsPatchCalladded inv0.230.0

type ProjectsLocationsRestoreChannelsPatchCall struct {// contains filtered or unexported fields}

func (*ProjectsLocationsRestoreChannelsPatchCall)Contextadded inv0.230.0

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsRestoreChannelsPatchCall)Doadded inv0.230.0

Do executes the "gkebackup.projects.locations.restoreChannels.patch" call.Any non-2xx status code is an error. Response headers are in either*GoogleLongrunningOperation.ServerResponse.Header or (if a response wasreturned at all) in error.(*googleapi.Error).Header. Usegoogleapi.IsNotModified to check whether the returned error was becausehttp.StatusNotModified was returned.

func (*ProjectsLocationsRestoreChannelsPatchCall)Fieldsadded inv0.230.0

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ProjectsLocationsRestoreChannelsPatchCall)Headeradded inv0.230.0

Header returns a http.Header that can be modified by the caller to addheaders to the request.

func (*ProjectsLocationsRestoreChannelsPatchCall)UpdateMaskadded inv0.230.0

UpdateMask sets the optional parameter "updateMask": This is used to specifythe fields to be overwritten in the RestoreChannel targeted for update. Thevalues for each of these updated fields will be taken from the`restore_channel` provided with this request. Field names are relative tothe root of the resource (e.g., `description`, `destination_project_id`,etc.) If no `update_mask` is provided, all fields in `restore_channel` willbe written to the target RestoreChannel resource. Note that OUTPUT_ONLY andIMMUTABLE fields in `restore_channel` are ignored and are not used to updatethe target RestoreChannel.

typeProjectsLocationsRestoreChannelsRestorePlanBindingsGetCalladded inv0.230.0

type ProjectsLocationsRestoreChannelsRestorePlanBindingsGetCall struct {// contains filtered or unexported fields}

func (*ProjectsLocationsRestoreChannelsRestorePlanBindingsGetCall)Contextadded inv0.230.0

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsRestoreChannelsRestorePlanBindingsGetCall)Doadded inv0.230.0

Do executes the "gkebackup.projects.locations.restoreChannels.restorePlanBindings.get" call.Any non-2xx status code is an error. Response headers are in either*RestorePlanBinding.ServerResponse.Header or (if a response was returned atall) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified tocheck whether the returned error was because http.StatusNotModified wasreturned.

func (*ProjectsLocationsRestoreChannelsRestorePlanBindingsGetCall)Fieldsadded inv0.230.0

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ProjectsLocationsRestoreChannelsRestorePlanBindingsGetCall)Headeradded inv0.230.0

Header returns a http.Header that can be modified by the caller to addheaders to the request.

func (*ProjectsLocationsRestoreChannelsRestorePlanBindingsGetCall)IfNoneMatchadded inv0.230.0

IfNoneMatch sets an optional parameter which makes the operation fail if theobject's ETag matches the given value. This is useful for getting updatesonly after the object has changed since the last request.

typeProjectsLocationsRestoreChannelsRestorePlanBindingsListCalladded inv0.230.0

type ProjectsLocationsRestoreChannelsRestorePlanBindingsListCall struct {// contains filtered or unexported fields}

func (*ProjectsLocationsRestoreChannelsRestorePlanBindingsListCall)Contextadded inv0.230.0

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsRestoreChannelsRestorePlanBindingsListCall)Doadded inv0.230.0

Do executes the "gkebackup.projects.locations.restoreChannels.restorePlanBindings.list" call.Any non-2xx status code is an error. Response headers are in either*ListRestorePlanBindingsResponse.ServerResponse.Header or (if a response wasreturned at all) in error.(*googleapi.Error).Header. Usegoogleapi.IsNotModified to check whether the returned error was becausehttp.StatusNotModified was returned.

func (*ProjectsLocationsRestoreChannelsRestorePlanBindingsListCall)Fieldsadded inv0.230.0

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ProjectsLocationsRestoreChannelsRestorePlanBindingsListCall)Filteradded inv0.230.0

Filter sets the optional parameter "filter": Field match expression used tofilter the results.

func (*ProjectsLocationsRestoreChannelsRestorePlanBindingsListCall)Headeradded inv0.230.0

Header returns a http.Header that can be modified by the caller to addheaders to the request.

func (*ProjectsLocationsRestoreChannelsRestorePlanBindingsListCall)IfNoneMatchadded inv0.230.0

IfNoneMatch sets an optional parameter which makes the operation fail if theobject's ETag matches the given value. This is useful for getting updatesonly after the object has changed since the last request.

func (*ProjectsLocationsRestoreChannelsRestorePlanBindingsListCall)OrderByadded inv0.230.0

OrderBy sets the optional parameter "orderBy": Field by which to sort theresults.

func (*ProjectsLocationsRestoreChannelsRestorePlanBindingsListCall)PageSizeadded inv0.230.0

PageSize sets the optional parameter "pageSize": The target number ofresults to return in a single response. If not specified, a default valuewill be chosen by the service. Note that the response may include a partiallist and a caller should only rely on the response's next_page_token todetermine if there are more instances left to be queried.

func (*ProjectsLocationsRestoreChannelsRestorePlanBindingsListCall)PageTokenadded inv0.230.0

PageToken sets the optional parameter "pageToken": The value ofnext_page_token received from a previous `ListRestorePlanBindings` call.Provide this to retrieve the subsequent page in a multi-page list ofresults. When paginating, all other parameters provided to`ListRestorePlanBindings` must match the call that provided the page token.

func (*ProjectsLocationsRestoreChannelsRestorePlanBindingsListCall)Pagesadded inv0.230.0

Pages invokes f for each page of results.A non-nil error returned from f will halt the iteration.The provided context supersedes any context provided to the Context method.

typeProjectsLocationsRestoreChannelsRestorePlanBindingsServiceadded inv0.230.0

type ProjectsLocationsRestoreChannelsRestorePlanBindingsService struct {// contains filtered or unexported fields}

funcNewProjectsLocationsRestoreChannelsRestorePlanBindingsServiceadded inv0.230.0

func NewProjectsLocationsRestoreChannelsRestorePlanBindingsService(s *Service) *ProjectsLocationsRestoreChannelsRestorePlanBindingsService

func (*ProjectsLocationsRestoreChannelsRestorePlanBindingsService)Getadded inv0.230.0

Get: Retrieve the details of a single RestorePlanBinding.

  • name: Fully qualified RestorePlanBinding name. Format:`projects/*/locations/*/restoreChannels/*/restorePlanBindings/*`.

func (*ProjectsLocationsRestoreChannelsRestorePlanBindingsService)Listadded inv0.230.0

List: Lists RestorePlanBindings in a given location.

  • parent: The RestoreChannel that contains the ListRestorePlanBindings tolist. Format: `projects/*/locations/*/restoreChannels/*`.

typeProjectsLocationsRestoreChannelsServiceadded inv0.230.0

type ProjectsLocationsRestoreChannelsService struct {RestorePlanBindings *ProjectsLocationsRestoreChannelsRestorePlanBindingsService// contains filtered or unexported fields}

funcNewProjectsLocationsRestoreChannelsServiceadded inv0.230.0

func NewProjectsLocationsRestoreChannelsService(s *Service) *ProjectsLocationsRestoreChannelsService

func (*ProjectsLocationsRestoreChannelsService)Createadded inv0.230.0

Create: Creates a new RestoreChannel in a given location.

  • parent: The location within which to create the RestoreChannel. Format:`projects/*/locations/*`.

func (*ProjectsLocationsRestoreChannelsService)Deleteadded inv0.230.0

Delete: Deletes an existing RestoreChannel.

  • name: Fully qualified RestoreChannel name. Format:`projects/*/locations/*/restoreChannels/*`.

func (*ProjectsLocationsRestoreChannelsService)Getadded inv0.230.0

Get: Retrieve the details of a single RestoreChannel.

  • name: Fully qualified RestoreChannel name. Format:`projects/*/locations/*/restoreChannels/*`.

func (*ProjectsLocationsRestoreChannelsService)Listadded inv0.230.0

List: Lists RestoreChannels in a given location.

  • parent: The location that contains the RestoreChannels to list. Format:`projects/*/locations/*`.

func (*ProjectsLocationsRestoreChannelsService)Patchadded inv0.230.0

Patch: Update a RestoreChannel.

  • name: Identifier. The fully qualified name of the RestoreChannel.`projects/*/locations/*/restoreChannels/*`.

typeProjectsLocationsRestorePlansCreateCall

type ProjectsLocationsRestorePlansCreateCall struct {// contains filtered or unexported fields}

func (*ProjectsLocationsRestorePlansCreateCall)Context

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsRestorePlansCreateCall)Do

Do executes the "gkebackup.projects.locations.restorePlans.create" call.Any non-2xx status code is an error. Response headers are in either*GoogleLongrunningOperation.ServerResponse.Header or (if a response wasreturned at all) in error.(*googleapi.Error).Header. Usegoogleapi.IsNotModified to check whether the returned error was becausehttp.StatusNotModified was returned.

func (*ProjectsLocationsRestorePlansCreateCall)Fields

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ProjectsLocationsRestorePlansCreateCall)Header

Header returns a http.Header that can be modified by the caller to addheaders to the request.

func (*ProjectsLocationsRestorePlansCreateCall)RestorePlanId

RestorePlanId sets the optional parameter "restorePlanId": Required. Theclient-provided short name for the RestorePlan resource. This name must: -be between 1 and 63 characters long (inclusive) - consist of only lower-caseASCII letters, numbers, and dashes - start with a lower-case letter - endwith a lower-case letter or number - be unique within the set ofRestorePlans in this location

typeProjectsLocationsRestorePlansDeleteCall

type ProjectsLocationsRestorePlansDeleteCall struct {// contains filtered or unexported fields}

func (*ProjectsLocationsRestorePlansDeleteCall)Context

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsRestorePlansDeleteCall)Do

Do executes the "gkebackup.projects.locations.restorePlans.delete" call.Any non-2xx status code is an error. Response headers are in either*GoogleLongrunningOperation.ServerResponse.Header or (if a response wasreturned at all) in error.(*googleapi.Error).Header. Usegoogleapi.IsNotModified to check whether the returned error was becausehttp.StatusNotModified was returned.

func (*ProjectsLocationsRestorePlansDeleteCall)Etag

Etag sets the optional parameter "etag": If provided, this value must matchthe current value of the target RestorePlan's etag field or the request isrejected.

func (*ProjectsLocationsRestorePlansDeleteCall)Fields

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ProjectsLocationsRestorePlansDeleteCall)Force

Force sets the optional parameter "force": If set to true, any Restoresbelow this RestorePlan will also be deleted. Otherwise, the request willonly succeed if the RestorePlan has no Restores.

func (*ProjectsLocationsRestorePlansDeleteCall)Header

Header returns a http.Header that can be modified by the caller to addheaders to the request.

typeProjectsLocationsRestorePlansGetCall

type ProjectsLocationsRestorePlansGetCall struct {// contains filtered or unexported fields}

func (*ProjectsLocationsRestorePlansGetCall)Context

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsRestorePlansGetCall)Do

Do executes the "gkebackup.projects.locations.restorePlans.get" call.Any non-2xx status code is an error. Response headers are in either*RestorePlan.ServerResponse.Header or (if a response was returned at all) inerror.(*googleapi.Error).Header. Use googleapi.IsNotModified to checkwhether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsRestorePlansGetCall)Fields

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ProjectsLocationsRestorePlansGetCall)Header

Header returns a http.Header that can be modified by the caller to addheaders to the request.

func (*ProjectsLocationsRestorePlansGetCall)IfNoneMatch

IfNoneMatch sets an optional parameter which makes the operation fail if theobject's ETag matches the given value. This is useful for getting updatesonly after the object has changed since the last request.

typeProjectsLocationsRestorePlansGetIamPolicyCall

type ProjectsLocationsRestorePlansGetIamPolicyCall struct {// contains filtered or unexported fields}

func (*ProjectsLocationsRestorePlansGetIamPolicyCall)Context

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsRestorePlansGetIamPolicyCall)Do

Do executes the "gkebackup.projects.locations.restorePlans.getIamPolicy" call.Any non-2xx status code is an error. Response headers are in either*Policy.ServerResponse.Header or (if a response was returned at all) inerror.(*googleapi.Error).Header. Use googleapi.IsNotModified to checkwhether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsRestorePlansGetIamPolicyCall)Fields

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ProjectsLocationsRestorePlansGetIamPolicyCall)Header

Header returns a http.Header that can be modified by the caller to addheaders to the request.

func (*ProjectsLocationsRestorePlansGetIamPolicyCall)IfNoneMatch

IfNoneMatch sets an optional parameter which makes the operation fail if theobject's ETag matches the given value. This is useful for getting updatesonly after the object has changed since the last request.

func (*ProjectsLocationsRestorePlansGetIamPolicyCall)OptionsRequestedPolicyVersion

func (c *ProjectsLocationsRestorePlansGetIamPolicyCall) OptionsRequestedPolicyVersion(optionsRequestedPolicyVersionint64) *ProjectsLocationsRestorePlansGetIamPolicyCall

OptionsRequestedPolicyVersion sets the optional parameter"options.requestedPolicyVersion": The maximum policy version that will beused to format the policy. Valid values are 0, 1, and 3. Requests specifyingan invalid value will be rejected. Requests for policies with anyconditional role bindings must specify version 3. Policies with noconditional role bindings may specify any valid value or leave the fieldunset. The policy in the response might use the policy version that youspecified, or it might use a lower policy version. For example, if youspecify version 3, but the policy has no conditional role bindings, theresponse uses version 1. To learn which resources support conditions intheir IAM policies, see the IAM documentation(https://cloud.google.com/iam/help/conditions/resource-policies).

typeProjectsLocationsRestorePlansGetTagsCalladded inv0.257.0

type ProjectsLocationsRestorePlansGetTagsCall struct {// contains filtered or unexported fields}

func (*ProjectsLocationsRestorePlansGetTagsCall)Contextadded inv0.257.0

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsRestorePlansGetTagsCall)Doadded inv0.257.0

Do executes the "gkebackup.projects.locations.restorePlans.getTags" call.Any non-2xx status code is an error. Response headers are in either*GetTagsResponse.ServerResponse.Header or (if a response was returned atall) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified tocheck whether the returned error was because http.StatusNotModified wasreturned.

func (*ProjectsLocationsRestorePlansGetTagsCall)Fieldsadded inv0.257.0

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ProjectsLocationsRestorePlansGetTagsCall)Headeradded inv0.257.0

Header returns a http.Header that can be modified by the caller to addheaders to the request.

func (*ProjectsLocationsRestorePlansGetTagsCall)IfNoneMatchadded inv0.257.0

IfNoneMatch sets an optional parameter which makes the operation fail if theobject's ETag matches the given value. This is useful for getting updatesonly after the object has changed since the last request.

typeProjectsLocationsRestorePlansListCall

type ProjectsLocationsRestorePlansListCall struct {// contains filtered or unexported fields}

func (*ProjectsLocationsRestorePlansListCall)Context

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsRestorePlansListCall)Do

Do executes the "gkebackup.projects.locations.restorePlans.list" call.Any non-2xx status code is an error. Response headers are in either*ListRestorePlansResponse.ServerResponse.Header or (if a response wasreturned at all) in error.(*googleapi.Error).Header. Usegoogleapi.IsNotModified to check whether the returned error was becausehttp.StatusNotModified was returned.

func (*ProjectsLocationsRestorePlansListCall)Fields

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ProjectsLocationsRestorePlansListCall)Filter

Filter sets the optional parameter "filter": Field match expression used tofilter the results.

func (*ProjectsLocationsRestorePlansListCall)Header

Header returns a http.Header that can be modified by the caller to addheaders to the request.

func (*ProjectsLocationsRestorePlansListCall)IfNoneMatch

IfNoneMatch sets an optional parameter which makes the operation fail if theobject's ETag matches the given value. This is useful for getting updatesonly after the object has changed since the last request.

func (*ProjectsLocationsRestorePlansListCall)OrderBy

OrderBy sets the optional parameter "orderBy": Field by which to sort theresults.

func (*ProjectsLocationsRestorePlansListCall)PageSize

PageSize sets the optional parameter "pageSize": The target number ofresults to return in a single response. If not specified, a default valuewill be chosen by the service. Note that the response may include a partiallist and a caller should only rely on the response's next_page_token todetermine if there are more instances left to be queried.

func (*ProjectsLocationsRestorePlansListCall)PageToken

PageToken sets the optional parameter "pageToken": The value ofnext_page_token received from a previous `ListRestorePlans` call. Providethis to retrieve the subsequent page in a multi-page list of results. Whenpaginating, all other parameters provided to `ListRestorePlans` must matchthe call that provided the page token.

func (*ProjectsLocationsRestorePlansListCall)Pages

Pages invokes f for each page of results.A non-nil error returned from f will halt the iteration.The provided context supersedes any context provided to the Context method.

typeProjectsLocationsRestorePlansPatchCall

type ProjectsLocationsRestorePlansPatchCall struct {// contains filtered or unexported fields}

func (*ProjectsLocationsRestorePlansPatchCall)Context

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsRestorePlansPatchCall)Do

Do executes the "gkebackup.projects.locations.restorePlans.patch" call.Any non-2xx status code is an error. Response headers are in either*GoogleLongrunningOperation.ServerResponse.Header or (if a response wasreturned at all) in error.(*googleapi.Error).Header. Usegoogleapi.IsNotModified to check whether the returned error was becausehttp.StatusNotModified was returned.

func (*ProjectsLocationsRestorePlansPatchCall)Fields

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ProjectsLocationsRestorePlansPatchCall)Header

Header returns a http.Header that can be modified by the caller to addheaders to the request.

func (*ProjectsLocationsRestorePlansPatchCall)UpdateMask

UpdateMask sets the optional parameter "updateMask": This is used to specifythe fields to be overwritten in the RestorePlan targeted for update. Thevalues for each of these updated fields will be taken from the`restore_plan` provided with this request. Field names are relative to theroot of the resource. If no `update_mask` is provided, all fields in`restore_plan` will be written to the target RestorePlan resource. Note thatOUTPUT_ONLY and IMMUTABLE fields in `restore_plan` are ignored and are notused to update the target RestorePlan.

typeProjectsLocationsRestorePlansRestoresCreateCall

type ProjectsLocationsRestorePlansRestoresCreateCall struct {// contains filtered or unexported fields}

func (*ProjectsLocationsRestorePlansRestoresCreateCall)Context

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsRestorePlansRestoresCreateCall)Do

Do executes the "gkebackup.projects.locations.restorePlans.restores.create" call.Any non-2xx status code is an error. Response headers are in either*GoogleLongrunningOperation.ServerResponse.Header or (if a response wasreturned at all) in error.(*googleapi.Error).Header. Usegoogleapi.IsNotModified to check whether the returned error was becausehttp.StatusNotModified was returned.

func (*ProjectsLocationsRestorePlansRestoresCreateCall)Fields

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ProjectsLocationsRestorePlansRestoresCreateCall)Header

Header returns a http.Header that can be modified by the caller to addheaders to the request.

func (*ProjectsLocationsRestorePlansRestoresCreateCall)RestoreId

RestoreId sets the optional parameter "restoreId": Required. Theclient-provided short name for the Restore resource. This name must: - bebetween 1 and 63 characters long (inclusive) - consist of only lower-caseASCII letters, numbers, and dashes - start with a lower-case letter - endwith a lower-case letter or number - be unique within the set of Restores inthis RestorePlan.

typeProjectsLocationsRestorePlansRestoresDeleteCall

type ProjectsLocationsRestorePlansRestoresDeleteCall struct {// contains filtered or unexported fields}

func (*ProjectsLocationsRestorePlansRestoresDeleteCall)Context

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsRestorePlansRestoresDeleteCall)Do

Do executes the "gkebackup.projects.locations.restorePlans.restores.delete" call.Any non-2xx status code is an error. Response headers are in either*GoogleLongrunningOperation.ServerResponse.Header or (if a response wasreturned at all) in error.(*googleapi.Error).Header. Usegoogleapi.IsNotModified to check whether the returned error was becausehttp.StatusNotModified was returned.

func (*ProjectsLocationsRestorePlansRestoresDeleteCall)Etag

Etag sets the optional parameter "etag": If provided, this value must matchthe current value of the target Restore's etag field or the request isrejected.

func (*ProjectsLocationsRestorePlansRestoresDeleteCall)Fields

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ProjectsLocationsRestorePlansRestoresDeleteCall)Force

Force sets the optional parameter "force": If set to true, anyVolumeRestores below this restore will also be deleted. Otherwise, therequest will only succeed if the restore has no VolumeRestores.

func (*ProjectsLocationsRestorePlansRestoresDeleteCall)Header

Header returns a http.Header that can be modified by the caller to addheaders to the request.

typeProjectsLocationsRestorePlansRestoresGetCall

type ProjectsLocationsRestorePlansRestoresGetCall struct {// contains filtered or unexported fields}

func (*ProjectsLocationsRestorePlansRestoresGetCall)Context

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsRestorePlansRestoresGetCall)Do

Do executes the "gkebackup.projects.locations.restorePlans.restores.get" call.Any non-2xx status code is an error. Response headers are in either*Restore.ServerResponse.Header or (if a response was returned at all) inerror.(*googleapi.Error).Header. Use googleapi.IsNotModified to checkwhether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsRestorePlansRestoresGetCall)Fields

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ProjectsLocationsRestorePlansRestoresGetCall)Header

Header returns a http.Header that can be modified by the caller to addheaders to the request.

func (*ProjectsLocationsRestorePlansRestoresGetCall)IfNoneMatch

IfNoneMatch sets an optional parameter which makes the operation fail if theobject's ETag matches the given value. This is useful for getting updatesonly after the object has changed since the last request.

typeProjectsLocationsRestorePlansRestoresGetIamPolicyCall

type ProjectsLocationsRestorePlansRestoresGetIamPolicyCall struct {// contains filtered or unexported fields}

func (*ProjectsLocationsRestorePlansRestoresGetIamPolicyCall)Context

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsRestorePlansRestoresGetIamPolicyCall)Do

Do executes the "gkebackup.projects.locations.restorePlans.restores.getIamPolicy" call.Any non-2xx status code is an error. Response headers are in either*Policy.ServerResponse.Header or (if a response was returned at all) inerror.(*googleapi.Error).Header. Use googleapi.IsNotModified to checkwhether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsRestorePlansRestoresGetIamPolicyCall)Fields

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ProjectsLocationsRestorePlansRestoresGetIamPolicyCall)Header

Header returns a http.Header that can be modified by the caller to addheaders to the request.

func (*ProjectsLocationsRestorePlansRestoresGetIamPolicyCall)IfNoneMatch

IfNoneMatch sets an optional parameter which makes the operation fail if theobject's ETag matches the given value. This is useful for getting updatesonly after the object has changed since the last request.

func (*ProjectsLocationsRestorePlansRestoresGetIamPolicyCall)OptionsRequestedPolicyVersion

OptionsRequestedPolicyVersion sets the optional parameter"options.requestedPolicyVersion": The maximum policy version that will beused to format the policy. Valid values are 0, 1, and 3. Requests specifyingan invalid value will be rejected. Requests for policies with anyconditional role bindings must specify version 3. Policies with noconditional role bindings may specify any valid value or leave the fieldunset. The policy in the response might use the policy version that youspecified, or it might use a lower policy version. For example, if youspecify version 3, but the policy has no conditional role bindings, theresponse uses version 1. To learn which resources support conditions intheir IAM policies, see the IAM documentation(https://cloud.google.com/iam/help/conditions/resource-policies).

typeProjectsLocationsRestorePlansRestoresListCall

type ProjectsLocationsRestorePlansRestoresListCall struct {// contains filtered or unexported fields}

func (*ProjectsLocationsRestorePlansRestoresListCall)Context

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsRestorePlansRestoresListCall)Do

Do executes the "gkebackup.projects.locations.restorePlans.restores.list" call.Any non-2xx status code is an error. Response headers are in either*ListRestoresResponse.ServerResponse.Header or (if a response was returnedat all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified tocheck whether the returned error was because http.StatusNotModified wasreturned.

func (*ProjectsLocationsRestorePlansRestoresListCall)Fields

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ProjectsLocationsRestorePlansRestoresListCall)Filter

Filter sets the optional parameter "filter": Field match expression used tofilter the results.

func (*ProjectsLocationsRestorePlansRestoresListCall)Header

Header returns a http.Header that can be modified by the caller to addheaders to the request.

func (*ProjectsLocationsRestorePlansRestoresListCall)IfNoneMatch

IfNoneMatch sets an optional parameter which makes the operation fail if theobject's ETag matches the given value. This is useful for getting updatesonly after the object has changed since the last request.

func (*ProjectsLocationsRestorePlansRestoresListCall)OrderBy

OrderBy sets the optional parameter "orderBy": Field by which to sort theresults.

func (*ProjectsLocationsRestorePlansRestoresListCall)PageSize

PageSize sets the optional parameter "pageSize": The target number ofresults to return in a single response. If not specified, a default valuewill be chosen by the service. Note that the response may include a partiallist and a caller should only rely on the response's next_page_token todetermine if there are more instances left to be queried.

func (*ProjectsLocationsRestorePlansRestoresListCall)PageToken

PageToken sets the optional parameter "pageToken": The value ofnext_page_token received from a previous `ListRestores` call. Provide thisto retrieve the subsequent page in a multi-page list of results. Whenpaginating, all other parameters provided to `ListRestores` must match thecall that provided the page token.

func (*ProjectsLocationsRestorePlansRestoresListCall)Pages

Pages invokes f for each page of results.A non-nil error returned from f will halt the iteration.The provided context supersedes any context provided to the Context method.

typeProjectsLocationsRestorePlansRestoresPatchCall

type ProjectsLocationsRestorePlansRestoresPatchCall struct {// contains filtered or unexported fields}

func (*ProjectsLocationsRestorePlansRestoresPatchCall)Context

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsRestorePlansRestoresPatchCall)Do

Do executes the "gkebackup.projects.locations.restorePlans.restores.patch" call.Any non-2xx status code is an error. Response headers are in either*GoogleLongrunningOperation.ServerResponse.Header or (if a response wasreturned at all) in error.(*googleapi.Error).Header. Usegoogleapi.IsNotModified to check whether the returned error was becausehttp.StatusNotModified was returned.

func (*ProjectsLocationsRestorePlansRestoresPatchCall)Fields

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ProjectsLocationsRestorePlansRestoresPatchCall)Header

Header returns a http.Header that can be modified by the caller to addheaders to the request.

func (*ProjectsLocationsRestorePlansRestoresPatchCall)UpdateMask

UpdateMask sets the optional parameter "updateMask": This is used to specifythe fields to be overwritten in the Restore targeted for update. The valuesfor each of these updated fields will be taken from the `restore` providedwith this request. Field names are relative to the root of the resource. Ifno `update_mask` is provided, all fields in `restore` will be written to thetarget Restore resource. Note that OUTPUT_ONLY and IMMUTABLE fields in`restore` are ignored and are not used to update the target Restore.

typeProjectsLocationsRestorePlansRestoresService

type ProjectsLocationsRestorePlansRestoresService struct {VolumeRestores *ProjectsLocationsRestorePlansRestoresVolumeRestoresService// contains filtered or unexported fields}

func (*ProjectsLocationsRestorePlansRestoresService)Create

Create: Creates a new Restore for the given RestorePlan.

  • parent: The RestorePlan within which to create the Restore. Format:`projects/*/locations/*/restorePlans/*`.

func (*ProjectsLocationsRestorePlansRestoresService)Delete

Delete: Deletes an existing Restore.

  • name: Full name of the Restore Format:`projects/*/locations/*/restorePlans/*/restores/*`.

func (*ProjectsLocationsRestorePlansRestoresService)Get

Get: Retrieves the details of a single Restore.

  • name: Name of the restore resource. Format:`projects/*/locations/*/restorePlans/*/restores/*`.

func (*ProjectsLocationsRestorePlansRestoresService)GetIamPolicy

GetIamPolicy: Gets the access control policy for a resource. Returns anempty policy if the resource exists and does not have a policy set.

func (*ProjectsLocationsRestorePlansRestoresService)List

List: Lists the Restores for a given RestorePlan.

  • parent: The RestorePlan that contains the Restores to list. Format:`projects/*/locations/*/restorePlans/*`.

func (*ProjectsLocationsRestorePlansRestoresService)Patch

Patch: Update a Restore.

  • name: Output only. Identifier. The full name of the Restore resource.Format: `projects/*/locations/*/restorePlans/*/restores/*`.

func (*ProjectsLocationsRestorePlansRestoresService)SetIamPolicy

SetIamPolicy: Sets the access control policy on the specified resource.Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`,and `PERMISSION_DENIED` errors.

func (*ProjectsLocationsRestorePlansRestoresService)TestIamPermissions

TestIamPermissions: Returns permissions that a caller has on the specifiedresource. If the resource does not exist, this will return an empty set ofpermissions, not a `NOT_FOUND` error. Note: This operation is designed to beused for building permission-aware UIs and command-line tools, not forauthorization checking. This operation may "fail open" without warning.

typeProjectsLocationsRestorePlansRestoresSetIamPolicyCall

type ProjectsLocationsRestorePlansRestoresSetIamPolicyCall struct {// contains filtered or unexported fields}

func (*ProjectsLocationsRestorePlansRestoresSetIamPolicyCall)Context

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsRestorePlansRestoresSetIamPolicyCall)Do

Do executes the "gkebackup.projects.locations.restorePlans.restores.setIamPolicy" call.Any non-2xx status code is an error. Response headers are in either*Policy.ServerResponse.Header or (if a response was returned at all) inerror.(*googleapi.Error).Header. Use googleapi.IsNotModified to checkwhether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsRestorePlansRestoresSetIamPolicyCall)Fields

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ProjectsLocationsRestorePlansRestoresSetIamPolicyCall)Header

Header returns a http.Header that can be modified by the caller to addheaders to the request.

typeProjectsLocationsRestorePlansRestoresTestIamPermissionsCall

type ProjectsLocationsRestorePlansRestoresTestIamPermissionsCall struct {// contains filtered or unexported fields}

func (*ProjectsLocationsRestorePlansRestoresTestIamPermissionsCall)Context

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsRestorePlansRestoresTestIamPermissionsCall)Do

Do executes the "gkebackup.projects.locations.restorePlans.restores.testIamPermissions" call.Any non-2xx status code is an error. Response headers are in either*TestIamPermissionsResponse.ServerResponse.Header or (if a response wasreturned at all) in error.(*googleapi.Error).Header. Usegoogleapi.IsNotModified to check whether the returned error was becausehttp.StatusNotModified was returned.

func (*ProjectsLocationsRestorePlansRestoresTestIamPermissionsCall)Fields

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ProjectsLocationsRestorePlansRestoresTestIamPermissionsCall)Header

Header returns a http.Header that can be modified by the caller to addheaders to the request.

typeProjectsLocationsRestorePlansRestoresVolumeRestoresGetCall

type ProjectsLocationsRestorePlansRestoresVolumeRestoresGetCall struct {// contains filtered or unexported fields}

func (*ProjectsLocationsRestorePlansRestoresVolumeRestoresGetCall)Context

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsRestorePlansRestoresVolumeRestoresGetCall)Do

Do executes the "gkebackup.projects.locations.restorePlans.restores.volumeRestores.get" call.Any non-2xx status code is an error. Response headers are in either*VolumeRestore.ServerResponse.Header or (if a response was returned at all)in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to checkwhether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsRestorePlansRestoresVolumeRestoresGetCall)Fields

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ProjectsLocationsRestorePlansRestoresVolumeRestoresGetCall)Header

Header returns a http.Header that can be modified by the caller to addheaders to the request.

func (*ProjectsLocationsRestorePlansRestoresVolumeRestoresGetCall)IfNoneMatch

IfNoneMatch sets an optional parameter which makes the operation fail if theobject's ETag matches the given value. This is useful for getting updatesonly after the object has changed since the last request.

typeProjectsLocationsRestorePlansRestoresVolumeRestoresGetIamPolicyCall

type ProjectsLocationsRestorePlansRestoresVolumeRestoresGetIamPolicyCall struct {// contains filtered or unexported fields}

func (*ProjectsLocationsRestorePlansRestoresVolumeRestoresGetIamPolicyCall)Context

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsRestorePlansRestoresVolumeRestoresGetIamPolicyCall)Do

Do executes the "gkebackup.projects.locations.restorePlans.restores.volumeRestores.getIamPolicy" call.Any non-2xx status code is an error. Response headers are in either*Policy.ServerResponse.Header or (if a response was returned at all) inerror.(*googleapi.Error).Header. Use googleapi.IsNotModified to checkwhether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsRestorePlansRestoresVolumeRestoresGetIamPolicyCall)Fields

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ProjectsLocationsRestorePlansRestoresVolumeRestoresGetIamPolicyCall)Header

Header returns a http.Header that can be modified by the caller to addheaders to the request.

func (*ProjectsLocationsRestorePlansRestoresVolumeRestoresGetIamPolicyCall)IfNoneMatch

IfNoneMatch sets an optional parameter which makes the operation fail if theobject's ETag matches the given value. This is useful for getting updatesonly after the object has changed since the last request.

func (*ProjectsLocationsRestorePlansRestoresVolumeRestoresGetIamPolicyCall)OptionsRequestedPolicyVersion

OptionsRequestedPolicyVersion sets the optional parameter"options.requestedPolicyVersion": The maximum policy version that will beused to format the policy. Valid values are 0, 1, and 3. Requests specifyingan invalid value will be rejected. Requests for policies with anyconditional role bindings must specify version 3. Policies with noconditional role bindings may specify any valid value or leave the fieldunset. The policy in the response might use the policy version that youspecified, or it might use a lower policy version. For example, if youspecify version 3, but the policy has no conditional role bindings, theresponse uses version 1. To learn which resources support conditions intheir IAM policies, see the IAM documentation(https://cloud.google.com/iam/help/conditions/resource-policies).

typeProjectsLocationsRestorePlansRestoresVolumeRestoresListCall

type ProjectsLocationsRestorePlansRestoresVolumeRestoresListCall struct {// contains filtered or unexported fields}

func (*ProjectsLocationsRestorePlansRestoresVolumeRestoresListCall)Context

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsRestorePlansRestoresVolumeRestoresListCall)Do

Do executes the "gkebackup.projects.locations.restorePlans.restores.volumeRestores.list" call.Any non-2xx status code is an error. Response headers are in either*ListVolumeRestoresResponse.ServerResponse.Header or (if a response wasreturned at all) in error.(*googleapi.Error).Header. Usegoogleapi.IsNotModified to check whether the returned error was becausehttp.StatusNotModified was returned.

func (*ProjectsLocationsRestorePlansRestoresVolumeRestoresListCall)Fields

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ProjectsLocationsRestorePlansRestoresVolumeRestoresListCall)Filter

Filter sets the optional parameter "filter": Field match expression used tofilter the results.

func (*ProjectsLocationsRestorePlansRestoresVolumeRestoresListCall)Header

Header returns a http.Header that can be modified by the caller to addheaders to the request.

func (*ProjectsLocationsRestorePlansRestoresVolumeRestoresListCall)IfNoneMatch

IfNoneMatch sets an optional parameter which makes the operation fail if theobject's ETag matches the given value. This is useful for getting updatesonly after the object has changed since the last request.

func (*ProjectsLocationsRestorePlansRestoresVolumeRestoresListCall)OrderBy

OrderBy sets the optional parameter "orderBy": Field by which to sort theresults.

func (*ProjectsLocationsRestorePlansRestoresVolumeRestoresListCall)PageSize

PageSize sets the optional parameter "pageSize": The target number ofresults to return in a single response. If not specified, a default valuewill be chosen by the service. Note that the response may include a partiallist and a caller should only rely on the response's next_page_token todetermine if there are more instances left to be queried.

func (*ProjectsLocationsRestorePlansRestoresVolumeRestoresListCall)PageToken

PageToken sets the optional parameter "pageToken": The value ofnext_page_token received from a previous `ListVolumeRestores` call. Providethis to retrieve the subsequent page in a multi-page list of results. Whenpaginating, all other parameters provided to `ListVolumeRestores` must matchthe call that provided the page token.

func (*ProjectsLocationsRestorePlansRestoresVolumeRestoresListCall)Pages

Pages invokes f for each page of results.A non-nil error returned from f will halt the iteration.The provided context supersedes any context provided to the Context method.

typeProjectsLocationsRestorePlansRestoresVolumeRestoresService

type ProjectsLocationsRestorePlansRestoresVolumeRestoresService struct {// contains filtered or unexported fields}

func (*ProjectsLocationsRestorePlansRestoresVolumeRestoresService)Get

Get: Retrieve the details of a single VolumeRestore.

  • name: Full name of the VolumeRestore resource. Format:`projects/*/locations/*/restorePlans/*/restores/*/volumeRestores/*`.

func (*ProjectsLocationsRestorePlansRestoresVolumeRestoresService)GetIamPolicy

GetIamPolicy: Gets the access control policy for a resource. Returns anempty policy if the resource exists and does not have a policy set.

func (*ProjectsLocationsRestorePlansRestoresVolumeRestoresService)List

List: Lists the VolumeRestores for a given Restore.

  • parent: The Restore that contains the VolumeRestores to list. Format:`projects/*/locations/*/restorePlans/*/restores/*`.

func (*ProjectsLocationsRestorePlansRestoresVolumeRestoresService)SetIamPolicy

SetIamPolicy: Sets the access control policy on the specified resource.Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`,and `PERMISSION_DENIED` errors.

func (*ProjectsLocationsRestorePlansRestoresVolumeRestoresService)TestIamPermissions

TestIamPermissions: Returns permissions that a caller has on the specifiedresource. If the resource does not exist, this will return an empty set ofpermissions, not a `NOT_FOUND` error. Note: This operation is designed to beused for building permission-aware UIs and command-line tools, not forauthorization checking. This operation may "fail open" without warning.

typeProjectsLocationsRestorePlansRestoresVolumeRestoresSetIamPolicyCall

type ProjectsLocationsRestorePlansRestoresVolumeRestoresSetIamPolicyCall struct {// contains filtered or unexported fields}

func (*ProjectsLocationsRestorePlansRestoresVolumeRestoresSetIamPolicyCall)Context

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsRestorePlansRestoresVolumeRestoresSetIamPolicyCall)Do

Do executes the "gkebackup.projects.locations.restorePlans.restores.volumeRestores.setIamPolicy" call.Any non-2xx status code is an error. Response headers are in either*Policy.ServerResponse.Header or (if a response was returned at all) inerror.(*googleapi.Error).Header. Use googleapi.IsNotModified to checkwhether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsRestorePlansRestoresVolumeRestoresSetIamPolicyCall)Fields

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ProjectsLocationsRestorePlansRestoresVolumeRestoresSetIamPolicyCall)Header

Header returns a http.Header that can be modified by the caller to addheaders to the request.

typeProjectsLocationsRestorePlansRestoresVolumeRestoresTestIamPermissionsCall

type ProjectsLocationsRestorePlansRestoresVolumeRestoresTestIamPermissionsCall struct {// contains filtered or unexported fields}

func (*ProjectsLocationsRestorePlansRestoresVolumeRestoresTestIamPermissionsCall)Context

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsRestorePlansRestoresVolumeRestoresTestIamPermissionsCall)Do

Do executes the "gkebackup.projects.locations.restorePlans.restores.volumeRestores.testIamPermissions" call.Any non-2xx status code is an error. Response headers are in either*TestIamPermissionsResponse.ServerResponse.Header or (if a response wasreturned at all) in error.(*googleapi.Error).Header. Usegoogleapi.IsNotModified to check whether the returned error was becausehttp.StatusNotModified was returned.

func (*ProjectsLocationsRestorePlansRestoresVolumeRestoresTestIamPermissionsCall)Fields

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ProjectsLocationsRestorePlansRestoresVolumeRestoresTestIamPermissionsCall)Header

Header returns a http.Header that can be modified by the caller to addheaders to the request.

typeProjectsLocationsRestorePlansService

type ProjectsLocationsRestorePlansService struct {Restores *ProjectsLocationsRestorePlansRestoresService// contains filtered or unexported fields}

func (*ProjectsLocationsRestorePlansService)Create

Create: Creates a new RestorePlan in a given location.

  • parent: The location within which to create the RestorePlan. Format:`projects/*/locations/*`.

func (*ProjectsLocationsRestorePlansService)Delete

Delete: Deletes an existing RestorePlan.

  • name: Fully qualified RestorePlan name. Format:`projects/*/locations/*/restorePlans/*`.

func (*ProjectsLocationsRestorePlansService)Get

Get: Retrieve the details of a single RestorePlan.

  • name: Fully qualified RestorePlan name. Format:`projects/*/locations/*/restorePlans/*`.

func (*ProjectsLocationsRestorePlansService)GetIamPolicy

GetIamPolicy: Gets the access control policy for a resource. Returns anempty policy if the resource exists and does not have a policy set.

func (*ProjectsLocationsRestorePlansService)GetTagsadded inv0.257.0

GetTags: Returns tags directly bound to a GCP resource.

- name: The full resource name of the service resource.

func (*ProjectsLocationsRestorePlansService)List

List: Lists RestorePlans in a given location.

  • parent: The location that contains the RestorePlans to list. Format:`projects/*/locations/*`.

func (*ProjectsLocationsRestorePlansService)Patch

Patch: Update a RestorePlan.

  • name: Output only. Identifier. The full name of the RestorePlan resource.Format: `projects/*/locations/*/restorePlans/*`.

func (*ProjectsLocationsRestorePlansService)SetIamPolicy

SetIamPolicy: Sets the access control policy on the specified resource.Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`,and `PERMISSION_DENIED` errors.

func (*ProjectsLocationsRestorePlansService)SetTagsadded inv0.257.0

SetTags: Updates tags directly bound to a GCP resource.

- name: The full resource name of the service resource.

func (*ProjectsLocationsRestorePlansService)TestIamPermissions

TestIamPermissions: Returns permissions that a caller has on the specifiedresource. If the resource does not exist, this will return an empty set ofpermissions, not a `NOT_FOUND` error. Note: This operation is designed to beused for building permission-aware UIs and command-line tools, not forauthorization checking. This operation may "fail open" without warning.

typeProjectsLocationsRestorePlansSetIamPolicyCall

type ProjectsLocationsRestorePlansSetIamPolicyCall struct {// contains filtered or unexported fields}

func (*ProjectsLocationsRestorePlansSetIamPolicyCall)Context

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsRestorePlansSetIamPolicyCall)Do

Do executes the "gkebackup.projects.locations.restorePlans.setIamPolicy" call.Any non-2xx status code is an error. Response headers are in either*Policy.ServerResponse.Header or (if a response was returned at all) inerror.(*googleapi.Error).Header. Use googleapi.IsNotModified to checkwhether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsRestorePlansSetIamPolicyCall)Fields

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ProjectsLocationsRestorePlansSetIamPolicyCall)Header

Header returns a http.Header that can be modified by the caller to addheaders to the request.

typeProjectsLocationsRestorePlansSetTagsCalladded inv0.257.0

type ProjectsLocationsRestorePlansSetTagsCall struct {// contains filtered or unexported fields}

func (*ProjectsLocationsRestorePlansSetTagsCall)Contextadded inv0.257.0

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsRestorePlansSetTagsCall)Doadded inv0.257.0

Do executes the "gkebackup.projects.locations.restorePlans.setTags" call.Any non-2xx status code is an error. Response headers are in either*SetTagsResponse.ServerResponse.Header or (if a response was returned atall) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified tocheck whether the returned error was because http.StatusNotModified wasreturned.

func (*ProjectsLocationsRestorePlansSetTagsCall)Fieldsadded inv0.257.0

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ProjectsLocationsRestorePlansSetTagsCall)Headeradded inv0.257.0

Header returns a http.Header that can be modified by the caller to addheaders to the request.

typeProjectsLocationsRestorePlansTestIamPermissionsCall

type ProjectsLocationsRestorePlansTestIamPermissionsCall struct {// contains filtered or unexported fields}

func (*ProjectsLocationsRestorePlansTestIamPermissionsCall)Context

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsRestorePlansTestIamPermissionsCall)Do

Do executes the "gkebackup.projects.locations.restorePlans.testIamPermissions" call.Any non-2xx status code is an error. Response headers are in either*TestIamPermissionsResponse.ServerResponse.Header or (if a response wasreturned at all) in error.(*googleapi.Error).Header. Usegoogleapi.IsNotModified to check whether the returned error was becausehttp.StatusNotModified was returned.

func (*ProjectsLocationsRestorePlansTestIamPermissionsCall)Fields

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ProjectsLocationsRestorePlansTestIamPermissionsCall)Header

Header returns a http.Header that can be modified by the caller to addheaders to the request.

typeProjectsLocationsService

type ProjectsLocationsService struct {BackupChannels *ProjectsLocationsBackupChannelsServiceBackupPlans *ProjectsLocationsBackupPlansServiceOperations *ProjectsLocationsOperationsServiceRestoreChannels *ProjectsLocationsRestoreChannelsServiceRestorePlans *ProjectsLocationsRestorePlansService// contains filtered or unexported fields}

funcNewProjectsLocationsService

func NewProjectsLocationsService(s *Service) *ProjectsLocationsService

func (*ProjectsLocationsService)Get

Get: Gets information about a location.

- name: Resource name for the location.

func (*ProjectsLocationsService)List

List: Lists information about the supported locations for this service.

- name: The resource that owns the locations collection, if applicable.

typeProjectsService

type ProjectsService struct {Locations *ProjectsLocationsService// contains filtered or unexported fields}

funcNewProjectsService

func NewProjectsService(s *Service) *ProjectsService

typeResourceFilteradded inv0.129.0

type ResourceFilter struct {// GroupKinds: Optional. (Filtering parameter) Any resource subject to// transformation must belong to one of the listed "types". If this field is// not provided, no type filtering will be performed (all resources of all// types matching previous filtering parameters will be candidates for// transformation).GroupKinds []*GroupKind `json:"groupKinds,omitempty"`// JsonPath: Optional. This is a [JSONPath]// (https://github.com/json-path/JsonPath/blob/master/README.md) expression// that matches specific fields of candidate resources and it operates as a// filtering parameter (resources that are not matched with this expression// will not be candidates for transformation).JsonPathstring `json:"jsonPath,omitempty"`// Namespaces: Optional. (Filtering parameter) Any resource subject to// transformation must be contained within one of the listed Kubernetes// Namespace in the Backup. If this field is not provided, no namespace// filtering will be performed (all resources in all Namespaces, including all// cluster-scoped resources, will be candidates for transformation).Namespaces []string `json:"namespaces,omitempty"`// ForceSendFields is a list of field names (e.g. "GroupKinds") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "GroupKinds") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

ResourceFilter: ResourceFilter specifies matching criteria to limit thescope of a change to a specific set of kubernetes resources that areselected for restoration from a backup.

func (ResourceFilter)MarshalJSONadded inv0.129.0

func (sResourceFilter) MarshalJSON() ([]byte,error)

typeResourceLabelsadded inv0.237.0

type ResourceLabels struct {// ResourceLabels: Optional. A list of Kubernetes label-value pairs.ResourceLabels []*Label `json:"resourceLabels,omitempty"`// ForceSendFields is a list of field names (e.g. "ResourceLabels") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "ResourceLabels") to include in// API requests with the JSON null value. By default, fields with empty values// are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

ResourceLabels: A list of Kubernetes labels.

func (ResourceLabels)MarshalJSONadded inv0.237.0

func (sResourceLabels) MarshalJSON() ([]byte,error)

typeResourceSelectoradded inv0.182.0

type ResourceSelector struct {// GroupKind: Optional. Selects resources using their Kubernetes GroupKinds. If// specified, only resources of provided GroupKind will be selected.GroupKind *GroupKind `json:"groupKind,omitempty"`// Labels: Optional. Selects resources using Kubernetes labels// (https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/).// If specified, a resource will be selected if and only if the resource has// all of the provided labels and all the label values match.Labels map[string]string `json:"labels,omitempty"`// Name: Optional. Selects resources using their resource names. If specified,// only resources with the provided name will be selected.Namestring `json:"name,omitempty"`// Namespace: Optional. Selects resources using their namespaces. This only// applies to namespace scoped resources and cannot be used for selecting// cluster scoped resources. If specified, only resources in the provided// namespace will be selected. If not specified, the filter will apply to both// cluster scoped and namespace scoped resources (e.g. name or label). The// Namespace (https://pkg.go.dev/k8s.io/api/core/v1#Namespace) resource itself// will be restored if and only if any resources within the namespace are// restored.Namespacestring `json:"namespace,omitempty"`// ForceSendFields is a list of field names (e.g. "GroupKind") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "GroupKind") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

ResourceSelector: Defines a selector to identify a single or a group ofresources. Conditions in the selector are optional, but at least one fieldshould be set to a non-empty value. If a condition is not specified, norestrictions will be applied on that dimension. If more than one conditionis specified, a resource will be selected if and only if all conditions aremet.

func (ResourceSelector)MarshalJSONadded inv0.182.0

func (sResourceSelector) MarshalJSON() ([]byte,error)

typeRestore

type Restore struct {// Backup: 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/*`.Backupstring `json:"backup,omitempty"`// Cluster: Output only. The target cluster into which this Restore will// restore data. Valid formats: - `projects/*/locations/*/clusters/*` -// `projects/*/zones/*/clusters/*` Inherited from parent RestorePlan's cluster// value.Clusterstring `json:"cluster,omitempty"`// CompleteTime: Output only. Timestamp of when the restore operation// completed.CompleteTimestring `json:"completeTime,omitempty"`// CreateTime: Output only. The timestamp when this Restore resource was// created.CreateTimestring `json:"createTime,omitempty"`// Description: Optional. User specified descriptive string for this Restore.Descriptionstring `json:"description,omitempty"`// Etag: Output only. `etag` is used for optimistic concurrency control as a// way to help prevent simultaneous updates of a restore from overwriting each// other. It is strongly suggested that systems make use of the `etag` in the// read-modify-write cycle to perform restore updates in order to avoid race// conditions: An `etag` is returned in the response to `GetRestore`, and// systems are expected to put that etag in the request to `UpdateRestore` or// `DeleteRestore` to ensure that their change will be applied to the same// version of the resource.Etagstring `json:"etag,omitempty"`// Filter: Optional. Immutable. Filters resources for `Restore`. If not// specified, the scope of the restore will remain the same as defined in the// `RestorePlan`. If this is specified and no resources are matched by the// `inclusion_filters` or everything is excluded by the `exclusion_filters`,// nothing will be restored. This filter can only be specified if the value of// namespaced_resource_restore_mode is set to `MERGE_SKIP_ON_CONFLICT`,// `MERGE_REPLACE_VOLUME_ON_CONFLICT` or `MERGE_REPLACE_ON_CONFLICT`.Filter *Filter `json:"filter,omitempty"`// Labels: A set of custom labels supplied by user.Labels map[string]string `json:"labels,omitempty"`// Name: Output only. Identifier. The full name of the Restore resource.// Format: `projects/*/locations/*/restorePlans/*/restores/*`Namestring `json:"name,omitempty"`// ResourcesExcludedCount: Output only. Number of resources excluded during the// restore execution.ResourcesExcludedCountint64 `json:"resourcesExcludedCount,omitempty"`// ResourcesFailedCount: Output only. Number of resources that failed to be// restored during the restore execution.ResourcesFailedCountint64 `json:"resourcesFailedCount,omitempty"`// ResourcesRestoredCount: Output only. Number of resources restored during the// restore execution.ResourcesRestoredCountint64 `json:"resourcesRestoredCount,omitempty"`// RestoreConfig: Output only. Configuration of the Restore. Inherited from// parent RestorePlan's restore_config.RestoreConfig *RestoreConfig `json:"restoreConfig,omitempty"`// State: Output only. The current state of the Restore.//// Possible values://   "STATE_UNSPECIFIED" - The Restore resource is in the process of being// created.//   "CREATING" - The Restore resource has been created and the associated// RestoreJob Kubernetes resource has been injected into target cluster.//   "IN_PROGRESS" - The gkebackup agent in the cluster has begun executing the// restore operation.//   "SUCCEEDED" - The restore operation has completed successfully. Restored// workloads may not yet be operational.//   "FAILED" - The restore operation has failed.//   "DELETING" - This Restore resource is in the process of being deleted.//   "VALIDATING" - The Kubernetes resources created by this Restore are being// validated.Statestring `json:"state,omitempty"`// StateReason: Output only. Human-readable description of why the Restore is// in its current state. This field is only meant for human readability and// should not be used programmatically as this field is not guaranteed to be// consistent.StateReasonstring `json:"stateReason,omitempty"`// TroubleshootingInfo: Output only. Information about the troubleshooting// steps which will provide debugging information to the end users.TroubleshootingInfo *TroubleshootingInfo `json:"troubleshootingInfo,omitempty"`// Uid: Output only. Server generated global unique identifier of UUID// (https://en.wikipedia.org/wiki/Universally_unique_identifier) format.Uidstring `json:"uid,omitempty"`// UpdateTime: Output only. The timestamp when this Restore resource was last// updated.UpdateTimestring `json:"updateTime,omitempty"`// VolumeDataRestorePolicyOverrides: Optional. Immutable. Overrides the volume// data restore policies selected in the Restore Config for override-scoped// resources.VolumeDataRestorePolicyOverrides []*VolumeDataRestorePolicyOverride `json:"volumeDataRestorePolicyOverrides,omitempty"`// VolumesRestoredCount: Output only. Number of volumes restored during the// restore execution.VolumesRestoredCountint64 `json:"volumesRestoredCount,omitempty"`// ServerResponse contains the HTTP response code and headers from the server.googleapi.ServerResponse `json:"-"`// ForceSendFields is a list of field names (e.g. "Backup") to unconditionally// include in API requests. By default, fields with empty or default values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Backup") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

Restore: Represents both a request to Restore some portion of a Backup intoa target GKE cluster and a record of the restore operation itself.

func (Restore)MarshalJSON

func (sRestore) MarshalJSON() ([]byte,error)

typeRestoreChanneladded inv0.230.0

type RestoreChannel struct {// CreateTime: Output only. The timestamp when this RestoreChannel was created.CreateTimestring `json:"createTime,omitempty"`// Description: Optional. User specified descriptive string for this// RestoreChannel.Descriptionstring `json:"description,omitempty"`// DestinationProject: Required. Immutable. The project into which the backups// will be restored. The format is `projects/{projectId}` or// `projects/{projectNumber}`.DestinationProjectstring `json:"destinationProject,omitempty"`// DestinationProjectId: Output only. The project_id where backups will be// restored. Example Project ID: "my-project-id". This will be an OUTPUT_ONLY// field to return the project_id of the destination project.DestinationProjectIdstring `json:"destinationProjectId,omitempty"`// Etag: Output only. `etag` is used for optimistic concurrency control as a// way to help prevent simultaneous updates of a RestoreChannel from// overwriting each other. It is strongly suggested that systems make use of// the 'etag' in the read-modify-write cycle to perform RestoreChannel updates// in order to avoid race conditions: An `etag` is returned in the response to// `GetRestoreChannel`, and systems are expected to put that etag in the// request to `UpdateRestoreChannel` or `DeleteRestoreChannel` to ensure that// their change will be applied to the same version of the resource.Etagstring `json:"etag,omitempty"`// Labels: Optional. A set of custom labels supplied by user.Labels map[string]string `json:"labels,omitempty"`// Name: Identifier. The fully qualified name of the RestoreChannel.// `projects/*/locations/*/restoreChannels/*`Namestring `json:"name,omitempty"`// Uid: Output only. Server generated global unique identifier of UUID// (https://en.wikipedia.org/wiki/Universally_unique_identifier) format.Uidstring `json:"uid,omitempty"`// UpdateTime: Output only. The timestamp when this RestoreChannel was last// updated.UpdateTimestring `json:"updateTime,omitempty"`// ServerResponse contains the HTTP response code and headers from the server.googleapi.ServerResponse `json:"-"`// ForceSendFields is a list of field names (e.g. "CreateTime") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "CreateTime") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

RestoreChannel: A RestoreChannel imposes constraints on where backups can berestored. The RestoreChannel should be in the same project and region as thebackups. The backups can only be restored in the `destination_project`.

func (RestoreChannel)MarshalJSONadded inv0.230.0

func (sRestoreChannel) MarshalJSON() ([]byte,error)

typeRestoreConfig

type RestoreConfig struct {// AllNamespaces: Restore all namespaced resources in the Backup if set to// "True". Specifying this field to "False" is an error.AllNamespacesbool `json:"allNamespaces,omitempty"`// ClusterResourceConflictPolicy: Optional. Defines the behavior for handling// the situation where cluster-scoped resources being restored already exist in// the target cluster. This MUST be set to a value other than// CLUSTER_RESOURCE_CONFLICT_POLICY_UNSPECIFIED if// cluster_resource_restore_scope is not empty.//// Possible values://   "CLUSTER_RESOURCE_CONFLICT_POLICY_UNSPECIFIED" - Unspecified. Only allowed// if no cluster-scoped resources will be restored.//   "USE_EXISTING_VERSION" - Do not attempt to restore the conflicting// resource.//   "USE_BACKUP_VERSION" - Delete the existing version before re-creating it// from the Backup. This is a dangerous option which could cause unintentional// data loss if used inappropriately. For example, deleting a CRD will cause// Kubernetes to delete all CRs of that type.ClusterResourceConflictPolicystring `json:"clusterResourceConflictPolicy,omitempty"`// ClusterResourceRestoreScope: Optional. Identifies the cluster-scoped// resources to restore from the Backup. Not specifying it means NO cluster// resource will be restored.ClusterResourceRestoreScope *ClusterResourceRestoreScope `json:"clusterResourceRestoreScope,omitempty"`// ExcludedNamespaces: A list of selected namespaces excluded from restoration.// All namespaces except those in this list will be restored.ExcludedNamespaces *Namespaces `json:"excludedNamespaces,omitempty"`// NamespacedResourceRestoreMode: Optional. Defines the behavior for handling// the situation where sets of namespaced resources being restored already// exist in the target cluster. This MUST be set to a value other than// NAMESPACED_RESOURCE_RESTORE_MODE_UNSPECIFIED.//// Possible values://   "NAMESPACED_RESOURCE_RESTORE_MODE_UNSPECIFIED" - Unspecified (invalid).//   "DELETE_AND_RESTORE" - When conflicting top-level resources (either// Namespaces or ProtectedApplications, depending upon the scope) are// encountered, this will first trigger a delete of the conflicting resource// AND ALL OF ITS REFERENCED RESOURCES (e.g., all resources in the Namespace or// all resources referenced by the ProtectedApplication) before restoring the// resources from the Backup. This mode should only be used when you are// intending to revert some portion of a cluster to an earlier state.//   "FAIL_ON_CONFLICT" - If conflicting top-level resources (either Namespaces// or ProtectedApplications, depending upon the scope) are encountered at the// beginning of a restore process, the Restore will fail. If a conflict occurs// during the restore process itself (e.g., because an out of band process// creates conflicting resources), a conflict will be reported.//   "MERGE_SKIP_ON_CONFLICT" - This mode merges the backup and the target// cluster and skips the conflicting resources. If a single resource to restore// exists in the cluster before restoration, the resource will be skipped,// otherwise it will be restored.//   "MERGE_REPLACE_VOLUME_ON_CONFLICT" - This mode merges the backup and the// target cluster and skips the conflicting resources except volume data. If a// PVC to restore already exists, this mode will restore/reconnect the volume// without overwriting the PVC. It is similar to MERGE_SKIP_ON_CONFLICT except// that it will apply the volume data policy for the conflicting PVCs: -// RESTORE_VOLUME_DATA_FROM_BACKUP: restore data only and respect the reclaim// policy of the original PV; - REUSE_VOLUME_HANDLE_FROM_BACKUP: reconnect and// respect the reclaim policy of the original PV; - NO_VOLUME_DATA_RESTORATION:// new provision and respect the reclaim policy of the original PV. Note that// this mode could cause data loss as the original PV can be retained or// deleted depending on its reclaim policy.//   "MERGE_REPLACE_ON_CONFLICT" - This mode merges the backup and the target// cluster and replaces the conflicting resources with the ones in the backup.// If a single resource to restore exists in the cluster before restoration,// the resource will be replaced with the one from the backup. To replace an// existing resource, the first attempt is to update the resource to match the// one from the backup; if the update fails, the second attempt is to delete// the resource and restore it from the backup. Note that this mode could cause// data loss as it replaces the existing resources in the target cluster, and// the original PV can be retained or deleted depending on its reclaim policy.NamespacedResourceRestoreModestring `json:"namespacedResourceRestoreMode,omitempty"`// NoNamespaces: Do not restore any namespaced resources if set to "True".// Specifying this field to "False" is not allowed.NoNamespacesbool `json:"noNamespaces,omitempty"`// RestoreOrder: Optional. RestoreOrder contains custom ordering to use on a// Restore.RestoreOrder *RestoreOrder `json:"restoreOrder,omitempty"`// SelectedApplications: A list of selected ProtectedApplications to restore.// The listed ProtectedApplications and all the resources to which they refer// will be restored.SelectedApplications *NamespacedNames `json:"selectedApplications,omitempty"`// SelectedNamespaces: A list of selected Namespaces to restore from the// Backup. The listed Namespaces and all resources contained in them will be// restored.SelectedNamespaces *Namespaces `json:"selectedNamespaces,omitempty"`// SubstitutionRules: Optional. A list of transformation rules to be applied// against Kubernetes resources as they are selected for restoration from a// Backup. Rules are executed in order defined - this order matters, as changes// made by a rule may impact the filtering logic of subsequent rules. An empty// list means no substitution will occur.SubstitutionRules []*SubstitutionRule `json:"substitutionRules,omitempty"`// TransformationRules: Optional. A list of transformation rules to be applied// against Kubernetes resources as they are selected for restoration from a// Backup. Rules are executed in order defined - this order matters, as changes// made by a rule may impact the filtering logic of subsequent rules. An empty// list means no transformation will occur.TransformationRules []*TransformationRule `json:"transformationRules,omitempty"`// VolumeDataRestorePolicy: Optional. Specifies the mechanism to be used to// restore volume data. Default: VOLUME_DATA_RESTORE_POLICY_UNSPECIFIED (will// be treated as NO_VOLUME_DATA_RESTORATION).//// Possible values://   "VOLUME_DATA_RESTORE_POLICY_UNSPECIFIED" - Unspecified (illegal).//   "RESTORE_VOLUME_DATA_FROM_BACKUP" - For each PVC to be restored, create a// new underlying volume and PV from the corresponding VolumeBackup contained// within the Backup.//   "REUSE_VOLUME_HANDLE_FROM_BACKUP" - For each PVC to be restored, attempt// to reuse the original PV contained in the Backup (with its original// underlying volume). This option is likely only usable when restoring a// workload to its original cluster.//   "NO_VOLUME_DATA_RESTORATION" - For each PVC to be restored, create PVC// without any particular action to restore data. In this case, the normal// Kubernetes provisioning logic would kick in, and this would likely result in// either dynamically provisioning blank PVs or binding to statically// provisioned PVs.VolumeDataRestorePolicystring `json:"volumeDataRestorePolicy,omitempty"`// VolumeDataRestorePolicyBindings: Optional. A table that binds volumes by// their scope to a restore policy. Bindings must have a unique scope. Any// volumes not scoped in the bindings are subject to the policy defined in// volume_data_restore_policy.VolumeDataRestorePolicyBindings []*VolumeDataRestorePolicyBinding `json:"volumeDataRestorePolicyBindings,omitempty"`// ForceSendFields is a list of field names (e.g. "AllNamespaces") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "AllNamespaces") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

RestoreConfig: Configuration of a restore.

func (RestoreConfig)MarshalJSON

func (sRestoreConfig) MarshalJSON() ([]byte,error)

typeRestoreOrderadded inv0.182.0

type RestoreOrder struct {// GroupKindDependencies: Optional. Contains a list of group kind dependency// pairs provided by the customer, that is used by Backup for GKE to generate a// group kind restore order.GroupKindDependencies []*GroupKindDependency `json:"groupKindDependencies,omitempty"`// ForceSendFields is a list of field names (e.g. "GroupKindDependencies") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "GroupKindDependencies") to// include in API requests with the JSON null value. By default, fields with// empty values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

RestoreOrder: Allows customers to specify dependencies between resourcesthat Backup for GKE can use to compute a resasonable restore order.

func (RestoreOrder)MarshalJSONadded inv0.182.0

func (sRestoreOrder) MarshalJSON() ([]byte,error)

typeRestorePlan

type RestorePlan struct {// BackupPlan: 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/*`.BackupPlanstring `json:"backupPlan,omitempty"`// Cluster: 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/*`Clusterstring `json:"cluster,omitempty"`// CreateTime: Output only. The timestamp when this RestorePlan resource was// created.CreateTimestring `json:"createTime,omitempty"`// Description: Optional. User specified descriptive string for this// RestorePlan.Descriptionstring `json:"description,omitempty"`// Etag: Output only. `etag` is used for optimistic concurrency control as a// way to help prevent simultaneous updates of a restore from overwriting each// other. It is strongly suggested that systems make use of the `etag` in the// read-modify-write cycle to perform restore updates in order to avoid race// conditions: An `etag` is returned in the response to `GetRestorePlan`, and// systems are expected to put that etag in the request to `UpdateRestorePlan`// or `DeleteRestorePlan` to ensure that their change will be applied to the// same version of the resource.Etagstring `json:"etag,omitempty"`// Labels: Optional. A set of custom labels supplied by user.Labels map[string]string `json:"labels,omitempty"`// Name: Output only. Identifier. The full name of the RestorePlan resource.// Format: `projects/*/locations/*/restorePlans/*`.Namestring `json:"name,omitempty"`// RestoreChannel: Output only. The fully qualified name of the RestoreChannel// to be used to create a RestorePlan. This field is set only if the// `backup_plan` is in a different project than the RestorePlan. Format:// `projects/*/locations/*/restoreChannels/*`RestoreChannelstring `json:"restoreChannel,omitempty"`// RestoreConfig: Required. Configuration of Restores created via this// RestorePlan.RestoreConfig *RestoreConfig `json:"restoreConfig,omitempty"`// State: Output only. State of the RestorePlan. This State field reflects the// various stages a RestorePlan can be in during the Create operation.//// Possible values://   "STATE_UNSPECIFIED" - Default first value for Enums.//   "CLUSTER_PENDING" - Waiting for cluster state to be RUNNING.//   "READY" - The RestorePlan has successfully been created and is ready for// Restores.//   "FAILED" - RestorePlan creation has failed.//   "DELETING" - The RestorePlan is in the process of being deleted.Statestring `json:"state,omitempty"`// StateReason: Output only. Human-readable description of why RestorePlan is// in the current `state`. This field is only meant for human readability and// should not be used programmatically as this field is not guaranteed to be// consistent.StateReasonstring `json:"stateReason,omitempty"`// Uid: Output only. Server generated global unique identifier of UUID// (https://en.wikipedia.org/wiki/Universally_unique_identifier) format.Uidstring `json:"uid,omitempty"`// UpdateTime: Output only. The timestamp when this RestorePlan resource was// last updated.UpdateTimestring `json:"updateTime,omitempty"`// ServerResponse contains the HTTP response code and headers from the server.googleapi.ServerResponse `json:"-"`// ForceSendFields is a list of field names (e.g. "BackupPlan") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "BackupPlan") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

RestorePlan: The configuration of a potential series of Restore operationsto be performed against Backups belong to a particular BackupPlan.

func (RestorePlan)MarshalJSON

func (sRestorePlan) MarshalJSON() ([]byte,error)

typeRestorePlanBindingadded inv0.230.0

type RestorePlanBinding struct {// BackupPlan: Output only. The fully qualified name of the BackupPlan bound to// the specified RestorePlan.// `projects/*/locations/*/backukpPlans/{backup_plan}`BackupPlanstring `json:"backupPlan,omitempty"`// CreateTime: Output only. The timestamp when this binding was created.CreateTimestring `json:"createTime,omitempty"`// Etag: Output only. `etag` is used for optimistic concurrency control as a// way to help prevent simultaneous updates of a RestorePlanBinding from// overwriting each other. It is strongly suggested that systems make use of// the 'etag' in the read-modify-write cycle to perform RestorePlanBinding// updates in order to avoid race conditions: An `etag` is returned in the// response to `GetRestorePlanBinding`, and systems are expected to put that// etag in the request to `UpdateRestorePlanBinding` or// `DeleteRestorePlanBinding` to ensure that their change will be applied to// the same version of the resource.Etagstring `json:"etag,omitempty"`// Name: Identifier. The fully qualified name of the RestorePlanBinding.// `projects/*/locations/*/restoreChannels/*/restorePlanBindings/*`Namestring `json:"name,omitempty"`// RestorePlan: Output only. The fully qualified name of the RestorePlan bound// to this RestoreChannel. `projects/*/locations/*/restorePlans/{restore_plan}`RestorePlanstring `json:"restorePlan,omitempty"`// Uid: Output only. Server generated global unique identifier of UUID4// (https://en.wikipedia.org/wiki/Universally_unique_identifier)Uidstring `json:"uid,omitempty"`// UpdateTime: Output only. The timestamp when this binding was created.UpdateTimestring `json:"updateTime,omitempty"`// ServerResponse contains the HTTP response code and headers from the server.googleapi.ServerResponse `json:"-"`// ForceSendFields is a list of field names (e.g. "BackupPlan") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "BackupPlan") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

RestorePlanBinding: A RestorePlanBinding binds a RestorePlan with aRestoreChannel. This resource is created automatically when a RestorePlan iscreated using a RestoreChannel. This also serves as a holder forcross-project fields that need to be displayed in the current project.

func (RestorePlanBinding)MarshalJSONadded inv0.230.0

func (sRestorePlanBinding) MarshalJSON() ([]byte,error)

typeRetentionPolicy

type RetentionPolicy struct {// BackupDeleteLockDays: Optional. Minimum age for Backups created via this// BackupPlan (in days). This field MUST be an integer value between 0-90// (inclusive). A Backup created under this BackupPlan will NOT be deletable// until it reaches Backup's (create_time + backup_delete_lock_days). Updating// this field of a BackupPlan does NOT affect existing Backups under it.// Backups created AFTER a successful update will inherit the new value.// Default: 0 (no delete blocking)BackupDeleteLockDaysint64 `json:"backupDeleteLockDays,omitempty"`// BackupRetainDays: Optional. The default maximum age of a Backup created via// this BackupPlan. This field MUST be an integer value >= 0 and <= 365. If// specified, a Backup created under this BackupPlan will be automatically// deleted after its age reaches (create_time + backup_retain_days). If not// specified, Backups created under this BackupPlan will NOT be subject to// automatic deletion. Updating this field does NOT affect existing Backups// under it. Backups created AFTER a successful update will automatically pick// up the new value. NOTE: backup_retain_days must be >=// backup_delete_lock_days. If cron_schedule is defined, then this must be <=// 360 * the creation interval. If rpo_config is defined, then this must be <=// 360 * target_rpo_minutes / (1440minutes/day). Default: 0 (no automatic// deletion)BackupRetainDaysint64 `json:"backupRetainDays,omitempty"`// Locked: Optional. This flag denotes whether the retention policy of this// BackupPlan is locked. If set to True, no further update is allowed on this// policy, including the `locked` field itself. Default: FalseLockedbool `json:"locked,omitempty"`// ForceSendFields is a list of field names (e.g. "BackupDeleteLockDays") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "BackupDeleteLockDays") to include// in API requests with the JSON null value. By default, fields with empty// values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

RetentionPolicy: RetentionPolicy defines a Backup retention policy for aBackupPlan.

func (RetentionPolicy)MarshalJSON

func (sRetentionPolicy) MarshalJSON() ([]byte,error)

typeRetentionPolicyDetailsadded inv0.234.0

type RetentionPolicyDetails struct {// BackupDeleteLockDays: Optional. Minimum age for Backups created via this// BackupPlan (in days). This field MUST be an integer value between 0-90// (inclusive). A Backup created under this BackupPlan will NOT be deletable// until it reaches Backup's (create_time + backup_delete_lock_days). Updating// this field of a BackupPlan does NOT affect existing Backups under it.// Backups created AFTER a successful update will inherit the new value.// Default: 0 (no delete blocking)BackupDeleteLockDaysint64 `json:"backupDeleteLockDays,omitempty"`// BackupRetainDays: Optional. The default maximum age of a Backup created via// this BackupPlan. This field MUST be an integer value >= 0 and <= 365. If// specified, a Backup created under this BackupPlan will be automatically// deleted after its age reaches (create_time + backup_retain_days). If not// specified, Backups created under this BackupPlan will NOT be subject to// automatic deletion. Default: 0 (no automatic deletion)BackupRetainDaysint64 `json:"backupRetainDays,omitempty"`// ForceSendFields is a list of field names (e.g. "BackupDeleteLockDays") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "BackupDeleteLockDays") to include// in API requests with the JSON null value. By default, fields with empty// values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

RetentionPolicyDetails: RetentionPolicyDetails defines a Backup retentionpolicy for a BackupPlan.

func (RetentionPolicyDetails)MarshalJSONadded inv0.234.0

func (sRetentionPolicyDetails) MarshalJSON() ([]byte,error)

typeRpoConfigadded inv0.173.0

type RpoConfig struct {// ExclusionWindows: Optional. User specified time windows during which backup// can NOT happen for this BackupPlan - backups should start and finish outside// of any given exclusion window. Note: backup jobs will be scheduled to start// and finish outside the duration of the window as much as possible, but// running jobs will not get canceled when it runs into the window. All the// time and date values in exclusion_windows entry in the API are in UTC. We// only allow <=1 recurrence (daily or weekly) exclusion window for a// BackupPlan while no restriction on number of single occurrence windows.ExclusionWindows []*ExclusionWindow `json:"exclusionWindows,omitempty"`// TargetRpoMinutes: Required. Defines the target RPO for the BackupPlan in// minutes, which means the target maximum data loss in time that is acceptable// for this BackupPlan. This must be at least 60, i.e., 1 hour, and at most// 86400, i.e., 60 days.TargetRpoMinutesint64 `json:"targetRpoMinutes,omitempty"`// ForceSendFields is a list of field names (e.g. "ExclusionWindows") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "ExclusionWindows") to include in// API requests with the JSON null value. By default, fields with empty values// are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

RpoConfig: Defines RPO scheduling configuration for automatically creatingBackups via this BackupPlan.

func (RpoConfig)MarshalJSONadded inv0.173.0

func (sRpoConfig) MarshalJSON() ([]byte,error)

typeSchedule

type Schedule struct {// CronSchedule: Optional. A standard cron (https://wikipedia.com/wiki/cron)// string that defines a repeating schedule for creating Backups via this// BackupPlan. This is mutually exclusive with the rpo_config field since at// most one schedule can be defined for a BackupPlan. If this is defined, then// backup_retain_days must also be defined. Default (empty): no automatic// backup creation will occur.CronSchedulestring `json:"cronSchedule,omitempty"`// NextScheduledBackupTime: Output only. Start time of next scheduled backup// under this BackupPlan by either cron_schedule or rpo config.NextScheduledBackupTimestring `json:"nextScheduledBackupTime,omitempty"`// Paused: Optional. This flag denotes whether automatic Backup creation is// paused for this BackupPlan. Default: FalsePausedbool `json:"paused,omitempty"`// RpoConfig: Optional. Defines the RPO schedule configuration for this// BackupPlan. This is mutually exclusive with the cron_schedule field since at// most one schedule can be defined for a BackupPLan. If this is defined, then// backup_retain_days must also be defined. Default (empty): no automatic// backup creation will occur.RpoConfig *RpoConfig `json:"rpoConfig,omitempty"`// ForceSendFields is a list of field names (e.g. "CronSchedule") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "CronSchedule") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

Schedule: Defines scheduling parameters for automatically creating Backupsvia this BackupPlan.

func (Schedule)MarshalJSON

func (sSchedule) MarshalJSON() ([]byte,error)

typeService

type Service struct {BasePathstring// API endpoint base URLUserAgentstring// optional additional User-Agent fragmentProjects *ProjectsService// contains filtered or unexported fields}

funcNewdeprecated

func New(client *http.Client) (*Service,error)

New creates a new Service. It uses the provided http.Client for requests.

Deprecated: please use NewService instead.To provide a custom HTTP client, use option.WithHTTPClient.If you are using google.golang.org/api/googleapis/transport.APIKey, use option.WithAPIKey with NewService instead.

funcNewService

func NewService(ctxcontext.Context, opts ...option.ClientOption) (*Service,error)

NewService creates a new Service.

typeSetIamPolicyRequest

type SetIamPolicyRequest struct {// Policy: REQUIRED: The complete policy to be applied to the `resource`. The// size of the policy is limited to a few 10s of KB. An empty policy is a valid// policy but certain Google Cloud services (such as Projects) might reject// them.Policy *Policy `json:"policy,omitempty"`// UpdateMask: OPTIONAL: A FieldMask specifying which fields of the policy to// modify. Only the fields in the mask will be modified. If no mask is// provided, the following default mask is used: `paths: "bindings, etag"UpdateMaskstring `json:"updateMask,omitempty"`// ForceSendFields is a list of field names (e.g. "Policy") to unconditionally// include in API requests. By default, fields with empty or default values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Policy") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

SetIamPolicyRequest: Request message for `SetIamPolicy` method.

func (SetIamPolicyRequest)MarshalJSON

func (sSetIamPolicyRequest) MarshalJSON() ([]byte,error)

typeSetTagsRequestadded inv0.257.0

type SetTagsRequest struct {// Etag: Optional. A checksum based on the current bindings which can be passed// to prevent race conditions. If not passed, etag check would be skipped.Etagstring `json:"etag,omitempty"`// RequestId: Optional. A unique identifier for this request. Must be a valid// UUID. This request is only idempotent if a `request_id` is provided.RequestIdstring `json:"requestId,omitempty"`// Tags: Required. These bindings will override any bindings previously set and// will be effective immediately. Each item in the map must be expressed as " :// ". For example: "123/environment" : "production", "123/costCenter" :// "marketing"Tags map[string]string `json:"tags,omitempty"`// ForceSendFields is a list of field names (e.g. "Etag") to unconditionally// include in API requests. By default, fields with empty or default values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Etag") to include in API requests// with the JSON null value. By default, fields with empty values are omitted// from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

SetTagsRequest: Request message for SetTags.

func (SetTagsRequest)MarshalJSONadded inv0.257.0

func (sSetTagsRequest) MarshalJSON() ([]byte,error)

typeSetTagsResponseadded inv0.257.0

type SetTagsResponse struct {// Etag: A checksum based on the current bindings. This field is always set in// server responses.Etagstring `json:"etag,omitempty"`// Name: Required. The full resource name of the service resource.Namestring `json:"name,omitempty"`// Tags: Required. Tag keys/values directly bound to this resource. Each item// in the map must be expressed as " : ". For example: "123/environment" :// "production", "123/costCenter" : "marketing"Tags map[string]string `json:"tags,omitempty"`// ServerResponse contains the HTTP response code and headers from the server.googleapi.ServerResponse `json:"-"`// ForceSendFields is a list of field names (e.g. "Etag") to unconditionally// include in API requests. By default, fields with empty or default values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Etag") to include in API requests// with the JSON null value. By default, fields with empty values are omitted// from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

SetTagsResponse: Response message for SetTags.

func (SetTagsResponse)MarshalJSONadded inv0.257.0

func (sSetTagsResponse) MarshalJSON() ([]byte,error)

typeSubstitutionRule

type SubstitutionRule struct {// NewValue: Optional. This is the new value to set for any fields that pass// the filtering and selection criteria. To remove a value from a Kubernetes// resource, either leave this field unspecified, or set it to the empty string// ("").NewValuestring `json:"newValue,omitempty"`// OriginalValuePattern: Optional. (Filtering parameter) This is a [regular// expression] (https://en.wikipedia.org/wiki/Regular_expression) that is// compared against the fields matched by the target_json_path expression (and// must also have passed the previous filters). Substitution will not be// performed against fields whose value does not match this expression. If this// field is NOT specified, then ALL fields matched by the target_json_path// expression will undergo substitution. Note that an empty (e.g., "", rather// than unspecified) value for this field will only match empty fields.OriginalValuePatternstring `json:"originalValuePattern,omitempty"`// TargetGroupKinds: Optional. (Filtering parameter) Any resource subject to// substitution must belong to one of the listed "types". If this field is not// provided, no type filtering will be performed (all resources of all types// matching previous filtering parameters will be candidates for substitution).TargetGroupKinds []*GroupKind `json:"targetGroupKinds,omitempty"`// TargetJsonPath: Required. This is a [JSONPath]// (https://kubernetes.io/docs/reference/kubectl/jsonpath/) expression that// matches specific fields of candidate resources and it operates as both a// filtering parameter (resources that are not matched with this expression// will not be candidates for substitution) as well as a field identifier// (identifies exactly which fields out of the candidate resources will be// modified).TargetJsonPathstring `json:"targetJsonPath,omitempty"`// TargetNamespaces: Optional. (Filtering parameter) Any resource subject to// substitution must be contained within one of the listed Kubernetes Namespace// in the Backup. If this field is not provided, no namespace filtering will be// performed (all resources in all Namespaces, including all cluster-scoped// resources, will be candidates for substitution). To mix cluster-scoped and// namespaced resources in the same rule, use an empty string ("") as one of// the target namespaces.TargetNamespaces []string `json:"targetNamespaces,omitempty"`// ForceSendFields is a list of field names (e.g. "NewValue") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "NewValue") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

SubstitutionRule: A transformation rule to be applied against Kubernetesresources as they are selected for restoration from a Backup. A rulecontains both filtering logic (which resources are subject to substitution)and substitution logic.

func (SubstitutionRule)MarshalJSON

func (sSubstitutionRule) MarshalJSON() ([]byte,error)

typeTestIamPermissionsRequest

type TestIamPermissionsRequest struct {// Permissions: The set of permissions to check for the `resource`. Permissions// with wildcards (such as `*` or `storage.*`) are not allowed. For more// information see IAM Overview// (https://cloud.google.com/iam/docs/overview#permissions).Permissions []string `json:"permissions,omitempty"`// ForceSendFields is a list of field names (e.g. "Permissions") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Permissions") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

TestIamPermissionsRequest: Request message for `TestIamPermissions` method.

func (TestIamPermissionsRequest)MarshalJSON

func (sTestIamPermissionsRequest) MarshalJSON() ([]byte,error)

typeTestIamPermissionsResponse

type TestIamPermissionsResponse struct {// Permissions: A subset of `TestPermissionsRequest.permissions` that the// caller is allowed.Permissions []string `json:"permissions,omitempty"`// ServerResponse contains the HTTP response code and headers from the server.googleapi.ServerResponse `json:"-"`// ForceSendFields is a list of field names (e.g. "Permissions") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Permissions") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

TestIamPermissionsResponse: Response message for `TestIamPermissions`method.

func (TestIamPermissionsResponse)MarshalJSON

func (sTestIamPermissionsResponse) MarshalJSON() ([]byte,error)

typeTimeOfDayadded inv0.173.0

type TimeOfDay struct {// Hours: Hours of a day in 24 hour format. Must be greater than or equal to 0// and typically must be less than or equal to 23. An API may choose to allow// the value "24:00:00" for scenarios like business closing time.Hoursint64 `json:"hours,omitempty"`// Minutes: Minutes of an hour. Must be greater than or equal to 0 and less// than or equal to 59.Minutesint64 `json:"minutes,omitempty"`// Nanos: Fractions of seconds, in nanoseconds. Must be greater than or equal// to 0 and less than or equal to 999,999,999.Nanosint64 `json:"nanos,omitempty"`// Seconds: Seconds of a minute. Must be greater than or equal to 0 and// typically must be less than or equal to 59. An API may allow the value 60 if// it allows leap-seconds.Secondsint64 `json:"seconds,omitempty"`// ForceSendFields is a list of field names (e.g. "Hours") to unconditionally// include in API requests. By default, fields with empty or default values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Hours") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

TimeOfDay: Represents a time of day. The date and time zone are either notsignificant or are specified elsewhere. An API may choose to allow leapseconds. Related types are google.type.Date and `google.protobuf.Timestamp`.

func (TimeOfDay)MarshalJSONadded inv0.173.0

func (sTimeOfDay) MarshalJSON() ([]byte,error)

typeTransformationRuleadded inv0.129.0

type TransformationRule struct {// Description: Optional. The description is a user specified string// description of the transformation rule.Descriptionstring `json:"description,omitempty"`// FieldActions: Required. A list of transformation rule actions to take// against candidate resources. Actions are executed in order defined - this// order matters, as they could potentially interfere with each other and the// first operation could affect the outcome of the second operation.FieldActions []*TransformationRuleAction `json:"fieldActions,omitempty"`// ResourceFilter: Optional. This field is used to specify a set of fields that// should be used to determine which resources in backup should be acted upon// by the supplied transformation rule actions, and this will ensure that only// specific resources are affected by transformation rule actions.ResourceFilter *ResourceFilter `json:"resourceFilter,omitempty"`// ForceSendFields is a list of field names (e.g. "Description") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Description") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

TransformationRule: A transformation rule to be applied against Kubernetesresources as they are selected for restoration from a Backup. A rulecontains both filtering logic (which resources are subject to transform) andtransformation logic.

func (TransformationRule)MarshalJSONadded inv0.129.0

func (sTransformationRule) MarshalJSON() ([]byte,error)

typeTransformationRuleActionadded inv0.129.0

type TransformationRuleAction struct {// FromPath: Optional. A string containing a JSON Pointer value that references// the location in the target document to move the value from.FromPathstring `json:"fromPath,omitempty"`// Op: Required. op specifies the operation to perform.//// Possible values://   "OP_UNSPECIFIED" - Unspecified operation//   "REMOVE" - The "remove" operation removes the value at the target// location.//   "MOVE" - The "move" operation removes the value at a specified location// and adds it to the target location.//   "COPY" - The "copy" operation copies the value at a specified location to// the target location.//   "ADD" - The "add" operation performs one of the following functions,// depending upon what the target location references: 1. If the target// location specifies an array index, a new value is inserted into the array at// the specified index. 2. If the target location specifies an object member// that does not already exist, a new member is added to the object. 3. If the// target location specifies an object member that does exist, that member's// value is replaced.//   "TEST" - The "test" operation tests that a value at the target location is// equal to a specified value.//   "REPLACE" - The "replace" operation replaces the value at the target// location with a new value. The operation object MUST contain a "value"// member whose content specifies the replacement value.Opstring `json:"op,omitempty"`// Path: Optional. A string containing a JSON-Pointer value that references a// location within the target document where the operation is performed.Pathstring `json:"path,omitempty"`// Value: Optional. A string that specifies the desired value in string format// to use for transformation.Valuestring `json:"value,omitempty"`// ForceSendFields is a list of field names (e.g. "FromPath") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "FromPath") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

TransformationRuleAction: TransformationRuleAction defines aTransformationRule action based on the JSON Patch RFC(https://www.rfc-editor.org/rfc/rfc6902)

func (TransformationRuleAction)MarshalJSONadded inv0.129.0

func (sTransformationRuleAction) MarshalJSON() ([]byte,error)

typeTroubleshootingInfoadded inv0.245.0

type TroubleshootingInfo struct {// StateReasonCode: Output only. Unique code for each backup/restore operation// failure message which helps user identify the failure.StateReasonCodestring `json:"stateReasonCode,omitempty"`// StateReasonUri: Output only. URL for the troubleshooting doc which will help// the user fix the failing backup/restore operation.StateReasonUristring `json:"stateReasonUri,omitempty"`// ForceSendFields is a list of field names (e.g. "StateReasonCode") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "StateReasonCode") to include in// API requests with the JSON null value. By default, fields with empty values// are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

TroubleshootingInfo: Stores information about troubleshooting doc fordebugging a particular state of an operation (eg - backup/restore). Thiswill be used by the end user to debug their operation failure scenarioeasily.

func (TroubleshootingInfo)MarshalJSONadded inv0.245.0

func (sTroubleshootingInfo) MarshalJSON() ([]byte,error)

typeVolumeBackup

type VolumeBackup struct {// CompleteTime: Output only. The timestamp when the associated underlying// volume backup operation completed.CompleteTimestring `json:"completeTime,omitempty"`// CreateTime: Output only. The timestamp when this VolumeBackup resource was// created.CreateTimestring `json:"createTime,omitempty"`// DiskSizeBytes: Output only. The minimum size of the disk to which this// VolumeBackup can be restored.DiskSizeBytesint64 `json:"diskSizeBytes,omitempty,string"`// Etag: Output only. `etag` is used for optimistic concurrency control as a// way to help prevent simultaneous updates of a volume backup from overwriting// each other. It is strongly suggested that systems make use of the `etag` in// the read-modify-write cycle to perform volume backup updates in order to// avoid race conditions.Etagstring `json:"etag,omitempty"`// Format: Output only. The format used for the volume backup.//// Possible values://   "VOLUME_BACKUP_FORMAT_UNSPECIFIED" - Default value, not specified.//   "GCE_PERSISTENT_DISK" - Compute Engine Persistent Disk snapshot based// volume backup.Formatstring `json:"format,omitempty"`// Name: Output only. The full name of the VolumeBackup resource. Format:// `projects/*/locations/*/backupPlans/*/backups/*/volumeBackups/*`.Namestring `json:"name,omitempty"`// SatisfiesPzi: Output only. [Output Only] Reserved for future use.SatisfiesPzibool `json:"satisfiesPzi,omitempty"`// SatisfiesPzs: Output only. [Output Only] Reserved for future use.SatisfiesPzsbool `json:"satisfiesPzs,omitempty"`// SourcePvc: Output only. A reference to the source Kubernetes PVC from which// this VolumeBackup was created.SourcePvc *NamespacedName `json:"sourcePvc,omitempty"`// State: Output only. The current state of this VolumeBackup.//// Possible values://   "STATE_UNSPECIFIED" - This is an illegal state and should not be// encountered.//   "CREATING" - A volume for the backup was identified and backup process is// about to start.//   "SNAPSHOTTING" - The volume backup operation has begun and is in the// initial "snapshot" phase of the process. Any defined ProtectedApplication// "pre" hooks will be executed before entering this state and "post" hooks// will be executed upon leaving this state.//   "UPLOADING" - The snapshot phase of the volume backup operation has// completed and the snapshot is now being uploaded to backup storage.//   "SUCCEEDED" - The volume backup operation has completed successfully.//   "FAILED" - The volume backup operation has failed.//   "DELETING" - This VolumeBackup resource (and its associated artifacts) is// in the process of being deleted.//   "CLEANED_UP" - The underlying artifacts of a volume backup (eg: persistent// disk snapshots) are deleted.Statestring `json:"state,omitempty"`// StateMessage: Output only. A human readable message explaining why the// VolumeBackup is in its current state. This field is only meant for human// consumption and should not be used programmatically as this field is not// guaranteed to be consistent.StateMessagestring `json:"stateMessage,omitempty"`// StorageBytes: Output only. The aggregate size of the underlying artifacts// associated with this VolumeBackup in the backup storage. This may change// over time when multiple backups of the same volume share the same backup// storage location. In particular, this is likely to increase in size when the// immediately preceding backup of the same volume is deleted.StorageBytesint64 `json:"storageBytes,omitempty,string"`// Uid: Output only. Server generated global unique identifier of UUID// (https://en.wikipedia.org/wiki/Universally_unique_identifier) format.Uidstring `json:"uid,omitempty"`// UpdateTime: Output only. The timestamp when this VolumeBackup resource was// last updated.UpdateTimestring `json:"updateTime,omitempty"`// VolumeBackupHandle: Output only. A storage system-specific opaque handle to// the underlying volume backup.VolumeBackupHandlestring `json:"volumeBackupHandle,omitempty"`// ServerResponse contains the HTTP response code and headers from the server.googleapi.ServerResponse `json:"-"`// ForceSendFields is a list of field names (e.g. "CompleteTime") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "CompleteTime") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

VolumeBackup: Represents the backup of a specific persistent volume as acomponent of a Backup - both the record of the operation and a pointer tothe underlying storage-specific artifacts.

func (VolumeBackup)MarshalJSON

func (sVolumeBackup) MarshalJSON() ([]byte,error)

typeVolumeDataRestorePolicyBindingadded inv0.182.0

type VolumeDataRestorePolicyBinding struct {// Policy: Required. The VolumeDataRestorePolicy to apply when restoring// volumes in scope.//// Possible values://   "VOLUME_DATA_RESTORE_POLICY_UNSPECIFIED" - Unspecified (illegal).//   "RESTORE_VOLUME_DATA_FROM_BACKUP" - For each PVC to be restored, create a// new underlying volume and PV from the corresponding VolumeBackup contained// within the Backup.//   "REUSE_VOLUME_HANDLE_FROM_BACKUP" - For each PVC to be restored, attempt// to reuse the original PV contained in the Backup (with its original// underlying volume). This option is likely only usable when restoring a// workload to its original cluster.//   "NO_VOLUME_DATA_RESTORATION" - For each PVC to be restored, create PVC// without any particular action to restore data. In this case, the normal// Kubernetes provisioning logic would kick in, and this would likely result in// either dynamically provisioning blank PVs or binding to statically// provisioned PVs.Policystring `json:"policy,omitempty"`// VolumeType: The volume type, as determined by the PVC's bound PV, to apply// the policy to.//// Possible values://   "VOLUME_TYPE_UNSPECIFIED" - Default//   "GCE_PERSISTENT_DISK" - Compute Engine Persistent Disk volumeVolumeTypestring `json:"volumeType,omitempty"`// ForceSendFields is a list of field names (e.g. "Policy") to unconditionally// include in API requests. By default, fields with empty or default values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Policy") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

VolumeDataRestorePolicyBinding: Binds resources in the scope to the givenVolumeDataRestorePolicy.

func (VolumeDataRestorePolicyBinding)MarshalJSONadded inv0.182.0

func (sVolumeDataRestorePolicyBinding) MarshalJSON() ([]byte,error)

typeVolumeDataRestorePolicyOverrideadded inv0.182.0

type VolumeDataRestorePolicyOverride struct {// Policy: Required. The VolumeDataRestorePolicy to apply when restoring// volumes in scope.//// Possible values://   "VOLUME_DATA_RESTORE_POLICY_UNSPECIFIED" - Unspecified (illegal).//   "RESTORE_VOLUME_DATA_FROM_BACKUP" - For each PVC to be restored, create a// new underlying volume and PV from the corresponding VolumeBackup contained// within the Backup.//   "REUSE_VOLUME_HANDLE_FROM_BACKUP" - For each PVC to be restored, attempt// to reuse the original PV contained in the Backup (with its original// underlying volume). This option is likely only usable when restoring a// workload to its original cluster.//   "NO_VOLUME_DATA_RESTORATION" - For each PVC to be restored, create PVC// without any particular action to restore data. In this case, the normal// Kubernetes provisioning logic would kick in, and this would likely result in// either dynamically provisioning blank PVs or binding to statically// provisioned PVs.Policystring `json:"policy,omitempty"`// SelectedPvcs: A list of PVCs to apply the policy override to.SelectedPvcs *NamespacedNames `json:"selectedPvcs,omitempty"`// ForceSendFields is a list of field names (e.g. "Policy") to unconditionally// include in API requests. By default, fields with empty or default values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Policy") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

VolumeDataRestorePolicyOverride: Defines an override to apply aVolumeDataRestorePolicy for scoped resources.

func (VolumeDataRestorePolicyOverride)MarshalJSONadded inv0.182.0

func (sVolumeDataRestorePolicyOverride) MarshalJSON() ([]byte,error)

typeVolumeRestore

type VolumeRestore struct {// CompleteTime: Output only. The timestamp when the associated underlying// volume restoration completed.CompleteTimestring `json:"completeTime,omitempty"`// CreateTime: Output only. The timestamp when this VolumeRestore resource was// created.CreateTimestring `json:"createTime,omitempty"`// Etag: Output only. `etag` is used for optimistic concurrency control as a// way to help prevent simultaneous updates of a volume restore from// overwriting each other. It is strongly suggested that systems make use of// the `etag` in the read-modify-write cycle to perform volume restore updates// in order to avoid race conditions.Etagstring `json:"etag,omitempty"`// Name: Output only. Full name of the VolumeRestore resource. Format:// `projects/*/locations/*/restorePlans/*/restores/*/volumeRestores/*`Namestring `json:"name,omitempty"`// State: Output only. The current state of this VolumeRestore.//// Possible values://   "STATE_UNSPECIFIED" - This is an illegal state and should not be// encountered.//   "CREATING" - A volume for the restore was identified and restore process// is about to start.//   "RESTORING" - The volume is currently being restored.//   "SUCCEEDED" - The volume has been successfully restored.//   "FAILED" - The volume restoration process failed.//   "DELETING" - This VolumeRestore resource is in the process of being// deleted.Statestring `json:"state,omitempty"`// StateMessage: Output only. A human readable message explaining why the// VolumeRestore is in its current state.StateMessagestring `json:"stateMessage,omitempty"`// TargetPvc: Output only. The reference to the target Kubernetes PVC to be// restored.TargetPvc *NamespacedName `json:"targetPvc,omitempty"`// Uid: Output only. Server generated global unique identifier of UUID// (https://en.wikipedia.org/wiki/Universally_unique_identifier) format.Uidstring `json:"uid,omitempty"`// UpdateTime: Output only. The timestamp when this VolumeRestore resource was// last updated.UpdateTimestring `json:"updateTime,omitempty"`// VolumeBackup: Output only. The full name of the VolumeBackup from which the// volume will be restored. Format:// `projects/*/locations/*/backupPlans/*/backups/*/volumeBackups/*`.VolumeBackupstring `json:"volumeBackup,omitempty"`// VolumeHandle: Output only. A storage system-specific opaque handler to the// underlying volume created for the target PVC from the volume backup.VolumeHandlestring `json:"volumeHandle,omitempty"`// VolumeType: Output only. The type of volume provisioned//// Possible values://   "VOLUME_TYPE_UNSPECIFIED" - Default//   "GCE_PERSISTENT_DISK" - Compute Engine Persistent Disk volumeVolumeTypestring `json:"volumeType,omitempty"`// ServerResponse contains the HTTP response code and headers from the server.googleapi.ServerResponse `json:"-"`// ForceSendFields is a list of field names (e.g. "CompleteTime") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "CompleteTime") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

VolumeRestore: Represents the operation of restoring a volume from aVolumeBackup.

func (VolumeRestore)MarshalJSON

func (sVolumeRestore) MarshalJSON() ([]byte,error)

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f orF : Jump to
y orY : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic.Learn more.

[8]ページ先頭

©2009-2025 Movatter.jp