Package co.elastic.clients.elasticsearch.snapshot

Class GetRepositoryRequest.Builder

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

  • Constructor Details

    • Builder

      public Builder()

  • Method Details

    • local

      public final GetRepositoryRequest.Builder local(@Nullable Boolean value)
      If true, the request gets information from the local node only. If false, the request gets information from the master node.

      API name: local

    • masterTimeout

      public final GetRepositoryRequest.Builder masterTimeout(@Nullable Time value)
      The period to wait for the master node. If the master node is not available before the timeout expires, the request fails and returns an error. To indicate that the request should never timeout, set it to -1.

      API name: master_timeout

    • masterTimeout

      public final GetRepositoryRequest.Builder masterTimeout(Function<Time.Builder,ObjectBuilder<Time>> fn)
      The period to wait for the master node. If the master node is not available before the timeout expires, the request fails and returns an error. To indicate that the request should never timeout, set it to -1.

      API name: master_timeout

    • name

      public final GetRepositoryRequest.Builder name(List<String> list)
      A comma-separated list of snapshot repository names used to limit the request. Wildcard (*) expressions are supported including combining wildcards with exclude patterns starting with -.

      To get information about all snapshot repositories registered in the cluster, omit this parameter or use * or _all.

      API name: repository

      Adds all elements of list to name.

    • name

      public final GetRepositoryRequest.Builder name(String value, String... values)
      A comma-separated list of snapshot repository names used to limit the request. Wildcard (*) expressions are supported including combining wildcards with exclude patterns starting with -.

      To get information about all snapshot repositories registered in the cluster, omit this parameter or use * or _all.

      API name: repository

      Adds one or more values to name.

    • self

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

    • build

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