gkebackup

package
v0.114.0 Latest Latest
Warning

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

Go to latest
Published: Mar 17, 2023 License: BSD-3-Clause Imports: 16 Imported by: 0

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

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 for authentication.

For information on how to create and obtain Application Default Credentials, see https://developers.google.com/identity/protocols/application-default-credentials.

Other authentication options

To use an API key for authentication (note: some APIs do not support API keys), use 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 OAuth flow), use option.WithTokenSource:

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

See https://godoc.org/google.golang.org/api/option/ 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

type AuditConfig

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.
	Service string `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. However, any
	// non-pointer, non-interface field appearing in ForceSendFields will be
	// sent to the server regardless of whether the field is empty or not.
	// This may be used to include empty fields in Patch requests.
	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. However, any field
	// with an empty value appearing in NullFields will be sent to the
	// server as null. It is an error if a field in this list has a
	// non-empty value. This may be used to include null fields in Patch
	// requests.
	NullFields []string `json:"-"`
}

AuditConfig: Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple 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" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts `jose@example.com` from DATA_READ logging, and `aliya@example.com` from DATA_WRITE logging.

func (*AuditConfig) MarshalJSON

func (s *AuditConfig) MarshalJSON() ([]byte, error)

type AuditLogConfig

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 list
	LogType string `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. However, any
	// non-pointer, non-interface field appearing in ForceSendFields will be
	// sent to the server regardless of whether the field is empty or not.
	// This may be used to include empty fields in Patch requests.
	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. However, any field
	// with an empty value appearing in NullFields will be sent to the
	// server as null. It is an error if a field in this list has a
	// non-empty value. This may be used to include null fields in Patch
	// requests.
	NullFields []string `json:"-"`
}

AuditLogConfig: Provides the configuration for logging a type of permissions. 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, while exempting jose@example.com from DATA_READ logging.

func (*AuditLogConfig) MarshalJSON

func (s *AuditLogConfig) MarshalJSON() ([]byte, error)

type Backup

type Backup struct {
	// AllNamespaces: Output only. If True, all namespaces were included in
	// the Backup.
	AllNamespaces bool `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 Backup
	CompleteTime string `json:"completeTime,omitempty"`

	// ConfigBackupSizeBytes: Output only. The size of the config backup in
	// bytes.
	ConfigBackupSizeBytes int64 `json:"configBackupSizeBytes,omitempty,string"`

	// ContainsSecrets: Output only. Whether or not the Backup contains
	// Kubernetes Secrets. Controlled by the parent BackupPlan's
	// include_secrets value.
	ContainsSecrets bool `json:"containsSecrets,omitempty"`

	// ContainsVolumeData: Output only. Whether or not the Backup contains
	// volume data. Controlled by the parent BackupPlan's
	// include_volume_data value.
	ContainsVolumeData bool `json:"containsVolumeData,omitempty"`

	// CreateTime: Output only. The timestamp when this Backup resource was
	// created.
	CreateTime string `json:"createTime,omitempty"`

	// DeleteLockDays: 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).
	DeleteLockDays int64 `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).
	DeleteLockExpireTime string `json:"deleteLockExpireTime,omitempty"`

	// Description: User specified descriptive string for this Backup.
	Description string `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.
	Etag string `json:"etag,omitempty"`

	// Labels: 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.
	Manual bool `json:"manual,omitempty"`

	// Name: Output only. The fully qualified name of the Backup.
	// `projects/*/locations/*/backupPlans/*/backups/*`
	Name string `json:"name,omitempty"`

	// PodCount: Output only. The total number of Kubernetes Pods contained
	// in the Backup.
	PodCount int64 `json:"podCount,omitempty"`

	// ResourceCount: Output only. The total number of Kubernetes resources
	// included in the Backup.
	ResourceCount int64 `json:"resourceCount,omitempty"`

	// RetainDays: 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.
	RetainDays int64 `json:"retainDays,omitempty"`

	// RetainExpireTime: Output only. The time at which this Backup will be
	// automatically deleted (calculated from create_time + retain_days).
	RetainExpireTime string `json:"retainExpireTime,omitempty"`

	// SelectedApplications: Output only. If set, the list of
	// ProtectedApplications whose resources were included in the Backup.
	SelectedApplications *NamespacedNames `json:"selectedApplications,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)
	SizeBytes int64 `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.
	State string `json:"state,omitempty"`

	// StateReason: Output only. Human-readable description of why the
	// backup is in the current `state`.
	StateReason string `json:"stateReason,omitempty"`

	// Uid: Output only. Server generated global unique identifier of UUID4
	// (https://en.wikipedia.org/wiki/Universally_unique_identifier)
	Uid string `json:"uid,omitempty"`

	// UpdateTime: Output only. The timestamp when this Backup resource was
	// last updated.
	UpdateTime string `json:"updateTime,omitempty"`

	// VolumeCount: Output only. The total number of volume backups
	// contained in the Backup.
	VolumeCount int64 `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. However, any
	// non-pointer, non-interface field appearing in ForceSendFields will be
	// sent to the server regardless of whether the field is empty or not.
	// This may be used to include empty fields in Patch requests.
	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. However, any field with
	// an empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

Backup: Represents a request to perform a single point-in-time capture of some portion of the state of a GKE cluster, the record of the backup operation itself, and an anchor for the underlying artifacts that comprise the Backup (the config backup and VolumeBackups). Next id: 28

func (*Backup) MarshalJSON

func (s *Backup) MarshalJSON() ([]byte, error)

type BackupConfig

type BackupConfig struct {
	// AllNamespaces: If True, include all namespaced resources
	AllNamespaces bool `json:"allNamespaces,omitempty"`

	// EncryptionKey: 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: This flag specifies whether Kubernetes Secret
	// resources should be included when they fall into the scope of
	// Backups. Default: False
	IncludeSecrets bool `json:"includeSecrets,omitempty"`

	// IncludeVolumeData: This flag specifies whether volume data should be
	// backed up when PVCs are included in the scope of a Backup. Default:
	// False
	IncludeVolumeData bool `json:"includeVolumeData,omitempty"`

	// SelectedApplications: If set, include just the resources referenced
	// by the listed ProtectedApplications.
	SelectedApplications *NamespacedNames `json:"selectedApplications,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. However, any
	// non-pointer, non-interface field appearing in ForceSendFields will be
	// sent to the server regardless of whether the field is empty or not.
	// This may be used to include empty fields in Patch requests.
	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. However, any field with
	// an empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

BackupConfig: BackupConfig defines the configuration of Backups created via this BackupPlan.

func (*BackupConfig) MarshalJSON

func (s *BackupConfig) MarshalJSON() ([]byte, error)

type BackupPlan

type BackupPlan struct {
	// BackupConfig: Defines the configuration of Backups created via this
	// BackupPlan.
	BackupConfig *BackupConfig `json:"backupConfig,omitempty"`

	// BackupSchedule: 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/*`
	Cluster string `json:"cluster,omitempty"`

	// CreateTime: Output only. The timestamp when this BackupPlan resource
	// was created.
	CreateTime string `json:"createTime,omitempty"`

	// Deactivated: This flag indicates whether this BackupPlan has been
	// deactivated. Setting this field to True locks the BackupPlan such
	// that no further updates will be allowed (except deletes), including
	// the deactivated field itself. It also prevents any new Backups from
	// being created via this BackupPlan (including scheduled Backups).
	// Default: False
	Deactivated bool `json:"deactivated,omitempty"`

	// Description: User specified descriptive string for this BackupPlan.
	Description string `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.
	Etag string `json:"etag,omitempty"`

	// Labels: A set of custom labels supplied by user.
	Labels map[string]string `json:"labels,omitempty"`

	// Name: Output only. The full name of the BackupPlan resource. Format:
	// `projects/*/locations/*/backupPlans/*`
	Name string `json:"name,omitempty"`

	// ProtectedPodCount: Output only. The number of Kubernetes Pods backed
	// up in the last successful Backup created via this BackupPlan.
	ProtectedPodCount int64 `json:"protectedPodCount,omitempty"`

	// RetentionPolicy: RetentionPolicy governs lifecycle of Backups created
	// under this plan.
	RetentionPolicy *RetentionPolicy `json:"retentionPolicy,omitempty"`

	// Uid: Output only. Server generated global unique identifier of UUID
	// (https://en.wikipedia.org/wiki/Universally_unique_identifier) format.
	Uid string `json:"uid,omitempty"`

	// UpdateTime: Output only. The timestamp when this BackupPlan resource
	// was last updated.
	UpdateTime string `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. "BackupConfig") to
	// unconditionally include in API requests. By default, fields with
	// empty or default values are omitted from API requests. However, any
	// non-pointer, non-interface field appearing in ForceSendFields will be
	// sent to the server regardless of whether the field is empty or not.
	// This may be used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "BackupConfig") to include
	// in API requests with the JSON null value. By default, fields with
	// empty values are omitted from API requests. However, any field with
	// an empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

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

func (*BackupPlan) MarshalJSON

func (s *BackupPlan) MarshalJSON() ([]byte, error)

type Binding

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`. *
	// `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.
	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`.
	Role string `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. However, any
	// non-pointer, non-interface field appearing in ForceSendFields will be
	// sent to the server regardless of whether the field is empty or not.
	// This may be used to include empty fields in Patch requests.
	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. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

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

func (*Binding) MarshalJSON

func (s *Binding) MarshalJSON() ([]byte, error)

type ClusterMetadata

type ClusterMetadata struct {
	// AnthosVersion: Anthos version
	AnthosVersion string `json:"anthosVersion,omitempty"`

	// BackupCrdVersions: A list of the Backup for GKE CRD versions found in
	// the cluster.
	BackupCrdVersions map[string]string `json:"backupCrdVersions,omitempty"`

	// Cluster: 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.
	Cluster string `json:"cluster,omitempty"`

	// GkeVersion: GKE version
	GkeVersion string `json:"gkeVersion,omitempty"`

	// K8sVersion: The Kubernetes server version of the source cluster.
	K8sVersion string `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. However, any
	// non-pointer, non-interface field appearing in ForceSendFields will be
	// sent to the server regardless of whether the field is empty or not.
	// This may be used to include empty fields in Patch requests.
	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. However, any field with
	// an empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

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

func (*ClusterMetadata) MarshalJSON

func (s *ClusterMetadata) MarshalJSON() ([]byte, error)

type ClusterResourceRestoreScope

type ClusterResourceRestoreScope struct {
	// SelectedGroupKinds: 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. "SelectedGroupKinds")
	// to unconditionally include in API requests. By default, fields with
	// empty or default values are omitted from API requests. However, any
	// non-pointer, non-interface field appearing in ForceSendFields will be
	// sent to the server regardless of whether the field is empty or not.
	// This may be used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "SelectedGroupKinds") to
	// include in API requests with the JSON null value. By default, fields
	// with empty values are omitted from API requests. However, any field
	// with an empty value appearing in NullFields will be sent to the
	// server as null. It is an error if a field in this list has a
	// non-empty value. This may be used to include null fields in Patch
	// requests.
	NullFields []string `json:"-"`
}

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

func (*ClusterResourceRestoreScope) MarshalJSON

func (s *ClusterResourceRestoreScope) MarshalJSON() ([]byte, error)

type Empty

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 defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }

type EncryptionKey

type EncryptionKey struct {
	// GcpKmsEncryptionKey: Google Cloud KMS encryption key. Format:
	// `projects/*/locations/*/keyRings/*/cryptoKeys/*`
	GcpKmsEncryptionKey string `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. However, any
	// non-pointer, non-interface field appearing in ForceSendFields will be
	// sent to the server regardless of whether the field is empty or not.
	// This may be used to include empty fields in Patch requests.
	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. However, any field
	// with an empty value appearing in NullFields will be sent to the
	// server as null. It is an error if a field in this list has a
	// non-empty value. This may be used to include null fields in Patch
	// requests.
	NullFields []string `json:"-"`
}

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

func (*EncryptionKey) MarshalJSON

func (s *EncryptionKey) MarshalJSON() ([]byte, error)

type Expr

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.
	Description string `json:"description,omitempty"`

	// Expression: Textual representation of an expression in Common
	// Expression Language syntax.
	Expression string `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.
	Location string `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.
	Title string `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. However, any
	// non-pointer, non-interface field appearing in ForceSendFields will be
	// sent to the server regardless of whether the field is empty or not.
	// This may be used to include empty fields in Patch requests.
	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. However, any field with
	// an empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	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 semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor 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 message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information.

func (*Expr) MarshalJSON

func (s *Expr) MarshalJSON() ([]byte, error)

type GoogleLongrunningCancelOperationRequest

type GoogleLongrunningCancelOperationRequest struct {
}

GoogleLongrunningCancelOperationRequest: The request message for Operations.CancelOperation.

type GoogleLongrunningListOperationsResponse

type GoogleLongrunningListOperationsResponse struct {
	// NextPageToken: The standard List next-page token.
	NextPageToken string `json:"nextPageToken,omitempty"`

	// Operations: A list of operations that matches the specified filter in
	// the request.
	Operations []*GoogleLongrunningOperation `json:"operations,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. However, any
	// non-pointer, non-interface field appearing in ForceSendFields will be
	// sent to the server regardless of whether the field is empty or not.
	// This may be used to include empty fields in Patch requests.
	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. However, any field with
	// an empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

GoogleLongrunningListOperationsResponse: The response message for Operations.ListOperations.

func (*GoogleLongrunningListOperationsResponse) MarshalJSON

func (s *GoogleLongrunningListOperationsResponse) MarshalJSON() ([]byte, error)

type GoogleLongrunningOperation

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.
	Done bool `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.
	Metadata googleapi.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}`.
	Name string `json:"name,omitempty"`

	// Response: The normal response of the operation in case of success. 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`.
	Response googleapi.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. However, any
	// non-pointer, non-interface field appearing in ForceSendFields will be
	// sent to the server regardless of whether the field is empty or not.
	// This may be used to include empty fields in Patch requests.
	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. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

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

func (*GoogleLongrunningOperation) MarshalJSON

func (s *GoogleLongrunningOperation) MarshalJSON() ([]byte, error)

type GoogleRpcStatus

type GoogleRpcStatus struct {
	// Code: The status code, which should be an enum value of
	// google.rpc.Code.
	Code int64 `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.
	Message string `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. However, any
	// non-pointer, non-interface field appearing in ForceSendFields will be
	// sent to the server regardless of whether the field is empty or not.
	// This may be used to include empty fields in Patch requests.
	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. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

GoogleRpcStatus: The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by gRPC (https://github.com/grpc). Each `Status` message contains 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 the API Design Guide (https://cloud.google.com/apis/design/errors).

func (*GoogleRpcStatus) MarshalJSON

func (s *GoogleRpcStatus) MarshalJSON() ([]byte, error)

type GroupKind

type GroupKind struct {
	// ResourceGroup: API group string of a Kubernetes resource, e.g.
	// "apiextensions.k8s.io", "storage.k8s.io", etc. Note: use empty string
	// for core API group
	ResourceGroup string `json:"resourceGroup,omitempty"`

	// ResourceKind: Kind of a Kubernetes resource, e.g.
	// "CustomResourceDefinition", "StorageClass", etc.
	ResourceKind string `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. However, any
	// non-pointer, non-interface field appearing in ForceSendFields will be
	// sent to the server regardless of whether the field is empty or not.
	// This may be used to include empty fields in Patch requests.
	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. However, any field with
	// an empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	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 is used for identifying specific "types" of resources to restore.

func (*GroupKind) MarshalJSON

func (s *GroupKind) MarshalJSON() ([]byte, error)

type ListBackupPlansResponse

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.
	NextPageToken string `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. However, any
	// non-pointer, non-interface field appearing in ForceSendFields will be
	// sent to the server regardless of whether the field is empty or not.
	// This may be used to include empty fields in Patch requests.
	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. However, any field with
	// an empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

ListBackupPlansResponse: Response message for ListBackupPlans.

func (*ListBackupPlansResponse) MarshalJSON

func (s *ListBackupPlansResponse) MarshalJSON() ([]byte, error)

type ListBackupsResponse

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.
	NextPageToken string `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. "Backups") to
	// unconditionally include in API requests. By default, fields with
	// empty or default values are omitted from API requests. However, any
	// non-pointer, non-interface field appearing in ForceSendFields will be
	// sent to the server regardless of whether the field is empty or not.
	// This may be used to include empty fields in Patch requests.
	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. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

ListBackupsResponse: Response message for ListBackups.

func (*ListBackupsResponse) MarshalJSON

func (s *ListBackupsResponse) MarshalJSON() ([]byte, error)

type ListLocationsResponse

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.
	NextPageToken string `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. However, any
	// non-pointer, non-interface field appearing in ForceSendFields will be
	// sent to the server regardless of whether the field is empty or not.
	// This may be used to include empty fields in Patch requests.
	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. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

ListLocationsResponse: The response message for Locations.ListLocations.

func (*ListLocationsResponse) MarshalJSON

func (s *ListLocationsResponse) MarshalJSON() ([]byte, error)

type ListRestorePlansResponse

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.
	NextPageToken string `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. However, any
	// non-pointer, non-interface field appearing in ForceSendFields will be
	// sent to the server regardless of whether the field is empty or not.
	// This may be used to include empty fields in Patch requests.
	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. However, any field with
	// an empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

ListRestorePlansResponse: Response message for ListRestorePlans.

func (*ListRestorePlansResponse) MarshalJSON

func (s *ListRestorePlansResponse) MarshalJSON() ([]byte, error)

type ListRestoresResponse

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.
	NextPageToken string `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. However, any
	// non-pointer, non-interface field appearing in ForceSendFields will be
	// sent to the server regardless of whether the field is empty or not.
	// This may be used to include empty fields in Patch requests.
	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. However, any field with
	// an empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

ListRestoresResponse: Response message for ListRestores.

func (*ListRestoresResponse) MarshalJSON

func (s *ListRestoresResponse) MarshalJSON() ([]byte, error)

type ListVolumeBackupsResponse

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.
	NextPageToken string `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. However, any
	// non-pointer, non-interface field appearing in ForceSendFields will be
	// sent to the server regardless of whether the field is empty or not.
	// This may be used to include empty fields in Patch requests.
	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. However, any field with
	// an empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

ListVolumeBackupsResponse: Response message for ListVolumeBackups.

func (*ListVolumeBackupsResponse) MarshalJSON

func (s *ListVolumeBackupsResponse) MarshalJSON() ([]byte, error)

type ListVolumeRestoresResponse

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.
	NextPageToken string `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. However, any
	// non-pointer, non-interface field appearing in ForceSendFields will be
	// sent to the server regardless of whether the field is empty or not.
	// This may be used to include empty fields in Patch requests.
	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. However, any field with
	// an empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

ListVolumeRestoresResponse: Response message for ListVolumeRestores.

func (*ListVolumeRestoresResponse) MarshalJSON

func (s *ListVolumeRestoresResponse) MarshalJSON() ([]byte, error)

type Location

type Location struct {
	// DisplayName: The friendly name for this location, typically a nearby
	// city name. For example, "Tokyo".
	DisplayName string `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".
	LocationId string `json:"locationId,omitempty"`

	// Metadata: Service-specific metadata. For example the available
	// capacity at the given location.
	Metadata googleapi.RawMessage `json:"metadata,omitempty"`

	// Name: Resource name for the location, which may vary between
	// implementations. For example:
	// "projects/example-project/locations/us-east1"
	Name string `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. However, any
	// non-pointer, non-interface field appearing in ForceSendFields will be
	// sent to the server regardless of whether the field is empty or not.
	// This may be used to include empty fields in Patch requests.
	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. However, any field with
	// an empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

Location: A resource that represents Google Cloud Platform location.

func (*Location) MarshalJSON

func (s *Location) MarshalJSON() ([]byte, error)

type NamespacedName

type NamespacedName struct {
	// Name: The name of the Kubernetes resource.
	Name string `json:"name,omitempty"`

	// Namespace: The Namespace of the Kubernetes resource.
	Namespace string `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. However, any
	// non-pointer, non-interface field appearing in ForceSendFields will be
	// sent to the server regardless of whether the field is empty or not.
	// This may be used to include empty fields in Patch requests.
	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. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

NamespacedName: A reference to a namespaced resource in Kubernetes.

func (*NamespacedName) MarshalJSON

func (s *NamespacedName) MarshalJSON() ([]byte, error)

type NamespacedNames

type NamespacedNames struct {
	// NamespacedNames: 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. However, any
	// non-pointer, non-interface field appearing in ForceSendFields will be
	// sent to the server regardless of whether the field is empty or not.
	// This may be used to include empty fields in Patch requests.
	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. However, any field
	// with an empty value appearing in NullFields will be sent to the
	// server as null. It is an error if a field in this list has a
	// non-empty value. This may be used to include null fields in Patch
	// requests.
	NullFields []string `json:"-"`
}

NamespacedNames: A list of namespaced Kubernetes resources.

func (*NamespacedNames) MarshalJSON

func (s *NamespacedNames) MarshalJSON() ([]byte, error)

type Namespaces

type Namespaces struct {
	// Namespaces: 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. However, any
	// non-pointer, non-interface field appearing in ForceSendFields will be
	// sent to the server regardless of whether the field is empty or not.
	// This may be used to include empty fields in Patch requests.
	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. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

Namespaces: A list of Kubernetes Namespaces

func (*Namespaces) MarshalJSON

func (s *Namespaces) MarshalJSON() ([]byte, error)

type OperationMetadata

type OperationMetadata struct {
	// ApiVersion: Output only. API version used to start the operation.
	ApiVersion string `json:"apiVersion,omitempty"`

	// CreateTime: Output only. The time the operation was created.
	CreateTime string `json:"createTime,omitempty"`

	// EndTime: Output only. The time the operation finished running.
	EndTime string `json:"endTime,omitempty"`

	// RequestedCancellation: Output only. Identifies whether the user has
	// requested cancellation of the operation. Operations that have
	// successfully been cancelled have Operation.error value with a
	// google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`.
	RequestedCancellation bool `json:"requestedCancellation,omitempty"`

	// StatusMessage: Output only. Human-readable status of the operation,
	// if any.
	StatusMessage string `json:"statusMessage,omitempty"`

	// Target: Output only. Server-defined resource path for the target of
	// the operation.
	Target string `json:"target,omitempty"`

	// Verb: Output only. Name of the verb executed by the operation.
	Verb string `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. However, any
	// non-pointer, non-interface field appearing in ForceSendFields will be
	// sent to the server regardless of whether the field is empty or not.
	// This may be used to include empty fields in Patch requests.
	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. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

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

func (*OperationMetadata) MarshalJSON

func (s *OperationMetadata) MarshalJSON() ([]byte, error)

type Policy

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.
	Etag string `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).
	Version int64 `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. However, any
	// non-pointer, non-interface field appearing in ForceSendFields will be
	// sent to the server regardless of whether the field is empty or not.
	// This may be used to include empty fields in Patch requests.
	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. However, any field with
	// an empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

Policy: An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the IAM documentation (https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** { "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.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer 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 For a description of IAM and its features, see the IAM documentation (https://cloud.google.com/iam/docs/).

func (*Policy) MarshalJSON

func (s *Policy) MarshalJSON() ([]byte, error)

type ProjectsLocationsBackupPlansBackupsCreateCall

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

func (*ProjectsLocationsBackupPlansBackupsCreateCall) BackupId

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

func (*ProjectsLocationsBackupPlansBackupsCreateCall) Context

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsLocationsBackupPlansBackupsCreateCall) Do

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

func (*ProjectsLocationsBackupPlansBackupsCreateCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*ProjectsLocationsBackupPlansBackupsCreateCall) Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

type ProjectsLocationsBackupPlansBackupsDeleteCall

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

func (*ProjectsLocationsBackupPlansBackupsDeleteCall) Context

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsLocationsBackupPlansBackupsDeleteCall) Do

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

func (*ProjectsLocationsBackupPlansBackupsDeleteCall) Etag

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

func (*ProjectsLocationsBackupPlansBackupsDeleteCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*ProjectsLocationsBackupPlansBackupsDeleteCall) Force

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

func (*ProjectsLocationsBackupPlansBackupsDeleteCall) Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

type ProjectsLocationsBackupPlansBackupsGetCall

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

func (*ProjectsLocationsBackupPlansBackupsGetCall) Context

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsLocationsBackupPlansBackupsGetCall) Do

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

func (*ProjectsLocationsBackupPlansBackupsGetCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*ProjectsLocationsBackupPlansBackupsGetCall) Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

func (*ProjectsLocationsBackupPlansBackupsGetCall) IfNoneMatch

IfNoneMatch sets the optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.

type ProjectsLocationsBackupPlansBackupsGetIamPolicyCall

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

func (*ProjectsLocationsBackupPlansBackupsGetIamPolicyCall) Context

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsLocationsBackupPlansBackupsGetIamPolicyCall) Do

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

func (*ProjectsLocationsBackupPlansBackupsGetIamPolicyCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*ProjectsLocationsBackupPlansBackupsGetIamPolicyCall) Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

func (*ProjectsLocationsBackupPlansBackupsGetIamPolicyCall) IfNoneMatch

IfNoneMatch sets the optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.

func (*ProjectsLocationsBackupPlansBackupsGetIamPolicyCall) OptionsRequestedPolicyVersion

func (c *ProjectsLocationsBackupPlansBackupsGetIamPolicyCall) OptionsRequestedPolicyVersion(optionsRequestedPolicyVersion int64) *ProjectsLocationsBackupPlansBackupsGetIamPolicyCall

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

type ProjectsLocationsBackupPlansBackupsListCall

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

func (*ProjectsLocationsBackupPlansBackupsListCall) Context

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsLocationsBackupPlansBackupsListCall) Do

Do executes the "gkebackup.projects.locations.backupPlans.backups.list" call. Exactly one of *ListBackupsResponse or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *ListBackupsResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsBackupPlansBackupsListCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*ProjectsLocationsBackupPlansBackupsListCall) Filter

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

func (*ProjectsLocationsBackupPlansBackupsListCall) Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

func (*ProjectsLocationsBackupPlansBackupsListCall) IfNoneMatch

IfNoneMatch sets the optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.

func (*ProjectsLocationsBackupPlansBackupsListCall) OrderBy

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

func (*ProjectsLocationsBackupPlansBackupsListCall) PageSize

PageSize sets the optional parameter "pageSize": The target number of results to return in a single response. If not specified, a default value will be chosen by the service. Note that the response may inclue a partial list and a caller should only rely on the response's next_page_token to determine if there are more instances left to be queried.

func (*ProjectsLocationsBackupPlansBackupsListCall) PageToken

PageToken sets the optional parameter "pageToken": The value of next_page_token received from a previous `ListBackups` call. Provide this to retrieve the subsequent page in a multi-page list of results. When paginating, all other parameters provided to `ListBackups` must match the call 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.

type ProjectsLocationsBackupPlansBackupsPatchCall

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

func (*ProjectsLocationsBackupPlansBackupsPatchCall) Context

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsLocationsBackupPlansBackupsPatchCall) Do

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

func (*ProjectsLocationsBackupPlansBackupsPatchCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*ProjectsLocationsBackupPlansBackupsPatchCall) Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

func (*ProjectsLocationsBackupPlansBackupsPatchCall) UpdateMask

UpdateMask sets the optional parameter "updateMask": This is used to specify the fields to be overwritten in the Backup targeted for update. The values 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 the resource. If no `update_mask` is provided, all fields in `backup` will be written to the target Backup resource. Note that OUTPUT_ONLY and IMMUTABLE fields in `backup` are ignored and are not used to update the target Backup.

type ProjectsLocationsBackupPlansBackupsService

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

func NewProjectsLocationsBackupPlansBackupsService

func NewProjectsLocationsBackupPlansBackupsService(s *Service) *ProjectsLocationsBackupPlansBackupsService

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) GetIamPolicy

GetIamPolicy: Gets the access control policy for a resource. Returns an empty 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. 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 specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.

type ProjectsLocationsBackupPlansBackupsSetIamPolicyCall

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

func (*ProjectsLocationsBackupPlansBackupsSetIamPolicyCall) Context

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsLocationsBackupPlansBackupsSetIamPolicyCall) Do

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

func (*ProjectsLocationsBackupPlansBackupsSetIamPolicyCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*ProjectsLocationsBackupPlansBackupsSetIamPolicyCall) Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

type ProjectsLocationsBackupPlansBackupsTestIamPermissionsCall

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

func (*ProjectsLocationsBackupPlansBackupsTestIamPermissionsCall) Context

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsLocationsBackupPlansBackupsTestIamPermissionsCall) Do

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

func (*ProjectsLocationsBackupPlansBackupsTestIamPermissionsCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*ProjectsLocationsBackupPlansBackupsTestIamPermissionsCall) Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

type ProjectsLocationsBackupPlansBackupsVolumeBackupsGetCall

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

func (*ProjectsLocationsBackupPlansBackupsVolumeBackupsGetCall) Context

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsLocationsBackupPlansBackupsVolumeBackupsGetCall) Do

Do executes the "gkebackup.projects.locations.backupPlans.backups.volumeBackups.get" call. Exactly one of *VolumeBackup or error will be non-nil. 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 check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsBackupPlansBackupsVolumeBackupsGetCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*ProjectsLocationsBackupPlansBackupsVolumeBackupsGetCall) Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

func (*ProjectsLocationsBackupPlansBackupsVolumeBackupsGetCall) IfNoneMatch

IfNoneMatch sets the optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.

type ProjectsLocationsBackupPlansBackupsVolumeBackupsGetIamPolicyCall

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

func (*ProjectsLocationsBackupPlansBackupsVolumeBackupsGetIamPolicyCall) Context

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsLocationsBackupPlansBackupsVolumeBackupsGetIamPolicyCall) Do

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

func (*ProjectsLocationsBackupPlansBackupsVolumeBackupsGetIamPolicyCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*ProjectsLocationsBackupPlansBackupsVolumeBackupsGetIamPolicyCall) Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

func (*ProjectsLocationsBackupPlansBackupsVolumeBackupsGetIamPolicyCall) IfNoneMatch

IfNoneMatch sets the optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.

func (*ProjectsLocationsBackupPlansBackupsVolumeBackupsGetIamPolicyCall) OptionsRequestedPolicyVersion

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

type ProjectsLocationsBackupPlansBackupsVolumeBackupsListCall

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

func (*ProjectsLocationsBackupPlansBackupsVolumeBackupsListCall) Context

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsLocationsBackupPlansBackupsVolumeBackupsListCall) Do

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

func (*ProjectsLocationsBackupPlansBackupsVolumeBackupsListCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*ProjectsLocationsBackupPlansBackupsVolumeBackupsListCall) Filter

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

func (*ProjectsLocationsBackupPlansBackupsVolumeBackupsListCall) Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

func (*ProjectsLocationsBackupPlansBackupsVolumeBackupsListCall) IfNoneMatch

IfNoneMatch sets the optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.

func (*ProjectsLocationsBackupPlansBackupsVolumeBackupsListCall) OrderBy

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

func (*ProjectsLocationsBackupPlansBackupsVolumeBackupsListCall) PageSize

PageSize sets the optional parameter "pageSize": The target number of results to return in a single response. If not specified, a default value will be chosen by the service. Note that the response may inclue a partial list and a caller should only rely on the response's next_page_token to determine if there are more instances left to be queried.

func (*ProjectsLocationsBackupPlansBackupsVolumeBackupsListCall) PageToken

PageToken sets the optional parameter "pageToken": The value of next_page_token received from a previous `ListVolumeBackups` call. Provide this to retrieve the subsequent page in a multi-page list of results. When paginating, all other parameters provided to `ListVolumeBackups` must match the 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.

type ProjectsLocationsBackupPlansBackupsVolumeBackupsService

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 an empty 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 specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.

type ProjectsLocationsBackupPlansBackupsVolumeBackupsSetIamPolicyCall

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

func (*ProjectsLocationsBackupPlansBackupsVolumeBackupsSetIamPolicyCall) Context

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsLocationsBackupPlansBackupsVolumeBackupsSetIamPolicyCall) Do

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

func (*ProjectsLocationsBackupPlansBackupsVolumeBackupsSetIamPolicyCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*ProjectsLocationsBackupPlansBackupsVolumeBackupsSetIamPolicyCall) Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

type ProjectsLocationsBackupPlansBackupsVolumeBackupsTestIamPermissionsCall

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

func (*ProjectsLocationsBackupPlansBackupsVolumeBackupsTestIamPermissionsCall) Context

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsLocationsBackupPlansBackupsVolumeBackupsTestIamPermissionsCall) Do

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

func (*ProjectsLocationsBackupPlansBackupsVolumeBackupsTestIamPermissionsCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*ProjectsLocationsBackupPlansBackupsVolumeBackupsTestIamPermissionsCall) Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

type ProjectsLocationsBackupPlansCreateCall

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

func (*ProjectsLocationsBackupPlansCreateCall) BackupPlanId

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

func (*ProjectsLocationsBackupPlansCreateCall) Context

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsLocationsBackupPlansCreateCall) Do

Do executes the "gkebackup.projects.locations.backupPlans.create" call. Exactly one of *GoogleLongrunningOperation or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *GoogleLongrunningOperation.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsBackupPlansCreateCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*ProjectsLocationsBackupPlansCreateCall) Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

type ProjectsLocationsBackupPlansDeleteCall

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

func (*ProjectsLocationsBackupPlansDeleteCall) Context

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsLocationsBackupPlansDeleteCall) Do

Do executes the "gkebackup.projects.locations.backupPlans.delete" call. Exactly one of *GoogleLongrunningOperation or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *GoogleLongrunningOperation.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsBackupPlansDeleteCall) Etag

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

func (*ProjectsLocationsBackupPlansDeleteCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*ProjectsLocationsBackupPlansDeleteCall) Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

type ProjectsLocationsBackupPlansGetCall

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

func (*ProjectsLocationsBackupPlansGetCall) Context

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsLocationsBackupPlansGetCall) Do

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

func (*ProjectsLocationsBackupPlansGetCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*ProjectsLocationsBackupPlansGetCall) Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

func (*ProjectsLocationsBackupPlansGetCall) IfNoneMatch

IfNoneMatch sets the optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.

type ProjectsLocationsBackupPlansGetIamPolicyCall

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

func (*ProjectsLocationsBackupPlansGetIamPolicyCall) Context

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsLocationsBackupPlansGetIamPolicyCall) Do

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

func (*ProjectsLocationsBackupPlansGetIamPolicyCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*ProjectsLocationsBackupPlansGetIamPolicyCall) Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

func (*ProjectsLocationsBackupPlansGetIamPolicyCall) IfNoneMatch

IfNoneMatch sets the optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.

func (*ProjectsLocationsBackupPlansGetIamPolicyCall) OptionsRequestedPolicyVersion

func (c *ProjectsLocationsBackupPlansGetIamPolicyCall) OptionsRequestedPolicyVersion(optionsRequestedPolicyVersion int64) *ProjectsLocationsBackupPlansGetIamPolicyCall

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

type ProjectsLocationsBackupPlansListCall

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

func (*ProjectsLocationsBackupPlansListCall) Context

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsLocationsBackupPlansListCall) Do

Do executes the "gkebackup.projects.locations.backupPlans.list" call. Exactly one of *ListBackupPlansResponse or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *ListBackupPlansResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsBackupPlansListCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*ProjectsLocationsBackupPlansListCall) Filter

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

func (*ProjectsLocationsBackupPlansListCall) Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

func (*ProjectsLocationsBackupPlansListCall) IfNoneMatch

IfNoneMatch sets the optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.

func (*ProjectsLocationsBackupPlansListCall) OrderBy

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

func (*ProjectsLocationsBackupPlansListCall) PageSize

PageSize sets the optional parameter "pageSize": The target number of results to return in a single response. If not specified, a default value will be chosen by the service. Note that the response may inclue a partial list and a caller should only rely on the response's next_page_token to determine if there are more instances left to be queried.

func (*ProjectsLocationsBackupPlansListCall) PageToken

PageToken sets the optional parameter "pageToken": The value of next_page_token received from a previous `ListBackupPlans` call. Provide this to retrieve the subsequent page in a multi-page list of results. When paginating, all other parameters provided to `ListBackupPlans` must match the 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.

type ProjectsLocationsBackupPlansPatchCall

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

func (*ProjectsLocationsBackupPlansPatchCall) Context

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsLocationsBackupPlansPatchCall) Do

Do executes the "gkebackup.projects.locations.backupPlans.patch" call. Exactly one of *GoogleLongrunningOperation or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *GoogleLongrunningOperation.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsBackupPlansPatchCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*ProjectsLocationsBackupPlansPatchCall) Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

func (*ProjectsLocationsBackupPlansPatchCall) UpdateMask

UpdateMask sets the optional parameter "updateMask": This is used to specify the fields to be overwritten in the BackupPlan targeted for update. The values 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 the resource (e.g., `description`, `backup_config.include_volume_data`, etc.) If no `update_mask` is provided, all fields in `backup_plan` will be written to the target BackupPlan resource. Note that OUTPUT_ONLY and IMMUTABLE fields in `backup_plan` are ignored and are not used to update the target BackupPlan.

type ProjectsLocationsBackupPlansService

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

func NewProjectsLocationsBackupPlansService

func NewProjectsLocationsBackupPlansService(s *Service) *ProjectsLocationsBackupPlansService

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 an empty policy if the resource exists and does not have a policy set.

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. 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) TestIamPermissions

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

type ProjectsLocationsBackupPlansSetIamPolicyCall

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

func (*ProjectsLocationsBackupPlansSetIamPolicyCall) Context

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsLocationsBackupPlansSetIamPolicyCall) Do

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

func (*ProjectsLocationsBackupPlansSetIamPolicyCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*ProjectsLocationsBackupPlansSetIamPolicyCall) Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

type ProjectsLocationsBackupPlansTestIamPermissionsCall

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

func (*ProjectsLocationsBackupPlansTestIamPermissionsCall) Context

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsLocationsBackupPlansTestIamPermissionsCall) Do

Do executes the "gkebackup.projects.locations.backupPlans.testIamPermissions" call. Exactly one of *TestIamPermissionsResponse or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *TestIamPermissionsResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsBackupPlansTestIamPermissionsCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*ProjectsLocationsBackupPlansTestIamPermissionsCall) Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

type ProjectsLocationsDeleteOperationsCall

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

func (*ProjectsLocationsDeleteOperationsCall) Context

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsLocationsDeleteOperationsCall) Do

Do executes the "gkebackup.projects.locations.deleteOperations" call. Exactly one of *Empty or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *Empty.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsDeleteOperationsCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*ProjectsLocationsDeleteOperationsCall) Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

type ProjectsLocationsGetCall

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

func (*ProjectsLocationsGetCall) Context

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsLocationsGetCall) Do

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

func (*ProjectsLocationsGetCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*ProjectsLocationsGetCall) Header

func (c *ProjectsLocationsGetCall) Header() http.Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

func (*ProjectsLocationsGetCall) IfNoneMatch

func (c *ProjectsLocationsGetCall) IfNoneMatch(entityTag string) *ProjectsLocationsGetCall

IfNoneMatch sets the optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.

type ProjectsLocationsListCall

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

func (*ProjectsLocationsListCall) Context

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsLocationsListCall) Do

Do executes the "gkebackup.projects.locations.list" call. Exactly one of *ListLocationsResponse or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *ListLocationsResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsListCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*ProjectsLocationsListCall) Filter

Filter sets the optional parameter "filter": A filter to narrow down results to 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 an http.Header that can be modified by the caller to add HTTP headers to the request.

func (*ProjectsLocationsListCall) IfNoneMatch

func (c *ProjectsLocationsListCall) IfNoneMatch(entityTag string) *ProjectsLocationsListCall

IfNoneMatch sets the optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.

func (*ProjectsLocationsListCall) PageSize

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

func (*ProjectsLocationsListCall) PageToken

PageToken sets the optional parameter "pageToken": A page token received from the `next_page_token` field in the response. Send that page token to receive 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.

type ProjectsLocationsOperationsCancelCall

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

func (*ProjectsLocationsOperationsCancelCall) Context

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsLocationsOperationsCancelCall) Do

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

func (*ProjectsLocationsOperationsCancelCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*ProjectsLocationsOperationsCancelCall) Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

type ProjectsLocationsOperationsGetCall

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

func (*ProjectsLocationsOperationsGetCall) Context

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsLocationsOperationsGetCall) Do

Do executes the "gkebackup.projects.locations.operations.get" call. Exactly one of *GoogleLongrunningOperation or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *GoogleLongrunningOperation.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsOperationsGetCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*ProjectsLocationsOperationsGetCall) Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

func (*ProjectsLocationsOperationsGetCall) IfNoneMatch

IfNoneMatch sets the optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.

type ProjectsLocationsOperationsListCall

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

func (*ProjectsLocationsOperationsListCall) Context

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsLocationsOperationsListCall) Do

Do executes the "gkebackup.projects.locations.operations.list" call. Exactly one of *GoogleLongrunningListOperationsResponse or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *GoogleLongrunningListOperationsResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsOperationsListCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*ProjectsLocationsOperationsListCall) Filter

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

func (*ProjectsLocationsOperationsListCall) Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

func (*ProjectsLocationsOperationsListCall) IfNoneMatch

IfNoneMatch sets the optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.

func (*ProjectsLocationsOperationsListCall) PageSize

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

func (*ProjectsLocationsOperationsListCall) PageToken

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

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.

type ProjectsLocationsOperationsService

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

func NewProjectsLocationsOperationsService

func NewProjectsLocationsOperationsService(s *Service) *ProjectsLocationsOperationsService

func (*ProjectsLocationsOperationsService) Cancel

Cancel: Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.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) Get

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

- name: The name of the operation resource.

func (*ProjectsLocationsOperationsService) List

List: Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. NOTE: the `name` binding allows API services to override the binding to use different resource name schemes, such as `users/*/operations`. To override the binding, API services can add a binding such as "/v1/{name=users/*}/operations" to their service configuration. For backwards compatibility, the default name includes the operations collection id, however overriding users must ensure the name binding is the parent resource, without the operations collection id.

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

type ProjectsLocationsRestorePlansCreateCall

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

func (*ProjectsLocationsRestorePlansCreateCall) Context

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsLocationsRestorePlansCreateCall) Do

Do executes the "gkebackup.projects.locations.restorePlans.create" call. Exactly one of *GoogleLongrunningOperation or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *GoogleLongrunningOperation.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsRestorePlansCreateCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*ProjectsLocationsRestorePlansCreateCall) Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

func (*ProjectsLocationsRestorePlansCreateCall) RestorePlanId

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

type ProjectsLocationsRestorePlansDeleteCall

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

func (*ProjectsLocationsRestorePlansDeleteCall) Context

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsLocationsRestorePlansDeleteCall) Do

Do executes the "gkebackup.projects.locations.restorePlans.delete" call. Exactly one of *GoogleLongrunningOperation or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *GoogleLongrunningOperation.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsRestorePlansDeleteCall) Etag

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

func (*ProjectsLocationsRestorePlansDeleteCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*ProjectsLocationsRestorePlansDeleteCall) Force

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

func (*ProjectsLocationsRestorePlansDeleteCall) Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

type ProjectsLocationsRestorePlansGetCall

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

func (*ProjectsLocationsRestorePlansGetCall) Context

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsLocationsRestorePlansGetCall) Do

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

func (*ProjectsLocationsRestorePlansGetCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*ProjectsLocationsRestorePlansGetCall) Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

func (*ProjectsLocationsRestorePlansGetCall) IfNoneMatch

IfNoneMatch sets the optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.

type ProjectsLocationsRestorePlansGetIamPolicyCall

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

func (*ProjectsLocationsRestorePlansGetIamPolicyCall) Context

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsLocationsRestorePlansGetIamPolicyCall) Do

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

func (*ProjectsLocationsRestorePlansGetIamPolicyCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*ProjectsLocationsRestorePlansGetIamPolicyCall) Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

func (*ProjectsLocationsRestorePlansGetIamPolicyCall) IfNoneMatch

IfNoneMatch sets the optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.

func (*ProjectsLocationsRestorePlansGetIamPolicyCall) OptionsRequestedPolicyVersion

func (c *ProjectsLocationsRestorePlansGetIamPolicyCall) OptionsRequestedPolicyVersion(optionsRequestedPolicyVersion int64) *ProjectsLocationsRestorePlansGetIamPolicyCall

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

type ProjectsLocationsRestorePlansListCall

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

func (*ProjectsLocationsRestorePlansListCall) Context

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsLocationsRestorePlansListCall) Do

Do executes the "gkebackup.projects.locations.restorePlans.list" call. Exactly one of *ListRestorePlansResponse or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *ListRestorePlansResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsRestorePlansListCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*ProjectsLocationsRestorePlansListCall) Filter

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

func (*ProjectsLocationsRestorePlansListCall) Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

func (*ProjectsLocationsRestorePlansListCall) IfNoneMatch

IfNoneMatch sets the optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.

func (*ProjectsLocationsRestorePlansListCall) OrderBy

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

func (*ProjectsLocationsRestorePlansListCall) PageSize

PageSize sets the optional parameter "pageSize": The target number of results to return in a single response. If not specified, a default value will be chosen by the service. Note that the response may inclue a partial list and a caller should only rely on the response's next_page_token to determine if there are more instances left to be queried.

func (*ProjectsLocationsRestorePlansListCall) PageToken

PageToken sets the optional parameter "pageToken": The value of next_page_token received from a previous `ListRestorePlans` call. Provide this to retrieve the subsequent page in a multi-page list of results. When paginating, all other parameters provided to `ListRestorePlans` must match the 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.

type ProjectsLocationsRestorePlansPatchCall

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

func (*ProjectsLocationsRestorePlansPatchCall) Context

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsLocationsRestorePlansPatchCall) Do

Do executes the "gkebackup.projects.locations.restorePlans.patch" call. Exactly one of *GoogleLongrunningOperation or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *GoogleLongrunningOperation.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsRestorePlansPatchCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*ProjectsLocationsRestorePlansPatchCall) Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

func (*ProjectsLocationsRestorePlansPatchCall) UpdateMask

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

type ProjectsLocationsRestorePlansRestoresCreateCall

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

func (*ProjectsLocationsRestorePlansRestoresCreateCall) Context

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsLocationsRestorePlansRestoresCreateCall) Do

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

func (*ProjectsLocationsRestorePlansRestoresCreateCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*ProjectsLocationsRestorePlansRestoresCreateCall) Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

func (*ProjectsLocationsRestorePlansRestoresCreateCall) RestoreId

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

type ProjectsLocationsRestorePlansRestoresDeleteCall

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

func (*ProjectsLocationsRestorePlansRestoresDeleteCall) Context

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsLocationsRestorePlansRestoresDeleteCall) Do

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

func (*ProjectsLocationsRestorePlansRestoresDeleteCall) Etag

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

func (*ProjectsLocationsRestorePlansRestoresDeleteCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*ProjectsLocationsRestorePlansRestoresDeleteCall) Force

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

func (*ProjectsLocationsRestorePlansRestoresDeleteCall) Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

type ProjectsLocationsRestorePlansRestoresGetCall

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

func (*ProjectsLocationsRestorePlansRestoresGetCall) Context

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsLocationsRestorePlansRestoresGetCall) Do

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

func (*ProjectsLocationsRestorePlansRestoresGetCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*ProjectsLocationsRestorePlansRestoresGetCall) Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

func (*ProjectsLocationsRestorePlansRestoresGetCall) IfNoneMatch

IfNoneMatch sets the optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.

type ProjectsLocationsRestorePlansRestoresGetIamPolicyCall

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

func (*ProjectsLocationsRestorePlansRestoresGetIamPolicyCall) Context

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsLocationsRestorePlansRestoresGetIamPolicyCall) Do

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

func (*ProjectsLocationsRestorePlansRestoresGetIamPolicyCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*ProjectsLocationsRestorePlansRestoresGetIamPolicyCall) Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

func (*ProjectsLocationsRestorePlansRestoresGetIamPolicyCall) IfNoneMatch

IfNoneMatch sets the optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.

func (*ProjectsLocationsRestorePlansRestoresGetIamPolicyCall) OptionsRequestedPolicyVersion

func (c *ProjectsLocationsRestorePlansRestoresGetIamPolicyCall) OptionsRequestedPolicyVersion(optionsRequestedPolicyVersion int64) *ProjectsLocationsRestorePlansRestoresGetIamPolicyCall

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

type ProjectsLocationsRestorePlansRestoresListCall

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

func (*ProjectsLocationsRestorePlansRestoresListCall) Context

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsLocationsRestorePlansRestoresListCall) Do

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

func (*ProjectsLocationsRestorePlansRestoresListCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*ProjectsLocationsRestorePlansRestoresListCall) Filter

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

func (*ProjectsLocationsRestorePlansRestoresListCall) Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

func (*ProjectsLocationsRestorePlansRestoresListCall) IfNoneMatch

IfNoneMatch sets the optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.

func (*ProjectsLocationsRestorePlansRestoresListCall) OrderBy

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

func (*ProjectsLocationsRestorePlansRestoresListCall) PageSize

PageSize sets the optional parameter "pageSize": The target number of results to return in a single response. If not specified, a default value will be chosen by the service. Note that the response may inclue a partial list and a caller should only rely on the response's next_page_token to determine if there are more instances left to be queried.

func (*ProjectsLocationsRestorePlansRestoresListCall) PageToken

PageToken sets the optional parameter "pageToken": The value of next_page_token received from a previous `ListRestores` call. Provide this to retrieve the subsequent page in a multi-page list of results. When paginating, all other parameters provided to `ListRestores` must match the call 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.

type ProjectsLocationsRestorePlansRestoresPatchCall

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

func (*ProjectsLocationsRestorePlansRestoresPatchCall) Context

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsLocationsRestorePlansRestoresPatchCall) Do

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

func (*ProjectsLocationsRestorePlansRestoresPatchCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*ProjectsLocationsRestorePlansRestoresPatchCall) Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

func (*ProjectsLocationsRestorePlansRestoresPatchCall) UpdateMask

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

type ProjectsLocationsRestorePlansRestoresService

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

func NewProjectsLocationsRestorePlansRestoresService

func NewProjectsLocationsRestorePlansRestoresService(s *Service) *ProjectsLocationsRestorePlansRestoresService

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 an empty 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. 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 specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.

type ProjectsLocationsRestorePlansRestoresSetIamPolicyCall

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

func (*ProjectsLocationsRestorePlansRestoresSetIamPolicyCall) Context

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsLocationsRestorePlansRestoresSetIamPolicyCall) Do

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

func (*ProjectsLocationsRestorePlansRestoresSetIamPolicyCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*ProjectsLocationsRestorePlansRestoresSetIamPolicyCall) Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

type ProjectsLocationsRestorePlansRestoresTestIamPermissionsCall

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

func (*ProjectsLocationsRestorePlansRestoresTestIamPermissionsCall) Context

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsLocationsRestorePlansRestoresTestIamPermissionsCall) Do

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

func (*ProjectsLocationsRestorePlansRestoresTestIamPermissionsCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*ProjectsLocationsRestorePlansRestoresTestIamPermissionsCall) Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

type ProjectsLocationsRestorePlansRestoresVolumeRestoresGetCall

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

func (*ProjectsLocationsRestorePlansRestoresVolumeRestoresGetCall) Context

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsLocationsRestorePlansRestoresVolumeRestoresGetCall) Do

Do executes the "gkebackup.projects.locations.restorePlans.restores.volumeRestores.get" call. Exactly one of *VolumeRestore or error will be non-nil. 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 check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsRestorePlansRestoresVolumeRestoresGetCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*ProjectsLocationsRestorePlansRestoresVolumeRestoresGetCall) Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

func (*ProjectsLocationsRestorePlansRestoresVolumeRestoresGetCall) IfNoneMatch

IfNoneMatch sets the optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.

type ProjectsLocationsRestorePlansRestoresVolumeRestoresGetIamPolicyCall

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

func (*ProjectsLocationsRestorePlansRestoresVolumeRestoresGetIamPolicyCall) Context

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsLocationsRestorePlansRestoresVolumeRestoresGetIamPolicyCall) Do

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

func (*ProjectsLocationsRestorePlansRestoresVolumeRestoresGetIamPolicyCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*ProjectsLocationsRestorePlansRestoresVolumeRestoresGetIamPolicyCall) Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

func (*ProjectsLocationsRestorePlansRestoresVolumeRestoresGetIamPolicyCall) IfNoneMatch

IfNoneMatch sets the optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.

func (*ProjectsLocationsRestorePlansRestoresVolumeRestoresGetIamPolicyCall) OptionsRequestedPolicyVersion

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

type ProjectsLocationsRestorePlansRestoresVolumeRestoresListCall

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

func (*ProjectsLocationsRestorePlansRestoresVolumeRestoresListCall) Context

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsLocationsRestorePlansRestoresVolumeRestoresListCall) Do

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

func (*ProjectsLocationsRestorePlansRestoresVolumeRestoresListCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*ProjectsLocationsRestorePlansRestoresVolumeRestoresListCall) Filter

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

func (*ProjectsLocationsRestorePlansRestoresVolumeRestoresListCall) Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

func (*ProjectsLocationsRestorePlansRestoresVolumeRestoresListCall) IfNoneMatch

IfNoneMatch sets the optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.

func (*ProjectsLocationsRestorePlansRestoresVolumeRestoresListCall) OrderBy

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

func (*ProjectsLocationsRestorePlansRestoresVolumeRestoresListCall) PageSize

PageSize sets the optional parameter "pageSize": The target number of results to return in a single response. If not specified, a default value will be chosen by the service. Note that the response may inclue a partial list and a caller should only rely on the response's next_page_token to determine if there are more instances left to be queried.

func (*ProjectsLocationsRestorePlansRestoresVolumeRestoresListCall) PageToken

PageToken sets the optional parameter "pageToken": The value of next_page_token received from a previous `ListVolumeRestores` call. Provide this to retrieve the subsequent page in a multi-page list of results. When paginating, all other parameters provided to `ListVolumeRestores` must match the 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.

type ProjectsLocationsRestorePlansRestoresVolumeRestoresService

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 an empty 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 specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.

type ProjectsLocationsRestorePlansRestoresVolumeRestoresSetIamPolicyCall

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

func (*ProjectsLocationsRestorePlansRestoresVolumeRestoresSetIamPolicyCall) Context

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsLocationsRestorePlansRestoresVolumeRestoresSetIamPolicyCall) Do

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

func (*ProjectsLocationsRestorePlansRestoresVolumeRestoresSetIamPolicyCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*ProjectsLocationsRestorePlansRestoresVolumeRestoresSetIamPolicyCall) Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

type ProjectsLocationsRestorePlansRestoresVolumeRestoresTestIamPermissionsCall

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

func (*ProjectsLocationsRestorePlansRestoresVolumeRestoresTestIamPermissionsCall) Context

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsLocationsRestorePlansRestoresVolumeRestoresTestIamPermissionsCall) Do

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

func (*ProjectsLocationsRestorePlansRestoresVolumeRestoresTestIamPermissionsCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*ProjectsLocationsRestorePlansRestoresVolumeRestoresTestIamPermissionsCall) Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

type ProjectsLocationsRestorePlansService

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

func NewProjectsLocationsRestorePlansService

func NewProjectsLocationsRestorePlansService(s *Service) *ProjectsLocationsRestorePlansService

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 an empty policy if the resource exists and does not have a policy set.

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. 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) TestIamPermissions

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

type ProjectsLocationsRestorePlansSetIamPolicyCall

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

func (*ProjectsLocationsRestorePlansSetIamPolicyCall) Context

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsLocationsRestorePlansSetIamPolicyCall) Do

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

func (*ProjectsLocationsRestorePlansSetIamPolicyCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*ProjectsLocationsRestorePlansSetIamPolicyCall) Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

type ProjectsLocationsRestorePlansTestIamPermissionsCall

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

func (*ProjectsLocationsRestorePlansTestIamPermissionsCall) Context

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsLocationsRestorePlansTestIamPermissionsCall) Do

Do executes the "gkebackup.projects.locations.restorePlans.testIamPermissions" call. Exactly one of *TestIamPermissionsResponse or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *TestIamPermissionsResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsRestorePlansTestIamPermissionsCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*ProjectsLocationsRestorePlansTestIamPermissionsCall) Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

type ProjectsLocationsService

type ProjectsLocationsService struct {
	BackupPlans *ProjectsLocationsBackupPlansService

	Operations *ProjectsLocationsOperationsService

	RestorePlans *ProjectsLocationsRestorePlansService
	// contains filtered or unexported fields
}

func NewProjectsLocationsService

func NewProjectsLocationsService(s *Service) *ProjectsLocationsService

func (*ProjectsLocationsService) DeleteOperations

DeleteOperations: Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the 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 (*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.

type ProjectsService

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

func NewProjectsService

func NewProjectsService(s *Service) *ProjectsService

type Restore

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/*`.
	Backup string `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.
	Cluster string `json:"cluster,omitempty"`

	// CompleteTime: Output only. Timestamp of when the restore operation
	// completed.
	CompleteTime string `json:"completeTime,omitempty"`

	// CreateTime: Output only. The timestamp when this Restore resource was
	// created.
	CreateTime string `json:"createTime,omitempty"`

	// Description: User specified descriptive string for this Restore.
	Description string `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.
	Etag string `json:"etag,omitempty"`

	// Labels: A set of custom labels supplied by user.
	Labels map[string]string `json:"labels,omitempty"`

	// Name: Output only. The full name of the Restore resource. Format:
	// `projects/*/locations/*/restorePlans/*/restores/*`
	Name string `json:"name,omitempty"`

	// ResourcesExcludedCount: Output only. Number of resources excluded
	// during the restore execution.
	ResourcesExcludedCount int64 `json:"resourcesExcludedCount,omitempty"`

	// ResourcesFailedCount: Output only. Number of resources that failed to
	// be restored during the restore execution.
	ResourcesFailedCount int64 `json:"resourcesFailedCount,omitempty"`

	// ResourcesRestoredCount: Output only. Number of resources restored
	// during the restore execution.
	ResourcesRestoredCount int64 `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.
	State string `json:"state,omitempty"`

	// StateReason: Output only. Human-readable description of why the
	// Restore is in its current state.
	StateReason string `json:"stateReason,omitempty"`

	// Uid: Output only. Server generated global unique identifier of UUID
	// (https://en.wikipedia.org/wiki/Universally_unique_identifier) format.
	Uid string `json:"uid,omitempty"`

	// UpdateTime: Output only. The timestamp when this Restore resource was
	// last updated.
	UpdateTime string `json:"updateTime,omitempty"`

	// VolumesRestoredCount: Output only. Number of volumes restored during
	// the restore execution.
	VolumesRestoredCount int64 `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. However, any
	// non-pointer, non-interface field appearing in ForceSendFields will be
	// sent to the server regardless of whether the field is empty or not.
	// This may be used to include empty fields in Patch requests.
	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. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

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

func (*Restore) MarshalJSON

func (s *Restore) MarshalJSON() ([]byte, error)

type RestoreConfig

type RestoreConfig struct {
	// AllNamespaces: Restore all namespaced resources in the Backup if set
	// to "True". Specifying this field to "False" is an error.
	AllNamespaces bool `json:"allNamespaces,omitempty"`

	// ClusterResourceConflictPolicy: 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. Note that 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.
	ClusterResourceConflictPolicy string `json:"clusterResourceConflictPolicy,omitempty"`

	// ClusterResourceRestoreScope: 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"`

	// NamespacedResourceRestoreMode: 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.
	NamespacedResourceRestoreMode string `json:"namespacedResourceRestoreMode,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: 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"`

	// VolumeDataRestorePolicy: 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,
	// will 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). Note that option is likely only usable
	// when restoring a workload to its original cluster.
	//   "NO_VOLUME_DATA_RESTORATION" - For each PVC to be restored, PVCs
	// will be created 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.
	VolumeDataRestorePolicy string `json:"volumeDataRestorePolicy,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. However, any
	// non-pointer, non-interface field appearing in ForceSendFields will be
	// sent to the server regardless of whether the field is empty or not.
	// This may be used to include empty fields in Patch requests.
	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. However, any field with
	// an empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

RestoreConfig: Configuration of a restore. Next id: 12

func (*RestoreConfig) MarshalJSON

func (s *RestoreConfig) MarshalJSON() ([]byte, error)

type RestorePlan

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/*`.
	BackupPlan string `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/*`
	Cluster string `json:"cluster,omitempty"`

	// CreateTime: Output only. The timestamp when this RestorePlan resource
	// was created.
	CreateTime string `json:"createTime,omitempty"`

	// Description: User specified descriptive string for this RestorePlan.
	Description string `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.
	Etag string `json:"etag,omitempty"`

	// Labels: A set of custom labels supplied by user.
	Labels map[string]string `json:"labels,omitempty"`

	// Name: Output only. The full name of the RestorePlan resource. Format:
	// `projects/*/locations/*/restorePlans/*`.
	Name string `json:"name,omitempty"`

	// RestoreConfig: Required. Configuration of Restores created via this
	// RestorePlan.
	RestoreConfig *RestoreConfig `json:"restoreConfig,omitempty"`

	// Uid: Output only. Server generated global unique identifier of UUID
	// (https://en.wikipedia.org/wiki/Universally_unique_identifier) format.
	Uid string `json:"uid,omitempty"`

	// UpdateTime: Output only. The timestamp when this RestorePlan resource
	// was last updated.
	UpdateTime string `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. However, any
	// non-pointer, non-interface field appearing in ForceSendFields will be
	// sent to the server regardless of whether the field is empty or not.
	// This may be used to include empty fields in Patch requests.
	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. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

RestorePlan: The configuration of a potential series of Restore operations to be performed against Backups belong to a particular BackupPlan. Next id: 13

func (*RestorePlan) MarshalJSON

func (s *RestorePlan) MarshalJSON() ([]byte, error)

type RetentionPolicy

type RetentionPolicy struct {
	// BackupDeleteLockDays: 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)
	BackupDeleteLockDays int64 `json:"backupDeleteLockDays,omitempty"`

	// BackupRetainDays: 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. Default: 0 (no automatic deletion)
	BackupRetainDays int64 `json:"backupRetainDays,omitempty"`

	// Locked: 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: False
	Locked bool `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. However, any non-pointer, non-interface field appearing in
	// ForceSendFields will be sent to the server regardless of whether the
	// field is empty or not. This may be used to include empty fields in
	// Patch requests.
	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. However, any field
	// with an empty value appearing in NullFields will be sent to the
	// server as null. It is an error if a field in this list has a
	// non-empty value. This may be used to include null fields in Patch
	// requests.
	NullFields []string `json:"-"`
}

RetentionPolicy: RetentionPolicy defines a Backup retention policy for a BackupPlan.

func (*RetentionPolicy) MarshalJSON

func (s *RetentionPolicy) MarshalJSON() ([]byte, error)

type Schedule

type Schedule struct {
	// CronSchedule: A standard cron (https://wikipedia.com/wiki/cron)
	// string that defines a repeating schedule for creating Backups via
	// this BackupPlan. If this is defined, then backup_retain_days must
	// also be defined. Default (empty): no automatic backup creation will
	// occur.
	CronSchedule string `json:"cronSchedule,omitempty"`

	// Paused: This flag denotes whether automatic Backup creation is paused
	// for this BackupPlan. Default: False
	Paused bool `json:"paused,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. However, any
	// non-pointer, non-interface field appearing in ForceSendFields will be
	// sent to the server regardless of whether the field is empty or not.
	// This may be used to include empty fields in Patch requests.
	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. However, any field with
	// an empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

Schedule: Schedule defines scheduling parameters for automatically creating Backups via this BackupPlan.

func (*Schedule) MarshalJSON

func (s *Schedule) MarshalJSON() ([]byte, error)

type Service

type Service struct {
	BasePath  string // API endpoint base URL
	UserAgent string // optional additional User-Agent fragment

	Projects *ProjectsService
	// contains filtered or unexported fields
}

func New deprecated

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.

func NewService

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

NewService creates a new Service.

type SetIamPolicyRequest

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"
	UpdateMask string `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. However, any
	// non-pointer, non-interface field appearing in ForceSendFields will be
	// sent to the server regardless of whether the field is empty or not.
	// This may be used to include empty fields in Patch requests.
	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. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

SetIamPolicyRequest: Request message for `SetIamPolicy` method.

func (*SetIamPolicyRequest) MarshalJSON

func (s *SetIamPolicyRequest) MarshalJSON() ([]byte, error)

type SubstitutionRule

type SubstitutionRule struct {
	// NewValue: 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 ("").
	NewValue string `json:"newValue,omitempty"`

	// OriginalValuePattern: (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.
	OriginalValuePattern string `json:"originalValuePattern,omitempty"`

	// TargetGroupKinds: (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).
	TargetJsonPath string `json:"targetJsonPath,omitempty"`

	// TargetNamespaces: (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. However, any
	// non-pointer, non-interface field appearing in ForceSendFields will be
	// sent to the server regardless of whether the field is empty or not.
	// This may be used to include empty fields in Patch requests.
	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. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

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

func (*SubstitutionRule) MarshalJSON

func (s *SubstitutionRule) MarshalJSON() ([]byte, error)

type TestIamPermissionsRequest

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. However, any
	// non-pointer, non-interface field appearing in ForceSendFields will be
	// sent to the server regardless of whether the field is empty or not.
	// This may be used to include empty fields in Patch requests.
	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. However, any field with
	// an empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

TestIamPermissionsRequest: Request message for `TestIamPermissions` method.

func (*TestIamPermissionsRequest) MarshalJSON

func (s *TestIamPermissionsRequest) MarshalJSON() ([]byte, error)

type TestIamPermissionsResponse

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. However, any
	// non-pointer, non-interface field appearing in ForceSendFields will be
	// sent to the server regardless of whether the field is empty or not.
	// This may be used to include empty fields in Patch requests.
	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. However, any field with
	// an empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

TestIamPermissionsResponse: Response message for `TestIamPermissions` method.

func (*TestIamPermissionsResponse) MarshalJSON

func (s *TestIamPermissionsResponse) MarshalJSON() ([]byte, error)

type VolumeBackup

type VolumeBackup struct {
	// CompleteTime: Output only. The timestamp when the associated
	// underlying volume backup operation completed.
	CompleteTime string `json:"completeTime,omitempty"`

	// CreateTime: Output only. The timestamp when this VolumeBackup
	// resource was created.
	CreateTime string `json:"createTime,omitempty"`

	// DiskSizeBytes: Output only. The minimum size of the disk to which
	// this VolumeBackup can be restored.
	DiskSizeBytes int64 `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.
	Etag string `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.
	Format string `json:"format,omitempty"`

	// Name: Output only. The full name of the VolumeBackup resource.
	// Format:
	// `projects/*/locations/*/backupPlans/*/backups/*/volumeBackups/*`.
	Name string `json:"name,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.
	State string `json:"state,omitempty"`

	// StateMessage: Output only. A human readable message explaining why
	// the VolumeBackup is in its current state.
	StateMessage string `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.
	StorageBytes int64 `json:"storageBytes,omitempty,string"`

	// Uid: Output only. Server generated global unique identifier of UUID
	// (https://en.wikipedia.org/wiki/Universally_unique_identifier) format.
	Uid string `json:"uid,omitempty"`

	// UpdateTime: Output only. The timestamp when this VolumeBackup
	// resource was last updated.
	UpdateTime string `json:"updateTime,omitempty"`

	// VolumeBackupHandle: Output only. A storage system-specific opaque
	// handle to the underlying volume backup.
	VolumeBackupHandle string `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. However, any
	// non-pointer, non-interface field appearing in ForceSendFields will be
	// sent to the server regardless of whether the field is empty or not.
	// This may be used to include empty fields in Patch requests.
	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. However, any field with
	// an empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

VolumeBackup: Represents the backup of a specific persistent volume as a component of a Backup - both the record of the operation and a pointer to the underlying storage-specific artifacts. Next id: 14

func (*VolumeBackup) MarshalJSON

func (s *VolumeBackup) MarshalJSON() ([]byte, error)

type VolumeRestore

type VolumeRestore struct {
	// CompleteTime: Output only. The timestamp when the associated
	// underlying volume restoration completed.
	CompleteTime string `json:"completeTime,omitempty"`

	// CreateTime: Output only. The timestamp when this VolumeRestore
	// resource was created.
	CreateTime string `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.
	Etag string `json:"etag,omitempty"`

	// Name: Output only. Full name of the VolumeRestore resource. Format:
	// `projects/*/locations/*/restorePlans/*/restores/*/volumeRestores/*`
	Name string `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.
	State string `json:"state,omitempty"`

	// StateMessage: Output only. A human readable message explaining why
	// the VolumeRestore is in its current state.
	StateMessage string `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.
	Uid string `json:"uid,omitempty"`

	// UpdateTime: Output only. The timestamp when this VolumeRestore
	// resource was last updated.
	UpdateTime string `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/*`.
	VolumeBackup string `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.
	VolumeHandle string `json:"volumeHandle,omitempty"`

	// VolumeType: Output only. The type of volume provisioned
	//
	// Possible values:
	//   "VOLUME_TYPE_UNSPECIFIED" - Default
	//   "GCE_PERSISTENT_DISK" - Compute Engine Persistent Disk volume
	VolumeType string `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. However, any
	// non-pointer, non-interface field appearing in ForceSendFields will be
	// sent to the server regardless of whether the field is empty or not.
	// This may be used to include empty fields in Patch requests.
	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. However, any field with
	// an empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

VolumeRestore: Represents the operation of restoring a volume from a VolumeBackup. Next id: 13

func (*VolumeRestore) MarshalJSON

func (s *VolumeRestore) MarshalJSON() ([]byte, error)

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL