Module: Elasticsearch::API::Connector::Actions

Included in:
ConnectorClient
Defined in:
lib/elasticsearch/api/namespace/connector.rb,
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/last_sync.rb,
lib/elasticsearch/api/actions/connector/update_name.rb,
lib/elasticsearch/api/actions/connector/update_error.rb,
lib/elasticsearch/api/actions/connector/update_pipeline.rb,
lib/elasticsearch/api/actions/connector/update_filtering.rb,
lib/elasticsearch/api/actions/connector/update_scheduling.rb,
lib/elasticsearch/api/actions/connector/update_configuration.rb more...

Instance Method Summary collapse

Instance Method Details

#check_in(arguments = {}) ⇒ Object

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.

Parameters:

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

    a customizable set of options

Options Hash (arguments):

  • :connector_id (String) —

    The unique identifier of the connector to be updated.

  • :headers (Hash) —

    Custom HTTP headers

Raises:

  • (ArgumentError)

See Also:

[View source]

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
 
# 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].inject({}) do |set_variables, variable|
    set_variables[variable] = arguments[variable] if arguments.key?(variable)
    set_variables
  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

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.

Parameters:

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

    a customizable set of options

Options Hash (arguments):

  • :connector_id (String) —

    The unique identifier of the connector to be deleted.

  • :headers (Hash) —

    Custom HTTP headers

Raises:

  • (ArgumentError)

See Also:

[View source]

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
 
# File 'lib/elasticsearch/api/actions/connector/delete.rb', line 36

def delete(arguments = {})
  request_opts = { endpoint: arguments[:endpoint] || "connector.delete" }

  defined_params = [:connector_id].inject({}) do |set_variables, variable|
    set_variables[variable] = arguments[variable] if arguments.key?(variable)
    set_variables
  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 = {}

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

#get(arguments = {}) ⇒ Object

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.

Parameters:

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

    a customizable set of options

Options Hash (arguments):

  • :connector_id (String) —

    The unique identifier of the connector to be returned.

  • :headers (Hash) —

    Custom HTTP headers

Raises:

  • (ArgumentError)

See Also:

[View source]

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
 
# File 'lib/elasticsearch/api/actions/connector/get.rb', line 36

def get(arguments = {})
  request_opts = { endpoint: arguments[:endpoint] || "connector.get" }

  defined_params = [:connector_id].inject({}) do |set_variables, variable|
    set_variables[variable] = arguments[variable] if arguments.key?(variable)
    set_variables
  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

#last_sync(arguments = {}) ⇒ Object

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.

Parameters:

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

    a customizable set of options

Options Hash (arguments):

  • :connector_id (String) —

    The unique identifier of the connector to be updated.

  • :headers (Hash) —

    Custom HTTP headers

  • :body (Hash) —

    Object with stats related to the last connector sync run. (Required)

Raises:

  • (ArgumentError)

See Also:

[View source]

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/last_sync.rb', line 37

def last_sync(arguments = {})
  request_opts = { endpoint: arguments[:endpoint] || "connector.last_sync" }

  defined_params = [:connector_id].inject({}) do |set_variables, variable|
    set_variables[variable] = arguments[variable] if arguments.key?(variable)
    set_variables
  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

#list(arguments = {}) ⇒ Object

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.

Parameters:

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

    a customizable set of options

Options Hash (arguments):

  • :from (Integer) —

    Starting offset (default: 0)

  • :size (Integer) —

    specifies a max number of results to get (default: 100)

  • :headers (Hash) —

    Custom HTTP headers

See Also:

[View source]

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

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

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.

Parameters:

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

    a customizable set of options

Options Hash (arguments):

  • :headers (Hash) —

    Custom HTTP headers

  • :body (Hash) —

    The connector configuration. (Required)

Raises:

  • (ArgumentError)

See Also:

[View source]

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

def post(arguments = {})
  request_opts = { endpoint: arguments[:endpoint] || "connector.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"
  params = {}

  Elasticsearch::API::Response.new(
    perform_request(method, path, params, body, headers, request_opts)
  )
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.

Parameters:

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

    a customizable set of options

Options Hash (arguments):

  • :connector_id (String) —

    The unique identifier of the connector to be created or updated.

  • :headers (Hash) —

    Custom HTTP headers

  • :body (Hash) —

    The connector configuration. (Required)

Raises:

  • (ArgumentError)

See Also:

[View source]

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].inject({}) do |set_variables, variable|
    set_variables[variable] = arguments[variable] if arguments.key?(variable)
    set_variables
  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)}"
  params = {}

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

#update_configuration(arguments = {}) ⇒ Object

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.

Parameters:

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

    a customizable set of options

Options Hash (arguments):

  • :connector_id (String) —

    The unique identifier of the connector to be updated.

  • :headers (Hash) —

    Custom HTTP headers

  • :body (Hash) —

    Mapping between field names to configuration. (Required)

Raises:

  • (ArgumentError)

See Also:

[View source]

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/update_configuration.rb', line 37

def update_configuration(arguments = {})
  request_opts = { endpoint: arguments[:endpoint] || "connector.update_configuration" }

  defined_params = [:connector_id].inject({}) do |set_variables, variable|
    set_variables[variable] = arguments[variable] if arguments.key?(variable)
    set_variables
  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

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.

Parameters:

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

    a customizable set of options

Options Hash (arguments):

  • :connector_id (String) —

    The unique identifier of the connector to be updated.

  • :headers (Hash) —

    Custom HTTP headers

  • :body (Hash) —

    An object containing the connector’s error. (Required)

Raises:

  • (ArgumentError)

See Also:

[View source]

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/update_error.rb', line 37

def update_error(arguments = {})
  request_opts = { endpoint: arguments[:endpoint] || "connector.update_error" }

  defined_params = [:connector_id].inject({}) do |set_variables, variable|
    set_variables[variable] = arguments[variable] if arguments.key?(variable)
    set_variables
  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_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.

Parameters:

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

    a customizable set of options

Options Hash (arguments):

  • :connector_id (String) —

    The unique identifier of the connector to be updated.

  • :headers (Hash) —

    Custom HTTP headers

  • :body (Hash) —

    A list of connector filtering configurations. (Required)

Raises:

  • (ArgumentError)

See Also:

[View source]

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/update_filtering.rb', line 37

def update_filtering(arguments = {})
  request_opts = { endpoint: arguments[:endpoint] || "connector.update_filtering" }

  defined_params = [:connector_id].inject({}) do |set_variables, variable|
    set_variables[variable] = arguments[variable] if arguments.key?(variable)
    set_variables
  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_name(arguments = {}) ⇒ Object

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.

Parameters:

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

    a customizable set of options

Options Hash (arguments):

  • :connector_id (String) —

    The unique identifier of the connector to be updated.

  • :headers (Hash) —

    Custom HTTP headers

  • :body (Hash) —

    An object containing the connector’s name and/or description. (Required)

Raises:

  • (ArgumentError)

See Also:

[View source]

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/update_name.rb', line 37

def update_name(arguments = {})
  request_opts = { endpoint: arguments[:endpoint] || "connector.update_name" }

  defined_params = [:connector_id].inject({}) do |set_variables, variable|
    set_variables[variable] = arguments[variable] if arguments.key?(variable)
    set_variables
  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_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.

Parameters:

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

    a customizable set of options

Options Hash (arguments):

  • :connector_id (String) —

    The unique identifier of the connector to be updated.

  • :headers (Hash) —

    Custom HTTP headers

  • :body (Hash) —

    An object with connector ingest pipeline configuration. (Required)

Raises:

  • (ArgumentError)

See Also:

[View source]

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/update_pipeline.rb', line 37

def update_pipeline(arguments = {})
  request_opts = { endpoint: arguments[:endpoint] || "connector.update_pipeline" }

  defined_params = [:connector_id].inject({}) do |set_variables, variable|
    set_variables[variable] = arguments[variable] if arguments.key?(variable)
    set_variables
  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

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.

Parameters:

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

    a customizable set of options

Options Hash (arguments):

  • :connector_id (String) —

    The unique identifier of the connector to be updated.

  • :headers (Hash) —

    Custom HTTP headers

  • :body (Hash) —

    An object containing the connector’s scheduling configuration. (Required)

Raises:

  • (ArgumentError)

See Also:

[View source]

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/update_scheduling.rb', line 37

def update_scheduling(arguments = {})
  request_opts = { endpoint: arguments[:endpoint] || "connector.update_scheduling" }

  defined_params = [:connector_id].inject({}) do |set_variables, variable|
    set_variables[variable] = arguments[variable] if arguments.key?(variable)
    set_variables
  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