Class ListRequest.Builder
java.lang.Object
co.elastic.clients.util.ObjectBuilderBase
co.elastic.clients.util.WithJsonObjectBuilderBase<BuilderT>
co.elastic.clients.elasticsearch._types.RequestBase.AbstractBuilder<ListRequest.Builder>
co.elastic.clients.elasticsearch.connector.ListRequest.Builder
- All Implemented Interfaces:
WithJson<ListRequest.Builder>
,ObjectBuilder<ListRequest>
- Enclosing class:
- ListRequest
public static class ListRequest.Builder
extends RequestBase.AbstractBuilder<ListRequest.Builder>
implements ObjectBuilder<ListRequest>
Builder for
ListRequest
.-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionbuild()
Builds aListRequest
.final ListRequest.Builder
connectorName
(String value, String... values) A comma-separated list of connector names to fetch connector documents forfinal ListRequest.Builder
connectorName
(List<String> list) A comma-separated list of connector names to fetch connector documents forfinal ListRequest.Builder
Starting offset (default: 0)final ListRequest.Builder
includeDeleted
(Boolean value) A flag to indicate if the desired connector should be fetched, even if it was soft-deleted.final ListRequest.Builder
A comma-separated list of connector index names to fetch connector documents forfinal ListRequest.Builder
A comma-separated list of connector index names to fetch connector documents forfinal ListRequest.Builder
A wildcard query string that filters connectors with matching name, description or index nameprotected ListRequest.Builder
self()
final ListRequest.Builder
serviceType
(String value, String... values) A comma-separated list of connector service types to fetch connector documents forfinal ListRequest.Builder
serviceType
(List<String> list) A comma-separated list of connector service types to fetch connector documents forfinal ListRequest.Builder
Specifies a max number of results to getMethods inherited from class co.elastic.clients.util.WithJsonObjectBuilderBase
withJson
Methods inherited from class co.elastic.clients.util.ObjectBuilderBase
_checkSingleUse, _listAdd, _listAddAll, _mapPut, _mapPutAll
-
Constructor Details
-
Builder
public Builder()
-
-
Method Details
-
connectorName
A comma-separated list of connector names to fetch connector documents forAPI name:
connector_name
Adds all elements of
list
toconnectorName
. -
connectorName
A comma-separated list of connector names to fetch connector documents forAPI name:
connector_name
Adds one or more values to
connectorName
. -
from
Starting offset (default: 0)API name:
from
-
includeDeleted
A flag to indicate if the desired connector should be fetched, even if it was soft-deleted.API name:
include_deleted
-
indexName
A comma-separated list of connector index names to fetch connector documents forAPI name:
index_name
Adds all elements of
list
toindexName
. -
indexName
A comma-separated list of connector index names to fetch connector documents forAPI name:
index_name
Adds one or more values to
indexName
. -
query
A wildcard query string that filters connectors with matching name, description or index nameAPI name:
query
-
serviceType
A comma-separated list of connector service types to fetch connector documents forAPI name:
service_type
Adds all elements of
list
toserviceType
. -
serviceType
A comma-separated list of connector service types to fetch connector documents forAPI name:
service_type
Adds one or more values to
serviceType
. -
size
Specifies a max number of results to getAPI name:
size
-
self
- Specified by:
self
in classRequestBase.AbstractBuilder<ListRequest.Builder>
-
build
Builds aListRequest
.- Specified by:
build
in interfaceObjectBuilder<ListRequest>
- Throws:
NullPointerException
- if some of the required fields are null.
-