Contents

# Licensed to Elasticsearch B.V. under one or more contributor
# license agreements. See the NOTICE file distributed with
# this work for additional information regarding copyright
# ownership. Elasticsearch B.V. licenses this file to you under
# the Apache License, Version 2.0 (the "License"); you may
# not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
#	http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing,
# software distributed under the License is distributed on an
# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
# KIND, either express or implied.  See the License for the
# specific language governing permissions and limitations
# under the License.

module Elasticsearch
  module XPack
    module API
      module DataFrame
        module Actions

          # Start a data frame analytics job.
          #
          # @option arguments [String] :transform_id The id of the transform to start. *Required*
          # @option arguments [String] :timeout Controls the time to wait for the transform to start.
          #
          # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/start-data-frame-transform.html
          #
          # @since 7.2.0
          def start_data_frame_transform(arguments={})
            raise ArgumentError, "Required argument 'transform_id' missing" unless arguments[:transform_id]
            arguments = arguments.clone
            transform_id = URI.escape(arguments.delete(:transform_id))

            valid_params = [
                :timeout]

            method = Elasticsearch::API::HTTP_POST
            path   = "_data_frame/transforms/#{transform_id}/_start"
            params = Elasticsearch::API::Utils.__validate_and_extract_params arguments, valid_params
            body   = nil

            perform_request(method, path, params, body).body
          end
        end
      end
    end
  end
end

Version data entries

2 entries across 2 versions & 1 rubygems

Version	Path
elasticsearch-xpack-7.2.1	lib/elasticsearch/xpack/api/actions/data_frame/start_data_frame_transform.rb
elasticsearch-xpack-7.2.0	lib/elasticsearch/xpack/api/actions/data_frame/start_data_frame_transform.rb