module Elasticsearch::API::CrossClusterReplication::Actions
Public Instance Methods
Source
# File lib/elasticsearch/api/actions/cross_cluster_replication/delete_auto_follow_pattern.rb, line 36 def delete_auto_follow_pattern(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'ccr.delete_auto_follow_pattern' } defined_params = [:name].each_with_object({}) do |variable, set_variables| set_variables[variable] = arguments[variable] if arguments.key?(variable) end request_opts[:defined_params] = defined_params unless defined_params.empty? 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 = Utils.process_params(arguments) Elasticsearch::API::Response.new( perform_request(method, path, params, body, headers, request_opts) ) end
Delete auto-follow patterns. Delete a collection of cross-cluster replication auto-follow patterns.
@option arguments [String] :name The auto-follow pattern collection to delete. (Required) @option arguments [Time] :master_timeout The period to wait for a connection to the master node.
If the master node is not available before the timeout expires, the request fails and returns an error. It can also be set to +-1+ to indicate that the request should never timeout. Server default: 30s.
@option arguments [Hash] :headers Custom HTTP headers
@see www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-ccr-delete-auto-follow-pattern
Source
# File lib/elasticsearch/api/actions/cross_cluster_replication/follow.rb, line 40 def follow(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'ccr.follow' } defined_params = [:index].each_with_object({}) do |variable, set_variables| set_variables[variable] = arguments[variable] if arguments.key?(variable) end request_opts[:defined_params] = defined_params unless defined_params.empty? 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, request_opts) ) end
Create a follower. Create a cross-cluster replication follower index that follows a specific leader index. When the API
returns, the follower index exists and cross-cluster replication starts replicating operations from the leader index to the follower index.
@option arguments [String] :index The name of the follower index. (Required) @option arguments [Time] :master_timeout Period to wait for a connection to the master node. Server default: 30s. @option arguments [Integer, String] :wait_for_active_shards Specifies the number of shards to wait on being active before responding. This defaults to waiting on none of the shards to be
active. A shard must be restored from the leader index before being active. Restoring a follower shard requires transferring all the remote Lucene segment files to the follower index.
@option arguments [Hash] :headers Custom HTTP headers @option arguments [Hash] :body request body
@see www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-ccr-follow
Source
# File lib/elasticsearch/api/actions/cross_cluster_replication/follow_info.rb, line 37 def follow_info(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'ccr.follow_info' } defined_params = [:index].each_with_object({}) do |variable, set_variables| set_variables[variable] = arguments[variable] if arguments.key?(variable) end request_opts[:defined_params] = defined_params unless defined_params.empty? 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 = Utils.process_params(arguments) Elasticsearch::API::Response.new( perform_request(method, path, params, body, headers, request_opts) ) end
Get follower information. Get information about all cross-cluster replication follower indices. For example, the results include follower index names, leader index names, replication options, and whether the follower indices are active or paused.
@option arguments [String, Array] :index A comma-delimited list of follower index patterns. (Required) @option arguments [Time] :master_timeout The period to wait for a connection to the master node.
If the master node is not available before the timeout expires, the request fails and returns an error. It can also be set to +-1+ to indicate that the request should never timeout. Server default: 30s.
@option arguments [Hash] :headers Custom HTTP headers
@see www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-ccr-follow-info
Source
# File lib/elasticsearch/api/actions/cross_cluster_replication/follow_stats.rb, line 36 def follow_stats(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'ccr.follow_stats' } defined_params = [:index].each_with_object({}) do |variable, set_variables| set_variables[variable] = arguments[variable] if arguments.key?(variable) end request_opts[:defined_params] = defined_params unless defined_params.empty? 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 = Utils.process_params(arguments) Elasticsearch::API::Response.new( perform_request(method, path, params, body, headers, request_opts) ) end
Get follower stats. Get cross-cluster replication follower stats. The API
returns shard-level stats about the “following tasks” associated with each shard for the specified indices.
@option arguments [String, Array] :index A comma-delimited list of index patterns. (Required) @option arguments [Time] :timeout The period to wait for a response.
If no response is received before the timeout expires, the request fails and returns an error. Server default: 30s.
@option arguments [Hash] :headers Custom HTTP headers
@see www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-ccr-follow-stats
Source
# File lib/elasticsearch/api/actions/cross_cluster_replication/forget_follower.rb, line 43 def forget_follower(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'ccr.forget_follower' } defined_params = [:index].each_with_object({}) do |variable, set_variables| set_variables[variable] = arguments[variable] if arguments.key?(variable) end request_opts[:defined_params] = defined_params unless defined_params.empty? 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 = Utils.process_params(arguments) Elasticsearch::API::Response.new( perform_request(method, path, params, body, headers, request_opts) ) end
Forget a follower. Remove the cross-cluster replication follower retention leases from the leader. A following index takes out retention leases on its leader index. These leases are used to increase the likelihood that the shards of the leader index retain the history of operations that the shards of the following index need to run replication. When a follower index is converted to a regular index by the unfollow API
(either by directly calling the API
or by index lifecycle management tasks), these leases are removed. However, removal of the leases can fail, for example when the remote cluster containing the leader index is unavailable. While the leases will eventually expire on their own, their extended existence can cause the leader index to hold more history than necessary and prevent index lifecycle management from performing some operations on the leader index. This API
exists to enable manually removing the leases when the unfollow API
is unable to do so. NOTE: This API
does not stop replication by a following index. If you use this API
with a follower index that is still actively following, the following index will add back retention leases on the leader. The only purpose of this API
is to handle the case of failure to remove the following retention leases after the unfollow API
is invoked.
@option arguments [String] :index the name of the leader index for which specified follower retention leases should be removed (Required) @option arguments [Time] :timeout Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. Server default: 30s. @option arguments [Hash] :headers Custom HTTP headers @option arguments [Hash] :body request body
@see www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-ccr-forget-follower
Source
# File lib/elasticsearch/api/actions/cross_cluster_replication/get_auto_follow_pattern.rb, line 37 def get_auto_follow_pattern(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'ccr.get_auto_follow_pattern' } defined_params = [:name].each_with_object({}) do |variable, set_variables| set_variables[variable] = arguments[variable] if arguments.key?(variable) end request_opts[:defined_params] = defined_params unless defined_params.empty? 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 = Utils.process_params(arguments) Elasticsearch::API::Response.new( perform_request(method, path, params, body, headers, request_opts) ) end
Get auto-follow patterns. Get cross-cluster replication auto-follow patterns.
@option arguments [String] :name The auto-follow pattern collection that you want to retrieve.
If you do not specify a name, the API returns information for all collections.
@option arguments [Time] :master_timeout The period to wait for a connection to the master node.
If the master node is not available before the timeout expires, the request fails and returns an error. It can also be set to +-1+ to indicate that the request should never timeout. Server default: 30s.
@option arguments [Hash] :headers Custom HTTP headers
@see www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-ccr-get-auto-follow-pattern-1
Source
# File lib/elasticsearch/api/actions/cross_cluster_replication/pause_auto_follow_pattern.rb, line 41 def pause_auto_follow_pattern(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'ccr.pause_auto_follow_pattern' } defined_params = [:name].each_with_object({}) do |variable, set_variables| set_variables[variable] = arguments[variable] if arguments.key?(variable) end request_opts[:defined_params] = defined_params unless defined_params.empty? 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 = Utils.process_params(arguments) Elasticsearch::API::Response.new( perform_request(method, path, params, body, headers, request_opts) ) end
Pause an auto-follow pattern. Pause a cross-cluster replication auto-follow pattern. When the API
returns, the auto-follow pattern is inactive. New indices that are created on the remote cluster and match the auto-follow patterns are ignored. You can resume auto-following with the resume auto-follow pattern API
. When it resumes, the auto-follow pattern is active again and automatically configures follower indices for newly created indices on the remote cluster that match its patterns. Remote indices that were created while the pattern was paused will also be followed, unless they have been deleted or closed in the interim.
@option arguments [String] :name The name of the auto-follow pattern to pause. (Required) @option arguments [Time] :master_timeout The period to wait for a connection to the master node.
If the master node is not available before the timeout expires, the request fails and returns an error. It can also be set to +-1+ to indicate that the request should never timeout. Server default: 30s.
@option arguments [Hash] :headers Custom HTTP headers
@see www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-ccr-pause-auto-follow-pattern
Source
# File lib/elasticsearch/api/actions/cross_cluster_replication/pause_follow.rb, line 39 def pause_follow(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'ccr.pause_follow' } defined_params = [:index].each_with_object({}) do |variable, set_variables| set_variables[variable] = arguments[variable] if arguments.key?(variable) end request_opts[:defined_params] = defined_params unless defined_params.empty? 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 = Utils.process_params(arguments) Elasticsearch::API::Response.new( perform_request(method, path, params, body, headers, request_opts) ) end
Pause a follower. Pause a cross-cluster replication follower index. The follower index will not fetch any additional operations from the leader index. You can resume following with the resume follower API
. You can pause and resume a follower index to change the configuration of the following task.
@option arguments [String] :index The name of the follower index. (Required) @option arguments [Time] :master_timeout The period to wait for a connection to the master node.
If the master node is not available before the timeout expires, the request fails and returns an error. It can also be set to +-1+ to indicate that the request should never timeout. Server default: 30s.
@option arguments [Hash] :headers Custom HTTP headers
@see www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-ccr-pause-follow
Source
# File lib/elasticsearch/api/actions/cross_cluster_replication/put_auto_follow_pattern.rb, line 39 def put_auto_follow_pattern(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'ccr.put_auto_follow_pattern' } defined_params = [:name].each_with_object({}) do |variable, set_variables| set_variables[variable] = arguments[variable] if arguments.key?(variable) end request_opts[:defined_params] = defined_params unless defined_params.empty? 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 = Utils.process_params(arguments) Elasticsearch::API::Response.new( perform_request(method, path, params, body, headers, request_opts) ) end
Create or update auto-follow patterns. Create a collection of cross-cluster replication auto-follow patterns for a remote cluster. Newly created indices on the remote cluster that match any of the patterns are automatically configured as follower indices. Indices
on the remote cluster that were created before the auto-follow pattern was created will not be auto-followed even if they match the pattern. This API
can also be used to update auto-follow patterns. NOTE: Follower indices that were configured automatically before updating an auto-follow pattern will remain unchanged even if they do not match against the new patterns.
@option arguments [String] :name The name of the collection of auto-follow patterns. (Required) @option arguments [Time] :master_timeout Period to wait for a connection to the master node. Server default: 30s. @option arguments [Hash] :headers Custom HTTP headers @option arguments [Hash] :body request body
@see www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-ccr-put-auto-follow-pattern
Source
# File lib/elasticsearch/api/actions/cross_cluster_replication/resume_auto_follow_pattern.rb, line 38 def resume_auto_follow_pattern(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'ccr.resume_auto_follow_pattern' } defined_params = [:name].each_with_object({}) do |variable, set_variables| set_variables[variable] = arguments[variable] if arguments.key?(variable) end request_opts[:defined_params] = defined_params unless defined_params.empty? 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 = Utils.process_params(arguments) Elasticsearch::API::Response.new( perform_request(method, path, params, body, headers, request_opts) ) end
Resume an auto-follow pattern. Resume a cross-cluster replication auto-follow pattern that was paused. The auto-follow pattern will resume configuring following indices for newly created indices that match its patterns on the remote cluster. Remote indices created while the pattern was paused will also be followed unless they have been deleted or closed in the interim.
@option arguments [String] :name The name of the auto-follow pattern to resume. (Required) @option arguments [Time] :master_timeout The period to wait for a connection to the master node.
If the master node is not available before the timeout expires, the request fails and returns an error. It can also be set to +-1+ to indicate that the request should never timeout. Server default: 30s.
@option arguments [Hash] :headers Custom HTTP headers
@see www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-ccr-resume-auto-follow-pattern
Source
# File lib/elasticsearch/api/actions/cross_cluster_replication/resume_follow.rb, line 38 def resume_follow(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'ccr.resume_follow' } defined_params = [:index].each_with_object({}) do |variable, set_variables| set_variables[variable] = arguments[variable] if arguments.key?(variable) end request_opts[:defined_params] = defined_params unless defined_params.empty? 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 = Utils.process_params(arguments) Elasticsearch::API::Response.new( perform_request(method, path, params, body, headers, request_opts) ) end
Resume a follower. Resume a cross-cluster replication follower index that was paused. The follower index could have been paused with the pause follower API
. Alternatively it could be paused due to replication that cannot be retried due to failures during following tasks. When this API
returns, the follower index will resume fetching operations from the leader index.
@option arguments [String] :index The name of the follow index to resume following. (Required) @option arguments [Time] :master_timeout Period to wait for a connection to the master node. Server default: 30s. @option arguments [Hash] :headers Custom HTTP headers @option arguments [Hash] :body request body
@see www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-ccr-resume-follow
Source
# File lib/elasticsearch/api/actions/cross_cluster_replication/stats.rb, line 36 def stats(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'ccr.stats' } arguments = arguments.clone headers = arguments.delete(:headers) || {} body = nil method = Elasticsearch::API::HTTP_GET path = '_ccr/stats' params = Utils.process_params(arguments) Elasticsearch::API::Response.new( perform_request(method, path, params, body, headers, request_opts) ) end
Get cross-cluster replication stats. This API
returns stats about auto-following and the same shard-level stats as the get follower stats API
.
@option arguments [Time] :master_timeout The period to wait for a connection to the master node.
If the master node is not available before the timeout expires, the request fails and returns an error. It can also be set to +-1+ to indicate that the request should never timeout. Server default: 30s.
@option arguments [Time] :timeout The period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. Server default: 30s. @option arguments [Hash] :headers Custom HTTP headers
@see www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-ccr-stats
Source
# File lib/elasticsearch/api/actions/cross_cluster_replication/unfollow.rb, line 38 def unfollow(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'ccr.unfollow' } defined_params = [:index].each_with_object({}) do |variable, set_variables| set_variables[variable] = arguments[variable] if arguments.key?(variable) end request_opts[:defined_params] = defined_params unless defined_params.empty? 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 = Utils.process_params(arguments) Elasticsearch::API::Response.new( perform_request(method, path, params, body, headers, request_opts) ) end
Unfollow an index. Convert a cross-cluster replication follower index to a regular index. The API
stops the following task associated with a follower index and removes index metadata and settings associated with cross-cluster replication. The follower index must be paused and closed before you call the unfollow API
.
@option arguments [String] :index The name of the follower index. (Required) @option arguments [Time] :master_timeout The period to wait for a connection to the master node.
If the master node is not available before the timeout expires, the request fails and returns an error. It can also be set to +-1+ to indicate that the request should never timeout. Server default: 30s.
@option arguments [Hash] :headers Custom HTTP headers
@see www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-ccr-unfollow