Package org.opensearch.client.opensearch.cat

Class IndicesRequest.Builder

    • Constructor Detail

      • Builder

        public Builder()

    • Method Detail

      • bytes

        public final IndicesRequest.Builder bytes​(@Nullable
                                          Bytes value)
        The unit in which to display byte values

        API name: bytes

      • expandWildcards

        public final IndicesRequest.Builder expandWildcards​(java.util.List<ExpandWildcard> list)
        Whether to expand wildcard expression to concrete indices that are open, closed or both.

        API name: expand_wildcards

        Adds all elements of list to expandWildcards.

      • expandWildcards

        public final IndicesRequest.Builder expandWildcards​(ExpandWildcard value,
                                                    ExpandWildcard... values)
        Whether to expand wildcard expression to concrete indices that are open, closed or both.

        API name: expand_wildcards

        Adds one or more values to expandWildcards.

      • health

        public final IndicesRequest.Builder health​(@Nullable
                                           HealthStatus value)
        A health status ("green", "yellow", or "red" to filter only indices matching the specified health status

        API name: health

      • includeUnloadedSegments

        public final IndicesRequest.Builder includeUnloadedSegments​(@Nullable
                                                            java.lang.Boolean value)
        If set to true segment stats will include stats for segments that are not currently loaded into memory

        API name: include_unloaded_segments

      • index

        public final IndicesRequest.Builder index​(java.util.List<java.lang.String> list)
        A comma-separated list of index names to limit the returned information

        API name: index

        Adds all elements of list to index.

      • index

        public final IndicesRequest.Builder index​(java.lang.String value,
                                          java.lang.String... values)
        A comma-separated list of index names to limit the returned information

        API name: index

        Adds one or more values to index.

      • pri

        public final IndicesRequest.Builder pri​(@Nullable
                                        java.lang.Boolean value)
        Set to true to return stats only for primary shards

        API name: pri

      • build

        public IndicesRequest build()
        Builds a IndicesRequest.
        Throws:
        java.lang.NullPointerException - if some of the required fields are null.