bulk

Documentation

Overview

Package bulk provides functionality for working with bulk operations in the Rackspace Cloud Files service.

Index

• type DeleteOpts
  • func (opts DeleteOpts) ToBulkDeleteBody() (string, error)
• type DeleteOptsBuilder
• type DeleteRespBody
• type DeleteResult
  • func Delete(c *gophercloud.ServiceClient, opts DeleteOptsBuilder) DeleteResult
  • func (dr DeleteResult) ExtractBody() (DeleteRespBody, error)

Types

type DeleteOpts

type DeleteOpts []string

DeleteOpts is a structure that holds parameters for deleting an object.

func (DeleteOpts) ToBulkDeleteBody

func (opts DeleteOpts) ToBulkDeleteBody() (string, error)

ToBulkDeleteBody formats a DeleteOpts into a request body.

type DeleteOptsBuilder

type DeleteOptsBuilder interface {
	ToBulkDeleteBody() (string, error)
}

DeleteOptsBuilder allows extensions to add additional parameters to the Delete request.

type DeleteRespBody

type DeleteRespBody struct {
	NumberNotFound int      `mapstructure:"Number Not Found"`
	ResponseStatus string   `mapstructure:"Response Status"`
	Errors         []string `mapstructure:"Errors"`
	NumberDeleted  int      `mapstructure:"Number Deleted"`
	ResponseBody   string   `mapstructure:"Response Body"`
}

DeleteRespBody is the form of the response body returned by a bulk delete request.

type DeleteResult

type DeleteResult struct {
	gophercloud.Result
}

DeleteResult represents the result of a bulk delete operation.

func Delete

func Delete(c *gophercloud.ServiceClient, opts DeleteOptsBuilder) DeleteResult

Delete will delete objects or containers in bulk.

func (DeleteResult) ExtractBody

func (dr DeleteResult) ExtractBody() (DeleteRespBody, error)

ExtractBody will extract the body returned by the bulk extract request.