Documentation
¶
Index ¶
- func VerificationTypeChoices() []string
- type DomainHandler
- func (h *DomainHandler) OrganizationDomainAdd(ctx context.Context, organizationId string, in *OrganizationDomainAddIn) (*OrganizationDomainAddOut, error)
- func (h *DomainHandler) OrganizationDomainUpdate(ctx context.Context, organizationId string, domainId string, ...) (*OrganizationDomainUpdateOut, error)
- func (h *DomainHandler) OrganizationDomainVerify(ctx context.Context, organizationId string, domainId string) (*OrganizationDomainVerifyOut, error)
- func (h *DomainHandler) OrganizationDomainsList(ctx context.Context, organizationId string) ([]DomainOut, error)
- func (h *DomainHandler) OrganizationDomainsRemove(ctx context.Context, organizationId string, domainId string) error
- type DomainOut
- type Handler
- type OrganizationDomainAddIn
- type OrganizationDomainAddOut
- type OrganizationDomainUpdateIn
- type OrganizationDomainUpdateOut
- type OrganizationDomainVerifyOut
- type VerificationType
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func VerificationTypeChoices ¶
func VerificationTypeChoices() []string
Types ¶
type DomainHandler ¶
type DomainHandler struct {
// contains filtered or unexported fields
}
func NewHandler ¶
func NewHandler(doer doer) DomainHandler
func (*DomainHandler) OrganizationDomainAdd ¶
func (h *DomainHandler) OrganizationDomainAdd(ctx context.Context, organizationId string, in *OrganizationDomainAddIn) (*OrganizationDomainAddOut, error)
func (*DomainHandler) OrganizationDomainUpdate ¶
func (h *DomainHandler) OrganizationDomainUpdate(ctx context.Context, organizationId string, domainId string, in *OrganizationDomainUpdateIn) (*OrganizationDomainUpdateOut, error)
func (*DomainHandler) OrganizationDomainVerify ¶
func (h *DomainHandler) OrganizationDomainVerify(ctx context.Context, organizationId string, domainId string) (*OrganizationDomainVerifyOut, error)
func (*DomainHandler) OrganizationDomainsList ¶
func (*DomainHandler) OrganizationDomainsRemove ¶
type DomainOut ¶
type DomainOut struct {
ChallengeToken string `json:"challenge_token"`
CreateTime time.Time `json:"create_time"`
DomainId string `json:"domain_id"`
DomainName string `json:"domain_name"`
OrganizationId string `json:"organization_id"`
State string `json:"state"`
VerificationType string `json:"verification_type"`
}
type Handler ¶
type Handler interface {
// OrganizationDomainAdd create a domain
// POST /organization/{organization_id}/domains
// https://api.aiven.io/doc/#tag/Domains/operation/OrganizationDomainAdd
OrganizationDomainAdd(ctx context.Context, organizationId string, in *OrganizationDomainAddIn) (*OrganizationDomainAddOut, error)
// OrganizationDomainUpdate update a domain
// PATCH /organization/{organization_id}/domains/{domain_id}
// https://api.aiven.io/doc/#tag/Domains/operation/OrganizationDomainUpdate
OrganizationDomainUpdate(ctx context.Context, organizationId string, domainId string, in *OrganizationDomainUpdateIn) (*OrganizationDomainUpdateOut, error)
// OrganizationDomainVerify verify a domain
// POST /organization/{organization_id}/domains/{domain_id}/verify
// https://api.aiven.io/doc/#tag/Domains/operation/OrganizationDomainVerify
OrganizationDomainVerify(ctx context.Context, organizationId string, domainId string) (*OrganizationDomainVerifyOut, error)
// OrganizationDomainsList list domains
// GET /organization/{organization_id}/domains
// https://api.aiven.io/doc/#tag/Domains/operation/OrganizationDomainsList
OrganizationDomainsList(ctx context.Context, organizationId string) ([]DomainOut, error)
// OrganizationDomainsRemove delete a domain
// DELETE /organization/{organization_id}/domains/{domain_id}
// https://api.aiven.io/doc/#tag/Domains/operation/OrganizationDomainsRemove
OrganizationDomainsRemove(ctx context.Context, organizationId string, domainId string) error
}
type OrganizationDomainAddIn ¶
type OrganizationDomainAddIn struct {
DomainName string `json:"domain_name"`
VerificationType VerificationType `json:"verification_type"`
}
type OrganizationDomainAddOut ¶
type OrganizationDomainAddOut struct {
ChallengeToken string `json:"challenge_token"`
CreateTime time.Time `json:"create_time"`
DomainId string `json:"domain_id"`
DomainName string `json:"domain_name"`
OrganizationId string `json:"organization_id"`
State string `json:"state"`
VerificationType string `json:"verification_type"`
}
type OrganizationDomainUpdateIn ¶
type OrganizationDomainUpdateIn struct {
VerificationType VerificationType `json:"verification_type,omitempty"`
}
type OrganizationDomainUpdateOut ¶
type OrganizationDomainUpdateOut struct {
ChallengeToken string `json:"challenge_token"`
CreateTime time.Time `json:"create_time"`
DomainId string `json:"domain_id"`
DomainName string `json:"domain_name"`
OrganizationId string `json:"organization_id"`
State string `json:"state"`
VerificationType string `json:"verification_type"`
}
type OrganizationDomainVerifyOut ¶
type OrganizationDomainVerifyOut struct {
ChallengeToken string `json:"challenge_token"`
CreateTime time.Time `json:"create_time"`
DomainId string `json:"domain_id"`
DomainName string `json:"domain_name"`
OrganizationId string `json:"organization_id"`
State string `json:"state"`
VerificationType string `json:"verification_type"`
}
type VerificationType ¶
type VerificationType string
const ( VerificationTypeDns VerificationType = "dns" VerificationTypeHttp VerificationType = "http" )
Click to show internal directories.
Click to hide internal directories.