src/main/java/org/apache/cassandra/sidecar/config/SSTableUploadConfiguration.java

/*
 * 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.cassandra.sidecar.config;

import java.nio.file.attribute.PosixFilePermission;

/**
 * Configuration for SSTable component uploads on this service
 */
public interface SSTableUploadConfiguration
{
    /**
     * @return the maximum number of concurrent SSTable component uploads allowed for this service
     */
    int concurrentUploadsLimit();

    /**
     * @return the configured minimum space percentage required for an SSTable component upload
     */
    float minimumSpacePercentageRequired();

    /**
     * Returns the String representation of a set of posix file permissions used during an SSTable file upload.
     * When an SSTable file is created the specified permissions will be used to create the file.
     * For example, the String {@code rw-r--r--} represents the set of permissions
     * {@link PosixFilePermission#OWNER_READ}, {@link PosixFilePermission#OWNER_WRITE},
     * {@link PosixFilePermission#GROUP_READ}, and {@link PosixFilePermission#OTHERS_READ}.
     *
     * @return the String representation of a set of posix file permissions used during an SSTable file upload
     */
    String filePermissions();
}