ecloudflex

Documentation

Overview

Code generated by github.com/ukfast/sdk-go/pkg/gen/model_paginated. DO NOT EDIT.

Code generated by github.com/ukfast/sdk-go/pkg/gen/response. DO NOT EDIT.

Index

• type ECloudFlexService
• type GetProjectResponseBody
• type GetProjectSliceResponseBody
• type PaginatedProject
  • func NewPaginatedProject(getFunc connection.PaginatedGetFunc, ...) *PaginatedProject
• type Project
• type ProjectNotFoundError
  • func (e *ProjectNotFoundError) Error() string
• type Service
  • func NewService(connection connection.Connection) *Service
  • func (s *Service) GetProject(projectID int) (Project, error)
  • func (s *Service) GetProjects(parameters connection.APIRequestParameters) ([]Project, error)
  • func (s *Service) GetProjectsPaginated(parameters connection.APIRequestParameters) (*PaginatedProject, error)

Types

type ECloudFlexService

type ECloudFlexService interface {
	GetProjects(parameters connection.APIRequestParameters) ([]Project, error)
	GetProjectsPaginated(parameters connection.APIRequestParameters) (*PaginatedProject, error)
	GetProject(projectID int) (Project, error)
}

ECloudFlexService is an interface for managing eCloud Flex

type GetProjectResponseBody

type GetProjectResponseBody struct {
	connection.APIResponseBody

	Data Project `json:"data"`
}

GetProjectResponseBody represents an API response body containing Project data

type GetProjectSliceResponseBody

type GetProjectSliceResponseBody struct {
	connection.APIResponseBody

	Data []Project `json:"data"`
}

GetProjectSliceResponseBody represents an API response body containing []Project data

type PaginatedProject

type PaginatedProject struct {
	*connection.PaginatedBase

	Items []Project
}

PaginatedProject represents a paginated collection of Project

func NewPaginatedProject

func NewPaginatedProject(getFunc connection.PaginatedGetFunc, parameters connection.APIRequestParameters, pagination connection.APIResponseMetadataPagination, items []Project) *PaginatedProject

NewPaginatedProject returns a pointer to an initialized PaginatedProject struct

type Project

type Project struct {
	ID        int                 `json:"id"`
	Name      string              `json:"name"`
	CreatedAt connection.DateTime `json:"created_at"`
}

Project represents an eCloud Flex project

type ProjectNotFoundError

type ProjectNotFoundError struct {
	ID int
}

ProjectNotFoundError indicates a project was not found

func (*ProjectNotFoundError) Error

func (e *ProjectNotFoundError) Error() string

type Service

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

Service implements ECloudFlexService for managing ECloudFlex certificates via the UKFast API

func NewService

func NewService(connection connection.Connection) *Service

NewService returns a new instance of ECloudFlexService

func (*Service) GetProject

func (s *Service) GetProject(projectID int) (Project, error)

GetProject retrieves a single project by id

func (*Service) GetProjects

func (s *Service) GetProjects(parameters connection.APIRequestParameters) ([]Project, error)

GetProjects retrieves a list of projects

func (*Service) GetProjectsPaginated

func (s *Service) GetProjectsPaginated(parameters connection.APIRequestParameters) (*PaginatedProject, error)

GetProjectsPaginated retrieves a paginated list of projects