Package co.elastic.clients.elasticsearch.connector

Class ListRequest

java.lang.Object

co.elastic.clients.elasticsearch._types.RequestBase

co.elastic.clients.elasticsearch.connector.ListRequest

public class ListRequest
extends RequestBase

Get all connectors.

Get information about all connectors.

See Also:

• API specification

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ListRequest.Builder	Builder for ListRequest.

Nested classes/interfaces inherited from class co.elastic.clients.elasticsearch._types.RequestBase

RequestBase.AbstractBuilder<BuilderT extends RequestBase.AbstractBuilder<BuilderT>>

Field Summary

Fields

Modifier and Type	Field	Description
static final Endpoint<ListRequest,ListResponse,ErrorResponse>	_ENDPOINT	Endpoint "connector.list".

Method Summary

Modifier and Type	Method	Description
final List<String>	connectorName()	A comma-separated list of connector names to fetch connector documents for
final Integer	from()	Starting offset (default: 0)
final Boolean	includeDeleted()	A flag to indicate if the desired connector should be fetched, even if it was soft-deleted.
final List<String>	indexName()	A comma-separated list of connector index names to fetch connector documents for
static ListRequest	of(Function<ListRequest.Builder,ObjectBuilder<ListRequest>> fn)
final String	query()	A wildcard query string that filters connectors with matching name, description or index name
final List<String>	serviceType()	A comma-separated list of connector service types to fetch connector documents for
final Integer	size()	Specifies a max number of results to get

Methods inherited from class co.elastic.clients.elasticsearch._types.RequestBase

toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Details

_ENDPOINT

public static final Endpoint<ListRequest,ListResponse,ErrorResponse> _ENDPOINT

Endpoint "connector.list".

Method Details

of

public static ListRequest of(Function<ListRequest.Builder,ObjectBuilder<ListRequest>> fn)

connectorName

public final List<String> connectorName()

A comma-separated list of connector names to fetch connector documents for

API name: connector_name

from

@Nullable
public final Integer from()

Starting offset (default: 0)

API name: from

includeDeleted

@Nullable
public final Boolean includeDeleted()

A flag to indicate if the desired connector should be fetched, even if it was soft-deleted.

API name: include_deleted

indexName

public final List<String> indexName()

A comma-separated list of connector index names to fetch connector documents for

API name: index_name

query

@Nullable
public final String query()

A wildcard query string that filters connectors with matching name, description or index name

API name: query

serviceType

public final List<String> serviceType()

A comma-separated list of connector service types to fetch connector documents for

API name: service_type

size

@Nullable
public final Integer size()

Specifies a max number of results to get

API name: size