Struct: s3.RestoreRequest

import "../ibm-cos-sdk-go/service/s3"

Overview

Container for restore job parameters.

Implemented Interfaces

s3crypto.Cipher, s3manager.ReadSeekerWriteTo, request.Validator, s3manager.WriterReadFrom

Structure Field Summary

• Days *int64

  Lifetime of the active copy in days.

• GlacierJobParameters *GlacierJobParameters

  S3 Glacier related parameters pertaining to this job.

• _ struct{}

Service Operations

• GoString() string operation

  GoString returns the string representation.

• SetDays(int64) *RestoreRequest operation

  SetDays sets the Days field's value.

• SetGlacierJobParameters(*GlacierJobParameters) *RestoreRequest operation

  SetGlacierJobParameters sets the GlacierJobParameters field's value.

• String() string operation

  String returns the string representation.

• Validate() error operation

  Validate inspects the fields of the type to determine if they are valid.

Structure Field Details

Days *int64 `type:"integer" required:"true"`

Lifetime of the active copy in days. Do not use with restores that specify OutputLocation.

The Days element is required for regular restores, and must not be provided for select requests.

Days is a required field

GlacierJobParameters *GlacierJobParameters `type:"structure"`

S3 Glacier related parameters pertaining to this job. Do not use with restores that specify OutputLocation.

_ struct{} `type:"structure"`

Method Details

func (s RestoreRequest) GoString() string

GoString returns the string representation.

API parameter values that are decorated as “sensitive” in the API will not be included in the string output. The member name will be present, but the value will be replaced with “sensitive”.

// File 'service/s3/api.go', line 21710

func (s RestoreRequest) GoString() string {
	return s.String()
}

func (s *RestoreRequest) SetDays(v int64) *RestoreRequest

SetDays sets the Days field's value.

// File 'service/s3/api.go', line 21733

func (s *RestoreRequest) SetDays(v int64) *RestoreRequest {
	s.Days = &v
	return s
}

func (s *RestoreRequest) SetGlacierJobParameters(v *GlacierJobParameters) *RestoreRequest

SetGlacierJobParameters sets the GlacierJobParameters field's value.

// File 'service/s3/api.go', line 21739

func (s *RestoreRequest) SetGlacierJobParameters(v *GlacierJobParameters) *RestoreRequest {
	s.GlacierJobParameters = v
	return s
}

func (s RestoreRequest) String() string

String returns the string representation.

API parameter values that are decorated as “sensitive” in the API will not be included in the string output. The member name will be present, but the value will be replaced with “sensitive”.

// File 'service/s3/api.go', line 21701

func (s RestoreRequest) String() string {
	return awsutil.Prettify(s)
}

func (s *RestoreRequest) Validate() error

Validate inspects the fields of the type to determine if they are valid.

// File 'service/s3/api.go', line 21715

func (s *RestoreRequest) Validate() error {
	invalidParams := request.ErrInvalidParams{Context: "RestoreRequest"}
	if s.Days == nil {
		invalidParams.Add(request.NewErrParamRequired("Days"))
	}
	if s.GlacierJobParameters != nil {
		if err := s.GlacierJobParameters.Validate(); err != nil {
			invalidParams.AddNested("GlacierJobParameters", err.(request.ErrInvalidParams))
		}
	}

	if invalidParams.Len() > 0 {
		return invalidParams
	}
	return nil
}