/**
 * (C) Copyright IBM Corp. 2018.
 *
 * Licensed 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.
 **/

import Foundation

/**
 Object that defines a Salesforce document object type crawl with this configuration.
 */
public struct SourceOptionsObject: Codable, Equatable {

    /**
     The name of the Salesforce document object to crawl. For example, `case`.
     */
    public var name: String

    /**
     The maximum number of documents to crawl for this document object. By default, all documents in the document object
     are crawled.
     */
    public var limit: Int?

    // Map each property name to the key that shall be used for encoding/decoding.
    private enum CodingKeys: String, CodingKey {
        case name = "name"
        case limit = "limit"
    }

    /**
     Initialize a `SourceOptionsObject` with member variables.

     - parameter name: The name of the Salesforce document object to crawl. For example, `case`.
     - parameter limit: The maximum number of documents to crawl for this document object. By default, all documents
       in the document object are crawled.

     - returns: An initialized `SourceOptionsObject`.
    */
    public init(
        name: String,
        limit: Int? = nil
    )
    {
        self.name = name
        self.limit = limit
    }

}
