程序包 org.easysearch.client.indices

类 FreezeIndexRequest

java.lang.Object
org.easysearch.client.TimedRequest
org.easysearch.client.indices.FreezeIndexRequest
所有已实现的接口:
Validatable
public final class FreezeIndexRequest
extends TimedRequest
Request for the _freeze index API

  • 字段概要

    从类继承的字段 org.easysearch.client.TimedRequest

    DEFAULT_ACK_TIMEOUT, DEFAULT_MASTER_NODE_TIMEOUT

    从接口继承的字段 org.easysearch.client.Validatable

    EMPTY

  • 构造器概要

    构造器
    构造器 说明
    FreezeIndexRequest​(java.lang.String... indices)
    Creates a new freeze index request

  • 方法概要

    修饰符和类型 方法 说明
    java.lang.String[] getIndices()
    Returns the indices to freeze
    org.easysearch.action.support.ActiveShardCount getWaitForActiveShards()
    Returns the wait for active shard count or null if the default should be used
    org.easysearch.action.support.IndicesOptions indicesOptions()
    Specifies what type of requested indices to ignore and how to deal with wildcard expressions.
    void setIndicesOptions​(org.easysearch.action.support.IndicesOptions indicesOptions)
    Specifies what type of requested indices to ignore and how to deal with wildcard expressions.
    void setWaitForActiveShards​(org.easysearch.action.support.ActiveShardCount waitForActiveShards)
    Sets the number of shard copies that should be active for indices opening to return.

    从类继承的方法 org.easysearch.client.TimedRequest

    masterNodeTimeout, setMasterTimeout, setTimeout, timeout

    从类继承的方法 java.lang.Object

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

    从接口继承的方法 org.easysearch.client.Validatable

    validate

  • 构造器详细资料

    • FreezeIndexRequest

      public FreezeIndexRequest​(java.lang.String... indices)
      Creates a new freeze index request
      参数:
      indices - the index to freeze

  • 方法详细资料

    • getIndices

      public java.lang.String[] getIndices()
      Returns the indices to freeze

    • indicesOptions

      public org.easysearch.action.support.IndicesOptions indicesOptions()
      Specifies what type of requested indices to ignore and how to deal with wildcard expressions. For example indices that don't exist.
      返回:
      the current behaviour when it comes to index names and wildcard indices expressions

    • setIndicesOptions

      public void setIndicesOptions​(org.easysearch.action.support.IndicesOptions indicesOptions)
      Specifies what type of requested indices to ignore and how to deal with wildcard expressions. For example indices that don't exist.
      参数:
      indicesOptions - the desired behaviour regarding indices to ignore and wildcard indices expressions

    • getWaitForActiveShards

      public org.easysearch.action.support.ActiveShardCount getWaitForActiveShards()
      Returns the wait for active shard count or null if the default should be used

    • setWaitForActiveShards

      public void setWaitForActiveShards​(org.easysearch.action.support.ActiveShardCount waitForActiveShards)
      Sets the number of shard copies that should be active for indices opening to return. Defaults to ActiveShardCount.DEFAULT, which will wait for one shard copy (the primary) to become active. Set this value to ActiveShardCount.ALL to wait for all shards (primary and all replicas) to be active before returning. Otherwise, use ActiveShardCount.from(int) to set this value to any non-negative integer, up to the number of copies per shard (number of replicas + 1), to wait for the desired amount of shard copies to become active before returning. Indices opening will only wait up until the timeout value for the number of shard copies to be active before returning. Check ShardsAcknowledgedResponse.isShardsAcknowledged() to determine if the requisite shard copies were all started before returning or timing out.
      参数:
      waitForActiveShards - number of active shard copies to wait on