Requests (Elasticsearch: Core 2.3.5.1 API)

java.lang.Object
- org.elasticsearch.client.Requests

```
public class Requests
extends Object
```
A handy one stop shop for creating requests (make sure to import static this class).

フィールドのサマリー

フィールド
修飾子とタイプ	フィールドと説明
`static XContentType`	`CONTENT_TYPE` The content type used to generate request builders (query / search).
`static XContentType`	`INDEX_CONTENT_TYPE` The default content type to use to generate source documents when indexing.

コンストラクタのサマリー

コンストラクタ
コンストラクタと説明

Requests()

コンストラクタ
コンストラクタと説明
`Requests()`

メソッドのサマリー

すべてのメソッド staticメソッド concreteメソッド非推奨のメソッド
修飾子とタイプ	メソッドと説明
`static BulkRequest`	`bulkRequest()` Creats a new bulk request.
`static CancelTasksRequest`	`cancelTasksRequest()` Creates a nodes tasks request against one or more nodes.
`static ClearIndicesCacheRequest`	`clearIndicesCacheRequest(String... indices)` Creates a clean indices cache request.
`static CloseIndexRequest`	`closeIndexRequest(String index)` Creates a close index request.
`static ClusterHealthRequest`	`clusterHealthRequest(String... indices)` Creates a cluster health request.
`static ClusterRerouteRequest`	`clusterRerouteRequest()`
`static ClusterSearchShardsRequest`	`clusterSearchShardsRequest()` List all shards for the give search
`static ClusterSearchShardsRequest`	`clusterSearchShardsRequest(String... indices)` List all shards for the give search
`static ClusterStateRequest`	`clusterStateRequest()` Creates a cluster state request.
`static ClusterStatsRequest`	`clusterStatsRequest()` Creates a cluster stats request.
`static ClusterUpdateSettingsRequest`	`clusterUpdateSettingsRequest()`
`static CountRequest`	`countRequest(String... indices)` 非推奨です。 use `searchRequest(String...)` instead and set size to 0
`static CreateIndexRequest`	`createIndexRequest(String index)` Creates a create index request.
`static CreateSnapshotRequest`	`createSnapshotRequest(String repository, String snapshot)` Creates new snapshot
`static DeleteIndexRequest`	`deleteIndexRequest(String index)` Creates a delete index request.
`static DeleteRepositoryRequest`	`deleteRepositoryRequest(String name)` Deletes registration for snapshot repository
`static DeleteRequest`	`deleteRequest(String index)` Creates a delete request against a specific index.
`static DeleteSnapshotRequest`	`deleteSnapshotRequest(String repository, String snapshot)` Deletes a snapshot
`static ExistsRequest`	`existsRequest(String... indices)` 非推奨です。 use `SearchRequest` instead and set `size` to `0` and `terminate_after` to `1`
`static FlushRequest`	`flushRequest(String... indices)` Creates a flush indices request.
`static ForceMergeRequest`	`forceMergeRequest(String... indices)` Creates a force merge request.
`static GetRepositoriesRequest`	`getRepositoryRequest(String... repositories)` Gets snapshot repository
`static GetRequest`	`getRequest(String index)` Creates a get request to get the JSON source from an index based on a type and id.
`static GetSnapshotsRequest`	`getSnapshotsRequest(String repository)` Gets snapshots from repository
`static IndicesAliasesRequest`	`indexAliasesRequest()` Creates an index aliases request allowing to add and remove aliases.
`static IndexRequest`	`indexRequest()`
`static IndexRequest`	`indexRequest(String index)` Create an index request against a specific index.
`static IndicesExistsRequest`	`indicesExistsRequest(String... indices)` Creates an indices exists request.
`static IndicesSegmentsRequest`	`indicesSegmentsRequest(String... indices)`
`static IndicesShardStoresRequest`	`indicesShardStoresRequest(String... indices)` Creates an indices shard stores info request.
`static ListTasksRequest`	`listTasksRequest()` Creates a nodes tasks request against all the nodes.
`static NodesInfoRequest`	`nodesInfoRequest()` Creates a nodes info request against all the nodes.
`static NodesInfoRequest`	`nodesInfoRequest(String... nodesIds)` Creates a nodes info request against one or more nodes.
`static NodesStatsRequest`	`nodesStatsRequest(String... nodesIds)` Creates a nodes stats request against one or more nodes.
`static OpenIndexRequest`	`openIndexRequest(String index)` Creates an open index request.
`static PutMappingRequest`	`putMappingRequest(String... indices)` Create a create mapping request against one or more indices.
`static PutRepositoryRequest`	`putRepositoryRequest(String name)` Registers snapshot repository
`static RefreshRequest`	`refreshRequest(String... indices)` Creates a refresh indices request.
`static RestoreSnapshotRequest`	`restoreSnapshotRequest(String repository, String snapshot)` Restores new snapshot
`static SearchRequest`	`searchRequest(String... indices)` Creates a search request against one or more indices.
`static SearchScrollRequest`	`searchScrollRequest(String scrollId)` Creates a search scroll request allowing to continue searching a previous search request.
`static SnapshotsStatusRequest`	`snapshotsStatusRequest(String repository)` Get status of snapshots
`static SuggestRequest`	`suggestRequest(String... indices)` Creates a suggest request for getting suggestions from provided `indices`.
`static SyncedFlushRequest`	`syncedFlushRequest(String... indices)` Creates a synced flush indices request.
`static UpdateSettingsRequest`	`updateSettingsRequest(String... indices)` A request to update indices settings.
`static UpgradeRequest`	`upgradeRequest(String... indices)` Creates an upgrade request.
`static VerifyRepositoryRequest`	`verifyRepositoryRequest(String name)` Verifies snapshot repository

クラスから継承されたメソッド java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- フィールドの詳細
  - CONTENT_TYPE
```
public static XContentType CONTENT_TYPE
```
    The content type used to generate request builders (query / search).
  - INDEX_CONTENT_TYPE
```
public static XContentType INDEX_CONTENT_TYPE
```
    The default content type to use to generate source documents when indexing.
- コンストラクタの詳細
  - Requests
```
public Requests()
```
- メソッドの詳細
  - indexRequest
```
public static IndexRequest indexRequest()
```
  - indexRequest
```
public static IndexRequest indexRequest(String index)
```
    Create an index request against a specific index. Note the IndexRequest.type(String) must be set as well and optionally the IndexRequest.id(String).
    
    パラメータ:
    
    index - The index name to index the request against
    
    戻り値:
    
    The index request
    
    関連項目:
    
    Client.index(org.elasticsearch.action.index.IndexRequest)
  - deleteRequest
```
public static DeleteRequest deleteRequest(String index)
```
    Creates a delete request against a specific index. Note the DeleteRequest.type(String) and DeleteRequest.id(String) must be set.
    
    パラメータ:
    
    index - The index name to delete from
    
    戻り値:
    
    The delete request
    
    関連項目:
    
    Client.delete(org.elasticsearch.action.delete.DeleteRequest)
  - bulkRequest
```
public static BulkRequest bulkRequest()
```
    Creats a new bulk request.
  - getRequest
```
public static GetRequest getRequest(String index)
```
    Creates a get request to get the JSON source from an index based on a type and id. Note, the GetRequest.type(String) and GetRequest.id(String) must be set.
    
    パラメータ:
    
    index - The index to get the JSON source from
    
    戻り値:
    
    The get request
    
    関連項目:
    
    Client.get(org.elasticsearch.action.get.GetRequest)
  - countRequest
```
@Deprecated
public static CountRequest countRequest(String... indices)
```
    非推奨です。 use searchRequest(String...) instead and set size to 0
    
    Creates a count request which counts the hits matched against a query. Note, the query itself must be set either using the JSON source of the query, or using a QueryBuilder (using QueryBuilders).
    
    パラメータ:
    
    indices - The indices to count matched documents against a query. Use null or _all to execute against all indices
    
    戻り値:
    
    The count request
    
    関連項目:
    
    Client.count(org.elasticsearch.action.count.CountRequest)
  - existsRequest
```
@Deprecated
public static ExistsRequest existsRequest(String... indices)
```
    非推奨です。 use SearchRequest instead and set `size` to `0` and `terminate_after` to `1`
    
    Creates a exists request which checks if any of the hits matched against a query exists. Note, the query itself must be set either using the JSON source of the query, or using a QueryBuilder (using QueryBuilders).
    
    パラメータ:
    
    indices - The indices to count matched documents against a query. Use null or _all to execute against all indices
    
    戻り値:
    
    The exists request
  - suggestRequest
```
public static SuggestRequest suggestRequest(String... indices)
```
    Creates a suggest request for getting suggestions from provided indices. The suggest query has to be set using the JSON source using SuggestRequest.suggest(org.elasticsearch.common.bytes.BytesReference).
    
    パラメータ:
    
    indices - The indices to suggest from. Use null or _all to execute against all indices
    
    関連項目:
    
    Client.suggest(org.elasticsearch.action.suggest.SuggestRequest)
  - searchRequest
```
public static SearchRequest searchRequest(String... indices)
```
    Creates a search request against one or more indices. Note, the search source must be set either using the actual JSON search source, or the SearchSourceBuilder.
    
    パラメータ:
    
    indices - The indices to search against. Use null or _all to execute against all indices
    
    戻り値:
    
    The search request
    
    関連項目:
    
    Client.search(org.elasticsearch.action.search.SearchRequest)
  - searchScrollRequest
```
public static SearchScrollRequest searchScrollRequest(String scrollId)
```
    Creates a search scroll request allowing to continue searching a previous search request.
    
    パラメータ:
    
    scrollId - The scroll id representing the scrollable search
    
    戻り値:
    
    The search scroll request
    
    関連項目:
    
    Client.searchScroll(org.elasticsearch.action.search.SearchScrollRequest)
  - indicesSegmentsRequest
```
public static IndicesSegmentsRequest indicesSegmentsRequest(String... indices)
```
  - indicesShardStoresRequest
```
public static IndicesShardStoresRequest indicesShardStoresRequest(String... indices)
```
    Creates an indices shard stores info request.
    
    パラメータ:
    
    indices - The indices to get shard store information on
    
    戻り値:
    
    The indices shard stores request
    
    関連項目:
    
    IndicesAdminClient.shardStores(IndicesShardStoresRequest)
  - indicesExistsRequest
```
public static IndicesExistsRequest indicesExistsRequest(String... indices)
```
    Creates an indices exists request.
    
    パラメータ:
    
    indices - The indices to check if they exists or not.
    
    戻り値:
    
    The indices exists request
    
    関連項目:
    
    IndicesAdminClient.exists(org.elasticsearch.action.admin.indices.exists.indices.IndicesExistsRequest)
  - createIndexRequest
```
public static CreateIndexRequest createIndexRequest(String index)
```
    Creates a create index request.
    
    パラメータ:
    
    index - The index to create
    
    戻り値:
    
    The index create request
    
    関連項目:
    
    IndicesAdminClient.create(org.elasticsearch.action.admin.indices.create.CreateIndexRequest)
  - deleteIndexRequest
```
public static DeleteIndexRequest deleteIndexRequest(String index)
```
    Creates a delete index request.
    
    パラメータ:
    
    index - The index to delete
    
    戻り値:
    
    The delete index request
    
    関連項目:
    
    IndicesAdminClient.delete(org.elasticsearch.action.admin.indices.delete.DeleteIndexRequest)
  - closeIndexRequest
```
public static CloseIndexRequest closeIndexRequest(String index)
```
    Creates a close index request.
    
    パラメータ:
    
    index - The index to close
    
    戻り値:
    
    The delete index request
    
    関連項目:
    
    IndicesAdminClient.close(org.elasticsearch.action.admin.indices.close.CloseIndexRequest)
  - openIndexRequest
```
public static OpenIndexRequest openIndexRequest(String index)
```
    Creates an open index request.
    
    パラメータ:
    
    index - The index to open
    
    戻り値:
    
    The delete index request
    
    関連項目:
    
    IndicesAdminClient.open(org.elasticsearch.action.admin.indices.open.OpenIndexRequest)
  - putMappingRequest
```
public static PutMappingRequest putMappingRequest(String... indices)
```
    Create a create mapping request against one or more indices.
    
    パラメータ:
    
    indices - The indices to create mapping. Use null or _all to execute against all indices
    
    戻り値:
    
    The create mapping request
    
    関連項目:
    
    IndicesAdminClient.putMapping(org.elasticsearch.action.admin.indices.mapping.put.PutMappingRequest)
  - indexAliasesRequest
```
public static IndicesAliasesRequest indexAliasesRequest()
```
    Creates an index aliases request allowing to add and remove aliases.
    
    戻り値:
    
    The index aliases request
  - refreshRequest
```
public static RefreshRequest refreshRequest(String... indices)
```
    Creates a refresh indices request.
    
    パラメータ:
    
    indices - The indices to refresh. Use null or _all to execute against all indices
    
    戻り値:
    
    The refresh request
    
    関連項目:
    
    IndicesAdminClient.refresh(org.elasticsearch.action.admin.indices.refresh.RefreshRequest)
  - flushRequest
```
public static FlushRequest flushRequest(String... indices)
```
    Creates a flush indices request.
    
    パラメータ:
    
    indices - The indices to flush. Use null or _all to execute against all indices
    
    戻り値:
    
    The flush request
    
    関連項目:
    
    IndicesAdminClient.flush(org.elasticsearch.action.admin.indices.flush.FlushRequest)
  - syncedFlushRequest
```
public static SyncedFlushRequest syncedFlushRequest(String... indices)
```
    Creates a synced flush indices request.
    
    パラメータ:
    
    indices - The indices to sync flush. Use null or _all to execute against all indices
    
    戻り値:
    
    The synced flush request
    
    関連項目:
    
    IndicesAdminClient.syncedFlush(SyncedFlushRequest)
  - forceMergeRequest
```
public static ForceMergeRequest forceMergeRequest(String... indices)
```
    Creates a force merge request.
    
    パラメータ:
    
    indices - The indices to force merge. Use null or _all to execute against all indices
    
    戻り値:
    
    The force merge request
    
    関連項目:
    
    IndicesAdminClient.forceMerge(org.elasticsearch.action.admin.indices.forcemerge.ForceMergeRequest)
  - upgradeRequest
```
public static UpgradeRequest upgradeRequest(String... indices)
```
    Creates an upgrade request.
    
    パラメータ:
    
    indices - The indices to upgrade. Use null or _all to execute against all indices
    
    戻り値:
    
    The upgrade request
    
    関連項目:
    
    IndicesAdminClient.upgrade(UpgradeRequest)
  - clearIndicesCacheRequest
```
public static ClearIndicesCacheRequest clearIndicesCacheRequest(String... indices)
```
    Creates a clean indices cache request.
    
    パラメータ:
    
    indices - The indices to clean their caches. Use null or _all to execute against all indices
    
    戻り値:
    
    The request
  - updateSettingsRequest
```
public static UpdateSettingsRequest updateSettingsRequest(String... indices)
```
    A request to update indices settings.
    
    パラメータ:
    
    indices - The indices to update the settings for. Use null or _all to executed against all indices.
    
    戻り値:
    
    The request
  - clusterStateRequest
```
public static ClusterStateRequest clusterStateRequest()
```
    Creates a cluster state request.
    
    戻り値:
    
    The cluster state request.
    
    関連項目:
    
    ClusterAdminClient.state(org.elasticsearch.action.admin.cluster.state.ClusterStateRequest)
  - clusterRerouteRequest
```
public static ClusterRerouteRequest clusterRerouteRequest()
```
  - clusterUpdateSettingsRequest
```
public static ClusterUpdateSettingsRequest clusterUpdateSettingsRequest()
```
  - clusterHealthRequest
```
public static ClusterHealthRequest clusterHealthRequest(String... indices)
```
    Creates a cluster health request.
    
    パラメータ:
    
    indices - The indices to provide additional cluster health information for. Use null or _all to execute against all indices
    
    戻り値:
    
    The cluster health request
    
    関連項目:
    
    ClusterAdminClient.health(org.elasticsearch.action.admin.cluster.health.ClusterHealthRequest)
  - clusterSearchShardsRequest
```
public static ClusterSearchShardsRequest clusterSearchShardsRequest()
```
    List all shards for the give search
  - clusterSearchShardsRequest
```
public static ClusterSearchShardsRequest clusterSearchShardsRequest(String... indices)
```
    List all shards for the give search
  - nodesInfoRequest
```
public static NodesInfoRequest nodesInfoRequest()
```
    Creates a nodes info request against all the nodes.
    
    戻り値:
    
    The nodes info request
    
    関連項目:
    
    ClusterAdminClient.nodesInfo(org.elasticsearch.action.admin.cluster.node.info.NodesInfoRequest)
  - nodesInfoRequest
```
public static NodesInfoRequest nodesInfoRequest(String... nodesIds)
```
    Creates a nodes info request against one or more nodes. Pass null or an empty array for all nodes.
    
    パラメータ:
    
    nodesIds - The nodes ids to get the status for
    
    戻り値:
    
    The nodes info request
    
    関連項目:
    
    ClusterAdminClient.nodesStats(org.elasticsearch.action.admin.cluster.node.stats.NodesStatsRequest)
  - nodesStatsRequest
```
public static NodesStatsRequest nodesStatsRequest(String... nodesIds)
```
    Creates a nodes stats request against one or more nodes. Pass null or an empty array for all nodes.
    
    パラメータ:
    
    nodesIds - The nodes ids to get the stats for
    
    戻り値:
    
    The nodes info request
    
    関連項目:
    
    ClusterAdminClient.nodesStats(org.elasticsearch.action.admin.cluster.node.stats.NodesStatsRequest)
  - clusterStatsRequest
```
public static ClusterStatsRequest clusterStatsRequest()
```
    Creates a cluster stats request.
    
    戻り値:
    
    The cluster stats request
    
    関連項目:
    
    ClusterAdminClient.clusterStats(org.elasticsearch.action.admin.cluster.stats.ClusterStatsRequest)
  - listTasksRequest
```
public static ListTasksRequest listTasksRequest()
```
    Creates a nodes tasks request against all the nodes.
    
    戻り値:
    
    The nodes tasks request
    
    関連項目:
    
    ClusterAdminClient.listTasks(ListTasksRequest)
  - cancelTasksRequest
```
public static CancelTasksRequest cancelTasksRequest()
```
    Creates a nodes tasks request against one or more nodes. Pass null or an empty array for all nodes.
    
    戻り値:
    
    The nodes tasks request
    
    関連項目:
    
    ClusterAdminClient.cancelTasks(CancelTasksRequest)
  - putRepositoryRequest
```
public static PutRepositoryRequest putRepositoryRequest(String name)
```
    Registers snapshot repository
    
    パラメータ:
    
    name - repository name
    
    戻り値:
    
    repository registration request
  - getRepositoryRequest
```
public static GetRepositoriesRequest getRepositoryRequest(String... repositories)
```
    Gets snapshot repository
    
    パラメータ:
    
    repositories - names of repositories
    
    戻り値:
    
    get repository request
  - deleteRepositoryRequest
```
public static DeleteRepositoryRequest deleteRepositoryRequest(String name)
```
    Deletes registration for snapshot repository
    
    パラメータ:
    
    name - repository name
    
    戻り値:
    
    delete repository request
  - verifyRepositoryRequest
```
public static VerifyRepositoryRequest verifyRepositoryRequest(String name)
```
    Verifies snapshot repository
    
    パラメータ:
    
    name - repository name
    
    戻り値:
    
    repository verification request
  - createSnapshotRequest
```
public static CreateSnapshotRequest createSnapshotRequest(String repository,
                                                          String snapshot)
```
    Creates new snapshot
    
    パラメータ:
    
    repository - repository name
    
    snapshot - snapshot name
    
    戻り値:
    
    create snapshot request
  - getSnapshotsRequest
```
public static GetSnapshotsRequest getSnapshotsRequest(String repository)
```
    Gets snapshots from repository
    
    パラメータ:
    
    repository - repository name
    
    戻り値:
    
    get snapshot request
  - restoreSnapshotRequest
```
public static RestoreSnapshotRequest restoreSnapshotRequest(String repository,
                                                            String snapshot)
```
    Restores new snapshot
    
    パラメータ:
    
    repository - repository name
    
    snapshot - snapshot name
    
    戻り値:
    
    snapshot creation request
  - deleteSnapshotRequest
```
public static DeleteSnapshotRequest deleteSnapshotRequest(String repository,
                                                          String snapshot)
```
    Deletes a snapshot
    
    パラメータ:
    
    snapshot - snapshot name
    
    repository - repository name
    
    戻り値:
    
    delete snapshot request
  - snapshotsStatusRequest
```
public static SnapshotsStatusRequest snapshotsStatusRequest(String repository)
```
    Get status of snapshots
    
    パラメータ:
    
    repository - repository name
    
    戻り値:
    
    snapshot status request

クラス Requests

フィールドのサマリー

コンストラクタのサマリー

メソッドのサマリー

クラスから継承されたメソッド java.lang.Object

フィールドの詳細

CONTENT_TYPE

INDEX_CONTENT_TYPE

コンストラクタの詳細

Requests

メソッドの詳細

indexRequest

indexRequest

deleteRequest

bulkRequest

getRequest

countRequest

existsRequest

suggestRequest

searchRequest

searchScrollRequest

indicesSegmentsRequest

indicesShardStoresRequest

indicesExistsRequest

createIndexRequest

deleteIndexRequest

closeIndexRequest

openIndexRequest

putMappingRequest

indexAliasesRequest

refreshRequest

flushRequest

syncedFlushRequest

forceMergeRequest

upgradeRequest

clearIndicesCacheRequest

updateSettingsRequest

clusterStateRequest

clusterRerouteRequest

clusterUpdateSettingsRequest

clusterHealthRequest

clusterSearchShardsRequest

clusterSearchShardsRequest

nodesInfoRequest

nodesInfoRequest

nodesStatsRequest

clusterStatsRequest

listTasksRequest

cancelTasksRequest

putRepositoryRequest

getRepositoryRequest

deleteRepositoryRequest

verifyRepositoryRequest

createSnapshotRequest

getSnapshotsRequest

restoreSnapshotRequest

deleteSnapshotRequest

snapshotsStatusRequest