client

Documentation

Index

• type BatchingOctopusApiClient
  • func (c *BatchingOctopusApiClient[T]) GetAllGlobalResourcesBatch(done <-chan struct{}, resourceType string) <-chan ResultError[T]
  • func (c *BatchingOctopusApiClient[T]) GetAllResourcesArrayBatch(done <-chan struct{}, resourceType string) <-chan ResultError[T]
  • func (c *BatchingOctopusApiClient[T]) GetAllResourcesBatch(done <-chan struct{}, resourceType string) <-chan ResultError[T]
• type OctopusApiClient
  • func (o *OctopusApiClient) EnsureSpaceDeleted(spaceId string) (deleted bool, funcErr error)
  • func (o *OctopusApiClient) GetAllGlobalResources(resourceType string, resources any, queryParams ...[]string) (funcErr error)
  • func (o *OctopusApiClient) GetAllResources(resourceType string, resources any, queryParams ...[]string) (funcErr error)
  • func (o *OctopusApiClient) GetBaseUrl() (string, error)
  • func (o *OctopusApiClient) GetGlobalResourceById(resourceType string, id string, resources any) (exists bool, funcErr error)
  • func (o *OctopusApiClient) GetResource(resourceType string, resources any) (exists bool, funcErr error)
  • func (o *OctopusApiClient) GetResourceById(resourceType string, id string, resources any) (funcErr error)
  • func (o *OctopusApiClient) GetResourceNameById(resourceType string, id string) (name string, funcErr error)
  • func (o *OctopusApiClient) GetResourceNamesByIds(resourceType string, id []string) (names []string, funcErr error)
  • func (o *OctopusApiClient) GetSpace(resources *octopus.Space) (funcErr error)
  • func (o *OctopusApiClient) GetSpaceBaseUrl() (string, error)
  • func (o *OctopusApiClient) GetSpaceResourceById(resourceType string, id string, resources any) (exists bool, funcErr error)
  • func (o *OctopusApiClient) GetSpaces() (spaces []octopus.Space, funcErr error)
• type OctopusClient
• type ResultError

Types

type BatchingOctopusApiClient

type BatchingOctopusApiClient[T any] struct {
	Client OctopusClient
}

BatchingOctopusApiClient is a wrapper over the regular client that exposes the ability to return a group of resources while making smaller batched requests to the Octopus API. This has the benefit of allowing large collections to be processed in a lazy fashion.

func (*BatchingOctopusApiClient[T]) GetAllGlobalResourcesBatch

func (c *BatchingOctopusApiClient[T]) GetAllGlobalResourcesBatch(done <-chan struct{}, resourceType string) <-chan ResultError[T]

GetAllGlobalResourcesBatch retrieves all the lobal (i.e. not space specific) resources of a given type but in small batches. This allows the resources to be exported in smaller chunks, which is useful for large spaces.

func (*BatchingOctopusApiClient[T]) GetAllResourcesArrayBatch

func (c *BatchingOctopusApiClient[T]) GetAllResourcesArrayBatch(done <-chan struct{}, resourceType string) <-chan ResultError[T]

GetAllResourcesArrayBatch retrieves all the resources of a given type as a plain array but in small batches. This allows the resources to be exported in smaller chunks, which is useful for large spaces.

func (*BatchingOctopusApiClient[T]) GetAllResourcesBatch

func (c *BatchingOctopusApiClient[T]) GetAllResourcesBatch(done <-chan struct{}, resourceType string) <-chan ResultError[T]

GetAllResourcesBatch retrieves all the resources of a given type but in small batches. This allows the resources to be exported in smaller chunks, which is useful for large spaces.

type OctopusApiClient

type OctopusApiClient struct {
	Url     string
	ApiKey  string
	Space   string
	Version string
	// contains filtered or unexported fields
}

func (*OctopusApiClient) EnsureSpaceDeleted

func (o *OctopusApiClient) EnsureSpaceDeleted(spaceId string) (deleted bool, funcErr error)

func (*OctopusApiClient) GetAllGlobalResources

func (o *OctopusApiClient) GetAllGlobalResources(resourceType string, resources any, queryParams ...[]string) (funcErr error)

func (*OctopusApiClient) GetAllResources

func (o *OctopusApiClient) GetAllResources(resourceType string, resources any, queryParams ...[]string) (funcErr error)

func (*OctopusApiClient) GetBaseUrl

func (o *OctopusApiClient) GetBaseUrl() (string, error)

func (*OctopusApiClient) GetGlobalResourceById

func (o *OctopusApiClient) GetGlobalResourceById(resourceType string, id string, resources any) (exists bool, funcErr error)

func (*OctopusApiClient) GetResource

func (o *OctopusApiClient) GetResource(resourceType string, resources any) (exists bool, funcErr error)

func (*OctopusApiClient) GetResourceById

func (o *OctopusApiClient) GetResourceById(resourceType string, id string, resources any) (funcErr error)

func (*OctopusApiClient) GetResourceNameById

func (o *OctopusApiClient) GetResourceNameById(resourceType string, id string) (name string, funcErr error)

func (*OctopusApiClient) GetResourceNamesByIds

func (o *OctopusApiClient) GetResourceNamesByIds(resourceType string, id []string) (names []string, funcErr error)

func (*OctopusApiClient) GetSpace

func (o *OctopusApiClient) GetSpace(resources *octopus.Space) (funcErr error)

func (*OctopusApiClient) GetSpaceBaseUrl

func (o *OctopusApiClient) GetSpaceBaseUrl() (string, error)

func (*OctopusApiClient) GetSpaceResourceById

func (o *OctopusApiClient) GetSpaceResourceById(resourceType string, id string, resources any) (exists bool, funcErr error)

func (*OctopusApiClient) GetSpaces

func (o *OctopusApiClient) GetSpaces() (spaces []octopus.Space, funcErr error)

type OctopusClient

type OctopusClient interface {
	GetSpaceBaseUrl() (string, error)
	GetSpace(resources *octopus.Space) error
	GetSpaces() ([]octopus.Space, error)
	EnsureSpaceDeleted(spaceId string) (deleted bool, funcErr error)
	GetResource(resourceType string, resources any) (exists bool, funcErr error)
	GetResourceById(resourceType string, id string, resources any) (funcErr error)
	GetSpaceResourceById(resourceType string, id string, resources any) (exists bool, funcErr error)
	GetGlobalResourceById(resourceType string, id string, resources any) (exists bool, funcErr error)
	GetResourceNameById(resourceType string, id string) (name string, funcErr error)
	GetResourceNamesByIds(resourceType string, id []string) (name []string, funcErr error)
	GetAllResources(resourceType string, resources any, queryParams ...[]string) (funcErr error)
	GetAllGlobalResources(resourceType string, resources any, queryParams ...[]string) (funcErr error)
}

type ResultError

type ResultError[T any] struct {
	Res T
	Err error
}

ResultError captures either a successful result or an error.