Documentation
¶
Index ¶
- func CacheExpires(r *http.Response) time.Time
- func IsNil(i interface{}) bool
- func NewConfiguration() *config.Configuration
- func ParameterValueToString(obj interface{}, key string) string
- func PtrBool(v bool) *bool
- func PtrFloat32(v float32) *float32
- func PtrFloat64(v float64) *float64
- func PtrInt(v int) *int
- func PtrInt32(v int32) *int32
- func PtrInt64(v int64) *int64
- func PtrString(v string) *string
- func PtrTime(v time.Time) *time.Time
- type APIClient
- func (a *APIClient) DisableService(ctx context.Context, projectId string, serviceId string) ApiDisableServiceRequest
- func (a *APIClient) DisableServiceExecute(ctx context.Context, projectId string, serviceId string) error
- func (a *APIClient) EnableService(ctx context.Context, projectId string, serviceId string) ApiEnableServiceRequest
- func (a *APIClient) EnableServiceExecute(ctx context.Context, projectId string, serviceId string) error
- func (c *APIClient) GetConfig() *config.Configuration
- func (a *APIClient) GetServiceStatus(ctx context.Context, projectId string, serviceId string) ApiGetServiceStatusRequest
- func (a *APIClient) GetServiceStatusExecute(ctx context.Context, projectId string, serviceId string) (*ServiceStatus, error)
- func (a *APIClient) ListServiceStatus(ctx context.Context, projectId string) ApiListServiceStatusRequest
- func (a *APIClient) ListServiceStatusExecute(ctx context.Context, projectId string) (*ListServiceStatus200Response, error)
- type ActionError
- type ApiDisableServiceRequest
- type ApiEnableServiceRequest
- type ApiGetServiceStatusRequest
- type ApiListServiceStatusRequest
- type CloudService
- type DefaultApiService
- type Dependencies
- type ListServiceStatus200Response
- type MappedNullable
- type NullableBool
- type NullableFloat32
- type NullableFloat64
- type NullableInt
- type NullableInt32
- type NullableInt64
- type NullableString
- type NullableTime
- type Parameters
- type ParametersGeneral
- type ServiceStatus
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func CacheExpires ¶
CacheExpires helper function to determine remaining time before repeating a request.
func NewConfiguration ¶
func NewConfiguration() *config.Configuration
NewConfiguration returns a new Configuration object
func ParameterValueToString ¶
func PtrFloat32 ¶
PtrFloat32 is a helper routine that returns a pointer to given float value.
func PtrFloat64 ¶
PtrFloat64 is a helper routine that returns a pointer to given float value.
Types ¶
type APIClient ¶
type APIClient struct {
// contains filtered or unexported fields
}
APIClient manages communication with the STACKIT Service Enablement API API v1.1 In most cases there should be only one, shared, APIClient.
func NewAPIClient ¶
func NewAPIClient(opts ...config.ConfigurationOption) (*APIClient, error)
NewAPIClient creates a new API client. Optionally receives configuration options
func (*APIClient) DisableService ¶
func (a *APIClient) DisableService(ctx context.Context, projectId string, serviceId string) ApiDisableServiceRequest
DisableService: Method for DisableService
disables the service in a project.
@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). @param projectId @param serviceId @return ApiDisableServiceRequest
func (*APIClient) DisableServiceExecute ¶
func (*APIClient) EnableService ¶
func (a *APIClient) EnableService(ctx context.Context, projectId string, serviceId string) ApiEnableServiceRequest
EnableService: Method for EnableService
enables the service in a project.
@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). @param projectId @param serviceId @return ApiEnableServiceRequest
func (*APIClient) EnableServiceExecute ¶
func (*APIClient) GetConfig ¶
func (c *APIClient) GetConfig() *config.Configuration
Allow modification of underlying config for alternate implementations and testing Caution: modifying the configuration while live can cause data races and potentially unwanted behavior
func (*APIClient) GetServiceStatus ¶
func (a *APIClient) GetServiceStatus(ctx context.Context, projectId string, serviceId string) ApiGetServiceStatusRequest
GetServiceStatus: Method for GetServiceStatus
returns the current status of a service in a project.
@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). @param projectId @param serviceId @return ApiGetServiceStatusRequest
func (*APIClient) GetServiceStatusExecute ¶
func (*APIClient) ListServiceStatus ¶
func (a *APIClient) ListServiceStatus(ctx context.Context, projectId string) ApiListServiceStatusRequest
ListServiceStatus: Method for ListServiceStatus
returns a list of all available services for a project.
@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). @param projectId @return ApiListServiceStatusRequest
func (*APIClient) ListServiceStatusExecute ¶
type ActionError ¶
type ApiDisableServiceRequest ¶
type ApiDisableServiceRequest struct {
// contains filtered or unexported fields
}
func (ApiDisableServiceRequest) Execute ¶
func (r ApiDisableServiceRequest) Execute() error
type ApiEnableServiceRequest ¶
type ApiEnableServiceRequest struct {
// contains filtered or unexported fields
}
func (ApiEnableServiceRequest) Execute ¶
func (r ApiEnableServiceRequest) Execute() error
type ApiGetServiceStatusRequest ¶
type ApiGetServiceStatusRequest struct {
// contains filtered or unexported fields
}
func (ApiGetServiceStatusRequest) Execute ¶
func (r ApiGetServiceStatusRequest) Execute() (*ServiceStatus, error)
type ApiListServiceStatusRequest ¶
type ApiListServiceStatusRequest struct {
// contains filtered or unexported fields
}
func (ApiListServiceStatusRequest) Cursor ¶
func (r ApiListServiceStatusRequest) Cursor(cursor string) ApiListServiceStatusRequest
func (ApiListServiceStatusRequest) Execute ¶
func (r ApiListServiceStatusRequest) Execute() (*ListServiceStatus200Response, error)
type CloudService ¶
type CloudService struct {
Dependencies *Dependencies `json:"dependencies,omitempty"`
Labels *map[string]string `json:"labels,omitempty"`
Scope *string `json:"scope,omitempty"`
// the id of the service
ServiceId *string `json:"serviceId,omitempty"`
}
type Dependencies ¶
type Dependencies struct {
// a list of service IDs which this service depend on. If the service is enabled, those service are enabled as well automatically.
Hard *[]string `json:"hard,omitempty"`
// a list of service IDs which this service depend on. When they are disabled a notification is sent.
Soft *[]string `json:"soft,omitempty"`
}
type ListServiceStatus200Response ¶
type ListServiceStatus200Response struct {
Items *[]ServiceStatus `json:"items,omitempty"`
NextCursor *string `json:"nextCursor,omitempty"`
}
type MappedNullable ¶
type NullableBool ¶
type NullableBool struct {
// contains filtered or unexported fields
}
func NewNullableBool ¶
func NewNullableBool(val *bool) *NullableBool
func (NullableBool) Get ¶
func (v NullableBool) Get() *bool
func (NullableBool) IsSet ¶
func (v NullableBool) IsSet() bool
func (NullableBool) MarshalJSON ¶
func (v NullableBool) MarshalJSON() ([]byte, error)
func (*NullableBool) Set ¶
func (v *NullableBool) Set(val *bool)
func (*NullableBool) UnmarshalJSON ¶
func (v *NullableBool) UnmarshalJSON(src []byte) error
func (*NullableBool) Unset ¶
func (v *NullableBool) Unset()
type NullableFloat32 ¶
type NullableFloat32 struct {
// contains filtered or unexported fields
}
func NewNullableFloat32 ¶
func NewNullableFloat32(val *float32) *NullableFloat32
func (NullableFloat32) Get ¶
func (v NullableFloat32) Get() *float32
func (NullableFloat32) IsSet ¶
func (v NullableFloat32) IsSet() bool
func (NullableFloat32) MarshalJSON ¶
func (v NullableFloat32) MarshalJSON() ([]byte, error)
func (*NullableFloat32) Set ¶
func (v *NullableFloat32) Set(val *float32)
func (*NullableFloat32) UnmarshalJSON ¶
func (v *NullableFloat32) UnmarshalJSON(src []byte) error
func (*NullableFloat32) Unset ¶
func (v *NullableFloat32) Unset()
type NullableFloat64 ¶
type NullableFloat64 struct {
// contains filtered or unexported fields
}
func NewNullableFloat64 ¶
func NewNullableFloat64(val *float64) *NullableFloat64
func (NullableFloat64) Get ¶
func (v NullableFloat64) Get() *float64
func (NullableFloat64) IsSet ¶
func (v NullableFloat64) IsSet() bool
func (NullableFloat64) MarshalJSON ¶
func (v NullableFloat64) MarshalJSON() ([]byte, error)
func (*NullableFloat64) Set ¶
func (v *NullableFloat64) Set(val *float64)
func (*NullableFloat64) UnmarshalJSON ¶
func (v *NullableFloat64) UnmarshalJSON(src []byte) error
func (*NullableFloat64) Unset ¶
func (v *NullableFloat64) Unset()
type NullableInt ¶
type NullableInt struct {
// contains filtered or unexported fields
}
func NewNullableInt ¶
func NewNullableInt(val *int) *NullableInt
func (NullableInt) Get ¶
func (v NullableInt) Get() *int
func (NullableInt) IsSet ¶
func (v NullableInt) IsSet() bool
func (NullableInt) MarshalJSON ¶
func (v NullableInt) MarshalJSON() ([]byte, error)
func (*NullableInt) Set ¶
func (v *NullableInt) Set(val *int)
func (*NullableInt) UnmarshalJSON ¶
func (v *NullableInt) UnmarshalJSON(src []byte) error
func (*NullableInt) Unset ¶
func (v *NullableInt) Unset()
type NullableInt32 ¶
type NullableInt32 struct {
// contains filtered or unexported fields
}
func NewNullableInt32 ¶
func NewNullableInt32(val *int32) *NullableInt32
func (NullableInt32) Get ¶
func (v NullableInt32) Get() *int32
func (NullableInt32) IsSet ¶
func (v NullableInt32) IsSet() bool
func (NullableInt32) MarshalJSON ¶
func (v NullableInt32) MarshalJSON() ([]byte, error)
func (*NullableInt32) Set ¶
func (v *NullableInt32) Set(val *int32)
func (*NullableInt32) UnmarshalJSON ¶
func (v *NullableInt32) UnmarshalJSON(src []byte) error
func (*NullableInt32) Unset ¶
func (v *NullableInt32) Unset()
type NullableInt64 ¶
type NullableInt64 struct {
// contains filtered or unexported fields
}
func NewNullableInt64 ¶
func NewNullableInt64(val *int64) *NullableInt64
func (NullableInt64) Get ¶
func (v NullableInt64) Get() *int64
func (NullableInt64) IsSet ¶
func (v NullableInt64) IsSet() bool
func (NullableInt64) MarshalJSON ¶
func (v NullableInt64) MarshalJSON() ([]byte, error)
func (*NullableInt64) Set ¶
func (v *NullableInt64) Set(val *int64)
func (*NullableInt64) UnmarshalJSON ¶
func (v *NullableInt64) UnmarshalJSON(src []byte) error
func (*NullableInt64) Unset ¶
func (v *NullableInt64) Unset()
type NullableString ¶
type NullableString struct {
// contains filtered or unexported fields
}
func NewNullableString ¶
func NewNullableString(val *string) *NullableString
func (NullableString) Get ¶
func (v NullableString) Get() *string
func (NullableString) IsSet ¶
func (v NullableString) IsSet() bool
func (NullableString) MarshalJSON ¶
func (v NullableString) MarshalJSON() ([]byte, error)
func (*NullableString) Set ¶
func (v *NullableString) Set(val *string)
func (*NullableString) UnmarshalJSON ¶
func (v *NullableString) UnmarshalJSON(src []byte) error
func (*NullableString) Unset ¶
func (v *NullableString) Unset()
type NullableTime ¶
type NullableTime struct {
// contains filtered or unexported fields
}
func NewNullableTime ¶
func NewNullableTime(val *time.Time) *NullableTime
func (NullableTime) Get ¶
func (v NullableTime) Get() *time.Time
func (NullableTime) IsSet ¶
func (v NullableTime) IsSet() bool
func (NullableTime) MarshalJSON ¶
func (v NullableTime) MarshalJSON() ([]byte, error)
func (*NullableTime) Set ¶
func (v *NullableTime) Set(val *time.Time)
func (*NullableTime) UnmarshalJSON ¶
func (v *NullableTime) UnmarshalJSON(src []byte) error
func (*NullableTime) Unset ¶
func (v *NullableTime) Unset()
type Parameters ¶
type Parameters struct {
General *ParametersGeneral `json:"general,omitempty"`
}
type ParametersGeneral ¶
type ServiceStatus ¶
type ServiceStatus struct {
Dependencies *Dependencies `json:"dependencies,omitempty"`
Enablement *string `json:"enablement,omitempty"`
Error *ActionError `json:"error,omitempty"`
Labels *map[string]string `json:"labels,omitempty"`
Lifecycle *string `json:"lifecycle,omitempty"`
Parameters *Parameters `json:"parameters,omitempty"`
Scope *string `json:"scope,omitempty"`
// the id of the service
ServiceId *string `json:"serviceId,omitempty"`
// the state of a service within a project
State *string `json:"state,omitempty"`
}