package
2.16.1
Repository: https://github.com/elastic/cloud-on-k8s.git
Documentation: pkg.go.dev

# Packages

No description provided by the author

# Functions

No description provided by the author
IsConflict checks whether the error was an HTTP 409 error.
IsForbidden checks whether the error was an HTTP 403 error.
IsNotFound checks whether the error was an HTTP 404 error.
IsTimeout checks whether the error was an HTTP 408 error.
IsUnauthorized checks whether the error was an HTTP 401 error.
NewElasticsearchClient creates a new client for the target cluster.
No description provided by the author
No description provided by the author
No description provided by the author
NewStaticURLProvider is a static implementation of the URL provider interface for testing purposes.
Timeout returns the Elasticsearch client timeout value for the given Elasticsearch resource.

# Constants

Supported ElasticsearchLicenseTypes.
Supported ElasticsearchLicenseTypes.
Supported ElasticsearchLicenseTypes.
Supported ElasticsearchLicenseTypes.
Supported ElasticsearchLicenseTypes.
ESClientTimeoutAnnotation is the name of the annotation used to set the Elasticsearch client timeout.
These are possible shard states.
No description provided by the author
These are possible shard states.
No description provided by the author
These are possible shard states.
These are possible shard states.

# Variables

DefaultESClientTimeout is the default timeout value for Elasticsearch requests.
ElasticsearchLicenseTypeOrder license types mapped to ints in increasing order of feature sets for sorting purposes.
Remove indicates the intent to permanently remove a node from the Elasticsearch cluster.
Restart indicates the intent to restart an Elasticsearch node.
ShutdownComplete means a shutdown request has been processed and the node can be either restarted or taken out of the cluster by an orchestrator.
ShutdownInProgress means a shutdown request has been accepted and is being processed in Elasticsearch.
ShutdownNotStarted is an error condition that should never be returned by Elasticsearch and indicates a bug if so.
ShutdownStalled means a shutdown request cannot be processed further because of a limiting constraint e.g.

# Structs

No description provided by the author
AllocationSettings model a subset of the supported attributes for dynamic Elasticsearch cluster settings.
APIError is a non 2xx response from the Elasticsearch API.
No description provided by the author
AutoscalingCapacity models a capacity value as received by Elasticsearch.
AutoscalingCapacityInfo models capacity information as received by the autoscaling Elasticsearch API.
AutoscalingCapacityResult models autoscaling capacity decisions.
No description provided by the author
No description provided by the author
No description provided by the author
BasicAuth contains credentials for an Elasticsearch user.
No description provided by the author
Cluster models the Elasticsearch response for searches that involve remote clusters.
No description provided by the author
ClusterRoutingAllocation models a subset of transient allocation settings for an Elasticsearch cluster.
No description provided by the author
ClusterState models the internal representation of the cluster state.
ClusterStateNode represents an element in the `node` structure in Elasticsearch cluster state.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
DiscoveryZen set minimum number of master eligible nodes that must be visible to form a cluster.
DiscoveryZenSettings are cluster settings related to the zen discovery mechanism.
ErrorResponse is an Elasticsearch error response.
No description provided by the author
No description provided by the author
No description provided by the author
Health represents the response from _cluster/health.
Hit represents a single search hit.
Hits are the collections of search hits.
No description provided by the author
Info represents the response from /.
No description provided by the author
License models the Elasticsearch license applied to a cluster.
LicenseResponse is the response to GET _xpack/license.
LicenseUpdateRequest is the request to apply a license to a cluster.
LicenseUpdateResponse is the response to a license update request.
MachineLearningSettings is used to build a request to update ML related settings for autoscaling.
MachineLearningSettingsGroup is a group of persistent settings.
No description provided by the author
Node partially models an Elasticsearch node retrieved from /_nodes.
Nodes partially models the response from a request to /_nodes.
No description provided by the author
NodeShutdown is the representation of an ongoing shutdown request.
NodesStats partially models the response from a request to /_nodes/stats.
NodeStats partially models an Elasticsearch node retrieved from /_nodes/stats.
PersistentTasks expresses the status of preparing ongoing persistent tasks for a node shutdown.
Plugins represents the status of Elasticsearch plugins being prepared for a node shutdown.
No description provided by the author
RemoteCluster is the set of seeds to use in a remote cluster setting.
RemoteClusters models the configuration of the remote clusters.
RemoteClustersSettings is used to build a request to update remote clusters.
No description provided by the author
Role represents an Elasticsearch role.
No description provided by the author
No description provided by the author
No description provided by the author
SearchResults are the results returned from a _search.
No description provided by the author
SettingsGroup is a group of persistent settings.
Shard partially models Elasticsearch cluster shard.
ShardMigration is the status of shards that are being migrated away from a node that goes through a shutdown.
ShutdownRequest is the body of a node shutdown request.
ShutdownResponse is the response wrapper for retrieving the status of ongoing node shutdowns from Elasticsearch.
StartBasicResponse is the response to the start trial API call.
StartTrialResponse is the response to the start trial API call.

# Interfaces

AllocationSetter captures Elasticsearch API calls around allocation filtering.
No description provided by the author
Client captures the information needed to interact with an Elasticsearch cluster via HTTP.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
ShardLister captures Elasticsearch API calls around shards retrieval.
No description provided by the author

# Type aliases

ElasticsearchLicenseType the type of a license.
No description provided by the author
Shards contains the shards in the Elasticsearch cluster.
No description provided by the author
No description provided by the author
ShutdownStatus is the set of different status a shutdown requests can have.
ShutdownType is the set of different shutdown operation types supported by Elasticsearch.