opensearch

package
v0.48.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Oct 25, 2024 License: Apache-2.0 Imports: 5 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func HealthTypeChoices added in v0.3.0 

func HealthTypeChoices() []string

func IndexeStatusTypeChoices added in v0.3.0 

func IndexeStatusTypeChoices() []string

func PermissionTypeChoices 

func PermissionTypeChoices() []string

Types

type AclIn 

type AclIn struct {
	Rules    []RuleIn `json:"rules"` // OpenSearch rules
	Username string   `json:"username"`
}

type AclOut 

type AclOut struct {
	Rules    []RuleOut `json:"rules"` // OpenSearch rules
	Username string    `json:"username"`
}

type Handler 

type Handler interface {
	// ServiceOpenSearchAclGet show OpenSearch ACL configuration
	// GET /v1/project/{project}/service/{service_name}/opensearch/acl
	// https://api.aiven.io/doc/#tag/Service:_OpenSearch/operation/ServiceOpenSearchAclGet
	ServiceOpenSearchAclGet(ctx context.Context, project string, serviceName string) (*ServiceOpenSearchAclGetOut, error)

	// ServiceOpenSearchAclSet set OpenSearch ACL configuration
	// POST /v1/project/{project}/service/{service_name}/opensearch/acl
	// https://api.aiven.io/doc/#tag/Service:_OpenSearch/operation/ServiceOpenSearchAclSet
	ServiceOpenSearchAclSet(ctx context.Context, project string, serviceName string, in *ServiceOpenSearchAclSetIn) (*ServiceOpenSearchAclSetOut, error)

	// ServiceOpenSearchAclUpdate update OpenSearch ACL configuration
	// PUT /v1/project/{project}/service/{service_name}/opensearch/acl
	// https://api.aiven.io/doc/#tag/Service:_OpenSearch/operation/ServiceOpenSearchAclUpdate
	ServiceOpenSearchAclUpdate(ctx context.Context, project string, serviceName string, in *ServiceOpenSearchAclUpdateIn) (*ServiceOpenSearchAclUpdateOut, error)

	// ServiceOpenSearchIndexDelete delete an OpenSearch index
	// DELETE /v1/project/{project}/service/{service_name}/index/{index_name}
	// https://api.aiven.io/doc/#tag/Service:_OpenSearch/operation/ServiceOpenSearchIndexDelete
	ServiceOpenSearchIndexDelete(ctx context.Context, project string, serviceName string, indexName string) error

	// ServiceOpenSearchIndexList list OpenSearch indexes
	// GET /v1/project/{project}/service/{service_name}/index
	// https://api.aiven.io/doc/#tag/Service:_OpenSearch/operation/ServiceOpenSearchIndexList
	ServiceOpenSearchIndexList(ctx context.Context, project string, serviceName string) ([]IndexeOut, error)

	// ServiceOpenSearchSecurityGet show OpenSearch security configuration status
	// GET /v1/project/{project}/service/{service_name}/opensearch/security
	// https://api.aiven.io/doc/#tag/Service:_OpenSearch/operation/ServiceOpenSearchSecurityGet
	ServiceOpenSearchSecurityGet(ctx context.Context, project string, serviceName string) (*ServiceOpenSearchSecurityGetOut, error)

	// ServiceOpenSearchSecurityReset change Opensearch Security Admin password
	// PUT /v1/project/{project}/service/{service_name}/opensearch/security/admin
	// https://api.aiven.io/doc/#tag/Service:_OpenSearch/operation/ServiceOpenSearchSecurityReset
	ServiceOpenSearchSecurityReset(ctx context.Context, project string, serviceName string, in *ServiceOpenSearchSecurityResetIn) (*ServiceOpenSearchSecurityResetOut, error)

	// ServiceOpenSearchSecuritySet enable Opensearch Security Admin by setting the password
	// POST /v1/project/{project}/service/{service_name}/opensearch/security/admin
	// https://api.aiven.io/doc/#tag/Service:_OpenSearch/operation/ServiceOpenSearchSecuritySet
	ServiceOpenSearchSecuritySet(ctx context.Context, project string, serviceName string, in *ServiceOpenSearchSecuritySetIn) (*ServiceOpenSearchSecuritySetOut, error)
}

type HealthType added in v0.3.0 

type HealthType string
const (
	HealthTypeGreen       HealthType = "green"
	HealthTypeYellow      HealthType = "yellow"
	HealthTypeRed         HealthType = "red"
	HealthTypeRedAsterisk HealthType = "red*"
	HealthTypeUnknown     HealthType = "unknown"
)

type IndexeOut 

type IndexeOut struct {
	CreateTime          time.Time        `json:"create_time"`                      // Timestamp in ISO 8601 format, always in UTC
	Docs                *int             `json:"docs,omitempty"`                   // Number of documents in index. -1 means not available.
	Health              HealthType       `json:"health,omitempty"`                 // Index health
	IndexName           string           `json:"index_name"`                       // Index name
	NumberOfReplicas    int              `json:"number_of_replicas"`               // Number of replicas for an index
	NumberOfShards      int              `json:"number_of_shards"`                 // Number of shards in an index
	ReadOnlyAllowDelete *bool            `json:"read_only_allow_delete,omitempty"` // Whether an index is set as read-only (but allows deletion). null means unknown.
	Replication         *ReplicationOut  `json:"replication,omitempty"`            // Index replication
	Size                *int             `json:"size,omitempty"`                   // Index size in bytes. -1 means not available.
	Status              IndexeStatusType `json:"status,omitempty"`                 // Index status
}

type IndexeStatusType added in v0.3.0 

type IndexeStatusType string
const (
	IndexeStatusTypeUnknown IndexeStatusType = "unknown"
	IndexeStatusTypeOpen    IndexeStatusType = "open"
	IndexeStatusTypeClose   IndexeStatusType = "close"
	IndexeStatusTypeNone    IndexeStatusType = "none"
)

type OpenSearchHandler 

type OpenSearchHandler struct {
	// contains filtered or unexported fields
}

func NewHandler 

func NewHandler(doer doer) OpenSearchHandler

func (*OpenSearchHandler) ServiceOpenSearchAclGet 

func (h *OpenSearchHandler) ServiceOpenSearchAclGet(ctx context.Context, project string, serviceName string) (*ServiceOpenSearchAclGetOut, error)

func (*OpenSearchHandler) ServiceOpenSearchAclSet 

func (h *OpenSearchHandler) ServiceOpenSearchAclSet(ctx context.Context, project string, serviceName string, in *ServiceOpenSearchAclSetIn) (*ServiceOpenSearchAclSetOut, error)

func (*OpenSearchHandler) ServiceOpenSearchAclUpdate 

func (h *OpenSearchHandler) ServiceOpenSearchAclUpdate(ctx context.Context, project string, serviceName string, in *ServiceOpenSearchAclUpdateIn) (*ServiceOpenSearchAclUpdateOut, error)

func (*OpenSearchHandler) ServiceOpenSearchIndexDelete 

func (h *OpenSearchHandler) ServiceOpenSearchIndexDelete(ctx context.Context, project string, serviceName string, indexName string) error

func (*OpenSearchHandler) ServiceOpenSearchIndexList 

func (h *OpenSearchHandler) ServiceOpenSearchIndexList(ctx context.Context, project string, serviceName string) ([]IndexeOut, error)

func (*OpenSearchHandler) ServiceOpenSearchSecurityGet 

func (h *OpenSearchHandler) ServiceOpenSearchSecurityGet(ctx context.Context, project string, serviceName string) (*ServiceOpenSearchSecurityGetOut, error)

func (*OpenSearchHandler) ServiceOpenSearchSecurityReset 

func (h *OpenSearchHandler) ServiceOpenSearchSecurityReset(ctx context.Context, project string, serviceName string, in *ServiceOpenSearchSecurityResetIn) (*ServiceOpenSearchSecurityResetOut, error)

func (*OpenSearchHandler) ServiceOpenSearchSecuritySet 

func (h *OpenSearchHandler) ServiceOpenSearchSecuritySet(ctx context.Context, project string, serviceName string, in *ServiceOpenSearchSecuritySetIn) (*ServiceOpenSearchSecuritySetOut, error)

type OpensearchAclConfigIn 

type OpensearchAclConfigIn struct {
	Acls    []AclIn `json:"acls"`    // List of OpenSearch ACLs
	Enabled bool    `json:"enabled"` // Enable OpenSearch ACLs. When disabled authenticated service users have unrestricted access.
}

OpensearchAclConfigIn OpenSearch ACL configuration

type PermissionType 

type PermissionType string
const (
	PermissionTypeDeny      PermissionType = "deny"
	PermissionTypeAdmin     PermissionType = "admin"
	PermissionTypeRead      PermissionType = "read"
	PermissionTypeReadwrite PermissionType = "readwrite"
	PermissionTypeWrite     PermissionType = "write"
)

type ReplicationOut 

type ReplicationOut struct {
	LeaderIndex   *string `json:"leader_index,omitempty"`   // Leader index name
	LeaderProject *string `json:"leader_project,omitempty"` // Leader project name
	LeaderService *string `json:"leader_service,omitempty"` // Leader service name
}

ReplicationOut Index replication

type RuleIn 

type RuleIn struct {
	Index      string         `json:"index"`      // OpenSearch index pattern
	Permission PermissionType `json:"permission"` // OpenSearch permission
}

type RuleOut 

type RuleOut struct {
	Index      string         `json:"index"`      // OpenSearch index pattern
	Permission PermissionType `json:"permission"` // OpenSearch permission
}

type ServiceOpenSearchAclGetOut 

type ServiceOpenSearchAclGetOut struct {
	Acls    []AclOut `json:"acls"`    // List of OpenSearch ACLs
	Enabled bool     `json:"enabled"` // Enable OpenSearch ACLs. When disabled authenticated service users have unrestricted access.
}

ServiceOpenSearchAclGetOut OpenSearch ACL configuration

type ServiceOpenSearchAclSetIn 

type ServiceOpenSearchAclSetIn struct {
	OpensearchAclConfig OpensearchAclConfigIn `json:"opensearch_acl_config"` // OpenSearch ACL configuration
}

ServiceOpenSearchAclSetIn ServiceOpenSearchAclSetRequestBody

type ServiceOpenSearchAclSetOut 

type ServiceOpenSearchAclSetOut struct {
	Acls    []AclOut `json:"acls"`    // List of OpenSearch ACLs
	Enabled bool     `json:"enabled"` // Enable OpenSearch ACLs. When disabled authenticated service users have unrestricted access.
}

ServiceOpenSearchAclSetOut OpenSearch ACL configuration

type ServiceOpenSearchAclUpdateIn 

type ServiceOpenSearchAclUpdateIn struct {
	OpensearchAclConfig ServiceOpenSearchAclUpdateOpensearchAclConfigIn `json:"opensearch_acl_config"` // OpenSearch ACL configuration
}

ServiceOpenSearchAclUpdateIn ServiceOpenSearchAclUpdateRequestBody

type ServiceOpenSearchAclUpdateOpensearchAclConfigIn added in v0.36.0 

type ServiceOpenSearchAclUpdateOpensearchAclConfigIn struct {
	Acls    *[]AclIn `json:"acls,omitempty"`    // List of OpenSearch ACLs
	Enabled *bool    `json:"enabled,omitempty"` // Enable OpenSearch ACLs. When disabled authenticated service users have unrestricted access.
}

ServiceOpenSearchAclUpdateOpensearchAclConfigIn OpenSearch ACL configuration

type ServiceOpenSearchAclUpdateOut 

type ServiceOpenSearchAclUpdateOut struct {
	Acls    []AclOut `json:"acls"`    // List of OpenSearch ACLs
	Enabled bool     `json:"enabled"` // Enable OpenSearch ACLs. When disabled authenticated service users have unrestricted access.
}

ServiceOpenSearchAclUpdateOut OpenSearch ACL configuration

type ServiceOpenSearchSecurityGetOut 

type ServiceOpenSearchSecurityGetOut struct {
	SecurityPluginAdminEnabled bool  `json:"security_plugin_admin_enabled"`     // security plugin admin defined
	SecurityPluginAvailable    bool  `json:"security_plugin_available"`         // Opensearch security available for the service
	SecurityPluginEnabled      *bool `json:"security_plugin_enabled,omitempty"` // Opensearch security enabled for the service
}

ServiceOpenSearchSecurityGetOut ServiceOpenSearchSecurityGetResponse

type ServiceOpenSearchSecurityResetIn 

type ServiceOpenSearchSecurityResetIn struct {
	AdminPassword string `json:"admin_password"` // Current os-sec-admin password
	NewPassword   string `json:"new_password"`   // New os-sec-admin password
}

ServiceOpenSearchSecurityResetIn ServiceOpenSearchSecurityResetRequestBody

type ServiceOpenSearchSecurityResetOut 

type ServiceOpenSearchSecurityResetOut struct {
	SecurityPluginAdminEnabled bool  `json:"security_plugin_admin_enabled"`     // security plugin admin defined
	SecurityPluginAvailable    bool  `json:"security_plugin_available"`         // Opensearch security available for the service
	SecurityPluginEnabled      *bool `json:"security_plugin_enabled,omitempty"` // Opensearch security enabled for the service
}

ServiceOpenSearchSecurityResetOut ServiceOpenSearchSecurityResetResponse

type ServiceOpenSearchSecuritySetIn 

type ServiceOpenSearchSecuritySetIn struct {
	AdminPassword string `json:"admin_password"` // os-sec-admin password
}

ServiceOpenSearchSecuritySetIn ServiceOpenSearchSecuritySetRequestBody

type ServiceOpenSearchSecuritySetOut 

type ServiceOpenSearchSecuritySetOut struct {
	SecurityPluginAdminEnabled bool  `json:"security_plugin_admin_enabled"`     // security plugin admin defined
	SecurityPluginAvailable    bool  `json:"security_plugin_available"`         // Opensearch security available for the service
	SecurityPluginEnabled      *bool `json:"security_plugin_enabled,omitempty"` // Opensearch security enabled for the service
}

ServiceOpenSearchSecuritySetOut ServiceOpenSearchSecuritySetResponse

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.