api

package

Go to main page

Versions in this module

v1

v1.3.1

Nov 15, 2024

v1.3.0

Nov 12, 2024

Changes in this version

+ const ReleaseChannelDefault

+ const ReleaseChannelFast

type Service

+ ReleaseChannel string

type ServiceUpdate

+ ReleaseChannel string

v1.2.5

Nov 7, 2024

v1.2.4

Oct 24, 2024

v1.2.3

Oct 16, 2024

v1.2.2

Oct 15, 2024

v1.2.1

Oct 1, 2024

v1.2.0

Sep 26, 2024

Changes in this version

+ type BackupConfiguration struct

+ BackupPeriodInHours *int32

+ BackupRetentionPeriodInHours *int32

+ BackupStartTime *string

type Client

+ GetBackupConfiguration func(ctx context.Context, serviceId string) (*BackupConfiguration, error)

+ UpdateBackupConfiguration func(ctx context.Context, serviceId string, b BackupConfiguration) (*BackupConfiguration, error)

type ClientImpl

+ func (c *ClientImpl) GetBackupConfiguration(ctx context.Context, serviceId string) (*BackupConfiguration, error)

+ func (c *ClientImpl) GetServicePrivateEndpointConfig(ctx context.Context, serviceId string) (*ServicePrivateEndpointConfig, error)

+ func (c *ClientImpl) UpdateBackupConfiguration(ctx context.Context, serviceId string, b BackupConfiguration) (*BackupConfiguration, error)

type ClientMock

+ GetBackupConfigurationMock mClientMockGetBackupConfiguration

+ UpdateBackupConfigurationMock mClientMockUpdateBackupConfiguration

+ func (m *ClientMock) MinimockGetBackupConfigurationDone() bool

+ func (m *ClientMock) MinimockGetBackupConfigurationInspect()

+ func (m *ClientMock) MinimockUpdateBackupConfigurationDone() bool

+ func (m *ClientMock) MinimockUpdateBackupConfigurationInspect()

+ func (mmGetBackupConfiguration *ClientMock) GetBackupConfiguration(ctx context.Context, serviceId string) (bp1 *BackupConfiguration, err error)

+ func (mmGetBackupConfiguration *ClientMock) GetBackupConfigurationAfterCounter() uint64

+ func (mmGetBackupConfiguration *ClientMock) GetBackupConfigurationBeforeCounter() uint64

+ func (mmUpdateBackupConfiguration *ClientMock) UpdateBackupConfiguration(ctx context.Context, serviceId string, b BackupConfiguration) (bp1 *BackupConfiguration, err error)

+ func (mmUpdateBackupConfiguration *ClientMock) UpdateBackupConfigurationAfterCounter() uint64

+ func (mmUpdateBackupConfiguration *ClientMock) UpdateBackupConfigurationBeforeCounter() uint64

+ type ClientMockGetBackupConfigurationExpectation struct

+ Counter uint64

+ func (e *ClientMockGetBackupConfigurationExpectation) Then(bp1 *BackupConfiguration, err error) *ClientMock

+ type ClientMockGetBackupConfigurationParamPtrs struct

+ type ClientMockGetBackupConfigurationParams struct

+ type ClientMockGetBackupConfigurationResults struct

+ type ClientMockUpdateBackupConfigurationExpectation struct

+ Counter uint64

+ func (e *ClientMockUpdateBackupConfigurationExpectation) Then(bp1 *BackupConfiguration, err error) *ClientMock

+ type ClientMockUpdateBackupConfigurationParamPtrs struct

+ type ClientMockUpdateBackupConfigurationParams struct

+ type ClientMockUpdateBackupConfigurationResults struct

+ type ResponseWithResult struct

+ Result T

type Service

+ BackupConfiguration *BackupConfiguration

v1.1.0

Sep 13, 2024

Changes in this version

+ const ResponseHeaderRateLimitReset

type Client

+ UpdateReplicaScaling func(ctx context.Context, serviceId string, s ReplicaScalingUpdate) (*Service, error)

type ClientImpl

+ func (c *ClientImpl) UpdateReplicaScaling(ctx context.Context, serviceId string, s ReplicaScalingUpdate) (*Service, error)

type ClientMock

+ UpdateReplicaScalingMock mClientMockUpdateReplicaScaling

+ func (m *ClientMock) MinimockUpdateReplicaScalingDone() bool

+ func (m *ClientMock) MinimockUpdateReplicaScalingInspect()

+ func (mmUpdateReplicaScaling *ClientMock) UpdateReplicaScaling(ctx context.Context, serviceId string, s ReplicaScalingUpdate) (sp1 *Service, err error)

+ func (mmUpdateReplicaScaling *ClientMock) UpdateReplicaScalingAfterCounter() uint64

+ func (mmUpdateReplicaScaling *ClientMock) UpdateReplicaScalingBeforeCounter() uint64

type ClientMockGetOrganizationPrivateEndpointsExpectation

+ func (e *ClientMockGetOrganizationPrivateEndpointsExpectation) Then(pap1 *[]PrivateEndpoint, err error) *ClientMock

+ type ClientMockGetOrganizationPrivateEndpointsParamPtrs struct

+ type ClientMockGetOrganizationPrivateEndpointsParams struct

+ type ClientMockUpdateReplicaScalingExpectation struct

+ Counter uint64

+ func (e *ClientMockUpdateReplicaScalingExpectation) Then(sp1 *Service, err error) *ClientMock

+ type ClientMockUpdateReplicaScalingParamPtrs struct

+ type ClientMockUpdateReplicaScalingParams struct

+ type ClientMockUpdateReplicaScalingResults struct

+ type ReplicaScalingUpdate struct

+ IdleScaling *bool

+ IdleTimeoutMinutes *int

+ MaxReplicaMemoryGb *int

+ MinReplicaMemoryGb *int

+ NumReplicas *int

type Service

+ MaxReplicaMemoryGb *int

+ MinReplicaMemoryGb *int

+ func (s *Service) FixMemoryBounds()

v1.0.0

Aug 23, 2024

Changes in this version

+ const StateProvisioning

+ const StateStopped

+ const StateStopping

+ func IsNotFound(err error) bool

+ func RetriableError(statusCode int) bool

type Client

+ WaitForServiceState func(serviceId string, stateChecker func(string) bool, maxWaitSeconds int) error

type ClientImpl

+ func (c *ClientImpl) WaitForServiceState(serviceId string, stateChecker func(string) bool, maxWaitSeconds int) error

type ClientMock

+ WaitForServiceStateMock mClientMockWaitForServiceState

+ func (m *ClientMock) MinimockWaitForServiceStateDone() bool

+ func (m *ClientMock) MinimockWaitForServiceStateInspect()

+ func (mmWaitForServiceState *ClientMock) WaitForServiceState(serviceId string, stateChecker func(string) bool, maxWaitSeconds int) (err error)

+ func (mmWaitForServiceState *ClientMock) WaitForServiceStateAfterCounter() uint64

+ func (mmWaitForServiceState *ClientMock) WaitForServiceStateBeforeCounter() uint64

+ type ClientMockWaitForServiceStateExpectation struct

+ Counter uint64

+ func (e *ClientMockWaitForServiceStateExpectation) Then(err error) *ClientMock

+ type ClientMockWaitForServiceStateParamPtrs struct

+ type ClientMockWaitForServiceStateParams struct

+ type ClientMockWaitForServiceStateResults struct

v0

v0.3.0

Aug 9, 2024

v0.2.3

Aug 7, 2024

v0.2.2

Aug 7, 2024

Changes in this version

+ const MaxRetry

+ const TierDevelopment

+ const TierProduction

+ type Client interface

+ CreateService func(s Service) (*Service, string, error)

+ DeleteService func(serviceId string) (*Service, error)

+ GetOrgPrivateEndpointConfig func(cloudProvider string, region string) (*OrgPrivateEndpointConfig, error)

+ GetOrganizationPrivateEndpoints func() (*[]PrivateEndpoint, error)

+ GetService func(serviceId string) (*Service, error)

+ GetServiceStatusCode func(serviceId string) (*int, error)

+ UpdateOrganizationPrivateEndpoints func(orgUpdate OrganizationUpdate) (*[]PrivateEndpoint, error)

+ UpdateService func(serviceId string, s ServiceUpdate) (*Service, error)

+ UpdateServicePassword func(serviceId string, u ServicePasswordUpdate) (*ServicePasswordUpdateResult, error)

+ UpdateServiceScaling func(serviceId string, s ServiceScalingUpdate) (*Service, error)

+ type ClientImpl struct

+ BaseUrl string

+ HttpClient *http.Client

+ OrganizationId string

+ TokenKey string

+ TokenSecret string

+ func NewClient(apiUrl string, organizationId string, tokenKey string, tokenSecret string) (*ClientImpl, error)

+ func (c *ClientImpl) CreateService(s Service) (*Service, string, error)

+ func (c *ClientImpl) DeleteService(serviceId string) (*Service, error)

+ func (c *ClientImpl) GetOrgPrivateEndpointConfig(cloudProvider string, region string) (*OrgPrivateEndpointConfig, error)

+ func (c *ClientImpl) GetOrganizationPrivateEndpoints() (*[]PrivateEndpoint, error)

+ func (c *ClientImpl) GetService(serviceId string) (*Service, error)

+ func (c *ClientImpl) GetServiceStatusCode(serviceId string) (*int, error)

+ func (c *ClientImpl) UpdateOrganizationPrivateEndpoints(orgUpdate OrganizationUpdate) (*[]PrivateEndpoint, error)

+ func (c *ClientImpl) UpdateService(serviceId string, s ServiceUpdate) (*Service, error)

+ func (c *ClientImpl) UpdateServicePassword(serviceId string, u ServicePasswordUpdate) (*ServicePasswordUpdateResult, error)

+ func (c *ClientImpl) UpdateServiceScaling(serviceId string, s ServiceScalingUpdate) (*Service, error)

+ type ClientMock struct

+ CreateServiceMock mClientMockCreateService

+ DeleteServiceMock mClientMockDeleteService

+ GetOrgPrivateEndpointConfigMock mClientMockGetOrgPrivateEndpointConfig

+ GetOrganizationPrivateEndpointsMock mClientMockGetOrganizationPrivateEndpoints

+ GetServiceMock mClientMockGetService

+ GetServiceStatusCodeMock mClientMockGetServiceStatusCode

+ UpdateOrganizationPrivateEndpointsMock mClientMockUpdateOrganizationPrivateEndpoints

+ UpdateServiceMock mClientMockUpdateService

+ UpdateServicePasswordMock mClientMockUpdateServicePassword

+ UpdateServiceScalingMock mClientMockUpdateServiceScaling

+ func NewClientMock(t minimock.Tester) *ClientMock

+ func (m *ClientMock) MinimockCreateServiceDone() bool

+ func (m *ClientMock) MinimockCreateServiceInspect()

+ func (m *ClientMock) MinimockDeleteServiceDone() bool

+ func (m *ClientMock) MinimockDeleteServiceInspect()

+ func (m *ClientMock) MinimockFinish()

+ func (m *ClientMock) MinimockGetOrgPrivateEndpointConfigDone() bool

+ func (m *ClientMock) MinimockGetOrgPrivateEndpointConfigInspect()

+ func (m *ClientMock) MinimockGetOrganizationPrivateEndpointsDone() bool

+ func (m *ClientMock) MinimockGetOrganizationPrivateEndpointsInspect()

+ func (m *ClientMock) MinimockGetServiceDone() bool

+ func (m *ClientMock) MinimockGetServiceInspect()

+ func (m *ClientMock) MinimockGetServiceStatusCodeDone() bool

+ func (m *ClientMock) MinimockGetServiceStatusCodeInspect()

+ func (m *ClientMock) MinimockUpdateOrganizationPrivateEndpointsDone() bool

+ func (m *ClientMock) MinimockUpdateOrganizationPrivateEndpointsInspect()

+ func (m *ClientMock) MinimockUpdateServiceDone() bool

+ func (m *ClientMock) MinimockUpdateServiceInspect()

+ func (m *ClientMock) MinimockUpdateServicePasswordDone() bool

+ func (m *ClientMock) MinimockUpdateServicePasswordInspect()

+ func (m *ClientMock) MinimockUpdateServiceScalingDone() bool

+ func (m *ClientMock) MinimockUpdateServiceScalingInspect()

+ func (m *ClientMock) MinimockWait(timeout mm_time.Duration)

+ func (mmCreateService *ClientMock) CreateService(s Service) (sp1 *Service, s1 string, err error)

+ func (mmCreateService *ClientMock) CreateServiceAfterCounter() uint64

+ func (mmCreateService *ClientMock) CreateServiceBeforeCounter() uint64

+ func (mmDeleteService *ClientMock) DeleteService(serviceId string) (sp1 *Service, err error)

+ func (mmDeleteService *ClientMock) DeleteServiceAfterCounter() uint64

+ func (mmDeleteService *ClientMock) DeleteServiceBeforeCounter() uint64

+ func (mmGetOrgPrivateEndpointConfig *ClientMock) GetOrgPrivateEndpointConfig(cloudProvider string, region string) (op1 *OrgPrivateEndpointConfig, err error)

+ func (mmGetOrgPrivateEndpointConfig *ClientMock) GetOrgPrivateEndpointConfigAfterCounter() uint64

+ func (mmGetOrgPrivateEndpointConfig *ClientMock) GetOrgPrivateEndpointConfigBeforeCounter() uint64

+ func (mmGetOrganizationPrivateEndpoints *ClientMock) GetOrganizationPrivateEndpoints() (pap1 *[]PrivateEndpoint, err error)

+ func (mmGetOrganizationPrivateEndpoints *ClientMock) GetOrganizationPrivateEndpointsAfterCounter() uint64

+ func (mmGetOrganizationPrivateEndpoints *ClientMock) GetOrganizationPrivateEndpointsBeforeCounter() uint64

+ func (mmGetService *ClientMock) GetService(serviceId string) (sp1 *Service, err error)

+ func (mmGetService *ClientMock) GetServiceAfterCounter() uint64

+ func (mmGetService *ClientMock) GetServiceBeforeCounter() uint64

+ func (mmGetServiceStatusCode *ClientMock) GetServiceStatusCode(serviceId string) (ip1 *int, err error)

+ func (mmGetServiceStatusCode *ClientMock) GetServiceStatusCodeAfterCounter() uint64

+ func (mmGetServiceStatusCode *ClientMock) GetServiceStatusCodeBeforeCounter() uint64

+ func (mmUpdateOrganizationPrivateEndpoints *ClientMock) UpdateOrganizationPrivateEndpoints(orgUpdate OrganizationUpdate) (pap1 *[]PrivateEndpoint, err error)

+ func (mmUpdateOrganizationPrivateEndpoints *ClientMock) UpdateOrganizationPrivateEndpointsAfterCounter() uint64

+ func (mmUpdateOrganizationPrivateEndpoints *ClientMock) UpdateOrganizationPrivateEndpointsBeforeCounter() uint64

+ func (mmUpdateService *ClientMock) UpdateService(serviceId string, s ServiceUpdate) (sp1 *Service, err error)

+ func (mmUpdateService *ClientMock) UpdateServiceAfterCounter() uint64

+ func (mmUpdateService *ClientMock) UpdateServiceBeforeCounter() uint64

+ func (mmUpdateServicePassword *ClientMock) UpdateServicePassword(serviceId string, u ServicePasswordUpdate) (sp1 *ServicePasswordUpdateResult, err error)

+ func (mmUpdateServicePassword *ClientMock) UpdateServicePasswordAfterCounter() uint64

+ func (mmUpdateServicePassword *ClientMock) UpdateServicePasswordBeforeCounter() uint64

+ func (mmUpdateServiceScaling *ClientMock) UpdateServiceScaling(serviceId string, s ServiceScalingUpdate) (sp1 *Service, err error)

+ func (mmUpdateServiceScaling *ClientMock) UpdateServiceScalingAfterCounter() uint64

+ func (mmUpdateServiceScaling *ClientMock) UpdateServiceScalingBeforeCounter() uint64

+ type ClientMockCreateServiceExpectation struct

+ Counter uint64

+ func (e *ClientMockCreateServiceExpectation) Then(sp1 *Service, s1 string, err error) *ClientMock

+ type ClientMockCreateServiceParamPtrs struct

+ type ClientMockCreateServiceParams struct

+ type ClientMockCreateServiceResults struct

+ type ClientMockDeleteServiceExpectation struct

+ Counter uint64

+ func (e *ClientMockDeleteServiceExpectation) Then(sp1 *Service, err error) *ClientMock

+ type ClientMockDeleteServiceParamPtrs struct

+ type ClientMockDeleteServiceParams struct

+ type ClientMockDeleteServiceResults struct

+ type ClientMockGetOrgPrivateEndpointConfigExpectation struct

+ Counter uint64

+ func (e *ClientMockGetOrgPrivateEndpointConfigExpectation) Then(op1 *OrgPrivateEndpointConfig, err error) *ClientMock

+ type ClientMockGetOrgPrivateEndpointConfigParamPtrs struct

+ type ClientMockGetOrgPrivateEndpointConfigParams struct

+ type ClientMockGetOrgPrivateEndpointConfigResults struct

+ type ClientMockGetOrganizationPrivateEndpointsExpectation struct

+ Counter uint64

+ type ClientMockGetOrganizationPrivateEndpointsResults struct

+ type ClientMockGetServiceExpectation struct

+ Counter uint64

+ func (e *ClientMockGetServiceExpectation) Then(sp1 *Service, err error) *ClientMock

+ type ClientMockGetServiceParamPtrs struct

+ type ClientMockGetServiceParams struct

+ type ClientMockGetServiceResults struct

+ type ClientMockGetServiceStatusCodeExpectation struct

+ Counter uint64

+ func (e *ClientMockGetServiceStatusCodeExpectation) Then(ip1 *int, err error) *ClientMock

+ type ClientMockGetServiceStatusCodeParamPtrs struct

+ type ClientMockGetServiceStatusCodeParams struct

+ type ClientMockGetServiceStatusCodeResults struct

+ type ClientMockUpdateOrganizationPrivateEndpointsExpectation struct

+ Counter uint64

+ func (e *ClientMockUpdateOrganizationPrivateEndpointsExpectation) Then(pap1 *[]PrivateEndpoint, err error) *ClientMock

+ type ClientMockUpdateOrganizationPrivateEndpointsParamPtrs struct

+ type ClientMockUpdateOrganizationPrivateEndpointsParams struct

+ type ClientMockUpdateOrganizationPrivateEndpointsResults struct

+ type ClientMockUpdateServiceExpectation struct

+ Counter uint64

+ func (e *ClientMockUpdateServiceExpectation) Then(sp1 *Service, err error) *ClientMock

+ type ClientMockUpdateServiceParamPtrs struct

+ type ClientMockUpdateServiceParams struct

+ type ClientMockUpdateServicePasswordExpectation struct

+ Counter uint64

+ func (e *ClientMockUpdateServicePasswordExpectation) Then(sp1 *ServicePasswordUpdateResult, err error) *ClientMock

+ type ClientMockUpdateServicePasswordParamPtrs struct

+ type ClientMockUpdateServicePasswordParams struct

+ type ClientMockUpdateServicePasswordResults struct

+ type ClientMockUpdateServiceResults struct

+ type ClientMockUpdateServiceScalingExpectation struct

+ Counter uint64

+ func (e *ClientMockUpdateServiceScalingExpectation) Then(sp1 *Service, err error) *ClientMock

+ type ClientMockUpdateServiceScalingParamPtrs struct

+ type ClientMockUpdateServiceScalingParams struct

+ type ClientMockUpdateServiceScalingResults struct

+ type Endpoint struct

+ Host string

+ Port int

+ Protocol string

+ type IpAccess struct

+ Description string

+ Source string

+ type IpAccessUpdate struct

+ Add []IpAccess

+ Remove []IpAccess

+ type OrgPrivateEndpointConfig struct

+ EndpointServiceId string

+ type OrgPrivateEndpointConfigGetResponse struct

+ Result OrgPrivateEndpointConfig

+ type OrgPrivateEndpointsUpdate struct

+ Add []PrivateEndpoint

+ Remove []PrivateEndpoint

+ type OrgResult struct

+ CreatedAt string

+ ID string

+ Name string

+ PrivateEndpoints []PrivateEndpoint

+ type OrganizationGetResponse struct

+ Result OrgResult

+ type OrganizationUpdate struct

+ PrivateEndpoints *OrgPrivateEndpointsUpdate

+ type OrganizationUpdateResponse struct

+ Result OrgResult

+ type PrivateEndpoint struct

+ CloudProvider string

+ Description string

+ EndpointId string

+ Region string

+ type PrivateEndpointIdsUpdate struct

+ Add []string

+ Remove []string

+ type Service struct

+ EncryptionAssumedRoleIdentifier string

+ EncryptionKey string

+ Endpoints []Endpoint

+ IAMRole string

+ Id string

+ IdleScaling bool

+ IdleTimeoutMinutes *int

+ IpAccessList []IpAccess

+ MaxTotalMemoryGb *int

+ MinTotalMemoryGb *int

+ Name string

+ NumReplicas *int

+ PrivateEndpointConfig *ServicePrivateEndpointConfig

+ PrivateEndpointIds []string

+ Provider string

+ Region string

+ State string

+ Tier string

+ type ServiceBody struct

+ Service Service

+ type ServiceDeleteResponse struct

+ Result ServiceResponseResult

+ type ServiceGetResponse struct

+ Result Service

+ type ServiceManagedEncryption struct

+ AssumeRoleArn string

+ KeyArn string

+ type ServicePasswordUpdate struct

+ NewDoubleSha1Hash string

+ NewPasswordHash string

+ type ServicePasswordUpdateResult struct

+ Password string

+ type ServicePatchResponse struct

+ Result Service

+ type ServicePostResponse struct

+ Result ServiceResponseResult

+ type ServicePrivateEndpointConfig struct

+ EndpointServiceId string

+ PrivateDnsHostname string

+ type ServicePrivateEndpointConfigResponse struct

+ Result ServicePrivateEndpointConfig

+ type ServiceResponseResult struct

+ Password string

+ Service Service

+ type ServiceScalingUpdate struct

+ IdleScaling *bool

+ IdleTimeoutMinutes *int

+ MaxTotalMemoryGb *int

+ MinTotalMemoryGb *int

+ NumReplicas *int

+ type ServiceStateUpdate struct

+ Command string

+ type ServiceUpdate struct

+ IpAccessList *IpAccessUpdate

+ Name string

+ PrivateEndpointIds *PrivateEndpointIdsUpdate

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