org.apache.plc4x.java.scraper.ScrapeJob Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of plc4j-scraper Show documentation

Utility to efficiently collect a large number of items on multiple devices by different triggers.

There is a newer version: 0.12.0

/*
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF 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.
 */

package org.apache.plc4x.java.scraper;

import java.util.Map;

/**
 * POJO Object to transport all Job informtation.
 * Is generated from {@link org.apache.plc4x.java.scraper.config.ScraperConfiguration} by
 * merging the sources and the {@link org.apache.plc4x.java.scraper.config.JobConfiguration}.
 */
public class ScrapeJob {

    private final String name;
    private final long scrapeRate;
    private final Map connections;
    private final Map fields;

    public ScrapeJob(String name, long scrapeRate, Map connections, Map fields) {
        this.name = name;
        this.scrapeRate = scrapeRate;
        this.connections = connections;
        this.fields = fields;
    }

    public String getName() {
        return name;
    }

    public long getScrapeRate() {
        return scrapeRate;
    }

    /**
     * alias -> connection-string
     */
    public Map getConnections() {
        return connections;
    }

    /**
     * alias -> field-query
     */
    public Map getFields() {
        return fields;
    }
}