com.pulumi.gitlab.inputs.GetGroupsArgs Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of gitlab Show documentation
A Pulumi package for creating and managing GitLab resources.
There is a newer version: 8.7.0-alpha.1732772606
// *** WARNING: this file was generated by pulumi-java-gen. ***
// *** Do not edit by hand unless you're certain you know what you are doing! ***

package com.pulumi.gitlab.inputs;

import com.pulumi.core.Output;
import com.pulumi.core.annotations.Import;
import java.lang.Boolean;
import java.lang.String;
import java.util.Objects;
import java.util.Optional;
import javax.annotation.Nullable;


public final class GetGroupsArgs extends com.pulumi.resources.InvokeArgs {

    public static final GetGroupsArgs Empty = new GetGroupsArgs();

    /**
     * Order the groups' list by `id`, `name`, `path`, or `similarity`. (Requires administrator privileges)
     * 
     */
    @Import(name="orderBy")
    private @Nullable Output orderBy;

    /**
     * @return Order the groups' list by `id`, `name`, `path`, or `similarity`. (Requires administrator privileges)
     * 
     */
    public Optional> orderBy() {
        return Optional.ofNullable(this.orderBy);
    }

    /**
     * Search groups by name or path.
     * 
     */
    @Import(name="search")
    private @Nullable Output search;

    /**
     * @return Search groups by name or path.
     * 
     */
    public Optional> search() {
        return Optional.ofNullable(this.search);
    }

    /**
     * Sort groups' list in asc or desc order. (Requires administrator privileges)
     * 
     */
    @Import(name="sort")
    private @Nullable Output sort;

    /**
     * @return Sort groups' list in asc or desc order. (Requires administrator privileges)
     * 
     */
    public Optional> sort() {
        return Optional.ofNullable(this.sort);
    }

    /**
     * Limit to top level groups, excluding all subgroups.
     * 
     */
    @Import(name="topLevelOnly")
    private @Nullable Output topLevelOnly;

    /**
     * @return Limit to top level groups, excluding all subgroups.
     * 
     */
    public Optional> topLevelOnly() {
        return Optional.ofNullable(this.topLevelOnly);
    }

    private GetGroupsArgs() {}

    private GetGroupsArgs(GetGroupsArgs $) {
        this.orderBy = $.orderBy;
        this.search = $.search;
        this.sort = $.sort;
        this.topLevelOnly = $.topLevelOnly;
    }

    public static Builder builder() {
        return new Builder();
    }
    public static Builder builder(GetGroupsArgs defaults) {
        return new Builder(defaults);
    }

    public static final class Builder {
        private GetGroupsArgs $;

        public Builder() {
            $ = new GetGroupsArgs();
        }

        public Builder(GetGroupsArgs defaults) {
            $ = new GetGroupsArgs(Objects.requireNonNull(defaults));
        }

        /**
         * @param orderBy Order the groups' list by `id`, `name`, `path`, or `similarity`. (Requires administrator privileges)
         * 
         * @return builder
         * 
         */
        public Builder orderBy(@Nullable Output orderBy) {
            $.orderBy = orderBy;
            return this;
        }

        /**
         * @param orderBy Order the groups' list by `id`, `name`, `path`, or `similarity`. (Requires administrator privileges)
         * 
         * @return builder
         * 
         */
        public Builder orderBy(String orderBy) {
            return orderBy(Output.of(orderBy));
        }

        /**
         * @param search Search groups by name or path.
         * 
         * @return builder
         * 
         */
        public Builder search(@Nullable Output search) {
            $.search = search;
            return this;
        }

        /**
         * @param search Search groups by name or path.
         * 
         * @return builder
         * 
         */
        public Builder search(String search) {
            return search(Output.of(search));
        }

        /**
         * @param sort Sort groups' list in asc or desc order. (Requires administrator privileges)
         * 
         * @return builder
         * 
         */
        public Builder sort(@Nullable Output sort) {
            $.sort = sort;
            return this;
        }

        /**
         * @param sort Sort groups' list in asc or desc order. (Requires administrator privileges)
         * 
         * @return builder
         * 
         */
        public Builder sort(String sort) {
            return sort(Output.of(sort));
        }

        /**
         * @param topLevelOnly Limit to top level groups, excluding all subgroups.
         * 
         * @return builder
         * 
         */
        public Builder topLevelOnly(@Nullable Output topLevelOnly) {
            $.topLevelOnly = topLevelOnly;
            return this;
        }

        /**
         * @param topLevelOnly Limit to top level groups, excluding all subgroups.
         * 
         * @return builder
         * 
         */
        public Builder topLevelOnly(Boolean topLevelOnly) {
            return topLevelOnly(Output.of(topLevelOnly));
        }

        public GetGroupsArgs build() {
            return $;
        }
    }

}