Package co.elastic.clients.elasticsearch.transform

Class GetTransformRequest.Builder

java.lang.Object
co.elastic.clients.util.ObjectBuilderBase
co.elastic.clients.util.WithJsonObjectBuilderBase<BuilderT>
co.elastic.clients.elasticsearch._types.RequestBase.AbstractBuilder<GetTransformRequest.Builder>
co.elastic.clients.elasticsearch.transform.GetTransformRequest.Builder
All Implemented Interfaces:
WithJson<GetTransformRequest.Builder>, ObjectBuilder<GetTransformRequest>
Enclosing class:
GetTransformRequest
public static class GetTransformRequest.Builder
extends RequestBase.AbstractBuilder<GetTransformRequest.Builder>
implements ObjectBuilder<GetTransformRequest>
Builder for GetTransformRequest.

  • Constructor Details

    • Builder

      public Builder()

  • Method Details

    • allowNoMatch

      public final GetTransformRequest.Builder allowNoMatch​(@Nullable java.lang.Boolean value)
      Specifies what to do when the request:
      1. Contains wildcard expressions and there are no transforms that match.
      2. Contains the _all string or no identifiers and there are no matches.
      3. Contains wildcard expressions and there are only partial matches.

      If this parameter is false, the request returns a 404 status code when there are no matches or only partial matches.

      API name: allow_no_match

    • excludeGenerated

      public final GetTransformRequest.Builder excludeGenerated​(@Nullable java.lang.Boolean value)
      Excludes fields that were automatically added when creating the transform. This allows the configuration to be in an acceptable format to be retrieved and then added to another cluster.

      API name: exclude_generated

    • from

      public final GetTransformRequest.Builder from​(@Nullable java.lang.Integer value)
      Skips the specified number of transforms.

      API name: from

    • size

      public final GetTransformRequest.Builder size​(@Nullable java.lang.Integer value)
      Specifies the maximum number of transforms to obtain.

      API name: size

    • transformId

      public final GetTransformRequest.Builder transformId​(java.util.List<java.lang.String> list)
      Identifier for the transform. It can be a transform identifier or a wildcard expression. You can get information for all transforms by using _all, by specifying * as the <transform_id>, or by omitting the <transform_id>.

      API name: transform_id

      Adds all elements of list to transformId.

    • transformId

      public final GetTransformRequest.Builder transformId​(java.lang.String value, java.lang.String... values)
      Identifier for the transform. It can be a transform identifier or a wildcard expression. You can get information for all transforms by using _all, by specifying * as the <transform_id>, or by omitting the <transform_id>.

      API name: transform_id

      Adds one or more values to transformId.

    • self

      protected GetTransformRequest.Builder self()
      Specified by:
      self in class RequestBase.AbstractBuilder<GetTransformRequest.Builder>

    • build

      public GetTransformRequest build()
      Builds a GetTransformRequest.
      Specified by:
      build in interface ObjectBuilder<GetTransformRequest>
      Throws:
      java.lang.NullPointerException - if some of the required fields are null.