pivnet

Documentation

Index

• Constants
• type Client
  • func NewClient(config NewClientConfig, logger logger.Logger) Client
• type CreateProductFileConfig
• type CreateReleaseConfig
• type CreateReleaseResponse
• type Eula
• type EulaResponse
• type Links
• type NewClientConfig
• type Product
• type ProductFile
• type ProductFileResponse
• type ProductFiles
• type Release
• type ReleasesResponse
• type UserGroup
• type UserGroups

Constants

const (
	Endpoint = "https://network.pivotal.io"
)

Types

type Client

type Client interface {
	ProductVersions(string) ([]string, error)
	CreateRelease(CreateReleaseConfig) (Release, error)
	ReleasesForProductSlug(string) ([]Release, error)
	GetRelease(string, string) (Release, error)
	UpdateRelease(string, Release) (Release, error)
	DeleteRelease(Release, string) error
	GetProductFiles(Release) (ProductFiles, error)
	GetProductFile(productSlug string, releaseID int, productID int) (ProductFile, error)
	AcceptEULA(productSlug string, releaseID int) error
	CreateProductFile(CreateProductFileConfig) (ProductFile, error)
	DeleteProductFile(productSlug string, id int) (ProductFile, error)
	AddProductFile(productID int, releaseID int, productFileID int) error
	FindProductForSlug(slug string) (Product, error)
	UserGroups(productSlug string, releaseID int) ([]UserGroup, error)
	AddUserGroup(productSlug string, releaseID int, userGroupID int) error
	ReleaseETag(string, Release) (string, error)
}

func NewClient

func NewClient(config NewClientConfig, logger logger.Logger) Client

type CreateProductFileConfig

type CreateProductFileConfig struct {
	ProductSlug  string
	FileVersion  string
	AWSObjectKey string
	Name         string
	MD5          string
	Description  string
}

type CreateReleaseConfig

type CreateReleaseConfig struct {
	ProductSlug     string
	ProductVersion  string
	ReleaseType     string
	ReleaseDate     string
	EulaSlug        string
	Description     string
	ReleaseNotesURL string
}

type CreateReleaseResponse

type CreateReleaseResponse struct {
	Release Release `json:"release,omitempty"`
}

type Eula

type Eula struct {
	Slug    string `json:"slug,omitempty"`
	ID      int    `json:"id,omitempty"`
	Version string `json:"version,omitempty"`
	Links   *Links `json:"_links,omitempty"`
}

type EulaResponse

type EulaResponse struct {
	AcceptedAt string `json:"accepted_at,omitempty"`
	Links      *Links `json:"_links,omitempty"`
}

type Links

type Links struct {
	Eula           map[string]string `json:"eula,omitempty"`
	Download       map[string]string `json:"download,omitempty"`
	ProductFiles   map[string]string `json:"product_files,omitempty"`
	EULAAcceptance map[string]string `json:"eula_acceptance,omitempty"`
}

type NewClientConfig

type NewClientConfig struct {
	Endpoint  string
	Token     string
	UserAgent string
}

type Product

type Product struct {
	ID   int    `json:"id,omitempty"`
	Slug string `json:"slug"`
}

type ProductFile

type ProductFile struct {
	ID           int    `json:"id,omitempty"`
	AWSObjectKey string `json:"aws_object_key,omitempty"`
	Links        *Links `json:"_links,omitempty"`
	FileType     string `json:"file_type,omitempty"`
	FileVersion  string `json:"file_version,omitempty"`
	Name         string `json:"name,omitempty"`
	MD5          string `json:"md5,omitempty"`
	Description  string `json:"description,omitempty"`
}

type ProductFileResponse

type ProductFileResponse struct {
	ProductFile ProductFile `json:"product_file,omitempty"`
}

type ProductFiles

type ProductFiles struct {
	ProductFiles []ProductFile `json:"product_files,omitempty"`
}

type Release

type Release struct {
	ID              int    `json:"id,omitempty"`
	Availability    string `json:"availability,omitempty"`
	Eula            *Eula  `json:"eula,omitempty"`
	OSSCompliant    string `json:"oss_compliant,omitempty"`
	ReleaseDate     string `json:"release_date,omitempty"`
	ReleaseType     string `json:"release_type,omitempty"`
	Version         string `json:"version,omitempty"`
	Links           *Links `json:"_links,omitempty"`
	Description     string `json:"description,omitempty"`
	ReleaseNotesURL string `json:"release_notes_url,omitempty"`
}

type ReleasesResponse

type ReleasesResponse struct {
	Releases []Release `json:"releases,omitempty"`
}

type UserGroup

type UserGroup struct {
	ID          int    `json:"id,omitempty"`
	Name        string `json:"name,omitempty"`
	Description string `json:"description,omitempty"`
}

type UserGroups

type UserGroups struct {
	UserGroups []UserGroup `json:"user_groups,omitempty"`
}