Module: Elasticsearch::API::CrossClusterReplication::Actions

Included in:

CrossClusterReplicationClient

Defined in:

lib/elasticsearch/api/namespace/cross_cluster_replication.rb,
lib/elasticsearch/api/actions/cross_cluster_replication/stats.rb,
lib/elasticsearch/api/actions/cross_cluster_replication/follow.rb,
lib/elasticsearch/api/actions/cross_cluster_replication/unfollow.rb,
lib/elasticsearch/api/actions/cross_cluster_replication/follow_info.rb,
lib/elasticsearch/api/actions/cross_cluster_replication/follow_stats.rb,
lib/elasticsearch/api/actions/cross_cluster_replication/pause_follow.rb,
lib/elasticsearch/api/actions/cross_cluster_replication/resume_follow.rb,
lib/elasticsearch/api/actions/cross_cluster_replication/forget_follower.rb,
lib/elasticsearch/api/actions/cross_cluster_replication/get_auto_follow_pattern.rb,
lib/elasticsearch/api/actions/cross_cluster_replication/put_auto_follow_pattern.rb,
lib/elasticsearch/api/actions/cross_cluster_replication/pause_auto_follow_pattern.rb,
lib/elasticsearch/api/actions/cross_cluster_replication/delete_auto_follow_pattern.rb,
lib/elasticsearch/api/actions/cross_cluster_replication/resume_auto_follow_pattern.rb more...

Instance Method Summary

• #delete_auto_follow_pattern(arguments = {}) ⇒ Object

  Deletes auto-follow patterns.

• #follow(arguments = {}) ⇒ Object

  Creates a new follower index configured to follow the referenced leader index.

• #follow_info(arguments = {}) ⇒ Object

  Retrieves information about all follower indices, including parameters and status for each follower index.

• #follow_stats(arguments = {}) ⇒ Object

  Retrieves follower stats.

• #forget_follower(arguments = {}) ⇒ Object

  Removes the follower retention leases from the leader.

• #get_auto_follow_pattern(arguments = {}) ⇒ Object

  Gets configured auto-follow patterns.

• #pause_auto_follow_pattern(arguments = {}) ⇒ Object

  Pauses an auto-follow pattern.

• #pause_follow(arguments = {}) ⇒ Object

  Pauses a follower index.

• #put_auto_follow_pattern(arguments = {}) ⇒ Object

  Creates a new named collection of auto-follow patterns against a specified remote cluster.

• #resume_auto_follow_pattern(arguments = {}) ⇒ Object

  Resumes an auto-follow pattern that has been paused.

• #resume_follow(arguments = {}) ⇒ Object

  Resumes a follower index that has been paused.

• #stats(arguments = {}) ⇒ Object

  Gets all stats related to cross-cluster replication.

• #unfollow(arguments = {}) ⇒ Object

  Stops the following task associated with a follower index and removes index metadata and settings associated with cross-cluster replication.

Instance Method Details

#delete_auto_follow_pattern(arguments = {}) ⇒ Object

Deletes auto-follow patterns.

Parameters:

• arguments (Hash) (defaults to: {}) —

  a customizable set of options

Options Hash (arguments):

• :name (String) —

  The name of the auto follow pattern.

• :headers (Hash) —

  Custom HTTP headers

Raises:

• (ArgumentError)

See Also:

• https://www.elastic.co/guide/en/elasticsearch/reference/8.8/ccr-delete-auto-follow-pattern.html

# File 'lib/elasticsearch/api/actions/cross_cluster_replication/delete_auto_follow_pattern.rb', line 32

def delete_auto_follow_pattern(arguments = {})
  raise ArgumentError, "Required argument 'name' missing" unless arguments[:name]

  arguments = arguments.clone
  headers = arguments.delete(:headers) || {}

  body = nil

  _name = arguments.delete(:name)

  method = Elasticsearch::API::HTTP_DELETE
  path   = "_ccr/auto_follow/#{Utils.__listify(_name)}"
  params = {}

  Elasticsearch::API::Response.new(
    perform_request(method, path, params, body, headers)
  )
end

#follow(arguments = {}) ⇒ Object

Creates a new follower index configured to follow the referenced leader index.

Parameters:

• arguments (Hash) (defaults to: {}) —

  a customizable set of options

Options Hash (arguments):

• :index (String) —

  The name of the follower index

• :wait_for_active_shards (String) —

  Sets the number of shard copies that must be active before returning. Defaults to 0. Set to ‘all` for all shard copies, otherwise set to any non-negative value less than or equal to the total number of copies for the shard (number of replicas + 1)

• :headers (Hash) —

  Custom HTTP headers

• :body (Hash) —

  The name of the leader index and other optional ccr related parameters (Required)

Raises:

• (ArgumentError)

See Also:

• https://www.elastic.co/guide/en/elasticsearch/reference/8.8/ccr-put-follow.html

# File 'lib/elasticsearch/api/actions/cross_cluster_replication/follow.rb', line 34

def follow(arguments = {})
  raise ArgumentError, "Required argument 'body' missing" unless arguments[:body]
  raise ArgumentError, "Required argument 'index' missing" unless arguments[:index]

  arguments = arguments.clone
  headers = arguments.delete(:headers) || {}

  body   = arguments.delete(:body)

  _index = arguments.delete(:index)

  method = Elasticsearch::API::HTTP_PUT
  path   = "#{Utils.__listify(_index)}/_ccr/follow"
  params = Utils.process_params(arguments)

  Elasticsearch::API::Response.new(
    perform_request(method, path, params, body, headers)
  )
end

#follow_info(arguments = {}) ⇒ Object

Retrieves information about all follower indices, including parameters and status for each follower index

Parameters:

• arguments (Hash) (defaults to: {}) —

  a customizable set of options

Options Hash (arguments):

• :index (List) —

  A comma-separated list of index patterns; use ‘_all` to perform the operation on all indices

• :headers (Hash) —

  Custom HTTP headers

Raises:

• (ArgumentError)

See Also:

• https://www.elastic.co/guide/en/elasticsearch/reference/8.8/ccr-get-follow-info.html

# File 'lib/elasticsearch/api/actions/cross_cluster_replication/follow_info.rb', line 32

def follow_info(arguments = {})
  raise ArgumentError, "Required argument 'index' missing" unless arguments[:index]

  arguments = arguments.clone
  headers = arguments.delete(:headers) || {}

  body   = nil

  _index = arguments.delete(:index)

  method = Elasticsearch::API::HTTP_GET
  path   = "#{Utils.__listify(_index)}/_ccr/info"
  params = {}

  Elasticsearch::API::Response.new(
    perform_request(method, path, params, body, headers)
  )
end

#follow_stats(arguments = {}) ⇒ Object

Retrieves follower stats. return shard-level stats about the following tasks associated with each shard for the specified indices.

Parameters:

• arguments (Hash) (defaults to: {}) —

  a customizable set of options

Options Hash (arguments):

• :index (List) —

  A comma-separated list of index patterns; use ‘_all` to perform the operation on all indices

• :headers (Hash) —

  Custom HTTP headers

Raises:

• (ArgumentError)

See Also:

• https://www.elastic.co/guide/en/elasticsearch/reference/8.8/ccr-get-follow-stats.html

# File 'lib/elasticsearch/api/actions/cross_cluster_replication/follow_stats.rb', line 32

def follow_stats(arguments = {})
  raise ArgumentError, "Required argument 'index' missing" unless arguments[:index]

  arguments = arguments.clone
  headers = arguments.delete(:headers) || {}

  body   = nil

  _index = arguments.delete(:index)

  method = Elasticsearch::API::HTTP_GET
  path   = "#{Utils.__listify(_index)}/_ccr/stats"
  params = {}

  Elasticsearch::API::Response.new(
    perform_request(method, path, params, body, headers)
  )
end

#forget_follower(arguments = {}) ⇒ Object

Removes the follower retention leases from the leader.

Parameters:

• arguments (Hash) (defaults to: {}) —

  a customizable set of options

Options Hash (arguments):

• :index (String) —

  the name of the leader index for which specified follower retention leases should be removed

• :headers (Hash) —

  Custom HTTP headers

• :body (Hash) —

  the name and UUID of the follower index, the name of the cluster containing the follower index, and the alias from the perspective of that cluster for the remote cluster containing the leader index (Required)

Raises:

• (ArgumentError)

See Also:

• https://www.elastic.co/guide/en/elasticsearch/reference/8.8/ccr-post-forget-follower.html

# File 'lib/elasticsearch/api/actions/cross_cluster_replication/forget_follower.rb', line 33

def forget_follower(arguments = {})
  raise ArgumentError, "Required argument 'body' missing" unless arguments[:body]
  raise ArgumentError, "Required argument 'index' missing" unless arguments[:index]

  arguments = arguments.clone
  headers = arguments.delete(:headers) || {}

  body   = arguments.delete(:body)

  _index = arguments.delete(:index)

  method = Elasticsearch::API::HTTP_POST
  path   = "#{Utils.__listify(_index)}/_ccr/forget_follower"
  params = {}

  Elasticsearch::API::Response.new(
    perform_request(method, path, params, body, headers)
  )
end

#get_auto_follow_pattern(arguments = {}) ⇒ Object

Gets configured auto-follow patterns. Returns the specified auto-follow pattern collection.

Parameters:

• arguments (Hash) (defaults to: {}) —

  a customizable set of options

Options Hash (arguments):

• :name (String) —

  The name of the auto follow pattern.

• :headers (Hash) —

  Custom HTTP headers

See Also:

• https://www.elastic.co/guide/en/elasticsearch/reference/8.8/ccr-get-auto-follow-pattern.html

# File 'lib/elasticsearch/api/actions/cross_cluster_replication/get_auto_follow_pattern.rb', line 32

def get_auto_follow_pattern(arguments = {})
  arguments = arguments.clone
  headers = arguments.delete(:headers) || {}

  body = nil

  _name = arguments.delete(:name)

  method = Elasticsearch::API::HTTP_GET
  path   = if _name
             "_ccr/auto_follow/#{Utils.__listify(_name)}"
           else
             "_ccr/auto_follow"
           end
  params = {}

  Elasticsearch::API::Response.new(
    perform_request(method, path, params, body, headers)
  )
end

#pause_auto_follow_pattern(arguments = {}) ⇒ Object

Pauses an auto-follow pattern

Parameters:

• arguments (Hash) (defaults to: {}) —

  a customizable set of options

Options Hash (arguments):

• :name (String) —

  The name of the auto follow pattern that should pause discovering new indices to follow.

• :headers (Hash) —

  Custom HTTP headers

Raises:

• (ArgumentError)

See Also:

• https://www.elastic.co/guide/en/elasticsearch/reference/8.8/ccr-pause-auto-follow-pattern.html

# File 'lib/elasticsearch/api/actions/cross_cluster_replication/pause_auto_follow_pattern.rb', line 32

def pause_auto_follow_pattern(arguments = {})
  raise ArgumentError, "Required argument 'name' missing" unless arguments[:name]

  arguments = arguments.clone
  headers = arguments.delete(:headers) || {}

  body = nil

  _name = arguments.delete(:name)

  method = Elasticsearch::API::HTTP_POST
  path   = "_ccr/auto_follow/#{Utils.__listify(_name)}/pause"
  params = {}

  Elasticsearch::API::Response.new(
    perform_request(method, path, params, body, headers)
  )
end

#pause_follow(arguments = {}) ⇒ Object

Pauses a follower index. The follower index will not fetch any additional operations from the leader index.

Parameters:

• arguments (Hash) (defaults to: {}) —

  a customizable set of options

Options Hash (arguments):

• :index (String) —

  The name of the follower index that should pause following its leader index.

• :headers (Hash) —

  Custom HTTP headers

Raises:

• (ArgumentError)

See Also:

• https://www.elastic.co/guide/en/elasticsearch/reference/8.8/ccr-post-pause-follow.html

# File 'lib/elasticsearch/api/actions/cross_cluster_replication/pause_follow.rb', line 32

def pause_follow(arguments = {})
  raise ArgumentError, "Required argument 'index' missing" unless arguments[:index]

  arguments = arguments.clone
  headers = arguments.delete(:headers) || {}

  body   = nil

  _index = arguments.delete(:index)

  method = Elasticsearch::API::HTTP_POST
  path   = "#{Utils.__listify(_index)}/_ccr/pause_follow"
  params = {}

  Elasticsearch::API::Response.new(
    perform_request(method, path, params, body, headers)
  )
end

#put_auto_follow_pattern(arguments = {}) ⇒ Object

Creates a new named collection of auto-follow patterns against a specified remote cluster. Newly created indices on the remote cluster matching any of the specified patterns will be automatically configured as follower indices.

Parameters:

• arguments (Hash) (defaults to: {}) —

  a customizable set of options

Options Hash (arguments):

• :name (String) —

  The name of the auto follow pattern.

• :headers (Hash) —

  Custom HTTP headers

• :body (Hash) —

  The specification of the auto follow pattern (Required)

Raises:

• (ArgumentError)

See Also:

• https://www.elastic.co/guide/en/elasticsearch/reference/8.8/ccr-put-auto-follow-pattern.html

# File 'lib/elasticsearch/api/actions/cross_cluster_replication/put_auto_follow_pattern.rb', line 33

def put_auto_follow_pattern(arguments = {})
  raise ArgumentError, "Required argument 'body' missing" unless arguments[:body]
  raise ArgumentError, "Required argument 'name' missing" unless arguments[:name]

  arguments = arguments.clone
  headers = arguments.delete(:headers) || {}

  body = arguments.delete(:body)

  _name = arguments.delete(:name)

  method = Elasticsearch::API::HTTP_PUT
  path   = "_ccr/auto_follow/#{Utils.__listify(_name)}"
  params = {}

  Elasticsearch::API::Response.new(
    perform_request(method, path, params, body, headers)
  )
end

#resume_auto_follow_pattern(arguments = {}) ⇒ Object

Resumes an auto-follow pattern that has been paused

Parameters:

• arguments (Hash) (defaults to: {}) —

  a customizable set of options

Options Hash (arguments):

• :name (String) —

  The name of the auto follow pattern to resume discovering new indices to follow.

• :headers (Hash) —

  Custom HTTP headers

Raises:

• (ArgumentError)

See Also:

• https://www.elastic.co/guide/en/elasticsearch/reference/8.8/ccr-resume-auto-follow-pattern.html

# File 'lib/elasticsearch/api/actions/cross_cluster_replication/resume_auto_follow_pattern.rb', line 32

def resume_auto_follow_pattern(arguments = {})
  raise ArgumentError, "Required argument 'name' missing" unless arguments[:name]

  arguments = arguments.clone
  headers = arguments.delete(:headers) || {}

  body = nil

  _name = arguments.delete(:name)

  method = Elasticsearch::API::HTTP_POST
  path   = "_ccr/auto_follow/#{Utils.__listify(_name)}/resume"
  params = {}

  Elasticsearch::API::Response.new(
    perform_request(method, path, params, body, headers)
  )
end

#resume_follow(arguments = {}) ⇒ Object

Resumes a follower index that has been paused

Parameters:

• arguments (Hash) (defaults to: {}) —

  a customizable set of options

Options Hash (arguments):

• :index (String) —

  The name of the follow index to resume following.

• :headers (Hash) —

  Custom HTTP headers

• :body (Hash) —

  The name of the leader index and other optional ccr related parameters

Raises:

• (ArgumentError)

See Also:

• https://www.elastic.co/guide/en/elasticsearch/reference/8.8/ccr-post-resume-follow.html

# File 'lib/elasticsearch/api/actions/cross_cluster_replication/resume_follow.rb', line 33

def resume_follow(arguments = {})
  raise ArgumentError, "Required argument 'index' missing" unless arguments[:index]

  arguments = arguments.clone
  headers = arguments.delete(:headers) || {}

  body   = arguments.delete(:body)

  _index = arguments.delete(:index)

  method = Elasticsearch::API::HTTP_POST
  path   = "#{Utils.__listify(_index)}/_ccr/resume_follow"
  params = {}

  Elasticsearch::API::Response.new(
    perform_request(method, path, params, body, headers)
  )
end

#stats(arguments = {}) ⇒ Object

Gets all stats related to cross-cluster replication.

Parameters:

• arguments (Hash) (defaults to: {}) —

  a customizable set of options

Options Hash (arguments):

• :headers (Hash) —

  Custom HTTP headers

See Also:

• https://www.elastic.co/guide/en/elasticsearch/reference/8.8/ccr-get-stats.html

# File 'lib/elasticsearch/api/actions/cross_cluster_replication/stats.rb', line 31

def stats(arguments = {})
  arguments = arguments.clone
  headers = arguments.delete(:headers) || {}

  body   = nil

  method = Elasticsearch::API::HTTP_GET
  path   = "_ccr/stats"
  params = {}

  Elasticsearch::API::Response.new(
    perform_request(method, path, params, body, headers)
  )
end

#unfollow(arguments = {}) ⇒ Object

Stops the following task associated with a follower index and removes index metadata and settings associated with cross-cluster replication.

Parameters:

• arguments (Hash) (defaults to: {}) —

  a customizable set of options

Options Hash (arguments):

• :index (String) —

  The name of the follower index that should be turned into a regular index.

• :headers (Hash) —

  Custom HTTP headers

Raises:

• (ArgumentError)

See Also:

• https://www.elastic.co/guide/en/elasticsearch/reference/8.8/ccr-post-unfollow.html

# File 'lib/elasticsearch/api/actions/cross_cluster_replication/unfollow.rb', line 32

def unfollow(arguments = {})
  raise ArgumentError, "Required argument 'index' missing" unless arguments[:index]

  arguments = arguments.clone
  headers = arguments.delete(:headers) || {}

  body   = nil

  _index = arguments.delete(:index)

  method = Elasticsearch::API::HTTP_POST
  path   = "#{Utils.__listify(_index)}/_ccr/unfollow"
  params = {}

  Elasticsearch::API::Response.new(
    perform_request(method, path, params, body, headers)
  )
end