provisioner

package
v1.0.0-beta.1 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jul 19, 2019 License: Apache-2.0 Imports: 3 Imported by: 2

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type CreateProvisionJobBody

type CreateProvisionJobBody struct {
	Apps   []string `json:"apps,omitempty"`
	Tenant *string  `json:"tenant,omitempty"`
}

type Error

type Error struct {
	// Service error code
	Code string `json:"code"`
	// Human readable error message
	Message string `json:"message"`
}

type ProvisionJobInfo

type ProvisionJobInfo struct {
	Apps      []string               `json:"apps"`
	CreatedAt string                 `json:"createdAt"`
	CreatedBy string                 `json:"createdBy"`
	Errors    ProvisionJobInfoErrors `json:"errors"`
	JobID     string                 `json:"jobID"`
	Status    ProvisionJobInfoStatus `json:"status"`
	Tenant    string                 `json:"tenant"`
}

type ProvisionJobInfoErrors

type ProvisionJobInfoErrors []ProvisionJobInfoErrorsItems

type ProvisionJobInfoErrorsItems

type ProvisionJobInfoErrorsItems struct {
	Code     string  `json:"code"`
	JobStage string  `json:"job_stage"`
	Message  string  `json:"message"`
	App      *string `json:"app,omitempty"`
}

type ProvisionJobInfoStatus

type ProvisionJobInfoStatus string
const (
	ProvisionJobInfoStatusCreated   ProvisionJobInfoStatus = "created"
	ProvisionJobInfoStatusRunning   ProvisionJobInfoStatus = "running"
	ProvisionJobInfoStatusCompleted ProvisionJobInfoStatus = "completed"
)

List of ProvisionJobInfoStatus

type ProvisionJobs

type ProvisionJobs []ProvisionJobInfo

type Service

type Service services.BaseService

func NewService

func NewService(config *services.Config) (*Service, error)

NewService creates a new provisioner service client from the given Config

func (*Service) CreateProvisionJob

func (s *Service) CreateProvisionJob(createProvisionJobBody CreateProvisionJobBody, resp ...*http.Response) (*ProvisionJobInfo, error)

CreateProvisionJob - provisioner service endpoint Creates a new job that provisions a new tenant and subscribes apps to the tenant Parameters:

createProvisionJobBody
resp: an optional pointer to a http.Response to be populated by this method. NOTE: only the first resp pointer will be used if multiple are provided

func (*Service) GetProvisionJob

func (s *Service) GetProvisionJob(jobId string, resp ...*http.Response) (*ProvisionJobInfo, error)

GetProvisionJob - provisioner service endpoint Gets details of a specific provision job Parameters:

jobId
resp: an optional pointer to a http.Response to be populated by this method. NOTE: only the first resp pointer will be used if multiple are provided

func (*Service) GetTenant

func (s *Service) GetTenant(tenantName string, resp ...*http.Response) (*TenantInfo, error)

GetTenant - provisioner service endpoint Gets a specific tenant Parameters:

tenantName
resp: an optional pointer to a http.Response to be populated by this method. NOTE: only the first resp pointer will be used if multiple are provided

func (*Service) ListProvisionJobs

func (s *Service) ListProvisionJobs(resp ...*http.Response) (*ProvisionJobs, error)

ListProvisionJobs - provisioner service endpoint Lists all provision jobs created by the user Parameters:

resp: an optional pointer to a http.Response to be populated by this method. NOTE: only the first resp pointer will be used if multiple are provided

func (*Service) ListTenants

func (s *Service) ListTenants(resp ...*http.Response) (*Tenants, error)

ListTenants - provisioner service endpoint Lists all tenants that the user can read Parameters:

resp: an optional pointer to a http.Response to be populated by this method. NOTE: only the first resp pointer will be used if multiple are provided

type Servicer

type Servicer interface {
	/*
		CreateProvisionJob - provisioner service endpoint
		Creates a new job that provisions a new tenant and subscribes apps to the tenant
		Parameters:
			createProvisionJobBody
			resp: an optional pointer to a http.Response to be populated by this method. NOTE: only the first resp pointer will be used if multiple are provided
	*/
	CreateProvisionJob(createProvisionJobBody CreateProvisionJobBody, resp ...*http.Response) (*ProvisionJobInfo, error)
	/*
		GetProvisionJob - provisioner service endpoint
		Gets details of a specific provision job
		Parameters:
			jobId
			resp: an optional pointer to a http.Response to be populated by this method. NOTE: only the first resp pointer will be used if multiple are provided
	*/
	GetProvisionJob(jobId string, resp ...*http.Response) (*ProvisionJobInfo, error)
	/*
		GetTenant - provisioner service endpoint
		Gets a specific tenant
		Parameters:
			tenantName
			resp: an optional pointer to a http.Response to be populated by this method. NOTE: only the first resp pointer will be used if multiple are provided
	*/
	GetTenant(tenantName string, resp ...*http.Response) (*TenantInfo, error)
	/*
		ListProvisionJobs - provisioner service endpoint
		Lists all provision jobs created by the user
		Parameters:
			resp: an optional pointer to a http.Response to be populated by this method. NOTE: only the first resp pointer will be used if multiple are provided
	*/
	ListProvisionJobs(resp ...*http.Response) (*ProvisionJobs, error)
	/*
		ListTenants - provisioner service endpoint
		Lists all tenants that the user can read
		Parameters:
			resp: an optional pointer to a http.Response to be populated by this method. NOTE: only the first resp pointer will be used if multiple are provided
	*/
	ListTenants(resp ...*http.Response) (*Tenants, error)
}

Servicer represents the interface for implementing all endpoints for this service

type TenantInfo

type TenantInfo struct {
	CreatedAt string `json:"createdAt"`
	CreatedBy string `json:"createdBy"`
	Name      string `json:"name"`
	Status    string `json:"status"`
}

type Tenants

type Tenants []TenantInfo

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL