resourceconfigurationv1

package
v2.2.0 Latest Latest
Warning

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

 Go to latest Published: Dec 11, 2024 License: Apache-2.0 Imports: 9 Imported by: 4

Documentation

Overview

Package resourceconfigurationv1 : Operations and models for the ResourceConfigurationV1 service

Index

Constants

View Source 
const (
	BackupPolicy_PolicyStatus_ActionNeeded = "action_needed"
	BackupPolicy_PolicyStatus_Active       = "active"
	BackupPolicy_PolicyStatus_Degraded     = "degraded"
	BackupPolicy_PolicyStatus_Failed       = "failed"
	BackupPolicy_PolicyStatus_Initializing = "initializing"
	BackupPolicy_PolicyStatus_Pending      = "pending"
)

Constants associated with the BackupPolicy.PolicyStatus property. The current status of the backup policy.

pending : the policy has been received and has begun processing. initializing : pre-existing objects are being sync to the backup vault. active : the policy is active and healthy. action_needed : the policy is unhealthy and requires some intervention to recover degraded : the policy is unhealthy failed : the policy has failed unrecoverably.

View Source 
const (
	Firewall_AllowedNetworkType_Direct  = "direct"
	Firewall_AllowedNetworkType_Private = "private"
	Firewall_AllowedNetworkType_Public  = "public"
)

Constants associated with the Firewall.AllowedNetworkType property. May contain `public`, `private`, and/or `direct` elements. Setting `allowed_network_type` to only `private` will prevent access to object storage from outside of the IBM Cloud. The entire array will be overwritten in a `PATCH` operation. For more information on network types, [see the documentation](https://cloud.ibm.com/docs/cloud-object-storage?topic=cloud-object-storage-endpoints#advanced-endpoint-types).

View Source 
const (
	ProtectionManagement_RequestedState_Activate   = "activate"
	ProtectionManagement_RequestedState_Deactivate = "deactivate"
)

Constants associated with the ProtectionManagement.RequestedState property. If set to `activate`, protection management action on the bucket is being activated.

View Source 
const (
	Restore_RestoreStatus_Complete     = "complete"
	Restore_RestoreStatus_Failed       = "failed"
	Restore_RestoreStatus_Initializing = "initializing"
	Restore_RestoreStatus_Running      = "running"
)

Constants associated with the Restore.RestoreStatus property. The current status for this restore operation.

initializing: The operation is initializing. Do not expect to see restored objects on the target bucket. running : The operation is ongoing. Expect to see some restored objects on the target bucket. complete: The operation has completed successfully. failed: The operation has completed unsuccessfully.

View Source 
const (
	BackupPolicy_BackupType_Continuous = "continuous"
)

Constants associated with the BackupPolicy.BackupType property. The type of backup to support. For LA+GA this is limited to "continuous".

View Source 
const (
	CreateBackupPolicyOptions_BackupType_Continuous = "continuous"
)

Constants associated with the CreateBackupPolicyOptions.BackupType property. The type of backup to support. For LA+GA this is limited to "continuous".

View Source 
const (
	CreateRestoreOptions_RestoreType_InPlace = "in_place"
)

Constants associated with the CreateRestoreOptions.RestoreType property. The type of restore to support. More options will be available in the future.

View Source 
const DefaultServiceName = "resource_configuration"

DefaultServiceName is the default key used to find external configuration information.

View Source 
const DefaultServiceURL = "https://config.cloud-object-storage.cloud.ibm.com/v1"

DefaultServiceURL is the default URL to make service requests to.

View Source 
const (
	Restore_RestoreType_InPlace = "in_place"
)

Constants associated with the Restore.RestoreType property. The type of restore to support. More options will be available in the future.

Variables

This section is empty.

Functions

func GetServiceURLForRegion 

func GetServiceURLForRegion(region string) (string, error)

GetServiceURLForRegion returns the service URL to be used for the specified region

func UnmarshalActivityTracking 

func UnmarshalActivityTracking(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalActivityTracking unmarshals an instance of ActivityTracking from the specified map of raw messages.

func UnmarshalBackupPolicy added in v2.2.0 

func UnmarshalBackupPolicy(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalBackupPolicy unmarshals an instance of BackupPolicy from the specified map of raw messages.

func UnmarshalBackupPolicyCollection added in v2.2.0 

func UnmarshalBackupPolicyCollection(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalBackupPolicyCollection unmarshals an instance of BackupPolicyCollection from the specified map of raw messages.

func UnmarshalBackupVault added in v2.2.0 

func UnmarshalBackupVault(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalBackupVault unmarshals an instance of BackupVault from the specified map of raw messages.

func UnmarshalBackupVaultActivityTracking added in v2.2.0 

func UnmarshalBackupVaultActivityTracking(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalBackupVaultActivityTracking unmarshals an instance of BackupVaultActivityTracking from the specified map of raw messages.

func UnmarshalBackupVaultCollection added in v2.2.0 

func UnmarshalBackupVaultCollection(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalBackupVaultCollection unmarshals an instance of BackupVaultCollection from the specified map of raw messages.

func UnmarshalBackupVaultMetricsMonitoring added in v2.2.0 

func UnmarshalBackupVaultMetricsMonitoring(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalBackupVaultMetricsMonitoring unmarshals an instance of BackupVaultMetricsMonitoring from the specified map of raw messages.

func UnmarshalBackupVaultPatch added in v2.2.0 

func UnmarshalBackupVaultPatch(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalBackupVaultPatch unmarshals an instance of BackupVaultPatch from the specified map of raw messages.

func UnmarshalBucket 

func UnmarshalBucket(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalBucket unmarshals an instance of Bucket from the specified map of raw messages.

func UnmarshalBucketPatch 

func UnmarshalBucketPatch(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalBucketPatch unmarshals an instance of BucketPatch from the specified map of raw messages.

func UnmarshalFirewall 

func UnmarshalFirewall(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalFirewall unmarshals an instance of Firewall from the specified map of raw messages.

func UnmarshalMetricsMonitoring 

func UnmarshalMetricsMonitoring(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalMetricsMonitoring unmarshals an instance of MetricsMonitoring from the specified map of raw messages.

func UnmarshalNextPagination added in v2.2.0 

func UnmarshalNextPagination(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalNextPagination unmarshals an instance of NextPagination from the specified map of raw messages.

func UnmarshalProtectionManagement added in v2.0.4 

func UnmarshalProtectionManagement(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalProtectionManagement unmarshals an instance of ProtectionManagement from the specified map of raw messages.

func UnmarshalProtectionManagementResponse added in v2.0.4 

func UnmarshalProtectionManagementResponse(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalProtectionManagementResponse unmarshals an instance of ProtectionManagementResponse from the specified map of raw messages.

func UnmarshalProtectionManagementResponseTokenEntry added in v2.0.4 

func UnmarshalProtectionManagementResponseTokenEntry(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalProtectionManagementResponseTokenEntry unmarshals an instance of ProtectionManagementResponseTokenEntry from the specified map of raw messages.

func UnmarshalRecoveryRange added in v2.2.0 

func UnmarshalRecoveryRange(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalRecoveryRange unmarshals an instance of RecoveryRange from the specified map of raw messages.

func UnmarshalRecoveryRangeCollection added in v2.2.0 

func UnmarshalRecoveryRangeCollection(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalRecoveryRangeCollection unmarshals an instance of RecoveryRangeCollection from the specified map of raw messages.

func UnmarshalRestore added in v2.2.0 

func UnmarshalRestore(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalRestore unmarshals an instance of Restore from the specified map of raw messages.

func UnmarshalRestoreCollection added in v2.2.0 

func UnmarshalRestoreCollection(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalRestoreCollection unmarshals an instance of RestoreCollection from the specified map of raw messages.

Types

type ActivityTracking 

type ActivityTracking struct {
	// If set to `true`, all object read events (i.e. downloads) will be sent to Activity Tracker Event Routing.
	ReadDataEvents *bool `json:"read_data_events,omitempty"`

	// If set to `true`, all object write events (i.e. uploads) will be sent to Activity Tracker Event Routing.
	WriteDataEvents *bool `json:"write_data_events,omitempty"`

	// When the `activity_tracker_crn` is not populated, then enabled events are sent to the Activity Tracker Event Routing
	// instance associated to the container's location unless otherwise specified in the Activity Tracker Event Routing
	// Event Routing service configuration. If `activity_tracker_crn` is populated, then enabled events are sent to the
	// Activity Tracker Event Routing instance specified and bucket management events are always enabled.
	ActivityTrackerCrn *string `json:"activity_tracker_crn,omitempty"`

	// This field only applies if `activity_tracker_crn` is not populated. If set to `true`, all bucket management events
	// will be sent to Activity Tracker Event Routing.
	ManagementEvents *bool `json:"management_events,omitempty"`
}

ActivityTracking : Enables sending log data to IBM Cloud Activity Tracker Event Routing to provide visibility into bucket management, object read and write events. (Recommended) When the `activity_tracker_crn` is not populated, then enabled events are sent to the Activity Tracker Event Routing instance at the container's location unless otherwise specified in the Activity Tracker Event Routing Event Routing service configuration. (Legacy) When the `activity_tracker_crn` is populated, then enabled events are sent to the Activity Tracker Event Routing instance specified.

type BackupPolicy added in v2.2.0 

type BackupPolicy struct {
	// The name granted to the policy. Validation :
	//   * chars limited to alphanumeric, underscore, hyphen and period.
	PolicyName *string `json:"policy_name" validate:"required"`

	// The CRN for a COS BackupVault.
	TargetBackupVaultCrn *string `json:"target_backup_vault_crn" validate:"required"`

	// The type of backup to support. For LA+GA this is limited to "continuous".
	BackupType *string `json:"backup_type" validate:"required"`

	// A UUID that uniquely identifies a resource.
	PolicyID *string `json:"policy_id" validate:"required"`

	// The current status of the backup policy.
	//
	// pending : the policy has been received and has begun processing. initializing : pre-existing objects are being sync
	// to the backup vault. active : the policy is active and healthy. action_needed : the policy is unhealthy and requires
	// some intervention to recover degraded : the policy is unhealthy failed : the policy has failed unrecoverably.
	PolicyStatus *string `json:"policy_status" validate:"required"`

	// Reports percent-doneness of init.
	//
	// Only present when policy_status=INITIALING.
	InitialSyncProgress *int64 `json:"initial_sync_progress,omitempty"`

	// reports error cause. Only present when policy_status=ERROR/FAILED.
	ErrorCause *string `json:"error_cause,omitempty"`
}

BackupPolicy : The current backup coverage for a COS Bucket.

type BackupPolicyCollection added in v2.2.0 

type BackupPolicyCollection struct {
	// A collection of backup policies.
	BackupPolicies []BackupPolicy `json:"backup_policies,omitempty"`
}

BackupPolicyCollection : A collection of backup policies.

type BackupVault added in v2.2.0 

type BackupVault struct {
	// Activity Tracking configuration. An empty object (`{}`) indicates no configuration, and no events will be sent (This
	// is the same behavior as `{"management_events":false}`). Note that read/write events cannot be enabled, and events
	// cannot be routed to a non-default Activity Tracker instance.
	ActivityTracking *BackupVaultActivityTracking `json:"activity_tracking,omitempty"`

	// Metrics Monitoring configuration. An empty object (`{}`) indicates no configuration, and no metrics will be
	// collected (This is the same behavior as `{"usage_metrics_enabled":false}`). Note that request metrics cannot be
	// enabled, and metrics cannot be routed to a non-default metrics router instance.
	MetricsMonitoring *BackupVaultMetricsMonitoring `json:"metrics_monitoring,omitempty"`

	// The name given to a Bucket.
	//
	// Bucket names must be between 3 and 63 characters long must be made of lowercase letters, numbers, dots (periods),
	// and dashes (hyphens). Bucket names must begin and end with a lowercase letter or number. Bucket names canâ€t contain
	// consecutive dots or dashes. Bucket names that resemble IP addresses are not allowed.
	//
	// Bucket and BackupVault names exist in a global global namespace and therefore must be unique.
	BackupVaultName *string `json:"backup_vault_name" validate:"required"`

	// the region in which this backup-vault should be created within.
	Region *string `json:"region" validate:"required"`

	// The CRN for a KeyProtect root key.
	SseKpCustomerRootKeyCrn *string `json:"sse_kp_customer_root_key_crn,omitempty"`

	// CRN of the backup-vault.
	Crn *string `json:"crn,omitempty"`

	// A COS ServiceInstance CRN.
	ServiceInstanceCrn *string `json:"service_instance_crn,omitempty"`

	// creation time of the backup-vault. Returns "YYYY-MM-DDTHH:mm:ss.sssZ" timestamp format.
	TimeCreated *strfmt.DateTime `json:"time_created,omitempty"`

	// time of last update to the backup-vault Returns "YYYY-MM-DDTHH:mm:ss.sssZ" timestamp format.
	TimeUpdated *strfmt.DateTime `json:"time_updated,omitempty"`

	// byte useage of the backup-vault. This should include all usage, including non-current versions.
	BytesUsed *int64 `json:"bytes_used,omitempty"`
}

BackupVault : Metadata associated with a backup vault.

type BackupVaultActivityTracking added in v2.2.0 

type BackupVaultActivityTracking struct {
	// Whether to send notifications for management events on the BackupVault.
	ManagementEvents *bool `json:"management_events,omitempty"`
}

BackupVaultActivityTracking : Activity Tracking configuration. An empty object (`{}`) indicates no configuration, and no events will be sent (This is the same behavior as `{"management_events":false}`). Note that read/write events cannot be enabled, and events cannot be routed to a non-default Activity Tracker instance.

type BackupVaultCollection added in v2.2.0 

type BackupVaultCollection struct {
	// Pagination response body.
	Next *NextPagination `json:"next,omitempty"`

	// List of Backup Vaults. If no Backup Vaults exist, this array will be empty.
	BackupVaults []string `json:"backup_vaults,omitempty"`
}

BackupVaultCollection : A listing of backup vaults.

func (*BackupVaultCollection) GetNextToken added in v2.2.0 

func (resp *BackupVaultCollection) GetNextToken() (*string, error)

Retrieve the value to be passed to a request to access the next page of results

type BackupVaultMetricsMonitoring added in v2.2.0 

type BackupVaultMetricsMonitoring struct {
	// Whether usage metrics are collected for this BackupVault.
	UsageMetricsEnabled *bool `json:"usage_metrics_enabled,omitempty"`
}

BackupVaultMetricsMonitoring : Metrics Monitoring configuration. An empty object (`{}`) indicates no configuration, and no metrics will be collected (This is the same behavior as `{"usage_metrics_enabled":false}`). Note that request metrics cannot be enabled, and metrics cannot be routed to a non-default metrics router instance.

type BackupVaultPatch added in v2.2.0 

type BackupVaultPatch struct {
	// Activity Tracking configuration. An empty object (`{}`) indicates no configuration, and no events will be sent (This
	// is the same behavior as `{"management_events":false}`). Note that read/write events cannot be enabled, and events
	// cannot be routed to a non-default Activity Tracker instance.
	ActivityTracking *BackupVaultActivityTracking `json:"activity_tracking,omitempty"`

	// Metrics Monitoring configuration. An empty object (`{}`) indicates no configuration, and no metrics will be
	// collected (This is the same behavior as `{"usage_metrics_enabled":false}`). Note that request metrics cannot be
	// enabled, and metrics cannot be routed to a non-default metrics router instance.
	MetricsMonitoring *BackupVaultMetricsMonitoring `json:"metrics_monitoring,omitempty"`
}

BackupVaultPatch : Metadata elements on a backup vault that can be updated.

func (*BackupVaultPatch) AsPatch added in v2.2.0 

func (backupVaultPatch *BackupVaultPatch) AsPatch() (_patch map[string]interface{}, err error)

AsPatch returns a generic map representation of the BackupVaultPatch

type BackupVaultsPager added in v2.2.0 

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

BackupVaultsPager can be used to simplify the use of the "ListBackupVaults" method.

func (*BackupVaultsPager) GetAll added in v2.2.0 

func (pager *BackupVaultsPager) GetAll() (allItems []string, err error)

GetAll invokes GetAllWithContext() using context.Background() as the Context parameter.

func (*BackupVaultsPager) GetAllWithContext added in v2.2.0 

func (pager *BackupVaultsPager) GetAllWithContext(ctx context.Context) (allItems []string, err error)

GetAllWithContext returns all results by invoking GetNextWithContext() repeatedly until all pages of results have been retrieved.

func (*BackupVaultsPager) GetNext added in v2.2.0 

func (pager *BackupVaultsPager) GetNext() (page []string, err error)

GetNext invokes GetNextWithContext() using context.Background() as the Context parameter.

func (*BackupVaultsPager) GetNextWithContext added in v2.2.0 

func (pager *BackupVaultsPager) GetNextWithContext(ctx context.Context) (page []string, err error)

GetNextWithContext returns the next page of results using the specified Context.

func (*BackupVaultsPager) HasNext added in v2.2.0 

func (pager *BackupVaultsPager) HasNext() bool

HasNext returns true if there are potentially more results to be retrieved.

type Bucket 

type Bucket struct {
	// The name of the bucket. Non-mutable.
	Name *string `json:"name,omitempty"`

	// The service instance that holds the bucket. Non-mutable.
	Crn *string `json:"crn,omitempty"`

	// The service instance that holds the bucket. Non-mutable.
	ServiceInstanceID *string `json:"service_instance_id,omitempty"`

	// The service instance that holds the bucket. Non-mutable.
	ServiceInstanceCrn *string `json:"service_instance_crn,omitempty"`

	// The creation time of the bucket in RFC 3339 format. Non-mutable.
	TimeCreated *strfmt.DateTime `json:"time_created,omitempty"`

	// The modification time of the bucket in RFC 3339 format. Non-mutable.
	TimeUpdated *strfmt.DateTime `json:"time_updated,omitempty"`

	// Total number of objects in the bucket. Non-mutable.
	ObjectCount *int64 `json:"object_count,omitempty"`

	// Total size of all objects in the bucket. Non-mutable.
	BytesUsed *int64 `json:"bytes_used,omitempty"`

	// Number of non-current object versions in the bucket. Non-mutable.
	NoncurrentObjectCount *int64 `json:"noncurrent_object_count,omitempty"`

	// Total size of all non-current object versions in the bucket. Non-mutable.
	NoncurrentBytesUsed *int64 `json:"noncurrent_bytes_used,omitempty"`

	// Total number of delete markers in the bucket. Non-mutable.
	DeleteMarkerCount *int64 `json:"delete_marker_count,omitempty"`

	// An access control mechanism based on the network (IP address) where request originated. Requests not originating
	// from IP addresses listed in the `allowed_ip` field will be denied regardless of any access policies (including
	// public access) that might otherwise permit the request.  Viewing or updating the `Firewall` element requires the
	// requester to have the `manager` role.
	Firewall *Firewall `json:"firewall,omitempty"`

	// Enables sending log data to IBM Cloud Activity Tracker Event Routing to provide visibility into bucket management,
	// object read and write events. (Recommended) When the `activity_tracker_crn` is not populated, then enabled events
	// are sent to the Activity Tracker Event Routing instance at the container's location unless otherwise specified in
	// the Activity Tracker Event Routing Event Routing service configuration. (Legacy) When the `activity_tracker_crn` is
	// populated, then enabled events are sent to the Activity Tracker Event Routing instance specified.
	ActivityTracking *ActivityTracking `json:"activity_tracking,omitempty"`

	// Enables sending metrics to IBM Cloud Monitoring.  All metrics are opt-in. (Recommended) When the
	// `metrics_monitoring_crn` is not populated, then enabled metrics are sent to the Monitoring instance at the
	// container's location unless otherwise specified in the Metrics Router service configuration. (Legacy) When the
	// `metrics_monitoring_crn` is populated, then enabled metrics are sent to the Monitoring instance defined in the
	// `metrics_monitoring_crn` field.
	MetricsMonitoring *MetricsMonitoring `json:"metrics_monitoring,omitempty"`

	// Maximum bytes for this bucket.
	HardQuota *int64 `json:"hard_quota,omitempty"`

	// Data structure holding protection management response.
	ProtectionManagement *ProtectionManagementResponse `json:"protection_management,omitempty"`
}

Bucket : A bucket.

type BucketPatch 

type BucketPatch struct {
	// An access control mechanism based on the network (IP address) where request originated. Requests not originating
	// from IP addresses listed in the `allowed_ip` field will be denied regardless of any access policies (including
	// public access) that might otherwise permit the request.  Viewing or updating the `Firewall` element requires the
	// requester to have the `manager` role.
	Firewall *Firewall `json:"firewall,omitempty"`

	// Enables sending log data to IBM Cloud Activity Tracker Event Routing to provide visibility into bucket management,
	// object read and write events. (Recommended) When the `activity_tracker_crn` is not populated, then enabled events
	// are sent to the Activity Tracker Event Routing instance at the container's location unless otherwise specified in
	// the Activity Tracker Event Routing Event Routing service configuration. (Legacy) When the `activity_tracker_crn` is
	// populated, then enabled events are sent to the Activity Tracker Event Routing instance specified.
	ActivityTracking *ActivityTracking `json:"activity_tracking,omitempty"`

	// Enables sending metrics to IBM Cloud Monitoring.  All metrics are opt-in. (Recommended) When the
	// `metrics_monitoring_crn` is not populated, then enabled metrics are sent to the Monitoring instance at the
	// container's location unless otherwise specified in the Metrics Router service configuration. (Legacy) When the
	// `metrics_monitoring_crn` is populated, then enabled metrics are sent to the Monitoring instance defined in the
	// `metrics_monitoring_crn` field.
	MetricsMonitoring *MetricsMonitoring `json:"metrics_monitoring,omitempty"`

	// Maximum bytes for this bucket.
	HardQuota *int64 `json:"hard_quota,omitempty"`

	// Data structure holding protection management operations.
	ProtectionManagement *ProtectionManagement `json:"protection_management,omitempty"`
}

BucketPatch : An object containing new bucket metadata.

func (*BucketPatch) AsPatch 

func (bucketPatch *BucketPatch) AsPatch() (_patch map[string]interface{}, err error)

AsPatch returns a generic map representation of the BucketPatch

type CreateBackupPolicyOptions added in v2.2.0 

type CreateBackupPolicyOptions struct {
	// Name of the COS Bucket name.
	Bucket *string `json:"bucket" validate:"required,ne="`

	// The name granted to the policy. Validation :
	//   * chars limited to alphanumeric, underscore, hyphen and period.
	PolicyName *string `json:"policy_name" validate:"required"`

	// The CRN for a COS BackupVault.
	TargetBackupVaultCrn *string `json:"target_backup_vault_crn" validate:"required"`

	// The type of backup to support. For LA+GA this is limited to "continuous".
	BackupType *string `json:"backup_type" validate:"required"`

	// MD5 hash of content. If provided, the hash of the request must match.
	MD5 *string `json:"MD5,omitempty"`

	// Allows users to set headers on API requests.
	Headers map[string]string
}

CreateBackupPolicyOptions : The CreateBackupPolicy options.

func (*CreateBackupPolicyOptions) SetBackupType added in v2.2.0 

func (_options *CreateBackupPolicyOptions) SetBackupType(backupType string) *CreateBackupPolicyOptions

SetBackupType : Allow user to set BackupType

func (*CreateBackupPolicyOptions) SetBucket added in v2.2.0 

func (_options *CreateBackupPolicyOptions) SetBucket(bucket string) *CreateBackupPolicyOptions

SetBucket : Allow user to set Bucket

func (*CreateBackupPolicyOptions) SetHeaders added in v2.2.0 

func (options *CreateBackupPolicyOptions) SetHeaders(param map[string]string) *CreateBackupPolicyOptions

SetHeaders : Allow user to set Headers

func (*CreateBackupPolicyOptions) SetMD5 added in v2.2.0 

func (_options *CreateBackupPolicyOptions) SetMD5(mD5 string) *CreateBackupPolicyOptions

SetMD5 : Allow user to set MD5

func (*CreateBackupPolicyOptions) SetPolicyName added in v2.2.0 

func (_options *CreateBackupPolicyOptions) SetPolicyName(policyName string) *CreateBackupPolicyOptions

SetPolicyName : Allow user to set PolicyName

func (*CreateBackupPolicyOptions) SetTargetBackupVaultCrn added in v2.2.0 

func (_options *CreateBackupPolicyOptions) SetTargetBackupVaultCrn(targetBackupVaultCrn string) *CreateBackupPolicyOptions

SetTargetBackupVaultCrn : Allow user to set TargetBackupVaultCrn

type CreateBackupVaultOptions added in v2.2.0 

type CreateBackupVaultOptions struct {
	// Name of the service_instance to list BackupVaults for.
	ServiceInstanceID *string `json:"service_instance_id" validate:"required"`

	// The name given to a Bucket.
	//
	// Bucket names must be between 3 and 63 characters long must be made of lowercase letters, numbers, dots (periods),
	// and dashes (hyphens). Bucket names must begin and end with a lowercase letter or number. Bucket names canâ€t contain
	// consecutive dots or dashes. Bucket names that resemble IP addresses are not allowed.
	//
	// Bucket and BackupVault names exist in a global global namespace and therefore must be unique.
	BackupVaultName *string `json:"backup_vault_name" validate:"required"`

	// the region in which this backup-vault should be created within.
	Region *string `json:"region" validate:"required"`

	// Activity Tracking configuration. An empty object (`{}`) indicates no configuration, and no events will be sent (This
	// is the same behavior as `{"management_events":false}`). Note that read/write events cannot be enabled, and events
	// cannot be routed to a non-default Activity Tracker instance.
	ActivityTracking *BackupVaultActivityTracking `json:"activity_tracking,omitempty"`

	// Metrics Monitoring configuration. An empty object (`{}`) indicates no configuration, and no metrics will be
	// collected (This is the same behavior as `{"usage_metrics_enabled":false}`). Note that request metrics cannot be
	// enabled, and metrics cannot be routed to a non-default metrics router instance.
	MetricsMonitoring *BackupVaultMetricsMonitoring `json:"metrics_monitoring,omitempty"`

	// The CRN for a KeyProtect root key.
	SseKpCustomerRootKeyCrn *string `json:"sse_kp_customer_root_key_crn,omitempty"`

	// Allows users to set headers on API requests.
	Headers map[string]string
}

CreateBackupVaultOptions : The CreateBackupVault options.

func (*CreateBackupVaultOptions) SetActivityTracking added in v2.2.0 

func (_options *CreateBackupVaultOptions) SetActivityTracking(activityTracking *BackupVaultActivityTracking) *CreateBackupVaultOptions

SetActivityTracking : Allow user to set ActivityTracking

func (*CreateBackupVaultOptions) SetBackupVaultName added in v2.2.0 

func (_options *CreateBackupVaultOptions) SetBackupVaultName(backupVaultName string) *CreateBackupVaultOptions

SetBackupVaultName : Allow user to set BackupVaultName

func (*CreateBackupVaultOptions) SetHeaders added in v2.2.0 

func (options *CreateBackupVaultOptions) SetHeaders(param map[string]string) *CreateBackupVaultOptions

SetHeaders : Allow user to set Headers

func (*CreateBackupVaultOptions) SetMetricsMonitoring added in v2.2.0 

func (_options *CreateBackupVaultOptions) SetMetricsMonitoring(metricsMonitoring *BackupVaultMetricsMonitoring) *CreateBackupVaultOptions

SetMetricsMonitoring : Allow user to set MetricsMonitoring

func (*CreateBackupVaultOptions) SetRegion added in v2.2.0 

func (_options *CreateBackupVaultOptions) SetRegion(region string) *CreateBackupVaultOptions

SetRegion : Allow user to set Region

func (*CreateBackupVaultOptions) SetServiceInstanceID added in v2.2.0 

func (_options *CreateBackupVaultOptions) SetServiceInstanceID(serviceInstanceID string) *CreateBackupVaultOptions

SetServiceInstanceID : Allow user to set ServiceInstanceID

func (*CreateBackupVaultOptions) SetSseKpCustomerRootKeyCrn added in v2.2.0 

func (_options *CreateBackupVaultOptions) SetSseKpCustomerRootKeyCrn(sseKpCustomerRootKeyCrn string) *CreateBackupVaultOptions

SetSseKpCustomerRootKeyCrn : Allow user to set SseKpCustomerRootKeyCrn

type CreateRestoreOptions added in v2.2.0 

type CreateRestoreOptions struct {
	// name of BackupVault to restore from.
	BackupVaultName *string `json:"backup_vault_name" validate:"required,ne="`

	// A UUID that uniquely identifies a resource.
	RecoveryRangeID *string `json:"recovery_range_id" validate:"required"`

	// The type of restore to support. More options will be available in the future.
	RestoreType *string `json:"restore_type" validate:"required"`

	// Timestamp format used throughout the API.
	//
	// Accepts the following formats:
	//
	// YYYY-MM-DDTHH:mm:ssZ YYYY-MM-DDTHH:mm:ss YYYY-MM-DDTHH:mm:ss-hh:mm YYYY-MM-DDTHH:mm:ss+hh:mm
	// YYYY-MM-DDTHH:mm:ss.sssZ YYYY-MM-DDTHH:mm:ss.sss YYYY-MM-DDTHH:mm:ss.sss-hh:mm YYYY-MM-DDTHH:mm:ss.sss+hh:mm.
	RestorePointInTime *strfmt.DateTime `json:"restore_point_in_time" validate:"required"`

	// The CRN for a COS Bucket.
	//
	// Note that Softlayer CRNs do not contain dashes within the service_instance_id, whereas regular CRNs do. Although
	// bucket backup is not supported for softlayer accounts, this need not be enforced at the CRN parsing level.
	TargetResourceCrn *string `json:"target_resource_crn" validate:"required"`

	// Allows users to set headers on API requests.
	Headers map[string]string
}

CreateRestoreOptions : The CreateRestore options.

func (*CreateRestoreOptions) SetBackupVaultName added in v2.2.0 

func (_options *CreateRestoreOptions) SetBackupVaultName(backupVaultName string) *CreateRestoreOptions

SetBackupVaultName : Allow user to set BackupVaultName

func (*CreateRestoreOptions) SetHeaders added in v2.2.0 

func (options *CreateRestoreOptions) SetHeaders(param map[string]string) *CreateRestoreOptions

SetHeaders : Allow user to set Headers

func (*CreateRestoreOptions) SetRecoveryRangeID added in v2.2.0 

func (_options *CreateRestoreOptions) SetRecoveryRangeID(recoveryRangeID string) *CreateRestoreOptions

SetRecoveryRangeID : Allow user to set RecoveryRangeID

func (*CreateRestoreOptions) SetRestorePointInTime added in v2.2.0 

func (_options *CreateRestoreOptions) SetRestorePointInTime(restorePointInTime *strfmt.DateTime) *CreateRestoreOptions

SetRestorePointInTime : Allow user to set RestorePointInTime

func (*CreateRestoreOptions) SetRestoreType added in v2.2.0 

func (_options *CreateRestoreOptions) SetRestoreType(restoreType string) *CreateRestoreOptions

SetRestoreType : Allow user to set RestoreType

func (*CreateRestoreOptions) SetTargetResourceCrn added in v2.2.0 

func (_options *CreateRestoreOptions) SetTargetResourceCrn(targetResourceCrn string) *CreateRestoreOptions

SetTargetResourceCrn : Allow user to set TargetResourceCrn

type DeleteBackupPolicyOptions added in v2.2.0 

type DeleteBackupPolicyOptions struct {
	// name of the bucket affected.
	Bucket *string `json:"bucket" validate:"required,ne="`

	// uuid of the BackupPolicy.
	PolicyID *string `json:"policy_id" validate:"required,ne="`

	// Allows users to set headers on API requests.
	Headers map[string]string
}

DeleteBackupPolicyOptions : The DeleteBackupPolicy options.

func (*DeleteBackupPolicyOptions) SetBucket added in v2.2.0 

func (_options *DeleteBackupPolicyOptions) SetBucket(bucket string) *DeleteBackupPolicyOptions

SetBucket : Allow user to set Bucket

func (*DeleteBackupPolicyOptions) SetHeaders added in v2.2.0 

func (options *DeleteBackupPolicyOptions) SetHeaders(param map[string]string) *DeleteBackupPolicyOptions

SetHeaders : Allow user to set Headers

func (*DeleteBackupPolicyOptions) SetPolicyID added in v2.2.0 

func (_options *DeleteBackupPolicyOptions) SetPolicyID(policyID string) *DeleteBackupPolicyOptions

SetPolicyID : Allow user to set PolicyID

type DeleteBackupVaultOptions added in v2.2.0 

type DeleteBackupVaultOptions struct {
	// Name of the backup-vault to create or update.
	BackupVaultName *string `json:"backup_vault_name" validate:"required,ne="`

	// Allows users to set headers on API requests.
	Headers map[string]string
}

DeleteBackupVaultOptions : The DeleteBackupVault options.

func (*DeleteBackupVaultOptions) SetBackupVaultName added in v2.2.0 

func (_options *DeleteBackupVaultOptions) SetBackupVaultName(backupVaultName string) *DeleteBackupVaultOptions

SetBackupVaultName : Allow user to set BackupVaultName

func (*DeleteBackupVaultOptions) SetHeaders added in v2.2.0 

func (options *DeleteBackupVaultOptions) SetHeaders(param map[string]string) *DeleteBackupVaultOptions

SetHeaders : Allow user to set Headers

type Firewall 

type Firewall struct {
	// List of IPv4 or IPv6 addresses in CIDR notation to be affected by firewall in CIDR notation is supported. Passing an
	// empty array will lift the IP address filter.  The `allowed_ip` array can contain a maximum of 1000 items.
	AllowedIp []string `json:"allowed_ip"`
}

Firewall : An access control mechanism based on the network (IP address) where request originated. Requests not originating from IP addresses listed in the `allowed_ip` field will be denied regardless of any access policies (including public access) that might otherwise permit the request. Viewing or updating the `Firewall` element requires the requester to have the `manager` role.

type GetBackupPolicyOptions added in v2.2.0 

type GetBackupPolicyOptions struct {
	// name of the bucket affected.
	Bucket *string `json:"bucket" validate:"required,ne="`

	// uuid of the BackupPolicy.
	PolicyID *string `json:"policy_id" validate:"required,ne="`

	// Allows users to set headers on API requests.
	Headers map[string]string
}

GetBackupPolicyOptions : The GetBackupPolicy options.

func (*GetBackupPolicyOptions) SetBucket added in v2.2.0 

func (_options *GetBackupPolicyOptions) SetBucket(bucket string) *GetBackupPolicyOptions

SetBucket : Allow user to set Bucket

func (*GetBackupPolicyOptions) SetHeaders added in v2.2.0 

func (options *GetBackupPolicyOptions) SetHeaders(param map[string]string) *GetBackupPolicyOptions

SetHeaders : Allow user to set Headers

func (*GetBackupPolicyOptions) SetPolicyID added in v2.2.0 

func (_options *GetBackupPolicyOptions) SetPolicyID(policyID string) *GetBackupPolicyOptions

SetPolicyID : Allow user to set PolicyID

type GetBackupVaultOptions added in v2.2.0 

type GetBackupVaultOptions struct {
	// Name of the backup-vault to create or update.
	BackupVaultName *string `json:"backup_vault_name" validate:"required,ne="`

	// Allows users to set headers on API requests.
	Headers map[string]string
}

GetBackupVaultOptions : The GetBackupVault options.

func (*GetBackupVaultOptions) SetBackupVaultName added in v2.2.0 

func (_options *GetBackupVaultOptions) SetBackupVaultName(backupVaultName string) *GetBackupVaultOptions

SetBackupVaultName : Allow user to set BackupVaultName

func (*GetBackupVaultOptions) SetHeaders added in v2.2.0 

func (options *GetBackupVaultOptions) SetHeaders(param map[string]string) *GetBackupVaultOptions

SetHeaders : Allow user to set Headers

type GetBucketConfigOptions 

type GetBucketConfigOptions struct {
	// Name of a bucket.
	Bucket *string `json:"bucket" validate:"required,ne="`

	// Allows users to set headers on API requests.
	Headers map[string]string
}

GetBucketConfigOptions : The GetBucketConfig options.

func (*GetBucketConfigOptions) SetBucket 

func (_options *GetBucketConfigOptions) SetBucket(bucket string) *GetBucketConfigOptions

SetBucket : Allow user to set Bucket

func (*GetBucketConfigOptions) SetHeaders 

func (options *GetBucketConfigOptions) SetHeaders(param map[string]string) *GetBucketConfigOptions

SetHeaders : Allow user to set Headers

type GetRestoreOptions added in v2.2.0 

type GetRestoreOptions struct {
	// name of BackupVault that the restore occured on.
	BackupVaultName *string `json:"backup_vault_name" validate:"required,ne="`

	// id of the restore to introspect on.
	RestoreID *string `json:"restore_id" validate:"required,ne="`

	// Allows users to set headers on API requests.
	Headers map[string]string
}

GetRestoreOptions : The GetRestore options.

func (*GetRestoreOptions) SetBackupVaultName added in v2.2.0 

func (_options *GetRestoreOptions) SetBackupVaultName(backupVaultName string) *GetRestoreOptions

SetBackupVaultName : Allow user to set BackupVaultName

func (*GetRestoreOptions) SetHeaders added in v2.2.0 

func (options *GetRestoreOptions) SetHeaders(param map[string]string) *GetRestoreOptions

SetHeaders : Allow user to set Headers

func (*GetRestoreOptions) SetRestoreID added in v2.2.0 

func (_options *GetRestoreOptions) SetRestoreID(restoreID string) *GetRestoreOptions

SetRestoreID : Allow user to set RestoreID

type GetSourceResourceRecoveryRangeOptions added in v2.2.0 

type GetSourceResourceRecoveryRangeOptions struct {
	// name of BackupVault to update.
	BackupVaultName *string `json:"backup_vault_name" validate:"required,ne="`

	// ID of the RecoveryRange to update.
	RecoveryRangeID *string `json:"recovery_range_id" validate:"required,ne="`

	// Allows users to set headers on API requests.
	Headers map[string]string
}

GetSourceResourceRecoveryRangeOptions : The GetSourceResourceRecoveryRange options.

func (*GetSourceResourceRecoveryRangeOptions) SetBackupVaultName added in v2.2.0 

func (_options *GetSourceResourceRecoveryRangeOptions) SetBackupVaultName(backupVaultName string) *GetSourceResourceRecoveryRangeOptions

SetBackupVaultName : Allow user to set BackupVaultName

func (*GetSourceResourceRecoveryRangeOptions) SetHeaders added in v2.2.0 

func (options *GetSourceResourceRecoveryRangeOptions) SetHeaders(param map[string]string) *GetSourceResourceRecoveryRangeOptions

SetHeaders : Allow user to set Headers

func (*GetSourceResourceRecoveryRangeOptions) SetRecoveryRangeID added in v2.2.0 

func (_options *GetSourceResourceRecoveryRangeOptions) SetRecoveryRangeID(recoveryRangeID string) *GetSourceResourceRecoveryRangeOptions

SetRecoveryRangeID : Allow user to set RecoveryRangeID

type ListBackupPoliciesOptions added in v2.2.0 

type ListBackupPoliciesOptions struct {
	// Name of the COS Bucket name.
	Bucket *string `json:"bucket" validate:"required,ne="`

	// Allows users to set headers on API requests.
	Headers map[string]string
}

ListBackupPoliciesOptions : The ListBackupPolicies options.

func (*ListBackupPoliciesOptions) SetBucket added in v2.2.0 

func (_options *ListBackupPoliciesOptions) SetBucket(bucket string) *ListBackupPoliciesOptions

SetBucket : Allow user to set Bucket

func (*ListBackupPoliciesOptions) SetHeaders added in v2.2.0 

func (options *ListBackupPoliciesOptions) SetHeaders(param map[string]string) *ListBackupPoliciesOptions

SetHeaders : Allow user to set Headers

type ListBackupVaultsOptions added in v2.2.0 

type ListBackupVaultsOptions struct {
	// Name of the service_instance to list BackupVaults for.
	ServiceInstanceID *string `json:"service_instance_id" validate:"required"`

	// the continuation token for controlling pagination.
	Token *string `json:"token,omitempty"`

	// Allows users to set headers on API requests.
	Headers map[string]string
}

ListBackupVaultsOptions : The ListBackupVaults options.

func (*ListBackupVaultsOptions) SetHeaders added in v2.2.0 

func (options *ListBackupVaultsOptions) SetHeaders(param map[string]string) *ListBackupVaultsOptions

SetHeaders : Allow user to set Headers

func (*ListBackupVaultsOptions) SetServiceInstanceID added in v2.2.0 

func (_options *ListBackupVaultsOptions) SetServiceInstanceID(serviceInstanceID string) *ListBackupVaultsOptions

SetServiceInstanceID : Allow user to set ServiceInstanceID

func (*ListBackupVaultsOptions) SetToken added in v2.2.0 

func (_options *ListBackupVaultsOptions) SetToken(token string) *ListBackupVaultsOptions

SetToken : Allow user to set Token

type ListRecoveryRangesOptions added in v2.2.0 

type ListRecoveryRangesOptions struct {
	// name of BackupVault.
	BackupVaultName *string `json:"backup_vault_name" validate:"required,ne="`

	// CRN of source resource to filter on. This limits ranges returned to only ranges where the source_resource_crn
	// matches the parameter value.
	SourceResourceCrn *string `json:"source_resource_crn,omitempty"`

	// the continuation token for controlling pagination.
	Token *string `json:"token,omitempty"`

	// Allows users to set headers on API requests.
	Headers map[string]string
}

ListRecoveryRangesOptions : The ListRecoveryRanges options.

func (*ListRecoveryRangesOptions) SetBackupVaultName added in v2.2.0 

func (_options *ListRecoveryRangesOptions) SetBackupVaultName(backupVaultName string) *ListRecoveryRangesOptions

SetBackupVaultName : Allow user to set BackupVaultName

func (*ListRecoveryRangesOptions) SetHeaders added in v2.2.0 

func (options *ListRecoveryRangesOptions) SetHeaders(param map[string]string) *ListRecoveryRangesOptions

SetHeaders : Allow user to set Headers

func (*ListRecoveryRangesOptions) SetSourceResourceCrn added in v2.2.0 

func (_options *ListRecoveryRangesOptions) SetSourceResourceCrn(sourceResourceCrn string) *ListRecoveryRangesOptions

SetSourceResourceCrn : Allow user to set SourceResourceCrn

func (*ListRecoveryRangesOptions) SetToken added in v2.2.0 

func (_options *ListRecoveryRangesOptions) SetToken(token string) *ListRecoveryRangesOptions

SetToken : Allow user to set Token

type ListRestoresOptions added in v2.2.0 

type ListRestoresOptions struct {
	// name of BackupVault to restore from.
	BackupVaultName *string `json:"backup_vault_name" validate:"required,ne="`

	// the continuation token for controlling pagination.
	Token *string `json:"token,omitempty"`

	// Allows users to set headers on API requests.
	Headers map[string]string
}

ListRestoresOptions : The ListRestores options.

func (*ListRestoresOptions) SetBackupVaultName added in v2.2.0 

func (_options *ListRestoresOptions) SetBackupVaultName(backupVaultName string) *ListRestoresOptions

SetBackupVaultName : Allow user to set BackupVaultName

func (*ListRestoresOptions) SetHeaders added in v2.2.0 

func (options *ListRestoresOptions) SetHeaders(param map[string]string) *ListRestoresOptions

SetHeaders : Allow user to set Headers

func (*ListRestoresOptions) SetToken added in v2.2.0 

func (_options *ListRestoresOptions) SetToken(token string) *ListRestoresOptions

SetToken : Allow user to set Token

type MetricsMonitoring 

type MetricsMonitoring struct {
	// If set to `true`, all usage metrics (i.e. `bytes_used`) will be sent to the monitoring service.
	UsageMetricsEnabled *bool `json:"usage_metrics_enabled,omitempty"`

	// If set to `true`, all request metrics (i.e. `rest.object.head`) will be sent to the monitoring service.
	RequestMetricsEnabled *bool `json:"request_metrics_enabled,omitempty"`

	// When the `metrics_monitoring_crn` is not populated, then enabled metrics are sent to the monitoring instance
	// associated to the container's location unless otherwise specified in the Metrics Router service configuration. If
	// `metrics_monitoring_crn` is populated, then enabled events are sent to the Metrics Monitoring instance specified.
	MetricsMonitoringCrn *string `json:"metrics_monitoring_crn,omitempty"`
}

MetricsMonitoring : Enables sending metrics to IBM Cloud Monitoring. All metrics are opt-in. (Recommended) When the `metrics_monitoring_crn` is not populated, then enabled metrics are sent to the Monitoring instance at the container's location unless otherwise specified in the Metrics Router service configuration. (Legacy) When the `metrics_monitoring_crn` is populated, then enabled metrics are sent to the Monitoring instance defined in the `metrics_monitoring_crn` field.

type NextPagination added in v2.2.0 

type NextPagination struct {
	// A URL to the continuation of results.
	Href *string `json:"href" validate:"required"`

	// The continutation token utilized for paginated results.
	Token *string `json:"token" validate:"required"`
}

NextPagination : Pagination response body.

type ProtectionManagement added in v2.0.4 

type ProtectionManagement struct {
	// If set to `activate`, protection management action on the bucket is being activated.
	RequestedState *string `json:"requested_state,omitempty"`

	// This field is required when using requested_state\:`activate` and holds a JWT that is provided by the Cloud
	// Operator. This should be the encoded JWT.
	ProtectionManagementToken *string `json:"protection_management_token,omitempty"`
}

ProtectionManagement : Data structure holding protection management operations.

type ProtectionManagementResponse added in v2.0.4 

type ProtectionManagementResponse struct {
	// Indicates the X number of protection management tokens that have been applied to the bucket in its lifetime.
	TokenAppliedCounter *string `json:"token_applied_counter,omitempty"`

	// The 'protection management token list' holding a recent list of applied tokens. This list may contain a subset of
	// all tokens applied to the bucket, as indicated by the counter.
	TokenEntries []ProtectionManagementResponseTokenEntry `json:"token_entries,omitempty"`
}

ProtectionManagementResponse : Data structure holding protection management response.

type ProtectionManagementResponseTokenEntry added in v2.0.4 

type ProtectionManagementResponseTokenEntry struct {
	TokenID *string `json:"token_id,omitempty"`

	TokenExpirationTime *string `json:"token_expiration_time,omitempty"`

	TokenReferenceID *string `json:"token_reference_id,omitempty"`

	AppliedTime *string `json:"applied_time,omitempty"`

	InvalidatedTime *string `json:"invalidated_time,omitempty"`

	ExpirationTime *string `json:"expiration_time,omitempty"`

	ShortenRetentionFlag *bool `json:"shorten_retention_flag,omitempty"`
}

ProtectionManagementResponseTokenEntry : Data structure holding protection management token.

type RecoveryRange added in v2.2.0 

type RecoveryRange struct {
	// The CRN of the sourceResource backed up by this RecoveryRange.
	SourceResourceCrn *string `json:"source_resource_crn,omitempty"`

	// The name of the backupPolicy that triggered the creation of this RecoveryRange.
	BackupPolicyName *string `json:"backup_policy_name,omitempty"`

	// The point in time at which backup coverage of the sourceResource begins.
	//
	// Returns "YYYY-MM-DDTHH:mm:ss.sssZ" timestamp format.
	RangeStartTime *strfmt.DateTime `json:"range_start_time,omitempty"`

	// the point in time at which backup coverage of the sourceResource ends. Returns "YYYY-MM-DDTHH:mm:ss.sssZ" timestamp
	// format.
	RangeEndTime *strfmt.DateTime `json:"range_end_time,omitempty"`

	// The time at which this recoveryRange was initially created.
	//
	// Returns "YYYY-MM-DDTHH:mm:ss.sssZ" timestamp format
	//
	// NOTE : this can be before the start-time.
	RangeCreateTime *strfmt.DateTime `json:"range_create_time,omitempty"`

	// A UUID that uniquely identifies a resource.
	RecoveryRangeID *string `json:"recovery_range_id,omitempty"`
}

RecoveryRange : Metadata associated with a recovery range.

type RecoveryRangeCollection added in v2.2.0 

type RecoveryRangeCollection struct {
	// Pagination response body.
	Next *NextPagination `json:"next,omitempty"`

	// A list of recovery ranges.
	RecoveryRanges []RecoveryRange `json:"recovery_ranges,omitempty"`
}

RecoveryRangeCollection : A collection of recovery ranges.

func (*RecoveryRangeCollection) GetNextToken added in v2.2.0 

func (resp *RecoveryRangeCollection) GetNextToken() (*string, error)

Retrieve the value to be passed to a request to access the next page of results

type RecoveryRangesPager added in v2.2.0 

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

RecoveryRangesPager can be used to simplify the use of the "ListRecoveryRanges" method.

func (*RecoveryRangesPager) GetAll added in v2.2.0 

func (pager *RecoveryRangesPager) GetAll() (allItems []RecoveryRange, err error)

GetAll invokes GetAllWithContext() using context.Background() as the Context parameter.

func (*RecoveryRangesPager) GetAllWithContext added in v2.2.0 

func (pager *RecoveryRangesPager) GetAllWithContext(ctx context.Context) (allItems []RecoveryRange, err error)

GetAllWithContext returns all results by invoking GetNextWithContext() repeatedly until all pages of results have been retrieved.

func (*RecoveryRangesPager) GetNext added in v2.2.0 

func (pager *RecoveryRangesPager) GetNext() (page []RecoveryRange, err error)

GetNext invokes GetNextWithContext() using context.Background() as the Context parameter.

func (*RecoveryRangesPager) GetNextWithContext added in v2.2.0 

func (pager *RecoveryRangesPager) GetNextWithContext(ctx context.Context) (page []RecoveryRange, err error)

GetNextWithContext returns the next page of results using the specified Context.

func (*RecoveryRangesPager) HasNext added in v2.2.0 

func (pager *RecoveryRangesPager) HasNext() bool

HasNext returns true if there are potentially more results to be retrieved.

type ResourceConfigurationV1 

type ResourceConfigurationV1 struct {
	Service *core.BaseService
}

ResourceConfigurationV1 : REST API used to configure Cloud Object Storage buckets.

API Version: 1.0.0

func NewResourceConfigurationV1 

func NewResourceConfigurationV1(options *ResourceConfigurationV1Options) (service *ResourceConfigurationV1, err error)

NewResourceConfigurationV1 : constructs an instance of ResourceConfigurationV1 with passed in options.

func NewResourceConfigurationV1UsingExternalConfig 

func NewResourceConfigurationV1UsingExternalConfig(options *ResourceConfigurationV1Options) (resourceConfiguration *ResourceConfigurationV1, err error)

NewResourceConfigurationV1UsingExternalConfig : constructs an instance of ResourceConfigurationV1 with passed in options and external configuration.

func (*ResourceConfigurationV1) Clone 

func (resourceConfiguration *ResourceConfigurationV1) Clone() *ResourceConfigurationV1

Clone makes a copy of "resourceConfiguration" suitable for processing requests.

func (*ResourceConfigurationV1) CreateBackupPolicy added in v2.2.0 

func (resourceConfiguration *ResourceConfigurationV1) CreateBackupPolicy(createBackupPolicyOptions *CreateBackupPolicyOptions) (result *BackupPolicy, response *core.DetailedResponse, err error)

CreateBackupPolicy : Add a new backup policy to the COS Bucket Attach a new Backup Policy on a bucket.

This request results in the creation of a single, new RecoveryRange on the destination BackupVault.

Deletion and re-creation of a BackupPolicy to the same BackupVault destination will generate a new RecoveryRange.

The following shall be validated. Any failure to validate shall cause a HTTP 400 to be returned.

  • the user has `cloud-object-storage.bucket.post_backup_policy` permissions on the source-bucket
  • the source-bucket must have `cloud-object-storage.backup_vault.sync` permissions on the Backup Vault
  • the source-bucket must have versioning-on
  • the Backup Vault must exist and be able to be contacted by the source-bucket
  • the source-bucket must not have an existing BackupPolicy targeting the Backup Vault
  • the source-bucket must not have a BackupPolicy with the same policy_name
  • the source-bucket must have fewer than 3 total BackupPolicies

This request generates the "cloud-object-storage.bucket-backup-policy.create" ActivityTracking event.

func (*ResourceConfigurationV1) CreateBackupPolicyWithContext added in v2.2.0 

func (resourceConfiguration *ResourceConfigurationV1) CreateBackupPolicyWithContext(ctx context.Context, createBackupPolicyOptions *CreateBackupPolicyOptions) (result *BackupPolicy, response *core.DetailedResponse, err error)

CreateBackupPolicyWithContext is an alternate form of the CreateBackupPolicy method which supports a Context parameter

func (*ResourceConfigurationV1) CreateBackupVault added in v2.2.0 

func (resourceConfiguration *ResourceConfigurationV1) CreateBackupVault(createBackupVaultOptions *CreateBackupVaultOptions) (result *BackupVault, response *core.DetailedResponse, err error)

CreateBackupVault : create a BackupVault Creates a BackupVault.

Requires that the user has `cloud-object-storage.backup_vault.post_backup_vault` permissions for the account.

Certain fields will be returned only if the user has specific permissions:

  • `activity_tracking` requires `cloud-object-storage.backup_vault.put_activity_tracking`
  • `metrics_monitoring` requires `cloud-object-storage.backup_vault.put_metrics_monitoring`

This request generates the "cloud-object-storage.backup-vault.create" ActivityTracking event.

func (*ResourceConfigurationV1) CreateBackupVaultWithContext added in v2.2.0 

func (resourceConfiguration *ResourceConfigurationV1) CreateBackupVaultWithContext(ctx context.Context, createBackupVaultOptions *CreateBackupVaultOptions) (result *BackupVault, response *core.DetailedResponse, err error)

CreateBackupVaultWithContext is an alternate form of the CreateBackupVault method which supports a Context parameter

func (*ResourceConfigurationV1) CreateRestore added in v2.2.0 

func (resourceConfiguration *ResourceConfigurationV1) CreateRestore(createRestoreOptions *CreateRestoreOptions) (result *Restore, response *core.DetailedResponse, err error)

CreateRestore : Initiate a Restore Initiates a restore operation against some RecoveryRange to some destination bucket.

The following shall be validated. Any failure to validate shall cause a HTTP 400 to be returned.

  • The specified RecoveryRange must exist
  • The restore time must be within the RecoveryRange
  • the user has `cloud-object-storage.backup-vault.post_restore` permissions on the backup-vault
  • the target-bucket must exist and be able to be contacted by the Backup Vault
  • target-bucket must have versioning-on
  • the Backup Vault must have `cloud-object-storage.bucket.restore_sync` permissions on the target-bucket

This request generates the "cloud-object-storage.backup-restore.create" ActivityTracking event.

func (*ResourceConfigurationV1) CreateRestoreWithContext added in v2.2.0 

func (resourceConfiguration *ResourceConfigurationV1) CreateRestoreWithContext(ctx context.Context, createRestoreOptions *CreateRestoreOptions) (result *Restore, response *core.DetailedResponse, err error)

CreateRestoreWithContext is an alternate form of the CreateRestore method which supports a Context parameter

func (*ResourceConfigurationV1) DeleteBackupPolicy added in v2.2.0 

func (resourceConfiguration *ResourceConfigurationV1) DeleteBackupPolicy(deleteBackupPolicyOptions *DeleteBackupPolicyOptions) (response *core.DetailedResponse, err error)

DeleteBackupPolicy : Delete a BackupPolicy Delete a specific BackupPolicy.

Requires that the user has `cloud-object-storage.bucket.delete_backup_policy` permissions on the bucket.

This request generates the "cloud-object-storage.bucket-backup-policy.delete" ActivityTracking event.

func (*ResourceConfigurationV1) DeleteBackupPolicyWithContext added in v2.2.0 

func (resourceConfiguration *ResourceConfigurationV1) DeleteBackupPolicyWithContext(ctx context.Context, deleteBackupPolicyOptions *DeleteBackupPolicyOptions) (response *core.DetailedResponse, err error)

DeleteBackupPolicyWithContext is an alternate form of the DeleteBackupPolicy method which supports a Context parameter

func (*ResourceConfigurationV1) DeleteBackupVault added in v2.2.0 

func (resourceConfiguration *ResourceConfigurationV1) DeleteBackupVault(deleteBackupVaultOptions *DeleteBackupVaultOptions) (response *core.DetailedResponse, err error)

DeleteBackupVault : Delete an empty Backup Vault Delete the Backup Vault.

Requires that the BackupVault not contain any RecoveryRanges. Requires that the user has `cloud-object-storage.backup_vault.delete_backup_vault` permissions for the account.

This request generates the "cloud-object-storage.backup-vault.delete" ActivityTracking event.

func (*ResourceConfigurationV1) DeleteBackupVaultWithContext added in v2.2.0 

func (resourceConfiguration *ResourceConfigurationV1) DeleteBackupVaultWithContext(ctx context.Context, deleteBackupVaultOptions *DeleteBackupVaultOptions) (response *core.DetailedResponse, err error)

DeleteBackupVaultWithContext is an alternate form of the DeleteBackupVault method which supports a Context parameter

func (*ResourceConfigurationV1) DisableRetries 

func (resourceConfiguration *ResourceConfigurationV1) DisableRetries()

DisableRetries disables automatic retries for requests invoked for this service instance.

func (*ResourceConfigurationV1) EnableRetries 

func (resourceConfiguration *ResourceConfigurationV1) EnableRetries(maxRetries int, maxRetryInterval time.Duration)

EnableRetries enables automatic retries for requests invoked for this service instance. If either parameter is specified as 0, then a default value is used instead.

func (*ResourceConfigurationV1) GetBackupPolicy added in v2.2.0 

func (resourceConfiguration *ResourceConfigurationV1) GetBackupPolicy(getBackupPolicyOptions *GetBackupPolicyOptions) (result *BackupPolicy, response *core.DetailedResponse, err error)

GetBackupPolicy : Get BackupPolicy Read a specific backup policy on a bucket.

Requires that the user has `cloud-object-storage.bucket.get_backup_policy` permissions on the bucket.

This request generates the "cloud-object-storage.bucket-backup-policy.read" ActivityTracking event.

func (*ResourceConfigurationV1) GetBackupPolicyWithContext added in v2.2.0 

func (resourceConfiguration *ResourceConfigurationV1) GetBackupPolicyWithContext(ctx context.Context, getBackupPolicyOptions *GetBackupPolicyOptions) (result *BackupPolicy, response *core.DetailedResponse, err error)

GetBackupPolicyWithContext is an alternate form of the GetBackupPolicy method which supports a Context parameter

func (*ResourceConfigurationV1) GetBackupVault added in v2.2.0 

func (resourceConfiguration *ResourceConfigurationV1) GetBackupVault(getBackupVaultOptions *GetBackupVaultOptions) (result *BackupVault, response *core.DetailedResponse, err error)

GetBackupVault : get the config for a Backup Vault Gets configuration information for a Backup Vault.

Requires that the user has `cloud-object-storage.backup_vault.get_basic` permissions on the backup vault.

Certain fields will be returned only if the user has specific permissions:

  • `activity_tracking` requires `cloud-object-storage.backup_vault.get_activity_tracking`
  • `metrics_monitoring` requires `cloud-object-storage.backup_vault.get_metrics_monitoring`
  • `sse_kp_customer_root_key_crn` requires `cloud-object-storage.backup_vault.get_crk_id`

This request generates the "cloud-object-storage.backup-vault-configuration.read" ActivityTracking event.

func (*ResourceConfigurationV1) GetBackupVaultWithContext added in v2.2.0 

func (resourceConfiguration *ResourceConfigurationV1) GetBackupVaultWithContext(ctx context.Context, getBackupVaultOptions *GetBackupVaultOptions) (result *BackupVault, response *core.DetailedResponse, err error)

GetBackupVaultWithContext is an alternate form of the GetBackupVault method which supports a Context parameter

func (*ResourceConfigurationV1) GetBucketConfig 

func (resourceConfiguration *ResourceConfigurationV1) GetBucketConfig(getBucketConfigOptions *GetBucketConfigOptions) (result *Bucket, response *core.DetailedResponse, err error)

GetBucketConfig : Returns metadata for the specified bucket Returns metadata for the specified bucket.

func (*ResourceConfigurationV1) GetBucketConfigWithContext 

func (resourceConfiguration *ResourceConfigurationV1) GetBucketConfigWithContext(ctx context.Context, getBucketConfigOptions *GetBucketConfigOptions) (result *Bucket, response *core.DetailedResponse, err error)

GetBucketConfigWithContext is an alternate form of the GetBucketConfig method which supports a Context parameter

func (*ResourceConfigurationV1) GetEnableGzipCompression 

func (resourceConfiguration *ResourceConfigurationV1) GetEnableGzipCompression() bool

GetEnableGzipCompression returns the service's EnableGzipCompression field

func (*ResourceConfigurationV1) GetRestore added in v2.2.0 

func (resourceConfiguration *ResourceConfigurationV1) GetRestore(getRestoreOptions *GetRestoreOptions) (result *Restore, response *core.DetailedResponse, err error)

GetRestore : Get Restore Introspect on a specific restore.

Requires that the user have `cloud-object-storage.backup_vault.get_restore` permission on the backup vault.

This request generates the "cloud-object-storage.backup-restore.read" ActivityTracking event.

func (*ResourceConfigurationV1) GetRestoreWithContext added in v2.2.0 

func (resourceConfiguration *ResourceConfigurationV1) GetRestoreWithContext(ctx context.Context, getRestoreOptions *GetRestoreOptions) (result *Restore, response *core.DetailedResponse, err error)

GetRestoreWithContext is an alternate form of the GetRestore method which supports a Context parameter

func (*ResourceConfigurationV1) GetServiceURL 

func (resourceConfiguration *ResourceConfigurationV1) GetServiceURL() string

GetServiceURL returns the service URL

func (*ResourceConfigurationV1) GetSourceResourceRecoveryRange added in v2.2.0 

func (resourceConfiguration *ResourceConfigurationV1) GetSourceResourceRecoveryRange(getSourceResourceRecoveryRangeOptions *GetSourceResourceRecoveryRangeOptions) (result *RecoveryRange, response *core.DetailedResponse, err error)

GetSourceResourceRecoveryRange : get RecoveryRange info Get info for a specific RecoveryRange.

Requires the user have `cloud-object-storage.backup_vault.get_recovery_range` permissions to the Backup Vault.

This request generates the "cloud-object-storage.backup-recovery-range.read" ActivityTracking event.

func (*ResourceConfigurationV1) GetSourceResourceRecoveryRangeWithContext added in v2.2.0 

func (resourceConfiguration *ResourceConfigurationV1) GetSourceResourceRecoveryRangeWithContext(ctx context.Context, getSourceResourceRecoveryRangeOptions *GetSourceResourceRecoveryRangeOptions) (result *RecoveryRange, response *core.DetailedResponse, err error)

GetSourceResourceRecoveryRangeWithContext is an alternate form of the GetSourceResourceRecoveryRange method which supports a Context parameter

func (*ResourceConfigurationV1) ListBackupPolicies added in v2.2.0 

func (resourceConfiguration *ResourceConfigurationV1) ListBackupPolicies(listBackupPoliciesOptions *ListBackupPoliciesOptions) (result *BackupPolicyCollection, response *core.DetailedResponse, err error)

ListBackupPolicies : List BackupPolicies Get all backup policies on a bucket.

Requires that the user has `cloud-object-storage.bucket.list_backup_policies` permissions on the source bucket.

This request generates the "cloud-object-storage.bucket-backup-policy.list" ActivityTracking event.

func (*ResourceConfigurationV1) ListBackupPoliciesWithContext added in v2.2.0 

func (resourceConfiguration *ResourceConfigurationV1) ListBackupPoliciesWithContext(ctx context.Context, listBackupPoliciesOptions *ListBackupPoliciesOptions) (result *BackupPolicyCollection, response *core.DetailedResponse, err error)

ListBackupPoliciesWithContext is an alternate form of the ListBackupPolicies method which supports a Context parameter

func (*ResourceConfigurationV1) ListBackupVaults added in v2.2.0 

func (resourceConfiguration *ResourceConfigurationV1) ListBackupVaults(listBackupVaultsOptions *ListBackupVaultsOptions) (result *BackupVaultCollection, response *core.DetailedResponse, err error)

ListBackupVaults : list BackupVaults Returns a list of BackupVault CRNs owned by the account.

Requires that the user has `cloud-object-storage.backup_vault.list_account_backup_vaults` permissions for the account.

This request generates the "cloud-object-storage.backup-vault.list" ActivityTracking event.

func (*ResourceConfigurationV1) ListBackupVaultsWithContext added in v2.2.0 

func (resourceConfiguration *ResourceConfigurationV1) ListBackupVaultsWithContext(ctx context.Context, listBackupVaultsOptions *ListBackupVaultsOptions) (result *BackupVaultCollection, response *core.DetailedResponse, err error)

ListBackupVaultsWithContext is an alternate form of the ListBackupVaults method which supports a Context parameter

func (*ResourceConfigurationV1) ListRecoveryRanges added in v2.2.0 

func (resourceConfiguration *ResourceConfigurationV1) ListRecoveryRanges(listRecoveryRangesOptions *ListRecoveryRangesOptions) (result *RecoveryRangeCollection, response *core.DetailedResponse, err error)

ListRecoveryRanges : List RecoveryRanges on a backup vault List RecoveryRanges on a backup vault. Lists all available ranges for all source resources by default. The `?source_resource_crn` query parameter will limit the list to only ranges for the specified resource.

Requires the user have `cloud-object-storage.backup_vault.list_recovery_ranges` permissions to the Backup Vault.

This request generates the "cloud-object-storage.backup-recovery-range.list" ActivityTracking event.

func (*ResourceConfigurationV1) ListRecoveryRangesWithContext added in v2.2.0 

func (resourceConfiguration *ResourceConfigurationV1) ListRecoveryRangesWithContext(ctx context.Context, listRecoveryRangesOptions *ListRecoveryRangesOptions) (result *RecoveryRangeCollection, response *core.DetailedResponse, err error)

ListRecoveryRangesWithContext is an alternate form of the ListRecoveryRanges method which supports a Context parameter

func (*ResourceConfigurationV1) ListRestores added in v2.2.0 

func (resourceConfiguration *ResourceConfigurationV1) ListRestores(listRestoresOptions *ListRestoresOptions) (result *RestoreCollection, response *core.DetailedResponse, err error)

ListRestores : List Restores List all current and complete restores.

Requires that the user have `cloud-object-storage.backup_vault.list_restores` permission on the backup vault.

This request generates the "cloud-object-storage.backup-restore.list" ActivityTracking event.

func (*ResourceConfigurationV1) ListRestoresWithContext added in v2.2.0 

func (resourceConfiguration *ResourceConfigurationV1) ListRestoresWithContext(ctx context.Context, listRestoresOptions *ListRestoresOptions) (result *RestoreCollection, response *core.DetailedResponse, err error)

ListRestoresWithContext is an alternate form of the ListRestores method which supports a Context parameter

func (*ResourceConfigurationV1) NewBackupVaultsPager added in v2.2.0 

func (resourceConfiguration *ResourceConfigurationV1) NewBackupVaultsPager(options *ListBackupVaultsOptions) (pager *BackupVaultsPager, err error)

NewBackupVaultsPager returns a new BackupVaultsPager instance.

func (*ResourceConfigurationV1) NewCreateBackupPolicyOptions added in v2.2.0 

func (*ResourceConfigurationV1) NewCreateBackupPolicyOptions(bucket string, policyName string, targetBackupVaultCrn string, backupType string) *CreateBackupPolicyOptions

NewCreateBackupPolicyOptions : Instantiate CreateBackupPolicyOptions

func (*ResourceConfigurationV1) NewCreateBackupVaultOptions added in v2.2.0 

func (*ResourceConfigurationV1) NewCreateBackupVaultOptions(serviceInstanceID string, backupVaultName string, region string) *CreateBackupVaultOptions

NewCreateBackupVaultOptions : Instantiate CreateBackupVaultOptions

func (*ResourceConfigurationV1) NewCreateRestoreOptions added in v2.2.0 

func (*ResourceConfigurationV1) NewCreateRestoreOptions(backupVaultName string, recoveryRangeID string, restoreType string, restorePointInTime *strfmt.DateTime, targetResourceCrn string) *CreateRestoreOptions

NewCreateRestoreOptions : Instantiate CreateRestoreOptions

func (*ResourceConfigurationV1) NewDeleteBackupPolicyOptions added in v2.2.0 

func (*ResourceConfigurationV1) NewDeleteBackupPolicyOptions(bucket string, policyID string) *DeleteBackupPolicyOptions

NewDeleteBackupPolicyOptions : Instantiate DeleteBackupPolicyOptions

func (*ResourceConfigurationV1) NewDeleteBackupVaultOptions added in v2.2.0 

func (*ResourceConfigurationV1) NewDeleteBackupVaultOptions(backupVaultName string) *DeleteBackupVaultOptions

NewDeleteBackupVaultOptions : Instantiate DeleteBackupVaultOptions

func (*ResourceConfigurationV1) NewGetBackupPolicyOptions added in v2.2.0 

func (*ResourceConfigurationV1) NewGetBackupPolicyOptions(bucket string, policyID string) *GetBackupPolicyOptions

NewGetBackupPolicyOptions : Instantiate GetBackupPolicyOptions

func (*ResourceConfigurationV1) NewGetBackupVaultOptions added in v2.2.0 

func (*ResourceConfigurationV1) NewGetBackupVaultOptions(backupVaultName string) *GetBackupVaultOptions

NewGetBackupVaultOptions : Instantiate GetBackupVaultOptions

func (*ResourceConfigurationV1) NewGetBucketConfigOptions 

func (*ResourceConfigurationV1) NewGetBucketConfigOptions(bucket string) *GetBucketConfigOptions

NewGetBucketConfigOptions : Instantiate GetBucketConfigOptions

func (*ResourceConfigurationV1) NewGetRestoreOptions added in v2.2.0 

func (*ResourceConfigurationV1) NewGetRestoreOptions(backupVaultName string, restoreID string) *GetRestoreOptions

NewGetRestoreOptions : Instantiate GetRestoreOptions

func (*ResourceConfigurationV1) NewGetSourceResourceRecoveryRangeOptions added in v2.2.0 

func (*ResourceConfigurationV1) NewGetSourceResourceRecoveryRangeOptions(backupVaultName string, recoveryRangeID string) *GetSourceResourceRecoveryRangeOptions

NewGetSourceResourceRecoveryRangeOptions : Instantiate GetSourceResourceRecoveryRangeOptions

func (*ResourceConfigurationV1) NewListBackupPoliciesOptions added in v2.2.0 

func (*ResourceConfigurationV1) NewListBackupPoliciesOptions(bucket string) *ListBackupPoliciesOptions

NewListBackupPoliciesOptions : Instantiate ListBackupPoliciesOptions

func (*ResourceConfigurationV1) NewListBackupVaultsOptions added in v2.2.0 

func (*ResourceConfigurationV1) NewListBackupVaultsOptions(serviceInstanceID string) *ListBackupVaultsOptions

NewListBackupVaultsOptions : Instantiate ListBackupVaultsOptions

func (*ResourceConfigurationV1) NewListRecoveryRangesOptions added in v2.2.0 

func (*ResourceConfigurationV1) NewListRecoveryRangesOptions(backupVaultName string) *ListRecoveryRangesOptions

NewListRecoveryRangesOptions : Instantiate ListRecoveryRangesOptions

func (*ResourceConfigurationV1) NewListRestoresOptions added in v2.2.0 

func (*ResourceConfigurationV1) NewListRestoresOptions(backupVaultName string) *ListRestoresOptions

NewListRestoresOptions : Instantiate ListRestoresOptions

func (*ResourceConfigurationV1) NewRecoveryRangesPager added in v2.2.0 

func (resourceConfiguration *ResourceConfigurationV1) NewRecoveryRangesPager(options *ListRecoveryRangesOptions) (pager *RecoveryRangesPager, err error)

NewRecoveryRangesPager returns a new RecoveryRangesPager instance.

func (*ResourceConfigurationV1) NewRestoresPager added in v2.2.0 

func (resourceConfiguration *ResourceConfigurationV1) NewRestoresPager(options *ListRestoresOptions) (pager *RestoresPager, err error)

NewRestoresPager returns a new RestoresPager instance.

func (*ResourceConfigurationV1) NewUpdateBackupVaultOptions added in v2.2.0 

func (*ResourceConfigurationV1) NewUpdateBackupVaultOptions(backupVaultName string, backupVaultPatch map[string]interface{}) *UpdateBackupVaultOptions

NewUpdateBackupVaultOptions : Instantiate UpdateBackupVaultOptions

func (*ResourceConfigurationV1) NewUpdateBucketConfigOptions 

func (*ResourceConfigurationV1) NewUpdateBucketConfigOptions(bucket string) *UpdateBucketConfigOptions

NewUpdateBucketConfigOptions : Instantiate UpdateBucketConfigOptions

func (*ResourceConfigurationV1) SetDefaultHeaders 

func (resourceConfiguration *ResourceConfigurationV1) SetDefaultHeaders(headers http.Header)

SetDefaultHeaders sets HTTP headers to be sent in every request

func (*ResourceConfigurationV1) SetEnableGzipCompression 

func (resourceConfiguration *ResourceConfigurationV1) SetEnableGzipCompression(enableGzip bool)

SetEnableGzipCompression sets the service's EnableGzipCompression field

func (*ResourceConfigurationV1) SetServiceURL 

func (resourceConfiguration *ResourceConfigurationV1) SetServiceURL(url string) error

SetServiceURL sets the service URL

func (*ResourceConfigurationV1) UpdateBackupVault added in v2.2.0 

func (resourceConfiguration *ResourceConfigurationV1) UpdateBackupVault(updateBackupVaultOptions *UpdateBackupVaultOptions) (result *BackupVault, response *core.DetailedResponse, err error)

UpdateBackupVault : Update the config on a Backup Vault Update the Backup Vault config via JSON Merge Patch update semantics.

In particular, note that providing an empty object (`{}`) to either field in the request body will remove any existing configuration.

Requires that the user has `cloud-object-storage.backup_vault.get_basic` permissions on the backup vault.

Certain fields can be modified only if the user has specific permissions:

  • `activity_tracking` requires `cloud-object-storage.backup_vault.put_activity_tracking`
  • `metrics_monitoring` requires `cloud-object-storage.backup_vault.put_metrics_monitoring`

This request generates the "cloud-object-storage.backup-vault-configuration.update" ActivityTracking event.

func (*ResourceConfigurationV1) UpdateBackupVaultWithContext added in v2.2.0 

func (resourceConfiguration *ResourceConfigurationV1) UpdateBackupVaultWithContext(ctx context.Context, updateBackupVaultOptions *UpdateBackupVaultOptions) (result *BackupVault, response *core.DetailedResponse, err error)

UpdateBackupVaultWithContext is an alternate form of the UpdateBackupVault method which supports a Context parameter

func (*ResourceConfigurationV1) UpdateBucketConfig 

func (resourceConfiguration *ResourceConfigurationV1) UpdateBucketConfig(updateBucketConfigOptions *UpdateBucketConfigOptions) (response *core.DetailedResponse, err error)

UpdateBucketConfig : Make changes to a bucket's configuration Updates a bucket using [JSON Merge Patch](https://tools.ietf.org/html/rfc7396). This request is used to add functionality (like an IP access filter) or to update existing parameters. **Primitives are overwritten and replaced in their entirety. It is not possible to append a new (or to delete a specific) value to an array.** Arrays can be cleared by updating the parameter with an empty array `[]`. A `PATCH` operation only updates specified mutable fields. Please don't use `PATCH` trying to update the number of objects in a bucket, any timestamps, or other non-mutable fields.

func (*ResourceConfigurationV1) UpdateBucketConfigWithContext 

func (resourceConfiguration *ResourceConfigurationV1) UpdateBucketConfigWithContext(ctx context.Context, updateBucketConfigOptions *UpdateBucketConfigOptions) (response *core.DetailedResponse, err error)

UpdateBucketConfigWithContext is an alternate form of the UpdateBucketConfig method which supports a Context parameter

type ResourceConfigurationV1Options 

type ResourceConfigurationV1Options struct {
	ServiceName   string
	URL           string
	Authenticator core.Authenticator
}

ResourceConfigurationV1Options : Service options

type Restore added in v2.2.0 

type Restore struct {
	// A UUID that uniquely identifies a resource.
	RecoveryRangeID *string `json:"recovery_range_id" validate:"required"`

	// The type of restore to support. More options will be available in the future.
	RestoreType *string `json:"restore_type" validate:"required"`

	// Timestamp format used throughout the API.
	//
	// Accepts the following formats:
	//
	// YYYY-MM-DDTHH:mm:ssZ YYYY-MM-DDTHH:mm:ss YYYY-MM-DDTHH:mm:ss-hh:mm YYYY-MM-DDTHH:mm:ss+hh:mm
	// YYYY-MM-DDTHH:mm:ss.sssZ YYYY-MM-DDTHH:mm:ss.sss YYYY-MM-DDTHH:mm:ss.sss-hh:mm YYYY-MM-DDTHH:mm:ss.sss+hh:mm.
	RestorePointInTime *strfmt.DateTime `json:"restore_point_in_time" validate:"required"`

	// The CRN for a COS Bucket.
	//
	// Note that Softlayer CRNs do not contain dashes within the service_instance_id, whereas regular CRNs do. Although
	// bucket backup is not supported for softlayer accounts, this need not be enforced at the CRN parsing level.
	TargetResourceCrn *string `json:"target_resource_crn" validate:"required"`

	// The name of the source resource that is being restored from.
	SourceResourceCrn *string `json:"source_resource_crn,omitempty"`

	// Unique system-defined UUID for this restore operation.
	RestoreID *string `json:"restore_id,omitempty"`

	// The current status for this restore operation.
	//
	// initializing: The operation is initializing. Do not expect to see restored objects on the target bucket.  running :
	// The operation is ongoing. Expect to see some restored objects on the target bucket.  complete: The operation has
	// completed successfully.  failed: The operation has completed unsuccessfully.
	RestoreStatus *string `json:"restore_status,omitempty"`

	// The time at which this restore was initiated Returns "YYYY-MM-DDTHH:mm:ss.sssZ" timestamp format.
	InitTime *strfmt.DateTime `json:"init_time,omitempty"`

	// The time at which this restore ended (in both success and error cases) Returns "YYYY-MM-DDTHH:mm:ss.sssZ" timestamp
	// format.
	CompleteTime *strfmt.DateTime `json:"complete_time,omitempty"`

	// reports percent-doneness of init. Only present when restore_status=running.
	RestorePercentProgress *int64 `json:"restore_percent_progress,omitempty"`

	// Only present when restore_status=running.
	ErrorCause *string `json:"error_cause,omitempty"`
}

Restore : Metadata associated with a requested restore operation.

type RestoreCollection added in v2.2.0 

type RestoreCollection struct {
	// Pagination response body.
	Next *NextPagination `json:"next,omitempty"`

	// A collection of active and completed restore operations.
	Restores []Restore `json:"restores,omitempty"`
}

RestoreCollection : A list of restore operations.

func (*RestoreCollection) GetNextToken added in v2.2.0 

func (resp *RestoreCollection) GetNextToken() (*string, error)

Retrieve the value to be passed to a request to access the next page of results

type RestoresPager added in v2.2.0 

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

RestoresPager can be used to simplify the use of the "ListRestores" method.

func (*RestoresPager) GetAll added in v2.2.0 

func (pager *RestoresPager) GetAll() (allItems []Restore, err error)

GetAll invokes GetAllWithContext() using context.Background() as the Context parameter.

func (*RestoresPager) GetAllWithContext added in v2.2.0 

func (pager *RestoresPager) GetAllWithContext(ctx context.Context) (allItems []Restore, err error)

GetAllWithContext returns all results by invoking GetNextWithContext() repeatedly until all pages of results have been retrieved.

func (*RestoresPager) GetNext added in v2.2.0 

func (pager *RestoresPager) GetNext() (page []Restore, err error)

GetNext invokes GetNextWithContext() using context.Background() as the Context parameter.

func (*RestoresPager) GetNextWithContext added in v2.2.0 

func (pager *RestoresPager) GetNextWithContext(ctx context.Context) (page []Restore, err error)

GetNextWithContext returns the next page of results using the specified Context.

func (*RestoresPager) HasNext added in v2.2.0 

func (pager *RestoresPager) HasNext() bool

HasNext returns true if there are potentially more results to be retrieved.

type UpdateBackupVaultOptions added in v2.2.0 

type UpdateBackupVaultOptions struct {
	// Name of the backup-vault to create or update.
	BackupVaultName *string `json:"backup_vault_name" validate:"required,ne="`

	// A Backup Vault config object containing changes to apply to the existing Backup Vault config.
	BackupVaultPatch map[string]interface{} `json:"BackupVault_patch" validate:"required"`

	// Conditionally update the Backup Vault config if and only if the ETag of the existing config exactly matches the
	// provided If-Match MD5.
	IfMatch *string `json:"If-Match,omitempty"`

	// Allows users to set headers on API requests.
	Headers map[string]string
}

UpdateBackupVaultOptions : The UpdateBackupVault options.

func (*UpdateBackupVaultOptions) SetBackupVaultName added in v2.2.0 

func (_options *UpdateBackupVaultOptions) SetBackupVaultName(backupVaultName string) *UpdateBackupVaultOptions

SetBackupVaultName : Allow user to set BackupVaultName

func (*UpdateBackupVaultOptions) SetBackupVaultPatch added in v2.2.0 

func (_options *UpdateBackupVaultOptions) SetBackupVaultPatch(backupVaultPatch map[string]interface{}) *UpdateBackupVaultOptions

SetBackupVaultPatch : Allow user to set BackupVaultPatch

func (*UpdateBackupVaultOptions) SetHeaders added in v2.2.0 

func (options *UpdateBackupVaultOptions) SetHeaders(param map[string]string) *UpdateBackupVaultOptions

SetHeaders : Allow user to set Headers

func (*UpdateBackupVaultOptions) SetIfMatch added in v2.2.0 

func (_options *UpdateBackupVaultOptions) SetIfMatch(ifMatch string) *UpdateBackupVaultOptions

SetIfMatch : Allow user to set IfMatch

type UpdateBucketConfigOptions 

type UpdateBucketConfigOptions struct {
	// Name of a bucket.
	Bucket *string `json:"bucket" validate:"required,ne="`

	// An object containing new configuration metadata.
	BucketPatch map[string]interface{} `json:"Bucket_patch,omitempty"`

	// An Etag previously returned in a header when fetching or updating a bucket's metadata. If this value does not match
	// the active Etag, the request will fail.
	IfMatch *string `json:"If-Match,omitempty"`

	// Allows users to set headers on API requests.
	Headers map[string]string
}

UpdateBucketConfigOptions : The UpdateBucketConfig options.

func (*UpdateBucketConfigOptions) SetBucket 

func (_options *UpdateBucketConfigOptions) SetBucket(bucket string) *UpdateBucketConfigOptions

SetBucket : Allow user to set Bucket

func (*UpdateBucketConfigOptions) SetBucketPatch 

func (_options *UpdateBucketConfigOptions) SetBucketPatch(bucketPatch map[string]interface{}) *UpdateBucketConfigOptions

SetBucketPatch : Allow user to set BucketPatch

func (*UpdateBucketConfigOptions) SetHeaders 

func (options *UpdateBucketConfigOptions) SetHeaders(param map[string]string) *UpdateBucketConfigOptions

SetHeaders : Allow user to set Headers

func (*UpdateBucketConfigOptions) SetIfMatch 

func (_options *UpdateBucketConfigOptions) SetIfMatch(ifMatch string) *UpdateBucketConfigOptions

SetIfMatch : Allow user to set IfMatch

Source Files

View all Source files

Jump to

Keyboard shortcuts

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