# README
OpenSearch Go Client
Welcome!
opensearch-go is a community-driven, open source fork of go-elasticsearch licensed under the Apache v2.0 License. For more information, see opensearch.org.
Project Resources
- Project Website
- Developer Guide
- User Guide
- Documentation
- API Documentation
- Need help? Try Forums
- Project Principles
- Contributing to OpenSearch
- Maintainer Responsibilities
- Release Management
- Admin Responsibilities
- Security
Code of Conduct
This project has adopted the Amazon Open Source Code of Conduct. For more information see the Code of Conduct FAQ, or contact [email protected] with any additional questions or comments.
License
This project is licensed under the Apache v2.0 License.
Copyright
Copyright OpenSearch Contributors. See NOTICE for details.
# Packages
SPDX-License-Identifier: Apache-2.0
The OpenSearch Contributors require contributions made to this file be licensed under the Apache-2.0 license or a compatible open source license.
Package opensearchtransport provides the transport layer for the OpenSearch client.
Package opensearchutil provides helper utilities to the Go client for OpenSearch.
No description provided by the author
No description provided by the author
# Functions
BuildRequest is a helper function to build a http.Request.
NewClient creates a new client with configuration from cfg.
NewDefaultClient creates a new client with default options.
ParseError tries to parse the opensearch error into an custom error.
ParseVersion returns an int64 representation of version.
ToPointer converts any value to a pointer, mainly used for request parameters.
# Constants
Version returns the package version as a string.
# Variables
Error vars.
Error vars.
Error vars.
Error vars.
Error vars.
Error vars.
Error vars.
Error vars.
Error vars.
Error vars.
# Structs
Client represents the OpenSearch client.
Config represents the client configuration.
Err represents the error of an API error response.
Error represents an Opensearch error with only an error field.
MessageError represents an Opensearch error with a message field.
ReasonError represents an Opensearch error with a reason field.
Response represents the API response.
RootCause represents the root_cause of an API error response.
StringError represnets an Opensearch error where error is a string.
StructError represents an Opensearch error with a detailed error struct.
# Interfaces
Request represents a requests the client can execute.