Documentation
¶
Index ¶
- Constants
- type AtmosProAPIClient
- func (c *AtmosProAPIClient) LockStack(dto *dtos.LockStackRequest) (dtos.LockStackResponse, error)
- func (c *AtmosProAPIClient) UnlockStack(dto *dtos.UnlockStackRequest) (dtos.UnlockStackResponse, error)
- func (c *AtmosProAPIClient) UploadAffectedStacks(dto *dtos.UploadAffectedStacksRequest) error
- func (c *AtmosProAPIClient) UploadInstanceStatus(dto *dtos.InstanceStatusUploadRequest) error
- func (c *AtmosProAPIClient) UploadInstances(dto *dtos.InstancesUploadRequest) error
- type AtmosProAPIClientInterface
Constants ¶
View Source
const ( DefaultHTTPTimeoutSecs = 30 DefaultDialTimeoutSecs = 10 DefaultIdleConnTimeoutSecs = 30 DefaultResponseHeaderTimeoutSecs = 15 DefaultExpectContinueTimeoutSecs = 1 )
View Source
const ( // DefaultHTTPClientTimeout is the default timeout for HTTP client requests. DefaultHTTPClientTimeout = 10 * time.Second )
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type AtmosProAPIClient ¶
type AtmosProAPIClient struct {
APIToken string
BaseAPIEndpoint string
BaseURL string
HTTPClient *http.Client
}
AtmosProAPIClient represents the client to interact with the AtmosPro API.
func NewAtmosProAPIClient ¶
func NewAtmosProAPIClient(baseURL, baseAPIEndpoint, apiToken string) *AtmosProAPIClient
NewAtmosProAPIClient creates a new instance of AtmosProAPIClient.
func NewAtmosProAPIClientFromEnv ¶
func NewAtmosProAPIClientFromEnv(atmosConfig *schema.AtmosConfiguration) (*AtmosProAPIClient, error)
NewAtmosProAPIClientFromEnv creates a new AtmosProAPIClient from environment variables.
func (*AtmosProAPIClient) LockStack ¶
func (c *AtmosProAPIClient) LockStack(dto *dtos.LockStackRequest) (dtos.LockStackResponse, error)
LockStack locks a specific stack.
func (*AtmosProAPIClient) UnlockStack ¶
func (c *AtmosProAPIClient) UnlockStack(dto *dtos.UnlockStackRequest) (dtos.UnlockStackResponse, error)
UnlockStack unlocks a specific stack.
func (*AtmosProAPIClient) UploadAffectedStacks ¶
func (c *AtmosProAPIClient) UploadAffectedStacks(dto *dtos.UploadAffectedStacksRequest) error
UploadAffectedStacks uploads information about affected stacks.
func (*AtmosProAPIClient) UploadInstanceStatus ¶ added in v1.192.0
func (c *AtmosProAPIClient) UploadInstanceStatus(dto *dtos.InstanceStatusUploadRequest) error
UploadInstanceStatus uploads the drift detection result status to the pro API.
func (*AtmosProAPIClient) UploadInstances ¶ added in v1.192.0
func (c *AtmosProAPIClient) UploadInstances(dto *dtos.InstancesUploadRequest) error
UploadInstances uploads drift detection data to the API.
type AtmosProAPIClientInterface ¶ added in v1.192.0
type AtmosProAPIClientInterface interface {
UploadInstances(req *dtos.InstancesUploadRequest) error
UploadInstanceStatus(dto *dtos.InstanceStatusUploadRequest) error
}
AtmosProAPIClientInterface defines the interface for the AtmosProAPIClient.
Source Files
¶
Directories
Click to show internal directories.
Click to hide internal directories.