Documentation
¶
Index ¶
- type CreateProvisionJobBody
- type Error
- type ProvisionJobInfo
- type ProvisionJobInfoErrors
- type ProvisionJobInfoErrorsItems
- type ProvisionJobInfoStatus
- type ProvisionJobs
- type Service
- func (s *Service) CreateProvisionJob(createProvisionJobBody CreateProvisionJobBody, resp ...*http.Response) (*ProvisionJobInfo, error)
- func (s *Service) GetProvisionJob(jobId string, resp ...*http.Response) (*ProvisionJobInfo, error)
- func (s *Service) GetTenant(tenantName string, resp ...*http.Response) (*TenantInfo, error)
- func (s *Service) ListProvisionJobs(resp ...*http.Response) (*ProvisionJobs, error)
- func (s *Service) ListTenants(resp ...*http.Response) (*Tenants, error)
- type Servicer
- type TenantInfo
- type Tenants
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type CreateProvisionJobBody ¶
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 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 ¶
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 ¶
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 ¶
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 ¶
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 Tenants ¶
type Tenants []TenantInfo