Module: Elasticsearch::API::Connector::Actions
- Defined in:
- lib/elasticsearch/api/actions/connector/get.rb,
lib/elasticsearch/api/actions/connector/put.rb,
lib/elasticsearch/api/actions/connector/list.rb,
lib/elasticsearch/api/actions/connector/post.rb,
lib/elasticsearch/api/actions/connector/delete.rb,
lib/elasticsearch/api/actions/connector/check_in.rb,
lib/elasticsearch/api/actions/connector/update_name.rb,
lib/elasticsearch/api/actions/connector/sync_job_get.rb,
lib/elasticsearch/api/actions/connector/update_error.rb,
lib/elasticsearch/api/actions/connector/sync_job_list.rb,
lib/elasticsearch/api/actions/connector/sync_job_post.rb,
lib/elasticsearch/api/actions/connector/update_native.rb,
lib/elasticsearch/api/actions/connector/update_status.rb,
lib/elasticsearch/api/actions/connector/sync_job_claim.rb,
lib/elasticsearch/api/actions/connector/sync_job_error.rb,
lib/elasticsearch/api/actions/connector/sync_job_cancel.rb,
lib/elasticsearch/api/actions/connector/sync_job_delete.rb,
lib/elasticsearch/api/actions/connector/update_features.rb,
lib/elasticsearch/api/actions/connector/update_pipeline.rb,
lib/elasticsearch/api/actions/connector/update_filtering.rb,
lib/elasticsearch/api/actions/connector/sync_job_check_in.rb,
lib/elasticsearch/api/actions/connector/update_api_key_id.rb,
lib/elasticsearch/api/actions/connector/update_index_name.rb,
lib/elasticsearch/api/actions/connector/update_scheduling.rb,
lib/elasticsearch/api/actions/connector/update_service_type.rb,
lib/elasticsearch/api/actions/connector/update_configuration.rb,
lib/elasticsearch/api/actions/connector/sync_job_update_stats.rb,
lib/elasticsearch/api/actions/connector/update_active_filtering.rb,
lib/elasticsearch/api/actions/connector/update_filtering_validation.rb
Instance Method Summary collapse
-
#check_in(arguments = {}) ⇒ Object
Check in a connector.
-
#delete(arguments = {}) ⇒ Object
Delete a connector.
-
#get(arguments = {}) ⇒ Object
Get a connector.
-
#list(arguments = {}) ⇒ Object
Get all connectors.
-
#post(arguments = {}) ⇒ Object
Create a connector.
-
#put(arguments = {}) ⇒ Object
Create or update a connector.
-
#sync_job_cancel(arguments = {}) ⇒ Object
Cancel a connector sync job.
-
#sync_job_check_in(arguments = {}) ⇒ Object
Check in a connector sync job.
-
#sync_job_claim(arguments = {}) ⇒ Object
Claim a connector sync job.
-
#sync_job_delete(arguments = {}) ⇒ Object
Delete a connector sync job.
-
#sync_job_error(arguments = {}) ⇒ Object
Set a connector sync job error.
-
#sync_job_get(arguments = {}) ⇒ Object
Get a connector sync job.
-
#sync_job_list(arguments = {}) ⇒ Object
Get all connector sync jobs.
-
#sync_job_post(arguments = {}) ⇒ Object
Create a connector sync job.
-
#sync_job_update_stats(arguments = {}) ⇒ Object
Set the connector sync job stats.
-
#update_active_filtering(arguments = {}) ⇒ Object
Activate the connector draft filter.
-
#update_api_key_id(arguments = {}) ⇒ Object
Update the connector API key ID.
-
#update_configuration(arguments = {}) ⇒ Object
Update the connector configuration.
-
#update_error(arguments = {}) ⇒ Object
Update the connector error field.
-
#update_features(arguments = {}) ⇒ Object
Update the connector features.
-
#update_filtering(arguments = {}) ⇒ Object
Update the connector filtering.
-
#update_filtering_validation(arguments = {}) ⇒ Object
Update the connector draft filtering validation.
-
#update_index_name(arguments = {}) ⇒ Object
Update the connector index name.
-
#update_name(arguments = {}) ⇒ Object
Update the connector name and description.
-
#update_native(arguments = {}) ⇒ Object
Update the connector is_native flag.
-
#update_pipeline(arguments = {}) ⇒ Object
Update the connector pipeline.
-
#update_scheduling(arguments = {}) ⇒ Object
Update the connector scheduling.
-
#update_service_type(arguments = {}) ⇒ Object
Update the connector service type.
-
#update_status(arguments = {}) ⇒ Object
Update the connector status.
Instance Method Details
#check_in(arguments = {}) ⇒ Object
Check in a connector. Update the last_seen
field in the connector and set it to the current timestamp. 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.
37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 |
# File 'lib/elasticsearch/api/actions/connector/check_in.rb', line 37 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 |
#delete(arguments = {}) ⇒ Object
Delete a connector. Removes a connector and associated sync jobs. This is a destructive action that is not recoverable. NOTE: This action doesn’t delete any API keys, ingest pipelines, or data indices associated with the connector. These need to be removed manually. This functionality is in Beta and is subject to change. The design and code is less mature than official GA features and is being provided as-is with no warranties. Beta features are not subject to the support SLA of official GA features.
42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 |
# File 'lib/elasticsearch/api/actions/connector/delete.rb', line 42 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 |
#get(arguments = {}) ⇒ Object
Get a connector. Get the details about a connector. This functionality is in Beta and is subject to change. The design and code is less mature than official GA features and is being provided as-is with no warranties. Beta features are not subject to the support SLA of official GA features.
38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 |
# File 'lib/elasticsearch/api/actions/connector/get.rb', line 38 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 = Utils.process_params(arguments) Elasticsearch::API::Response.new( perform_request(method, path, params, body, headers, request_opts) ) end |
#list(arguments = {}) ⇒ Object
Get all connectors. Get information about all connectors. This functionality is in Beta and is subject to change. The design and code is less mature than official GA features and is being provided as-is with no warranties. Beta features are not subject to the support SLA of official GA features.
43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 |
# File 'lib/elasticsearch/api/actions/connector/list.rb', line 43 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 |
#post(arguments = {}) ⇒ Object
Create a connector. Connectors are Elasticsearch integrations that bring content from third-party data sources, which can be deployed on Elastic Cloud or hosted on your own infrastructure. Elastic managed connectors (Native connectors) are a managed service on Elastic Cloud. Self-managed connectors (Connector clients) are self-managed on your infrastructure. This functionality is in Beta and is subject to change. The design and code is less mature than official GA features and is being provided as-is with no warranties. Beta features are not subject to the support SLA of official GA features.
39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 |
# File 'lib/elasticsearch/api/actions/connector/post.rb', line 39 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 |
#put(arguments = {}) ⇒ Object
Create or update a connector. This functionality is in Beta and is subject to change. The design and code is less mature than official GA features and is being provided as-is with no warranties. Beta features are not subject to the support SLA of official GA features.
37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 |
# 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 |
#sync_job_cancel(arguments = {}) ⇒ Object
Cancel a connector sync job. Cancel a connector sync job, which sets the status to cancelling and updates cancellation_requested_at
to the current time. The connector service is then responsible for setting the status of connector sync jobs to cancelled. This functionality is in Beta and is subject to change. The design and code is less mature than official GA features and is being provided as-is with no warranties. Beta features are not subject to the support SLA of official GA features.
38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 |
# File 'lib/elasticsearch/api/actions/connector/sync_job_cancel.rb', line 38 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 |
#sync_job_check_in(arguments = {}) ⇒ Object
Check in a connector sync job. Check in a connector sync job and set the last_seen
field to the current time before updating it in the internal index. To sync data using self-managed connectors, you need to deploy the Elastic connector service on your own infrastructure. This service runs automatically on Elastic Cloud for Elastic managed 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.
39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 |
# File 'lib/elasticsearch/api/actions/connector/sync_job_check_in.rb', line 39 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 |
#sync_job_claim(arguments = {}) ⇒ Object
Claim a connector sync job. This action updates the job status to in_progress
and sets the last_seen
and started_at
timestamps to the current time. Additionally, it can set the sync_cursor
property for the sync job. This API is not intended for direct connector management by users. It supports the implementation of services that utilize the connector protocol to communicate with Elasticsearch. To sync data using self-managed connectors, you need to deploy the Elastic connector service on your own infrastructure. This service runs automatically on Elastic Cloud for Elastic managed 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.
43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 |
# File 'lib/elasticsearch/api/actions/connector/sync_job_claim.rb', line 43 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 |
#sync_job_delete(arguments = {}) ⇒ Object
Delete a connector sync job. Remove a connector sync job and its associated data. This is a destructive action that is not recoverable. This functionality is in Beta and is subject to change. The design and code is less mature than official GA features and is being provided as-is with no warranties. Beta features are not subject to the support SLA of official GA features.
38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 |
# File 'lib/elasticsearch/api/actions/connector/sync_job_delete.rb', line 38 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 |
#sync_job_error(arguments = {}) ⇒ Object
Set a connector sync job error. Set the error
field for a connector sync job and set its status
to error
. To sync data using self-managed connectors, you need to deploy the Elastic connector service on your own infrastructure. This service runs automatically on Elastic Cloud for Elastic managed 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.
40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 |
# File 'lib/elasticsearch/api/actions/connector/sync_job_error.rb', line 40 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 |
#sync_job_get(arguments = {}) ⇒ Object
Get a connector sync job. This functionality is in Beta and is subject to change. The design and code is less mature than official GA features and is being provided as-is with no warranties. Beta features are not subject to the support SLA of official GA features.
36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 |
# 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 |
#sync_job_list(arguments = {}) ⇒ Object
Get all connector sync jobs. Get information about all stored connector sync jobs listed by their creation date in ascending order. This functionality is in Beta and is subject to change. The design and code is less mature than official GA features and is being provided as-is with no warranties. Beta features are not subject to the support SLA of official GA features.
41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 |
# File 'lib/elasticsearch/api/actions/connector/sync_job_list.rb', line 41 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 |
#sync_job_post(arguments = {}) ⇒ Object
Create a connector sync job. Create a connector sync job document in the internal index and initialize its counters and timestamps with default values. This functionality is in Beta and is subject to change. The design and code is less mature than official GA features and is being provided as-is with no warranties. Beta features are not subject to the support SLA of official GA features.
37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 |
# File 'lib/elasticsearch/api/actions/connector/sync_job_post.rb', line 37 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 |
#sync_job_update_stats(arguments = {}) ⇒ Object
Set the connector sync job stats. Stats include: deleted_document_count
, indexed_document_count
, indexed_document_volume
, and total_document_count
. You can also update last_seen
. This API is mainly used by the connector service for updating sync job information. To sync data using self-managed connectors, you need to deploy the Elastic connector service on your own infrastructure. This service runs automatically on Elastic Cloud for Elastic managed 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.
42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 |
# File 'lib/elasticsearch/api/actions/connector/sync_job_update_stats.rb', line 42 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 |
#update_active_filtering(arguments = {}) ⇒ Object
Activate the connector draft filter. Activates the valid draft filtering 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.
37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 |
# File 'lib/elasticsearch/api/actions/connector/update_active_filtering.rb', line 37 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 |
#update_api_key_id(arguments = {}) ⇒ Object
Update the connector API key ID. Update the api_key_id
and api_key_secret_id
fields of a connector. You can specify the ID of the API key used for authorization and the ID of the connector secret where the API key is stored. The connector secret ID is required only for Elastic managed (native) connectors. Self-managed connectors (connector clients) do not use this field. This functionality is in Beta and is subject to change. The design and code is less mature than official GA features and is being provided as-is with no warranties. Beta features are not subject to the support SLA of official GA features.
41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 |
# File 'lib/elasticsearch/api/actions/connector/update_api_key_id.rb', line 41 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 |
#update_configuration(arguments = {}) ⇒ Object
Update the connector configuration. Update the configuration field in the connector document. This functionality is in Beta and is subject to change. The design and code is less mature than official GA features and is being provided as-is with no warranties. Beta features are not subject to the support SLA of official GA features.
38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 |
# File 'lib/elasticsearch/api/actions/connector/update_configuration.rb', line 38 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 |
#update_error(arguments = {}) ⇒ Object
Update the connector error field. Set the error field for the connector. If the error provided in the request body is non-null, the connector’s status is updated to error. Otherwise, if the error is reset to null, the connector status is updated to connected. 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.
40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 |
# File 'lib/elasticsearch/api/actions/connector/update_error.rb', line 40 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 |
#update_features(arguments = {}) ⇒ Object
Update the connector features. Update the connector features in the connector document. This API can be used to control the following aspects of a connector:
-
document-level security
-
incremental syncs
-
advanced sync rules
-
basic sync rules
Normally, the running connector service automatically manages these features. However, you can use this API to override the default behavior. To sync data using self-managed connectors, you need to deploy the Elastic connector service on your own infrastructure. This service runs automatically on Elastic Cloud for Elastic managed 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.
47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 |
# File 'lib/elasticsearch/api/actions/connector/update_features.rb', line 47 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 |
#update_filtering(arguments = {}) ⇒ Object
Update the connector filtering. Update the draft filtering configuration of a connector and marks the draft validation state as edited. The filtering draft is activated once validated by the running Elastic connector service. The filtering property is used to configure sync rules (both basic and advanced) for a connector. This functionality is in Beta and is subject to change. The design and code is less mature than official GA features and is being provided as-is with no warranties. Beta features are not subject to the support SLA of official GA features.
40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 |
# File 'lib/elasticsearch/api/actions/connector/update_filtering.rb', line 40 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 |
#update_filtering_validation(arguments = {}) ⇒ Object
Update the connector draft filtering validation. Update the draft filtering validation info 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.
38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 |
# File 'lib/elasticsearch/api/actions/connector/update_filtering_validation.rb', line 38 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 |
#update_index_name(arguments = {}) ⇒ Object
Update the connector index name. Update the index_name
field of a connector, specifying the index where the data ingested by the connector is stored. This functionality is in Beta and is subject to change. The design and code is less mature than official GA features and is being provided as-is with no warranties. Beta features are not subject to the support SLA of official GA features.
38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 |
# File 'lib/elasticsearch/api/actions/connector/update_index_name.rb', line 38 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 |
#update_name(arguments = {}) ⇒ Object
Update the connector name and description. This functionality is in Beta and is subject to change. The design and code is less mature than official GA features and is being provided as-is with no warranties. Beta features are not subject to the support SLA of official GA features.
37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 |
# 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 |
#update_native(arguments = {}) ⇒ Object
Update the connector is_native flag. This functionality is in Beta and is subject to change. The design and code is less mature than official GA features and is being provided as-is with no warranties. Beta features are not subject to the support SLA of official GA features.
37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 |
# 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 |
#update_pipeline(arguments = {}) ⇒ Object
Update the connector pipeline. When you create a new connector, the configuration of an ingest pipeline is populated with default settings. This functionality is in Beta and is subject to change. The design and code is less mature than official GA features and is being provided as-is with no warranties. Beta features are not subject to the support SLA of official GA features.
38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 |
# File 'lib/elasticsearch/api/actions/connector/update_pipeline.rb', line 38 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 |
#update_scheduling(arguments = {}) ⇒ Object
Update the connector scheduling. This functionality is in Beta and is subject to change. The design and code is less mature than official GA features and is being provided as-is with no warranties. Beta features are not subject to the support SLA of official GA features.
37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 |
# 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 |
#update_service_type(arguments = {}) ⇒ Object
Update the connector service type. This functionality is in Beta and is subject to change. The design and code is less mature than official GA features and is being provided as-is with no warranties. Beta features are not subject to the support SLA of official GA features.
37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 |
# 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 |
#update_status(arguments = {}) ⇒ Object
Update the connector status. 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.
37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 |
# 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 |