Package co.elastic.clients.elasticsearch.cat

Class TransformsRequest

java.lang.Object
co.elastic.clients.elasticsearch._types.RequestBase
co.elastic.clients.elasticsearch.cat.CatRequestBase
co.elastic.clients.elasticsearch.cat.TransformsRequest
public class TransformsRequest
extends CatRequestBase
Returns configuration and usage information about transforms.

IMPORTANT: cat APIs are only intended for human consumption using the Kibana console or command line. They are not intended for use by applications. For application consumption, use the get transform statistics API.

See Also:
API specification

  • Field Details

  • Method Details

    • of

      public static TransformsRequest of​(java.util.function.Function<TransformsRequest.Builder,​ObjectBuilder<TransformsRequest>> fn)

    • allowNoMatch

      @Nullable public final java.lang.Boolean allowNoMatch()
      Whether to ignore if a wildcard expression matches no transforms. (This includes _all string or when no transforms have been specified)

      API name: allow_no_match

    • from

      @Nullable public final java.lang.Integer from()
      skips a number of transform configs, defaults to 0

      API name: from

    • h

      public final java.util.List<CatTransformColumn> h()
      Comma-separated list of column names to display.

      API name: h

    • s

      public final java.util.List<CatTransformColumn> s()
      Comma-separated list of column names or column aliases used to sort the response.

      API name: s

    • size

      @Nullable public final java.lang.Integer size()
      specifies a max number of transforms to get, defaults to 100

      API name: size

    • time

      @Nullable public final Time time()
      Unit used to display time values.

      API name: time

    • transformId

      @Nullable public final java.lang.String transformId()
      The id of the transform for which to get stats. '_all' or '*' implies all transforms

      API name: transform_id