com.hedera.node.app.service.schedule.ScheduleServiceDefinition Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of app-service-schedule Show documentation
Hedera Schedule Service API
The newest version!
/*
 * Copyright (C) 2023-2024 Hedera Hashgraph, LLC
 *
 * 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.hedera.node.app.service.schedule;

import static java.util.Objects.requireNonNull;

import com.hedera.hapi.node.base.Transaction;
import com.hedera.hapi.node.transaction.Query;
import com.hedera.hapi.node.transaction.Response;
import com.hedera.hapi.node.transaction.TransactionResponse;
import com.hedera.node.app.hapi.utils.CommonUtils;
import com.hedera.pbj.runtime.RpcMethodDefinition;
import com.hedera.pbj.runtime.RpcServiceDefinition;
import edu.umd.cs.findbugs.annotations.NonNull;
import java.util.Set;

/**
 * Transactions and queries for the Schedule Service.
 */
@SuppressWarnings("java:S6548")
public final class ScheduleServiceDefinition implements RpcServiceDefinition {
    /**
     * The global singleton ScheduleServiceDefinition INSTANCE.
     */
    public static final ScheduleServiceDefinition INSTANCE = new ScheduleServiceDefinition();

    /**
     * The set of methods supported by the Schedule Service.
     */
    private static final Set> methods = Set.of(
            new RpcMethodDefinition<>("createSchedule", Transaction.class, TransactionResponse.class),
            new RpcMethodDefinition<>("signSchedule", Transaction.class, TransactionResponse.class),
            new RpcMethodDefinition<>("deleteSchedule", Transaction.class, TransactionResponse.class),
            new RpcMethodDefinition<>("getScheduleInfo", Query.class, Response.class));

    private ScheduleServiceDefinition() {
        // Just something to keep the Gradle build believing we have a non-transitive
        // "requires" and hence preserving our module-info.class in the compiled JAR
        requireNonNull(CommonUtils.class);
    }

    /**
     * Returns the base path for the Schedule Service.
     *
     * @return the base path
     */
    @Override
    @NonNull
    public String basePath() {
        return "proto.ScheduleService";
    }

    /**
     * Returns the set of methods supported by the Schedule Service.
     *
     * @return the methods
     */
    @Override
    @NonNull
    public Set> methods() {
        return methods;
    }
}