This documentation contains work-in-progress information for future Elastic Stack and Cloud releases. Use the version selector to view supported release docs. It also contains some Elastic Cloud serverless information. Check out our serverless docs for more details.
« Package structure and namespace clients Blocking and asynchronous clients »
Elastic Docs ›Elasticsearch Java API Client [master] ›API conventions

Method naming conventions

edit

Method naming conventions

edit

Classes in the Java API Client contain two kinds of methods and properties:

  • Methods and properties that are part of the API, such as ElasticsearchClient.search() or SearchResponse.maxScore(). They are derived from their respective names in the Elasticsearch JSON API using the standard Java camelCaseNaming convention.
  • Methods and properties that are part of the framework on which the Java API Client is built, such as Query._kind(). These methods and properties are prefixed with an underscore to both avoid any naming conflicts with API names, and as an easy way to distinguish the API from the framework.
« Package structure and namespace clients Blocking and asynchronous clients »