Module: ElasticsearchServerless::API::Connector::Actions

Defined in:
lib/elasticsearch-serverless/api/connector/get.rb,
lib/elasticsearch-serverless/api/connector/put.rb,
lib/elasticsearch-serverless/api/connector/list.rb,
lib/elasticsearch-serverless/api/connector/post.rb,
lib/elasticsearch-serverless/api/connector/delete.rb,
lib/elasticsearch-serverless/api/connector/check_in.rb,
lib/elasticsearch-serverless/api/connector/last_sync.rb,
lib/elasticsearch-serverless/api/connector/update_name.rb,
lib/elasticsearch-serverless/api/connector/sync_job_get.rb,
lib/elasticsearch-serverless/api/connector/update_error.rb,
lib/elasticsearch-serverless/api/connector/sync_job_list.rb,
lib/elasticsearch-serverless/api/connector/sync_job_post.rb,
lib/elasticsearch-serverless/api/connector/update_native.rb,
lib/elasticsearch-serverless/api/connector/update_status.rb,
lib/elasticsearch-serverless/api/connector/sync_job_cancel.rb,
lib/elasticsearch-serverless/api/connector/sync_job_delete.rb,
lib/elasticsearch-serverless/api/connector/update_pipeline.rb,
lib/elasticsearch-serverless/api/connector/update_filtering.rb,
lib/elasticsearch-serverless/api/connector/update_api_key_id.rb,
lib/elasticsearch-serverless/api/connector/update_index_name.rb,
lib/elasticsearch-serverless/api/connector/update_scheduling.rb,
lib/elasticsearch-serverless/api/connector/update_service_type.rb,
lib/elasticsearch-serverless/api/connector/update_configuration.rb,
lib/elasticsearch-serverless/api/connector/update_active_filtering.rb,
lib/elasticsearch-serverless/api/connector/update_filtering_validation.rb

Instance Method Summary collapse

Instance Method Details

#check_in(arguments = {}) ⇒ Object

Updates the last_seen field in the connector, and sets it to 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.

Options Hash (arguments):

  • :connector_id (String) —

    The unique identifier of the connector to be checked in (Required)

  • :headers (Hash) —

    Custom HTTP headers

Raises:

  • (ArgumentError)

See Also:



36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
 
# File 'lib/elasticsearch-serverless/api/connector/check_in.rb', line 36

def check_in(arguments = {})
  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 = ElasticsearchServerless::API::HTTP_PUT
  path   = "_connector/#{Utils.listify(_connector_id)}/_check_in"
  params = {}

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

#delete(arguments = {}) ⇒ Object

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.

Options Hash (arguments):

  • :connector_id (String) —

    The unique identifier of the connector to be deleted (Required)

  • :delete_sync_jobs (Boolean) —

    Determines whether associated sync jobs are also deleted. (Required)

  • :headers (Hash) —

    Custom HTTP headers

Raises:

  • (ArgumentError)

See Also:



37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
 
# File 'lib/elasticsearch-serverless/api/connector/delete.rb', line 37

def delete(arguments = {})
  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 = ElasticsearchServerless::API::HTTP_DELETE
  path   = "_connector/#{Utils.listify(_connector_id)}"
  params = Utils.process_params(arguments)

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

#get(arguments = {}) ⇒ Object

Retrieves 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.

Options Hash (arguments):

  • :connector_id (String) —

    The unique identifier of the connector (Required)

  • :headers (Hash) —

    Custom HTTP headers

Raises:

  • (ArgumentError)

See Also:



36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
 
# File 'lib/elasticsearch-serverless/api/connector/get.rb', line 36

def get(arguments = {})
  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 = ElasticsearchServerless::API::HTTP_GET
  path   = "_connector/#{Utils.listify(_connector_id)}"
  params = {}

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

#last_sync(arguments = {}) ⇒ Object

Updates last sync stats 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.

Options Hash (arguments):

  • :connector_id (String) —

    The unique identifier of the connector to be updated (Required)

  • :headers (Hash) —

    Custom HTTP headers

  • :body (Hash) —

    request body

Raises:

  • (ArgumentError)

See Also:



37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
 
# File 'lib/elasticsearch-serverless/api/connector/last_sync.rb', line 37

def last_sync(arguments = {})
  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 = ElasticsearchServerless::API::HTTP_PUT
  path   = "_connector/#{Utils.listify(_connector_id)}/_last_sync"
  params = {}

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

#list(arguments = {}) ⇒ Object

Returns existing 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.

Options Hash (arguments):

  • :from (Integer) —

    Starting offset (default: 0)

  • :size (Integer) —

    Specifies a max number of results to get

  • :index_name (String, Array) —

    A comma-separated list of connector index names to fetch connector documents for

  • :connector_name (String, Array<String>) —

    A comma-separated list of connector names to fetch connector documents for

  • :service_type (String, Array<String>) —

    A comma-separated list of connector service types to fetch connector documents for

  • :query (String) —

    A wildcard query string that filters connectors with matching name, description or index name

  • :headers (Hash) —

    Custom HTTP headers

See Also:



41
42
43
44
45
46
47
48
49
50
51
52
53
54
 
# File 'lib/elasticsearch-serverless/api/connector/list.rb', line 41

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

  body = nil

  method = ElasticsearchServerless::API::HTTP_GET
  path   = "_connector"
  params = Utils.process_params(arguments)

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

#post(arguments = {}) ⇒ Object

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.

Options Hash (arguments):

  • :headers (Hash) —

    Custom HTTP headers

  • :body (Hash) —

    request body

See Also:



36
37
38
39
40
41
42
43
44
45
46
47
48
49
 
# File 'lib/elasticsearch-serverless/api/connector/post.rb', line 36

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

  body = arguments.delete(:body)

  method = ElasticsearchServerless::API::HTTP_POST
  path   = "_connector"
  params = {}

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

#put(arguments = {}) ⇒ Object

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.

Options Hash (arguments):

  • :connector_id (String) —

    The unique identifier of the connector to be created or updated (Required)

  • :headers (Hash) —

    Custom HTTP headers

  • :body (Hash) —

    request body

See Also:



37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
 
# File 'lib/elasticsearch-serverless/api/connector/put.rb', line 37

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

  body = arguments.delete(:body)

  _connector_id = arguments.delete(:connector_id)

  method = ElasticsearchServerless::API::HTTP_PUT
  path   = if _connector_id
             "_connector/#{Utils.listify(_connector_id)}"
           else
             "_connector"
           end
  params = {}

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

#sync_job_cancel(arguments = {}) ⇒ Object

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.

Options Hash (arguments):

  • :connector_sync_job_id (String) —

    The unique identifier of the connector sync job (Required)

  • :headers (Hash) —

    Custom HTTP headers

Raises:

  • (ArgumentError)

See Also:



36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
 
# File 'lib/elasticsearch-serverless/api/connector/sync_job_cancel.rb', line 36

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

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

  body = nil

  _connector_sync_job_id = arguments.delete(:connector_sync_job_id)

  method = ElasticsearchServerless::API::HTTP_PUT
  path   = "_connector/_sync_job/#{Utils.listify(_connector_sync_job_id)}/_cancel"
  params = {}

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

#sync_job_delete(arguments = {}) ⇒ Object

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.

Options Hash (arguments):

  • :connector_sync_job_id (String) —

    The unique identifier of the connector sync job to be deleted (Required)

  • :headers (Hash) —

    Custom HTTP headers

Raises:

  • (ArgumentError)

See Also:



36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
 
# File 'lib/elasticsearch-serverless/api/connector/sync_job_delete.rb', line 36

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

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

  body = nil

  _connector_sync_job_id = arguments.delete(:connector_sync_job_id)

  method = ElasticsearchServerless::API::HTTP_DELETE
  path   = "_connector/_sync_job/#{Utils.listify(_connector_sync_job_id)}"
  params = {}

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

#sync_job_get(arguments = {}) ⇒ Object

Retrieves 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.

Options Hash (arguments):

  • :connector_sync_job_id (String) —

    The unique identifier of the connector sync job (Required)

  • :headers (Hash) —

    Custom HTTP headers

Raises:

  • (ArgumentError)

See Also:



36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
 
# File 'lib/elasticsearch-serverless/api/connector/sync_job_get.rb', line 36

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

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

  body = nil

  _connector_sync_job_id = arguments.delete(:connector_sync_job_id)

  method = ElasticsearchServerless::API::HTTP_GET
  path   = "_connector/_sync_job/#{Utils.listify(_connector_sync_job_id)}"
  params = {}

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

#sync_job_list(arguments = {}) ⇒ Object

Lists 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.

Options Hash (arguments):

  • :from (Integer) —

    Starting offset (default: 0)

  • :size (Integer) —

    Specifies a max number of results to get

  • :status (String) —

    A sync job status to fetch connector sync jobs for

  • :connector_id (String) —

    A connector id to fetch connector sync jobs for

  • :job_type (Array<String>) —

    A comma-separated list of job types to fetch the sync jobs for

  • :headers (Hash) —

    Custom HTTP headers

See Also:



40
41
42
43
44
45
46
47
48
49
50
51
52
53
 
# File 'lib/elasticsearch-serverless/api/connector/sync_job_list.rb', line 40

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

  body = nil

  method = ElasticsearchServerless::API::HTTP_GET
  path   = "_connector/_sync_job"
  params = Utils.process_params(arguments)

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

#sync_job_post(arguments = {}) ⇒ Object

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.

Options Hash (arguments):

  • :headers (Hash) —

    Custom HTTP headers

  • :body (Hash) —

    request body

Raises:

  • (ArgumentError)

See Also:



36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
 
# File 'lib/elasticsearch-serverless/api/connector/sync_job_post.rb', line 36

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

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

  body = arguments.delete(:body)

  method = ElasticsearchServerless::API::HTTP_POST
  path   = "_connector/_sync_job"
  params = {}

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

#update_active_filtering(arguments = {}) ⇒ Object

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.

Options Hash (arguments):

  • :connector_id (String) —

    The unique identifier of the connector to be updated (Required)

  • :headers (Hash) —

    Custom HTTP headers

Raises:

  • (ArgumentError)

See Also:



36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
 
# File 'lib/elasticsearch-serverless/api/connector/update_active_filtering.rb', line 36

def update_active_filtering(arguments = {})
  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 = ElasticsearchServerless::API::HTTP_PUT
  path   = "_connector/#{Utils.listify(_connector_id)}/_filtering/_activate"
  params = {}

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

#update_api_key_id(arguments = {}) ⇒ Object

Updates the API key id 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.

Options Hash (arguments):

  • :connector_id (String) —

    The unique identifier of the connector to be updated (Required)

  • :headers (Hash) —

    Custom HTTP headers

  • :body (Hash) —

    request body

Raises:

  • (ArgumentError)

See Also:



37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
 
# File 'lib/elasticsearch-serverless/api/connector/update_api_key_id.rb', line 37

def update_api_key_id(arguments = {})
  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 = ElasticsearchServerless::API::HTTP_PUT
  path   = "_connector/#{Utils.listify(_connector_id)}/_api_key_id"
  params = {}

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

#update_configuration(arguments = {}) ⇒ Object

Updates the configuration 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.

Options Hash (arguments):

  • :connector_id (String) —

    The unique identifier of the connector to be updated (Required)

  • :headers (Hash) —

    Custom HTTP headers

  • :body (Hash) —

    request body

Raises:

  • (ArgumentError)

See Also:



37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
 
# File 'lib/elasticsearch-serverless/api/connector/update_configuration.rb', line 37

def update_configuration(arguments = {})
  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 = ElasticsearchServerless::API::HTTP_PUT
  path   = "_connector/#{Utils.listify(_connector_id)}/_configuration"
  params = {}

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

#update_error(arguments = {}) ⇒ Object

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.

Options Hash (arguments):

  • :connector_id (String) —

    The unique identifier of the connector to be updated (Required)

  • :headers (Hash) —

    Custom HTTP headers

  • :body (Hash) —

    request body

Raises:

  • (ArgumentError)

See Also:



37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
 
# File 'lib/elasticsearch-serverless/api/connector/update_error.rb', line 37

def update_error(arguments = {})
  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 = ElasticsearchServerless::API::HTTP_PUT
  path   = "_connector/#{Utils.listify(_connector_id)}/_error"
  params = {}

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

#update_filtering(arguments = {}) ⇒ Object

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.

Options Hash (arguments):

  • :connector_id (String) —

    The unique identifier of the connector to be updated (Required)

  • :headers (Hash) —

    Custom HTTP headers

  • :body (Hash) —

    request body

Raises:

  • (ArgumentError)

See Also:



37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
 
# File 'lib/elasticsearch-serverless/api/connector/update_filtering.rb', line 37

def update_filtering(arguments = {})
  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 = ElasticsearchServerless::API::HTTP_PUT
  path   = "_connector/#{Utils.listify(_connector_id)}/_filtering"
  params = {}

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

#update_filtering_validation(arguments = {}) ⇒ Object

Updates 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.

Options Hash (arguments):

  • :connector_id (String) —

    The unique identifier of the connector to be updated (Required)

  • :headers (Hash) —

    Custom HTTP headers

  • :body (Hash) —

    request body

Raises:

  • (ArgumentError)

See Also:



37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
 
# File 'lib/elasticsearch-serverless/api/connector/update_filtering_validation.rb', line 37

def update_filtering_validation(arguments = {})
  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 = ElasticsearchServerless::API::HTTP_PUT
  path   = "_connector/#{Utils.listify(_connector_id)}/_filtering/_validation"
  params = {}

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

#update_index_name(arguments = {}) ⇒ Object

Updates the index_name 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.

Options Hash (arguments):

  • :connector_id (String) —

    The unique identifier of the connector to be updated (Required)

  • :headers (Hash) —

    Custom HTTP headers

  • :body (Hash) —

    request body

Raises:

  • (ArgumentError)

See Also:



37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
 
# File 'lib/elasticsearch-serverless/api/connector/update_index_name.rb', line 37

def update_index_name(arguments = {})
  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 = ElasticsearchServerless::API::HTTP_PUT
  path   = "_connector/#{Utils.listify(_connector_id)}/_index_name"
  params = {}

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

#update_name(arguments = {}) ⇒ Object

Updates the name and 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.

Options Hash (arguments):

  • :connector_id (String) —

    The unique identifier of the connector to be updated (Required)

  • :headers (Hash) —

    Custom HTTP headers

  • :body (Hash) —

    request body

Raises:

  • (ArgumentError)

See Also:



37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
 
# File 'lib/elasticsearch-serverless/api/connector/update_name.rb', line 37

def update_name(arguments = {})
  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 = ElasticsearchServerless::API::HTTP_PUT
  path   = "_connector/#{Utils.listify(_connector_id)}/_name"
  params = {}

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

#update_native(arguments = {}) ⇒ Object

Updates the is_native flag 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.

Options Hash (arguments):

  • :connector_id (String) —

    The unique identifier of the connector to be updated (Required)

  • :headers (Hash) —

    Custom HTTP headers

  • :body (Hash) —

    request body

Raises:

  • (ArgumentError)

See Also:



37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
 
# File 'lib/elasticsearch-serverless/api/connector/update_native.rb', line 37

def update_native(arguments = {})
  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 = ElasticsearchServerless::API::HTTP_PUT
  path   = "_connector/#{Utils.listify(_connector_id)}/_native"
  params = {}

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

#update_pipeline(arguments = {}) ⇒ Object

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.

Options Hash (arguments):

  • :connector_id (String) —

    The unique identifier of the connector to be updated (Required)

  • :headers (Hash) —

    Custom HTTP headers

  • :body (Hash) —

    request body

Raises:

  • (ArgumentError)

See Also:



37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
 
# File 'lib/elasticsearch-serverless/api/connector/update_pipeline.rb', line 37

def update_pipeline(arguments = {})
  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 = ElasticsearchServerless::API::HTTP_PUT
  path   = "_connector/#{Utils.listify(_connector_id)}/_pipeline"
  params = {}

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

#update_scheduling(arguments = {}) ⇒ Object

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.

Options Hash (arguments):

  • :connector_id (String) —

    The unique identifier of the connector to be updated (Required)

  • :headers (Hash) —

    Custom HTTP headers

  • :body (Hash) —

    request body

Raises:

  • (ArgumentError)

See Also:



37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
 
# File 'lib/elasticsearch-serverless/api/connector/update_scheduling.rb', line 37

def update_scheduling(arguments = {})
  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 = ElasticsearchServerless::API::HTTP_PUT
  path   = "_connector/#{Utils.listify(_connector_id)}/_scheduling"
  params = {}

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

#update_service_type(arguments = {}) ⇒ Object

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.

Options Hash (arguments):

  • :connector_id (String) —

    The unique identifier of the connector to be updated (Required)

  • :headers (Hash) —

    Custom HTTP headers

  • :body (Hash) —

    request body

Raises:

  • (ArgumentError)

See Also:



37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
 
# File 'lib/elasticsearch-serverless/api/connector/update_service_type.rb', line 37

def update_service_type(arguments = {})
  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 = ElasticsearchServerless::API::HTTP_PUT
  path   = "_connector/#{Utils.listify(_connector_id)}/_service_type"
  params = {}

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

#update_status(arguments = {}) ⇒ Object

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.

Options Hash (arguments):

  • :connector_id (String) —

    The unique identifier of the connector to be updated (Required)

  • :headers (Hash) —

    Custom HTTP headers

  • :body (Hash) —

    request body

Raises:

  • (ArgumentError)

See Also:



37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
 
# File 'lib/elasticsearch-serverless/api/connector/update_status.rb', line 37

def update_status(arguments = {})
  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 = ElasticsearchServerless::API::HTTP_PUT
  path   = "_connector/#{Utils.listify(_connector_id)}/_status"
  params = {}

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