com.netflix.genie.web.services.JobResolverService Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of genie-web Show documentation
genie-web
There is a newer version: 4.3.20
/*
 *
 *  Copyright 2018 Netflix, Inc.
 *
 *     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.
 *
 */
package com.netflix.genie.web.services;

import com.netflix.genie.common.internal.dtos.JobRequest;
import com.netflix.genie.common.internal.dtos.JobStatus;
import com.netflix.genie.common.internal.exceptions.checked.GenieJobResolutionException;
import com.netflix.genie.common.internal.exceptions.unchecked.GenieJobResolutionRuntimeException;
import com.netflix.genie.web.dtos.ResolvedJob;
import org.springframework.validation.annotation.Validated;

import javax.annotation.Nonnull;
import javax.validation.Valid;

/**
 * Service API for taking inputs from a user and resolving them to concrete information that the Genie system will use
 * to execute the users job.
 *
 * @author tgianos
 * @since 4.0.0
 */
@Validated
public interface JobResolverService {

    /**
     * Given the id of a job that was successfully submitted to the system this API will attempt to resolve all the
     * concrete details (cluster, command, resources, etc) needed for the system to actually launch the job. Once these
     * details are determined they are persisted and the job is marked as {@link JobStatus#RESOLVED}.
     *
     * @param id The id of the job to resolve. The job must exist and its status must return {@literal true} from
     *           {@link JobStatus}{@literal #isResolvable()}
     * @return A {@link ResolvedJob} instance containing all the concrete information needed to execute the job
     * @throws GenieJobResolutionException        When the job cannot resolved due to unsatisfiable constraints
     * @throws GenieJobResolutionRuntimeException When the job fails to resolve due to a runtime error.
     */
    @Nonnull
    ResolvedJob resolveJob(String id) throws GenieJobResolutionException, GenieJobResolutionRuntimeException;

    /**
     * Given a job request resolve all the details needed to run a job. This API is stateless and saves nothing.
     *
     * @param id         The id of the job
     * @param jobRequest The job request containing all details a user wants to have for their job
     * @param apiJob     {@literal true} if this job was submitted via the REST API. {@literal false} otherwise.
     * @return The completely resolved job information within a {@link ResolvedJob} instance
     * @throws GenieJobResolutionException        When the job cannot resolved due to unsatisfiable constraints
     * @throws GenieJobResolutionRuntimeException When the job fails to resolve due to a runtime error.
     */
    @Nonnull
    ResolvedJob resolveJob(
        String id,
        @Valid JobRequest jobRequest,
        boolean apiJob
    ) throws GenieJobResolutionException, GenieJobResolutionRuntimeException;
}