protectiongroups

Documentation

Overview

Package protectiongroups contains methods related to ProtectionGroups

Index

• type ProtectionGroupsV1
  • func (p *ProtectionGroupsV1) AddBucketProtectionGroup(groupId string, body models.AddBucketProtectionGroupV1Request) (*models.AddBucketToProtectionGroupResponse, *apiutils.APIError)
  • func (p *ProtectionGroupsV1) CreateProtectionGroup(body models.CreateProtectionGroupV1Request) (*models.CreateProtectionGroupResponse, *apiutils.APIError)
  • func (p *ProtectionGroupsV1) DeleteBucketProtectionGroup(groupId string, bucketId string) (*models.DeleteBucketFromProtectionGroupResponse, *apiutils.APIError)
  • func (p *ProtectionGroupsV1) DeleteProtectionGroup(groupId string) (interface{}, *apiutils.APIError)
  • func (p *ProtectionGroupsV1) ListProtectionGroups(limit *int64, start *string, filter *string) (*models.ListProtectionGroupsResponse, *apiutils.APIError)
  • func (p *ProtectionGroupsV1) ReadProtectionGroup(groupId string) (*models.ReadProtectionGroupResponse, *apiutils.APIError)
  • func (p *ProtectionGroupsV1) UpdateProtectionGroup(groupId string, body *models.UpdateProtectionGroupV1Request) (*models.UpdateProtectionGroupResponse, *apiutils.APIError)
• type ProtectionGroupsV1Client
  • func NewProtectionGroupsV1(config config.Config) ProtectionGroupsV1Client

Types

type ProtectionGroupsV1

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

ProtectionGroupsV1 represents a custom type struct

func (*ProtectionGroupsV1) AddBucketProtectionGroup

func (p *ProtectionGroupsV1) AddBucketProtectionGroup(
	groupId string,
	body models.AddBucketProtectionGroupV1Request) (
	*models.AddBucketToProtectionGroupResponse, *apiutils.APIError)

AddBucketProtectionGroup Adds a bucket to protection group and creates a child protection group S3 asset.

Appearance in /datasources/protection-groups/s3-assets read/listing is asynchronous
and may take a few seconds to minutes at most. Must be in the same OU context as
the creator of this protection group. Bucket ID in body can be found in
datasources/aws/s3.

func (*ProtectionGroupsV1) CreateProtectionGroup

func (p *ProtectionGroupsV1) CreateProtectionGroup(
	body models.CreateProtectionGroupV1Request) (
	*models.CreateProtectionGroupResponse, *apiutils.APIError)

CreateProtectionGroup Creates a new protection group by specifying object filters. Appearance in

datasources/protection-groups read/listing is asynchronous and may take a few
seconds to minutes at most. As a result, the protection group won't be protectable
via /policies/assignments until it appears in the /datasources/protection-groups
endpoint. Additionally, to create a protection group in the context of another Organizational
Unit, refer to the Getting Started
documentation.

func (*ProtectionGroupsV1) DeleteBucketProtectionGroup

func (p *ProtectionGroupsV1) DeleteBucketProtectionGroup(
	groupId string,
	bucketId string) (
	*models.DeleteBucketFromProtectionGroupResponse, *apiutils.APIError)

DeleteBucketProtectionGroup Deletes a bucket from a protection group and the child protection group S3 asset.

Appearance in /datasources/protection-groups/s3-assets read/listing is asynchronous
and may take a few seconds to minutes at most. Must be in the same OU context as
the creator of this protection group. Bucket ID in path can be found in
datasources/aws/s3.

func (*ProtectionGroupsV1) DeleteProtectionGroup

func (p *ProtectionGroupsV1) DeleteProtectionGroup(
	groupId string) (
	interface{}, *apiutils.APIError)

DeleteProtectionGroup Marks a protection group as deleted by taking the protection group ID. Appearance

in /datasources/protection-groups read/listing is asynchronous and may take a few
seconds to minutes at most. Must be in the same OU context as the creator of this
protection group.

func (*ProtectionGroupsV1) ListProtectionGroups

func (p *ProtectionGroupsV1) ListProtectionGroups(
	limit *int64,
	start *string,
	filter *string) (
	*models.ListProtectionGroupsResponse, *apiutils.APIError)

ListProtectionGroups Returns a list of protection groups.

func (*ProtectionGroupsV1) ReadProtectionGroup

func (p *ProtectionGroupsV1) ReadProtectionGroup(
	groupId string) (
	*models.ReadProtectionGroupResponse, *apiutils.APIError)

ReadProtectionGroup Returns a representation of the specified protection group.

func (*ProtectionGroupsV1) UpdateProtectionGroup

func (p *ProtectionGroupsV1) UpdateProtectionGroup(
	groupId string,
	body *models.UpdateProtectionGroupV1Request) (
	*models.UpdateProtectionGroupResponse, *apiutils.APIError)

UpdateProtectionGroup Updates a protection group by modifying object filters. Appearance in

datasources/protection-groups read/listing is asynchronous and may take a few
seconds to minutes at most. Must be in the same OU context as the creator of this
protection group.

type ProtectionGroupsV1Client

type ProtectionGroupsV1Client interface {
	// ListProtectionGroups Returns a list of protection groups.
	ListProtectionGroups(
		limit *int64,
		start *string,
		filter *string) (
		*models.ListProtectionGroupsResponse, *apiutils.APIError)

	// ReadProtectionGroup Returns a representation of the specified protection group.
	ReadProtectionGroup(
		groupId string) (
		*models.ReadProtectionGroupResponse, *apiutils.APIError)

	// CreateProtectionGroup Creates a new protection group by specifying object filters. Appearance in
	//  datasources/protection-groups read/listing is asynchronous and may take a few
	//  seconds to minutes at most. As a result, the protection group won't be protectable
	//  via /policies/assignments until it appears in the /datasources/protection-groups
	//  endpoint. Additionally, to create a protection group in the context of another Organizational
	//  Unit, refer to the Getting Started
	//  documentation.
	CreateProtectionGroup(
		body models.CreateProtectionGroupV1Request) (
		*models.CreateProtectionGroupResponse, *apiutils.APIError)

	// UpdateProtectionGroup Updates a protection group by modifying object filters. Appearance in
	//  datasources/protection-groups read/listing is asynchronous and may take a few
	//  seconds to minutes at most. Must be in the same OU context as the creator of this
	//  protection group.
	UpdateProtectionGroup(
		groupId string,
		body *models.UpdateProtectionGroupV1Request) (
		*models.UpdateProtectionGroupResponse, *apiutils.APIError)

	// DeleteProtectionGroup Marks a protection group as deleted by taking the protection group ID. Appearance
	//  in /datasources/protection-groups read/listing is asynchronous and may take a few
	//  seconds to minutes at most. Must be in the same OU context as the creator of this
	//  protection group.
	DeleteProtectionGroup(
		groupId string) (
		interface{}, *apiutils.APIError)

	// AddBucketProtectionGroup Adds a bucket to protection group and creates a child protection group S3 asset.
	//  Appearance in /datasources/protection-groups/s3-assets read/listing is asynchronous
	//  and may take a few seconds to minutes at most. Must be in the same OU context as
	//  the creator of this protection group. Bucket ID in body can be found in
	//  datasources/aws/s3.
	AddBucketProtectionGroup(
		groupId string,
		body models.AddBucketProtectionGroupV1Request) (
		*models.AddBucketToProtectionGroupResponse, *apiutils.APIError)

	// DeleteBucketProtectionGroup Deletes a bucket from a protection group and the child protection group S3 asset.
	//  Appearance in /datasources/protection-groups/s3-assets read/listing is asynchronous
	//  and may take a few seconds to minutes at most. Must be in the same OU context as
	//  the creator of this protection group. Bucket ID in path can be found in
	//  datasources/aws/s3.
	DeleteBucketProtectionGroup(
		groupId string,
		bucketId string) (
		*models.DeleteBucketFromProtectionGroupResponse, *apiutils.APIError)
}

ProtectionGroupsV1Client represents a custom type interface

func NewProtectionGroupsV1

func NewProtectionGroupsV1(config config.Config) ProtectionGroupsV1Client

NewProtectionGroupsV1 returns ProtectionGroupsV1Client