Package org.apache.solr.handler.admin.api

Class GetSchemaFieldAPI

java.lang.Object

org.apache.solr.api.JerseyResource

org.apache.solr.handler.admin.api.GetSchemaFieldAPI

@Path("/{a:cores|collections}/{collectionName}/schema")
public class GetSchemaFieldAPI
extends JerseyResource

GetSchemaFieldAPI contains the V2 APIs for all field related endpoint which are

• /fields
• /fields/{fieldName}
• /copyfields
• /dynamicfields
• /dynamicfields/{fieldName}
• /fieldtypes
• /fieldtypes/{fieldTypeName}

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	GetSchemaFieldAPI.SchemaGetDynamicFieldInfoResponse
static class	GetSchemaFieldAPI.SchemaGetFieldInfoResponse
static class	GetSchemaFieldAPI.SchemaGetFieldTypeInfoResponse
static class	GetSchemaFieldAPI.SchemaListCopyFieldsResponse
static class	GetSchemaFieldAPI.SchemaListDynamicFieldsResponse
static class	GetSchemaFieldAPI.SchemaListFieldsResponse
static class	GetSchemaFieldAPI.SchemaListFieldTypesResponse

Field Summary

Fields inherited from class org.apache.solr.api.JerseyResource

containerRequestContext

Constructor Summary

Constructors

Constructor	Description
GetSchemaFieldAPI(IndexSchema indexSchema, org.apache.solr.common.params.SolrParams params)

Method Summary

Modifier and Type	Method	Description
GetSchemaFieldAPI.SchemaGetDynamicFieldInfoResponse	getDynamicFieldInfo(String fieldName)
GetSchemaFieldAPI.SchemaGetFieldInfoResponse	getFieldInfo(String fieldName)
GetSchemaFieldAPI.SchemaGetFieldTypeInfoResponse	getFieldTypeInfo(String fieldTypeName)
GetSchemaFieldAPI.SchemaListCopyFieldsResponse	listCopyFields()
GetSchemaFieldAPI.SchemaListDynamicFieldsResponse	listDynamicFields()
GetSchemaFieldAPI.SchemaListFieldsResponse	listSchemaFields()
GetSchemaFieldAPI.SchemaListFieldTypesResponse	listSchemaFieldTypes()

Methods inherited from class org.apache.solr.api.JerseyResource

ensureRequiredParameterProvided, ensureRequiredRequestBodyProvided, instantiateJerseyResponse, instantiateJerseyResponse

Methods inherited from class java.lang.Object

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

Constructor Detail

GetSchemaFieldAPI

@Inject
public GetSchemaFieldAPI(IndexSchema indexSchema,
                         org.apache.solr.common.params.SolrParams params)

Method Detail

listSchemaFields

@GET
@Path("/fields")
@Produces({"application/json","application/xml","application/vnd.apache.solr.javabin"})
public GetSchemaFieldAPI.SchemaListFieldsResponse listSchemaFields()

getFieldInfo

@GET
@Path("/fields/{fieldName}")
@Produces({"application/json","application/atom+xml","application/vnd.apache.solr.javabin"})
public GetSchemaFieldAPI.SchemaGetFieldInfoResponse getFieldInfo(@PathParam("fieldName")
                                                                 String fieldName)

listCopyFields

@GET
@Path("/copyfields")
@Produces({"application/json","application/xml","application/vnd.apache.solr.javabin"})
public GetSchemaFieldAPI.SchemaListCopyFieldsResponse listCopyFields()

listDynamicFields

@GET
@Path("/dynamicfields")
@Produces({"application/json","application/xml","application/vnd.apache.solr.javabin"})
public GetSchemaFieldAPI.SchemaListDynamicFieldsResponse listDynamicFields()

getDynamicFieldInfo

@GET
@Path("/dynamicfields/{fieldName}")
@Produces({"application/json","application/atom+xml","application/vnd.apache.solr.javabin"})
public GetSchemaFieldAPI.SchemaGetDynamicFieldInfoResponse getDynamicFieldInfo(@PathParam("fieldName")
                                                                               String fieldName)

listSchemaFieldTypes

@GET
@Path("/fieldtypes")
@Produces({"application/json","application/xml","application/vnd.apache.solr.javabin"})
public GetSchemaFieldAPI.SchemaListFieldTypesResponse listSchemaFieldTypes()

getFieldTypeInfo

@GET
@Path("/fieldtypes/{fieldTypeName}")
@Produces({"application/json","application/atom+xml","application/vnd.apache.solr.javabin"})
public GetSchemaFieldAPI.SchemaGetFieldTypeInfoResponse getFieldTypeInfo(@PathParam("fieldTypeName")
                                                                         String fieldTypeName)