io.milvus.param.role.SelectRoleParam Maven / Gradle / Ivy

Go to download
/*
 * 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 io.milvus.param.role;

import io.milvus.exception.ParamException;
import io.milvus.param.ParamUtils;
import lombok.Getter;
import lombok.NonNull;
import lombok.ToString;

@Getter
@ToString
public class SelectRoleParam {

    private final String roleName;
    private final boolean includeUserInfo;

    private SelectRoleParam(@NonNull SelectRoleParam.Builder builder) {
        this.roleName = builder.roleName;
        this.includeUserInfo = builder.includeUserInfo;
    }

    public static SelectRoleParam.Builder newBuilder() {
        return new SelectRoleParam.Builder();
    }

    /**
     * Builder for {@link SelectRoleParam} class.
     */
    public static final class Builder {
        private String roleName;
        private boolean includeUserInfo;

        private Builder() {
        }

        /**
         * Sets the roleName. RoleName cannot be empty or null.
         *
         * @param roleName roleName
         * @return Builder
         */
        public SelectRoleParam.Builder withRoleName(@NonNull String roleName) {
            this.roleName = roleName;
            return this;
        }

        /**
         * Sets the includeUserInfo. includeUserInfo default false.
         *
         * @param includeUserInfo includeUserInfo
         * @return Builder
         */
        public SelectRoleParam.Builder withIncludeUserInfo(boolean includeUserInfo) {
            this.includeUserInfo = includeUserInfo;
            return this;
        }

        /**
         * Verifies parameters and creates a new {@link SelectRoleParam} instance.
         *
         * @return {@link SelectRoleParam}
         */
        public SelectRoleParam build() throws ParamException {
            ParamUtils.CheckNullEmptyString(roleName, "RoleName");

            return new SelectRoleParam(this);
        }
    }

}