awss3buckets

Documentation

Overview

Package awss3buckets contains methods related to AwsS3Buckets

Index

• type AwsS3BucketsV1
  • func (a *AwsS3BucketsV1) ListAwsS3Buckets(limit *int64, start *string, filter *string) (*models.ListBucketsResponse, *apiutils.APIError)
  • func (a *AwsS3BucketsV1) ReadAwsS3Bucket(bucketId string) (*models.ReadBucketResponse, *apiutils.APIError)
  • func (a *AwsS3BucketsV1) SetBucketProperties(bucketId string, body *models.SetBucketPropertiesV1Request) (*models.SetBucketPropertiesResponse, *apiutils.APIError)
• type AwsS3BucketsV1Client
  • func NewAwsS3BucketsV1(config config.Config) AwsS3BucketsV1Client

Types

type AwsS3BucketsV1

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

AwsS3BucketsV1 represents a custom type struct

func (*AwsS3BucketsV1) ListAwsS3Buckets

func (a *AwsS3BucketsV1) ListAwsS3Buckets(
	limit *int64,
	start *string,
	filter *string) (
	*models.ListBucketsResponse, *apiutils.APIError)

ListAwsS3Buckets Returns a list of S3 buckets.

func (*AwsS3BucketsV1) ReadAwsS3Bucket

func (a *AwsS3BucketsV1) ReadAwsS3Bucket(
	bucketId string) (
	*models.ReadBucketResponse, *apiutils.APIError)

ReadAwsS3Bucket Returns a representation of the specified S3 bucket.

func (*AwsS3BucketsV1) SetBucketProperties

func (a *AwsS3BucketsV1) SetBucketProperties(
	bucketId string,
	body *models.SetBucketPropertiesV1Request) (
	*models.SetBucketPropertiesResponse, *apiutils.APIError)

SetBucketProperties Idempotent call to set properties on an S3 bucket to enable flows like S3

continuous backup.

type AwsS3BucketsV1Client

type AwsS3BucketsV1Client interface {
	// ListAwsS3Buckets Returns a list of S3 buckets.
	ListAwsS3Buckets(
		limit *int64,
		start *string,
		filter *string) (
		*models.ListBucketsResponse, *apiutils.APIError)

	// ReadAwsS3Bucket Returns a representation of the specified S3 bucket.
	ReadAwsS3Bucket(
		bucketId string) (
		*models.ReadBucketResponse, *apiutils.APIError)

	// SetBucketProperties Idempotent call to set properties on an S3 bucket to enable flows like S3
	//  continuous backup.
	SetBucketProperties(
		bucketId string,
		body *models.SetBucketPropertiesV1Request) (
		*models.SetBucketPropertiesResponse, *apiutils.APIError)
}

AwsS3BucketsV1Client represents a custom type interface

func NewAwsS3BucketsV1

func NewAwsS3BucketsV1(config config.Config) AwsS3BucketsV1Client

NewAwsS3BucketsV1 returns AwsS3BucketsV1Client