restore

package

v1.0.6 Latest Latest Go to latest Published: Jan 29, 2026 License: Apache-2.0 Imports: 3 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/Scorpio69t/rustfs-go

Links

Open Source Insights

Documentation ¶

Overview ¶

Package restore provides archived object restore request types.

Package restore provides restore request types for archived objects.

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

This section is empty.

Types ¶

type Encryption ¶

type Encryption struct {
	EncryptionType string `xml:"EncryptionType,omitempty"`
	KMSContext     string `xml:"KMSContext,omitempty"`
	KMSKeyID       string `xml:"KMSKeyId,omitempty"`
}

Encryption describes the server-side encryption for the restored object copy.

type GlacierJobParameters ¶

type GlacierJobParameters struct {
	Tier TierType `xml:"Tier,omitempty"`
}

GlacierJobParameters represents the retrieval tier parameter.

type MetadataEntry ¶

type MetadataEntry struct {
	Name  string `xml:"Name,omitempty"`
	Value string `xml:"Value,omitempty"`
}

MetadataEntry represents a metadata entry for restore output.

type OutputLocation ¶

type OutputLocation struct {
	XMLName xml.Name `xml:"OutputLocation"`
	S3      S3       `xml:"S3"`
}

OutputLocation holds properties of the copy of the archived object.

type RestoreRequest ¶

type RestoreRequest struct {
	XMLName xml.Name `xml:"RestoreRequest"`
	XMLNS   string   `xml:"xmlns,attr,omitempty"`

	Type                 *RestoreType          `xml:"Type,omitempty"`
	Tier                 *TierType             `xml:"Tier,omitempty"`
	Days                 *int                  `xml:"Days,omitempty"`
	GlacierJobParameters *GlacierJobParameters `xml:"GlacierJobParameters,omitempty"`
	Description          *string               `xml:"Description,omitempty"`
	SelectParameters     *SelectParameters     `xml:"SelectParameters,omitempty"`
	OutputLocation       *OutputLocation       `xml:"OutputLocation,omitempty"`
}

RestoreRequest describes a restore object request.

func (*RestoreRequest) Normalize ¶

func (r *RestoreRequest) Normalize()

Normalize ensures required XML defaults.

func (*RestoreRequest) SetDays ¶

func (r *RestoreRequest) SetDays(v int)

SetDays sets the days parameter of the restore request.

func (*RestoreRequest) SetDescription ¶

func (r *RestoreRequest) SetDescription(v string)

SetDescription sets the description of the restore request.

func (*RestoreRequest) SetGlacierJobParameters ¶

func (r *RestoreRequest) SetGlacierJobParameters(v GlacierJobParameters)

SetGlacierJobParameters sets the GlacierJobParameters of the restore request.

func (*RestoreRequest) SetOutputLocation ¶

func (r *RestoreRequest) SetOutputLocation(v OutputLocation)

SetOutputLocation sets the properties of the copy of the archived object.

func (*RestoreRequest) SetSelectParameters ¶

func (r *RestoreRequest) SetSelectParameters(v SelectParameters)

SetSelectParameters sets SelectParameters of the restore select request.

func (*RestoreRequest) SetTier ¶

func (r *RestoreRequest) SetTier(v TierType)

SetTier sets the retrieval tier of the restore request.

func (*RestoreRequest) SetType ¶

func (r *RestoreRequest) SetType(v RestoreType)

SetType sets the type of the restore request.

type RestoreType ¶

type RestoreType string

RestoreType represents the restore request type.

const (
	// RestoreSelect represents a select restore operation.
	RestoreSelect RestoreType = "SELECT"
)

type S3 ¶

type S3 struct {
	AccessControlList *acl.ACL       `xml:"AccessControlPolicy,omitempty"`
	BucketName        string         `xml:"BucketName,omitempty"`
	Prefix            string         `xml:"Prefix,omitempty"`
	CannedACL         *string        `xml:"CannedACL,omitempty"`
	Encryption        *Encryption    `xml:"Encryption,omitempty"`
	StorageClass      *string        `xml:"StorageClass,omitempty"`
	Tagging           *Tagging       `xml:"Tagging,omitempty"`
	UserMetadata      *MetadataEntry `xml:"UserMetadata,omitempty"`
}

S3 holds properties of the restored object copy.

type SelectParameters ¶

type SelectParameters struct {
	XMLName             xml.Name                     `xml:"SelectParameters"`
	ExpressionType      s3select.QueryExpressionType `xml:"ExpressionType"`
	Expression          string                       `xml:"Expression"`
	InputSerialization  s3select.InputSerialization  `xml:"InputSerialization"`
	OutputSerialization s3select.OutputSerialization `xml:"OutputSerialization"`
}

SelectParameters holds the select request parameters.

type Tag ¶

type Tag struct {
	Key   string `xml:"Key,omitempty"`
	Value string `xml:"Value,omitempty"`
}

Tag represents a tag key-value pair.

type Tagging ¶

type Tagging struct {
	TagSet []Tag `xml:"TagSet>Tag,omitempty"`
}

Tagging represents a tagging set.

type TierType ¶

type TierType string

TierType represents a retrieval tier.

const (
	// TierStandard is the standard retrieval tier.
	TierStandard TierType = "Standard"
	// TierBulk is the bulk retrieval tier.
	TierBulk TierType = "Bulk"
	// TierExpedited is the expedited retrieval tier.
	TierExpedited TierType = "Expedited"
)

Source Files ¶

View all Source files

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