Package org.elasticsearch.client.indices
Class GetFieldMappingsRequest
- java.lang.Object
-
- org.elasticsearch.client.indices.GetFieldMappingsRequest
-
- All Implemented Interfaces:
Validatable
public class GetFieldMappingsRequest extends java.lang.Object implements Validatable
Request the mappings of specific fields
-
-
Field Summary
-
Fields inherited from interface org.elasticsearch.client.Validatable
EMPTY
-
-
Constructor Summary
Constructors Constructor Description GetFieldMappingsRequest()
-
Method Summary
Modifier and Type Method Description java.lang.String[]
fields()
GetFieldMappingsRequest
fields(java.lang.String... fields)
boolean
includeDefaults()
GetFieldMappingsRequest
includeDefaults(boolean includeDefaults)
Indicates whether default mapping settings should be returnedjava.lang.String[]
indices()
GetFieldMappingsRequest
indices(java.lang.String... indices)
IndicesOptions
indicesOptions()
GetFieldMappingsRequest
indicesOptions(IndicesOptions indicesOptions)
boolean
local()
GetFieldMappingsRequest
local(boolean local)
Indicate whether the receiving node should operate based on local index information or forward requests, where needed, to other nodes.-
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
Methods inherited from interface org.elasticsearch.client.Validatable
validate
-
-
-
-
Method Detail
-
local
public GetFieldMappingsRequest local(boolean local)
Indicate whether the receiving node should operate based on local index information or forward requests, where needed, to other nodes. If running locally, request will not raise errors if running locally & missing indices.
-
local
public boolean local()
-
indices
public GetFieldMappingsRequest indices(java.lang.String... indices)
-
indicesOptions
public GetFieldMappingsRequest indicesOptions(IndicesOptions indicesOptions)
-
indices
public java.lang.String[] indices()
-
indicesOptions
public IndicesOptions indicesOptions()
-
fields
public GetFieldMappingsRequest fields(java.lang.String... fields)
- Parameters:
fields
- a list of fields to retrieve the mapping for
-
fields
public java.lang.String[] fields()
-
includeDefaults
public boolean includeDefaults()
-
includeDefaults
public GetFieldMappingsRequest includeDefaults(boolean includeDefaults)
Indicates whether default mapping settings should be returned
-
-