module Elasticsearch::API::Connector::Actions
Public Instance Methods
Updates the last_seen timestamp in the connector document. This functionality is Experimental and may be changed or removed completely in a future release. Elastic will take a best effort approach to fix any issues, but experimental features are not subject to the support SLA of official GA features.
@option arguments [String] :connector_id The unique identifier of the connector to be updated. @option arguments [Hash] :headers Custom HTTP headers
@see www.elastic.co/guide/en/elasticsearch/reference/8.16/check-in-connector-api.html
# File lib/elasticsearch/api/actions/connector/check_in.rb, line 36 def check_in(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'connector.check_in' } defined_params = [:connector_id].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 'connector_id' missing" unless arguments[:connector_id] arguments = arguments.clone headers = arguments.delete(:headers) || {} body = nil _connector_id = arguments.delete(:connector_id) method = Elasticsearch::API::HTTP_PUT path = "_connector/#{Utils.__listify(_connector_id)}/_check_in" params = {} Elasticsearch::API::Response.new( perform_request(method, path, params, body, headers, request_opts) ) end
Deletes a connector. This functionality is Experimental and may be changed or removed completely in a future release. Elastic will take a best effort approach to fix any issues, but experimental features are not subject to the support SLA of official GA features.
@option arguments [String] :connector_id The unique identifier of the connector to be deleted. @option arguments [Boolean] :delete_sync_jobs Determines whether associated sync jobs are also deleted. @option arguments [Hash] :headers Custom HTTP headers
@see www.elastic.co/guide/en/elasticsearch/reference/8.16/delete-connector-api.html
# File lib/elasticsearch/api/actions/connector/delete.rb, line 37 def delete(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'connector.delete' } defined_params = [:connector_id].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 'connector_id' missing" unless arguments[:connector_id] arguments = arguments.clone headers = arguments.delete(:headers) || {} body = nil _connector_id = arguments.delete(:connector_id) method = Elasticsearch::API::HTTP_DELETE path = "_connector/#{Utils.__listify(_connector_id)}" params = Utils.process_params(arguments) Elasticsearch::API::Response.new( perform_request(method, path, params, body, headers, request_opts) ) end
Returns the details about a connector. This functionality is Experimental and may be changed or removed completely in a future release. Elastic will take a best effort approach to fix any issues, but experimental features are not subject to the support SLA of official GA features.
@option arguments [String] :connector_id The unique identifier of the connector to be returned. @option arguments [Hash] :headers Custom HTTP headers
@see www.elastic.co/guide/en/elasticsearch/reference/8.16/get-connector-api.html
# File lib/elasticsearch/api/actions/connector/get.rb, line 36 def get(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'connector.get' } defined_params = [:connector_id].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 'connector_id' missing" unless arguments[:connector_id] arguments = arguments.clone headers = arguments.delete(:headers) || {} body = nil _connector_id = arguments.delete(:connector_id) method = Elasticsearch::API::HTTP_GET path = "_connector/#{Utils.__listify(_connector_id)}" params = {} Elasticsearch::API::Response.new( perform_request(method, path, params, body, headers, request_opts) ) end
Updates the stats of last sync in the connector document. This functionality is Experimental and may be changed or removed completely in a future release. Elastic will take a best effort approach to fix any issues, but experimental features are not subject to the support SLA of official GA features.
@option arguments [String] :connector_id The unique identifier of the connector to be updated. @option arguments [Hash] :headers Custom HTTP headers @option arguments [Hash] :body Object with stats related to the last connector sync run. (Required)
@see www.elastic.co/guide/en/elasticsearch/reference/8.16/update-connector-last-sync-api.html
# File lib/elasticsearch/api/actions/connector/last_sync.rb, line 37 def last_sync(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'connector.last_sync' } defined_params = [:connector_id].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 'connector_id' missing" unless arguments[:connector_id] arguments = arguments.clone headers = arguments.delete(:headers) || {} body = arguments.delete(:body) _connector_id = arguments.delete(:connector_id) method = Elasticsearch::API::HTTP_PUT path = "_connector/#{Utils.__listify(_connector_id)}/_last_sync" params = {} Elasticsearch::API::Response.new( perform_request(method, path, params, body, headers, request_opts) ) end
Lists all connectors. This functionality is Experimental and may be changed or removed completely in a future release. Elastic will take a best effort approach to fix any issues, but experimental features are not subject to the support SLA of official GA features.
@option arguments [Integer] :from Starting offset (default: 0) @option arguments [Integer] :size Specifies a max number of results to get (default: 100) @option arguments [List] :index_name A comma-separated list of connector index names to fetch connector documents for @option arguments [List] :connector_name A comma-separated list of connector names to fetch connector documents for @option arguments [List] :service_type A comma-separated list of connector service types to fetch connector documents for @option arguments [String] :query A search string for querying connectors, filtering results by matching against connector names, descriptions, and index names @option arguments [Hash] :headers Custom HTTP headers
@see www.elastic.co/guide/en/elasticsearch/reference/8.16/list-connector-api.html
# File lib/elasticsearch/api/actions/connector/list.rb, line 41 def list(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'connector.list' } arguments = arguments.clone headers = arguments.delete(:headers) || {} body = nil method = Elasticsearch::API::HTTP_GET path = '_connector' params = Utils.process_params(arguments) Elasticsearch::API::Response.new( perform_request(method, path, params, body, headers, request_opts) ) end
Creates a connector. This functionality is Experimental and may be changed or removed completely in a future release. Elastic will take a best effort approach to fix any issues, but experimental features are not subject to the support SLA of official GA features.
@option arguments [Hash] :headers Custom HTTP headers @option arguments [Hash] :body The connector configuration.
@see www.elastic.co/guide/en/elasticsearch/reference/8.16/create-connector-api.html
# File lib/elasticsearch/api/actions/connector/post.rb, line 36 def post(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'connector.post' } arguments = arguments.clone headers = arguments.delete(:headers) || {} body = arguments.delete(:body) method = Elasticsearch::API::HTTP_POST path = '_connector' params = {} Elasticsearch::API::Response.new( perform_request(method, path, params, body, headers, request_opts) ) end
Creates or updates a connector. This functionality is Experimental and may be changed or removed completely in a future release. Elastic will take a best effort approach to fix any issues, but experimental features are not subject to the support SLA of official GA features.
@option arguments [String] :connector_id The unique identifier of the connector to be created or updated. @option arguments [Hash] :headers Custom HTTP headers @option arguments [Hash] :body The connector configuration.
@see www.elastic.co/guide/en/elasticsearch/reference/8.16/create-connector-api.html
# File lib/elasticsearch/api/actions/connector/put.rb, line 37 def put(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'connector.put' } defined_params = [:connector_id].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 = arguments.delete(:body) _connector_id = arguments.delete(:connector_id) method = Elasticsearch::API::HTTP_PUT path = if _connector_id "_connector/#{Utils.__listify(_connector_id)}" else '_connector' end params = {} Elasticsearch::API::Response.new( perform_request(method, path, params, body, headers, request_opts) ) end
Deletes a connector secret. This functionality is Experimental and may be changed or removed completely in a future release. Elastic will take a best effort approach to fix any issues, but experimental features are not subject to the support SLA of official GA features.
@option arguments [String] :id The ID of the secret @option arguments [Hash] :headers Custom HTTP headers
@see [TODO]
# File lib/elasticsearch/api/actions/connector/secret_delete.rb, line 36 def secret_delete(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'connector.secret_delete' } defined_params = [:id].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 'id' missing" unless arguments[:id] arguments = arguments.clone headers = arguments.delete(:headers) || {} body = nil _id = arguments.delete(:id) method = Elasticsearch::API::HTTP_DELETE path = "_connector/_secret/#{Utils.__listify(_id)}" params = {} Elasticsearch::API::Response.new( perform_request(method, path, params, body, headers, request_opts) ) end
Retrieves a secret stored by Connectors. This functionality is Experimental and may be changed or removed completely in a future release. Elastic will take a best effort approach to fix any issues, but experimental features are not subject to the support SLA of official GA features.
@option arguments [String] :id The ID of the secret @option arguments [Hash] :headers Custom HTTP headers
@see [TODO]
# File lib/elasticsearch/api/actions/connector/secret_get.rb, line 36 def secret_get(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'connector.secret_get' } defined_params = [:id].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 'id' missing" unless arguments[:id] arguments = arguments.clone headers = arguments.delete(:headers) || {} body = nil _id = arguments.delete(:id) method = Elasticsearch::API::HTTP_GET path = "_connector/_secret/#{Utils.__listify(_id)}" params = {} Elasticsearch::API::Response.new( perform_request(method, path, params, body, headers, request_opts) ) end
Creates a secret for a Connector
. This functionality is Experimental and may be changed or removed completely in a future release. Elastic will take a best effort approach to fix any issues, but experimental features are not subject to the support SLA of official GA features.
@option arguments [Hash] :headers Custom HTTP headers @option arguments [Hash] :body The secret value to store (Required)
@see [TODO]
# File lib/elasticsearch/api/actions/connector/secret_post.rb, line 36 def secret_post(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'connector.secret_post' } raise ArgumentError, "Required argument 'body' missing" unless arguments[:body] arguments = arguments.clone headers = arguments.delete(:headers) || {} body = arguments.delete(:body) method = Elasticsearch::API::HTTP_POST path = '_connector/_secret' params = {} Elasticsearch::API::Response.new( perform_request(method, path, params, body, headers, request_opts) ) end
Creates or updates a secret for a Connector
. This functionality is Experimental and may be changed or removed completely in a future release. Elastic will take a best effort approach to fix any issues, but experimental features are not subject to the support SLA of official GA features.
@option arguments [String] :id The unique identifier of the connector secret to be created or updated. @option arguments [Hash] :headers Custom HTTP headers @option arguments [Hash] :body The secret value to store (Required)
@see [TODO]
# File lib/elasticsearch/api/actions/connector/secret_put.rb, line 37 def secret_put(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'connector.secret_put' } defined_params = [:id].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 'id' missing" unless arguments[:id] arguments = arguments.clone headers = arguments.delete(:headers) || {} body = arguments.delete(:body) _id = arguments.delete(:id) method = Elasticsearch::API::HTTP_PUT path = "_connector/_secret/#{Utils.__listify(_id)}" params = {} Elasticsearch::API::Response.new( perform_request(method, path, params, body, headers, request_opts) ) end
Cancels a connector sync job. This functionality is Experimental and may be changed or removed completely in a future release. Elastic will take a best effort approach to fix any issues, but experimental features are not subject to the support SLA of official GA features.
@option arguments [String] :connector_sync_job_id The unique identifier of the connector sync job to be canceled @option arguments [Hash] :headers Custom HTTP headers
@see www.elastic.co/guide/en/elasticsearch/reference/8.16/cancel-connector-sync-job-api.html
# File lib/elasticsearch/api/actions/connector/sync_job_cancel.rb, line 36 def sync_job_cancel(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'connector.sync_job_cancel' } defined_params = [:connector_sync_job_id].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? unless arguments[:connector_sync_job_id] raise ArgumentError, "Required argument 'connector_sync_job_id' missing" end arguments = arguments.clone headers = arguments.delete(:headers) || {} body = nil _connector_sync_job_id = arguments.delete(:connector_sync_job_id) method = Elasticsearch::API::HTTP_PUT path = "_connector/_sync_job/#{Utils.__listify(_connector_sync_job_id)}/_cancel" params = {} Elasticsearch::API::Response.new( perform_request(method, path, params, body, headers, request_opts) ) end
Checks in a connector sync job (refreshes ‘last_seen’). This functionality is Experimental and may be changed or removed completely in a future release. Elastic will take a best effort approach to fix any issues, but experimental features are not subject to the support SLA of official GA features.
@option arguments [String] :connector_sync_job_id The unique identifier of the connector sync job to be checked in @option arguments [Hash] :headers Custom HTTP headers
@see www.elastic.co/guide/en/elasticsearch/reference/8.16/check-in-connector-sync-job-api.html
# File lib/elasticsearch/api/actions/connector/sync_job_check_in.rb, line 36 def sync_job_check_in(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'connector.sync_job_check_in' } defined_params = [:connector_sync_job_id].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? unless arguments[:connector_sync_job_id] raise ArgumentError, "Required argument 'connector_sync_job_id' missing" end arguments = arguments.clone headers = arguments.delete(:headers) || {} body = nil _connector_sync_job_id = arguments.delete(:connector_sync_job_id) method = Elasticsearch::API::HTTP_PUT path = "_connector/_sync_job/#{Utils.__listify(_connector_sync_job_id)}/_check_in" params = {} Elasticsearch::API::Response.new( perform_request(method, path, params, body, headers, request_opts) ) end
Claims a connector sync job. This functionality is Experimental and may be changed or removed completely in a future release. Elastic will take a best effort approach to fix any issues, but experimental features are not subject to the support SLA of official GA features.
@option arguments [String] :connector_sync_job_id The unique identifier of the connector sync job to be claimed. @option arguments [Hash] :headers Custom HTTP headers @option arguments [Hash] :body Data to claim a sync job. (Required)
@see www.elastic.co/guide/en/elasticsearch/reference/8.16/claim-connector-sync-job-api.html
# File lib/elasticsearch/api/actions/connector/sync_job_claim.rb, line 37 def sync_job_claim(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'connector.sync_job_claim' } defined_params = [:connector_sync_job_id].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] unless arguments[:connector_sync_job_id] raise ArgumentError, "Required argument 'connector_sync_job_id' missing" end arguments = arguments.clone headers = arguments.delete(:headers) || {} body = arguments.delete(:body) _connector_sync_job_id = arguments.delete(:connector_sync_job_id) method = Elasticsearch::API::HTTP_PUT path = "_connector/_sync_job/#{Utils.__listify(_connector_sync_job_id)}/_claim" params = {} Elasticsearch::API::Response.new( perform_request(method, path, params, body, headers, request_opts) ) end
Deletes a connector sync job. This functionality is Experimental and may be changed or removed completely in a future release. Elastic will take a best effort approach to fix any issues, but experimental features are not subject to the support SLA of official GA features.
@option arguments [String] :connector_sync_job_id The unique identifier of the connector sync job to be deleted. @option arguments [Hash] :headers Custom HTTP headers
@see www.elastic.co/guide/en/elasticsearch/reference/8.16/delete-connector-sync-job-api.html
# File lib/elasticsearch/api/actions/connector/sync_job_delete.rb, line 36 def sync_job_delete(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'connector.sync_job_delete' } defined_params = [:connector_sync_job_id].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? unless arguments[:connector_sync_job_id] raise ArgumentError, "Required argument 'connector_sync_job_id' missing" end arguments = arguments.clone headers = arguments.delete(:headers) || {} body = nil _connector_sync_job_id = arguments.delete(:connector_sync_job_id) method = Elasticsearch::API::HTTP_DELETE path = "_connector/_sync_job/#{Utils.__listify(_connector_sync_job_id)}" params = {} Elasticsearch::API::Response.new( perform_request(method, path, params, body, headers, request_opts) ) end
Sets an error for a connector sync job. This functionality is Experimental and may be changed or removed completely in a future release. Elastic will take a best effort approach to fix any issues, but experimental features are not subject to the support SLA of official GA features.
@option arguments [String] :connector_sync_job_id The unique identifier of the connector sync job to set an error for. @option arguments [Hash] :headers Custom HTTP headers @option arguments [Hash] :body The error to set in the connector sync job. (Required)
@see www.elastic.co/guide/en/elasticsearch/reference/8.16/set-connector-sync-job-error-api.html
# File lib/elasticsearch/api/actions/connector/sync_job_error.rb, line 37 def sync_job_error(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'connector.sync_job_error' } defined_params = [:connector_sync_job_id].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] unless arguments[:connector_sync_job_id] raise ArgumentError, "Required argument 'connector_sync_job_id' missing" end arguments = arguments.clone headers = arguments.delete(:headers) || {} body = arguments.delete(:body) _connector_sync_job_id = arguments.delete(:connector_sync_job_id) method = Elasticsearch::API::HTTP_PUT path = "_connector/_sync_job/#{Utils.__listify(_connector_sync_job_id)}/_error" params = {} Elasticsearch::API::Response.new( perform_request(method, path, params, body, headers, request_opts) ) end
Returns the details about a connector sync job. This functionality is Experimental and may be changed or removed completely in a future release. Elastic will take a best effort approach to fix any issues, but experimental features are not subject to the support SLA of official GA features.
@option arguments [String] :connector_sync_job_id The unique identifier of the connector sync job to be returned. @option arguments [Hash] :headers Custom HTTP headers
@see www.elastic.co/guide/en/elasticsearch/reference/8.16/get-connector-sync-job-api.html
# File lib/elasticsearch/api/actions/connector/sync_job_get.rb, line 36 def sync_job_get(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'connector.sync_job_get' } defined_params = [:connector_sync_job_id].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? unless arguments[:connector_sync_job_id] raise ArgumentError, "Required argument 'connector_sync_job_id' missing" end arguments = arguments.clone headers = arguments.delete(:headers) || {} body = nil _connector_sync_job_id = arguments.delete(:connector_sync_job_id) method = Elasticsearch::API::HTTP_GET path = "_connector/_sync_job/#{Utils.__listify(_connector_sync_job_id)}" params = {} Elasticsearch::API::Response.new( perform_request(method, path, params, body, headers, request_opts) ) end
Lists all connector sync jobs. This functionality is Experimental and may be changed or removed completely in a future release. Elastic will take a best effort approach to fix any issues, but experimental features are not subject to the support SLA of official GA features.
@option arguments [Integer] :from Starting offset (default: 0) @option arguments [Integer] :size specifies a max number of results to get (default: 100) @option arguments [String] :status Sync job status, which sync jobs are fetched for @option arguments [String] :connector_id Id of the connector to fetch the sync jobs for @option arguments [List] :job_type A comma-separated list of job types @option arguments [Hash] :headers Custom HTTP headers
@see www.elastic.co/guide/en/elasticsearch/reference/8.16/list-connector-sync-jobs-api.html
# File lib/elasticsearch/api/actions/connector/sync_job_list.rb, line 40 def sync_job_list(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'connector.sync_job_list' } arguments = arguments.clone headers = arguments.delete(:headers) || {} body = nil method = Elasticsearch::API::HTTP_GET path = '_connector/_sync_job' params = Utils.process_params(arguments) Elasticsearch::API::Response.new( perform_request(method, path, params, body, headers, request_opts) ) end
Creates a connector sync job. This functionality is Experimental and may be changed or removed completely in a future release. Elastic will take a best effort approach to fix any issues, but experimental features are not subject to the support SLA of official GA features.
@option arguments [Hash] :headers Custom HTTP headers @option arguments [Hash] :body The connector sync job data. (Required)
@see www.elastic.co/guide/en/elasticsearch/reference/8.16/create-connector-sync-job-api.html
# File lib/elasticsearch/api/actions/connector/sync_job_post.rb, line 36 def sync_job_post(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'connector.sync_job_post' } raise ArgumentError, "Required argument 'body' missing" unless arguments[:body] arguments = arguments.clone headers = arguments.delete(:headers) || {} body = arguments.delete(:body) method = Elasticsearch::API::HTTP_POST path = '_connector/_sync_job' params = {} Elasticsearch::API::Response.new( perform_request(method, path, params, body, headers, request_opts) ) end
Updates the stats fields in the connector sync job document. This functionality is Experimental and may be changed or removed completely in a future release. Elastic will take a best effort approach to fix any issues, but experimental features are not subject to the support SLA of official GA features.
@option arguments [String] :connector_sync_job_id The unique identifier of the connector sync job to be updated. @option arguments [Hash] :headers Custom HTTP headers @option arguments [Hash] :body The stats to update for the connector sync job. (Required)
@see www.elastic.co/guide/en/elasticsearch/reference/8.16/set-connector-sync-job-stats-api.html
# File lib/elasticsearch/api/actions/connector/sync_job_update_stats.rb, line 37 def sync_job_update_stats(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'connector.sync_job_update_stats' } defined_params = [:connector_sync_job_id].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] unless arguments[:connector_sync_job_id] raise ArgumentError, "Required argument 'connector_sync_job_id' missing" end arguments = arguments.clone headers = arguments.delete(:headers) || {} body = arguments.delete(:body) _connector_sync_job_id = arguments.delete(:connector_sync_job_id) method = Elasticsearch::API::HTTP_PUT path = "_connector/_sync_job/#{Utils.__listify(_connector_sync_job_id)}/_stats" params = {} Elasticsearch::API::Response.new( perform_request(method, path, params, body, headers, request_opts) ) end
Activates the draft filtering rules if they are in a validated state. This functionality is Experimental and may be changed or removed completely in a future release. Elastic will take a best effort approach to fix any issues, but experimental features are not subject to the support SLA of official GA features.
@option arguments [String] :connector_id The unique identifier of the connector to be updated. @option arguments [Hash] :headers Custom HTTP headers
@see www.elastic.co/guide/en/elasticsearch/reference/8.16/update-connector-filtering-api.html
# File lib/elasticsearch/api/actions/connector/update_active_filtering.rb, line 36 def update_active_filtering(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'connector.update_active_filtering' } defined_params = [:connector_id].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 'connector_id' missing" unless arguments[:connector_id] arguments = arguments.clone headers = arguments.delete(:headers) || {} body = nil _connector_id = arguments.delete(:connector_id) method = Elasticsearch::API::HTTP_PUT path = "_connector/#{Utils.__listify(_connector_id)}/_filtering/_activate" params = {} Elasticsearch::API::Response.new( perform_request(method, path, params, body, headers, request_opts) ) end
Updates the API
key id and/or API
key secret id fields in the connector document. This functionality is Experimental and may be changed or removed completely in a future release. Elastic will take a best effort approach to fix any issues, but experimental features are not subject to the support SLA of official GA features.
@option arguments [String] :connector_id The unique identifier of the connector to be updated. @option arguments [Hash] :headers Custom HTTP headers @option arguments [Hash] :body An object containing the connector’s API
key id and/or Connector
Secret document id for that API
key. (Required)
@see www.elastic.co/guide/en/elasticsearch/reference/8.16/update-connector-api-key-id-api.html
# File lib/elasticsearch/api/actions/connector/update_api_key_id.rb, line 37 def update_api_key_id(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'connector.update_api_key_id' } defined_params = [:connector_id].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 'connector_id' missing" unless arguments[:connector_id] arguments = arguments.clone headers = arguments.delete(:headers) || {} body = arguments.delete(:body) _connector_id = arguments.delete(:connector_id) method = Elasticsearch::API::HTTP_PUT path = "_connector/#{Utils.__listify(_connector_id)}/_api_key_id" params = {} Elasticsearch::API::Response.new( perform_request(method, path, params, body, headers, request_opts) ) end
Updates the connector configuration. This functionality is Experimental and may be changed or removed completely in a future release. Elastic will take a best effort approach to fix any issues, but experimental features are not subject to the support SLA of official GA features.
@option arguments [String] :connector_id The unique identifier of the connector to be updated. @option arguments [Hash] :headers Custom HTTP headers @option arguments [Hash] :body Mapping between field names to configuration. (Required)
@see www.elastic.co/guide/en/elasticsearch/reference/8.16/update-connector-configuration-api.html
# File lib/elasticsearch/api/actions/connector/update_configuration.rb, line 37 def update_configuration(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'connector.update_configuration' } defined_params = [:connector_id].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 'connector_id' missing" unless arguments[:connector_id] arguments = arguments.clone headers = arguments.delete(:headers) || {} body = arguments.delete(:body) _connector_id = arguments.delete(:connector_id) method = Elasticsearch::API::HTTP_PUT path = "_connector/#{Utils.__listify(_connector_id)}/_configuration" params = {} Elasticsearch::API::Response.new( perform_request(method, path, params, body, headers, request_opts) ) end
Updates the error field in the connector document. This functionality is Experimental and may be changed or removed completely in a future release. Elastic will take a best effort approach to fix any issues, but experimental features are not subject to the support SLA of official GA features.
@option arguments [String] :connector_id The unique identifier of the connector to be updated. @option arguments [Hash] :headers Custom HTTP headers @option arguments [Hash] :body An object containing the connector’s error. (Required)
@see www.elastic.co/guide/en/elasticsearch/reference/8.16/update-connector-error-api.html
# File lib/elasticsearch/api/actions/connector/update_error.rb, line 37 def update_error(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'connector.update_error' } defined_params = [:connector_id].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 'connector_id' missing" unless arguments[:connector_id] arguments = arguments.clone headers = arguments.delete(:headers) || {} body = arguments.delete(:body) _connector_id = arguments.delete(:connector_id) method = Elasticsearch::API::HTTP_PUT path = "_connector/#{Utils.__listify(_connector_id)}/_error" params = {} Elasticsearch::API::Response.new( perform_request(method, path, params, body, headers, request_opts) ) end
Updates the connector features in the connector document. This functionality is Experimental and may be changed or removed completely in a future release. Elastic will take a best effort approach to fix any issues, but experimental features are not subject to the support SLA of official GA features.
@option arguments [String] :connector_id The unique identifier of the connector to be updated. @option arguments [Hash] :headers Custom HTTP headers @option arguments [Hash] :body An object containing the connector’s features definition. (Required)
@see www.elastic.co/guide/en/elasticsearch/reference/8.16/update-connector-features-api.html
# File lib/elasticsearch/api/actions/connector/update_features.rb, line 37 def update_features(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'connector.update_features' } defined_params = [:connector_id].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 'connector_id' missing" unless arguments[:connector_id] arguments = arguments.clone headers = arguments.delete(:headers) || {} body = arguments.delete(:body) _connector_id = arguments.delete(:connector_id) method = Elasticsearch::API::HTTP_PUT path = "_connector/#{Utils.__listify(_connector_id)}/_features" params = {} Elasticsearch::API::Response.new( perform_request(method, path, params, body, headers, request_opts) ) end
Updates the filtering field in the connector document. This functionality is Experimental and may be changed or removed completely in a future release. Elastic will take a best effort approach to fix any issues, but experimental features are not subject to the support SLA of official GA features.
@option arguments [String] :connector_id The unique identifier of the connector to be updated. @option arguments [Hash] :headers Custom HTTP headers @option arguments [Hash] :body A list of connector filtering configurations. (Required)
@see www.elastic.co/guide/en/elasticsearch/reference/8.16/update-connector-filtering-api.html
# File lib/elasticsearch/api/actions/connector/update_filtering.rb, line 37 def update_filtering(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'connector.update_filtering' } defined_params = [:connector_id].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 'connector_id' missing" unless arguments[:connector_id] arguments = arguments.clone headers = arguments.delete(:headers) || {} body = arguments.delete(:body) _connector_id = arguments.delete(:connector_id) method = Elasticsearch::API::HTTP_PUT path = "_connector/#{Utils.__listify(_connector_id)}/_filtering" params = {} Elasticsearch::API::Response.new( perform_request(method, path, params, body, headers, request_opts) ) end
Updates the validation info of the draft filtering rules. This functionality is Experimental and may be changed or removed completely in a future release. Elastic will take a best effort approach to fix any issues, but experimental features are not subject to the support SLA of official GA features.
@option arguments [String] :connector_id The unique identifier of the connector to be updated. @option arguments [Hash] :headers Custom HTTP headers @option arguments [Hash] :body Validation info for the draft filtering rules (Required)
@see www.elastic.co/guide/en/elasticsearch/reference/8.16/update-connector-filtering-api.html
# File lib/elasticsearch/api/actions/connector/update_filtering_validation.rb, line 37 def update_filtering_validation(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'connector.update_filtering_validation' } defined_params = [:connector_id].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 'connector_id' missing" unless arguments[:connector_id] arguments = arguments.clone headers = arguments.delete(:headers) || {} body = arguments.delete(:body) _connector_id = arguments.delete(:connector_id) method = Elasticsearch::API::HTTP_PUT path = "_connector/#{Utils.__listify(_connector_id)}/_filtering/_validation" params = {} Elasticsearch::API::Response.new( perform_request(method, path, params, body, headers, request_opts) ) end
Updates the index name of the connector. This functionality is Experimental and may be changed or removed completely in a future release. Elastic will take a best effort approach to fix any issues, but experimental features are not subject to the support SLA of official GA features.
@option arguments [String] :connector_id The unique identifier of the connector to be updated. @option arguments [Hash] :headers Custom HTTP headers @option arguments [Hash] :body An object containing the connector’s index name. (Required)
@see www.elastic.co/guide/en/elasticsearch/reference/8.16/update-connector-index-name-api.html
# File lib/elasticsearch/api/actions/connector/update_index_name.rb, line 37 def update_index_name(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'connector.update_index_name' } defined_params = [:connector_id].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 'connector_id' missing" unless arguments[:connector_id] arguments = arguments.clone headers = arguments.delete(:headers) || {} body = arguments.delete(:body) _connector_id = arguments.delete(:connector_id) method = Elasticsearch::API::HTTP_PUT path = "_connector/#{Utils.__listify(_connector_id)}/_index_name" params = {} Elasticsearch::API::Response.new( perform_request(method, path, params, body, headers, request_opts) ) end
Updates the name and/or description fields in the connector document. This functionality is Experimental and may be changed or removed completely in a future release. Elastic will take a best effort approach to fix any issues, but experimental features are not subject to the support SLA of official GA features.
@option arguments [String] :connector_id The unique identifier of the connector to be updated. @option arguments [Hash] :headers Custom HTTP headers @option arguments [Hash] :body An object containing the connector’s name and/or description. (Required)
@see www.elastic.co/guide/en/elasticsearch/reference/8.16/update-connector-name-description-api.html
# File lib/elasticsearch/api/actions/connector/update_name.rb, line 37 def update_name(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'connector.update_name' } defined_params = [:connector_id].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 'connector_id' missing" unless arguments[:connector_id] arguments = arguments.clone headers = arguments.delete(:headers) || {} body = arguments.delete(:body) _connector_id = arguments.delete(:connector_id) method = Elasticsearch::API::HTTP_PUT path = "_connector/#{Utils.__listify(_connector_id)}/_name" params = {} Elasticsearch::API::Response.new( perform_request(method, path, params, body, headers, request_opts) ) end
Updates the is_native flag of the connector. This functionality is Experimental and may be changed or removed completely in a future release. Elastic will take a best effort approach to fix any issues, but experimental features are not subject to the support SLA of official GA features.
@option arguments [String] :connector_id The unique identifier of the connector to be updated. @option arguments [Hash] :headers Custom HTTP headers @option arguments [Hash] :body An object containing the connector’s is_native flag (Required)
@see www.elastic.co/guide/en/elasticsearch/reference/8.16/connector-apis.html
# File lib/elasticsearch/api/actions/connector/update_native.rb, line 37 def update_native(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'connector.update_native' } defined_params = [:connector_id].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 'connector_id' missing" unless arguments[:connector_id] arguments = arguments.clone headers = arguments.delete(:headers) || {} body = arguments.delete(:body) _connector_id = arguments.delete(:connector_id) method = Elasticsearch::API::HTTP_PUT path = "_connector/#{Utils.__listify(_connector_id)}/_native" params = {} Elasticsearch::API::Response.new( perform_request(method, path, params, body, headers, request_opts) ) end
Updates the pipeline field in the connector document. This functionality is Experimental and may be changed or removed completely in a future release. Elastic will take a best effort approach to fix any issues, but experimental features are not subject to the support SLA of official GA features.
@option arguments [String] :connector_id The unique identifier of the connector to be updated. @option arguments [Hash] :headers Custom HTTP headers @option arguments [Hash] :body An object with connector ingest pipeline configuration. (Required)
@see www.elastic.co/guide/en/elasticsearch/reference/8.16/update-connector-pipeline-api.html
# File lib/elasticsearch/api/actions/connector/update_pipeline.rb, line 37 def update_pipeline(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'connector.update_pipeline' } defined_params = [:connector_id].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 'connector_id' missing" unless arguments[:connector_id] arguments = arguments.clone headers = arguments.delete(:headers) || {} body = arguments.delete(:body) _connector_id = arguments.delete(:connector_id) method = Elasticsearch::API::HTTP_PUT path = "_connector/#{Utils.__listify(_connector_id)}/_pipeline" params = {} Elasticsearch::API::Response.new( perform_request(method, path, params, body, headers, request_opts) ) end
Updates the scheduling field in the connector document. This functionality is Experimental and may be changed or removed completely in a future release. Elastic will take a best effort approach to fix any issues, but experimental features are not subject to the support SLA of official GA features.
@option arguments [String] :connector_id The unique identifier of the connector to be updated. @option arguments [Hash] :headers Custom HTTP headers @option arguments [Hash] :body An object containing the connector’s scheduling configuration. (Required)
@see www.elastic.co/guide/en/elasticsearch/reference/8.16/update-connector-scheduling-api.html
# File lib/elasticsearch/api/actions/connector/update_scheduling.rb, line 37 def update_scheduling(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'connector.update_scheduling' } defined_params = [:connector_id].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 'connector_id' missing" unless arguments[:connector_id] arguments = arguments.clone headers = arguments.delete(:headers) || {} body = arguments.delete(:body) _connector_id = arguments.delete(:connector_id) method = Elasticsearch::API::HTTP_PUT path = "_connector/#{Utils.__listify(_connector_id)}/_scheduling" params = {} Elasticsearch::API::Response.new( perform_request(method, path, params, body, headers, request_opts) ) end
Updates the service type of the connector. This functionality is Experimental and may be changed or removed completely in a future release. Elastic will take a best effort approach to fix any issues, but experimental features are not subject to the support SLA of official GA features.
@option arguments [String] :connector_id The unique identifier of the connector to be updated. @option arguments [Hash] :headers Custom HTTP headers @option arguments [Hash] :body An object containing the connector’s service type. (Required)
@see www.elastic.co/guide/en/elasticsearch/reference/8.16/update-connector-service-type-api.html
# File lib/elasticsearch/api/actions/connector/update_service_type.rb, line 37 def update_service_type(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'connector.update_service_type' } defined_params = [:connector_id].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 'connector_id' missing" unless arguments[:connector_id] arguments = arguments.clone headers = arguments.delete(:headers) || {} body = arguments.delete(:body) _connector_id = arguments.delete(:connector_id) method = Elasticsearch::API::HTTP_PUT path = "_connector/#{Utils.__listify(_connector_id)}/_service_type" params = {} Elasticsearch::API::Response.new( perform_request(method, path, params, body, headers, request_opts) ) end
Updates the status of the connector. This functionality is Experimental and may be changed or removed completely in a future release. Elastic will take a best effort approach to fix any issues, but experimental features are not subject to the support SLA of official GA features.
@option arguments [String] :connector_id The unique identifier of the connector to be updated. @option arguments [Hash] :headers Custom HTTP headers @option arguments [Hash] :body An object containing the connector’s status. (Required)
@see www.elastic.co/guide/en/elasticsearch/reference/8.16/update-connector-status-api.html
# File lib/elasticsearch/api/actions/connector/update_status.rb, line 37 def update_status(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'connector.update_status' } defined_params = [:connector_id].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 'connector_id' missing" unless arguments[:connector_id] arguments = arguments.clone headers = arguments.delete(:headers) || {} body = arguments.delete(:body) _connector_id = arguments.delete(:connector_id) method = Elasticsearch::API::HTTP_PUT path = "_connector/#{Utils.__listify(_connector_id)}/_status" params = {} Elasticsearch::API::Response.new( perform_request(method, path, params, body, headers, request_opts) ) end