com.pulumi.keycloak.saml.ClientScopeArgs Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of keycloak Show documentation
A Pulumi package for creating and managing keycloak cloud resources.
The newest version!
// *** 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.keycloak.saml;

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


public final class ClientScopeArgs extends com.pulumi.resources.ResourceArgs {

    public static final ClientScopeArgs Empty = new ClientScopeArgs();

    /**
     * When set, a consent screen will be displayed to users authenticating to clients with this scope attached. The consent screen will display the string value of this attribute.
     * 
     */
    @Import(name="consentScreenText")
    private @Nullable Output consentScreenText;

    /**
     * @return When set, a consent screen will be displayed to users authenticating to clients with this scope attached. The consent screen will display the string value of this attribute.
     * 
     */
    public Optional> consentScreenText() {
        return Optional.ofNullable(this.consentScreenText);
    }

    /**
     * The description of this client scope in the GUI.
     * 
     */
    @Import(name="description")
    private @Nullable Output description;

    /**
     * @return The description of this client scope in the GUI.
     * 
     */
    public Optional> description() {
        return Optional.ofNullable(this.description);
    }

    /**
     * Specify order of the client scope in GUI (such as in Consent page) as integer.
     * 
     */
    @Import(name="guiOrder")
    private @Nullable Output guiOrder;

    /**
     * @return Specify order of the client scope in GUI (such as in Consent page) as integer.
     * 
     */
    public Optional> guiOrder() {
        return Optional.ofNullable(this.guiOrder);
    }

    /**
     * The display name of this client scope in the GUI.
     * 
     */
    @Import(name="name")
    private @Nullable Output name;

    /**
     * @return The display name of this client scope in the GUI.
     * 
     */
    public Optional> name() {
        return Optional.ofNullable(this.name);
    }

    /**
     * The realm this client scope belongs to.
     * 
     */
    @Import(name="realmId", required=true)
    private Output realmId;

    /**
     * @return The realm this client scope belongs to.
     * 
     */
    public Output realmId() {
        return this.realmId;
    }

    private ClientScopeArgs() {}

    private ClientScopeArgs(ClientScopeArgs $) {
        this.consentScreenText = $.consentScreenText;
        this.description = $.description;
        this.guiOrder = $.guiOrder;
        this.name = $.name;
        this.realmId = $.realmId;
    }

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

    public static final class Builder {
        private ClientScopeArgs $;

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

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

        /**
         * @param consentScreenText When set, a consent screen will be displayed to users authenticating to clients with this scope attached. The consent screen will display the string value of this attribute.
         * 
         * @return builder
         * 
         */
        public Builder consentScreenText(@Nullable Output consentScreenText) {
            $.consentScreenText = consentScreenText;
            return this;
        }

        /**
         * @param consentScreenText When set, a consent screen will be displayed to users authenticating to clients with this scope attached. The consent screen will display the string value of this attribute.
         * 
         * @return builder
         * 
         */
        public Builder consentScreenText(String consentScreenText) {
            return consentScreenText(Output.of(consentScreenText));
        }

        /**
         * @param description The description of this client scope in the GUI.
         * 
         * @return builder
         * 
         */
        public Builder description(@Nullable Output description) {
            $.description = description;
            return this;
        }

        /**
         * @param description The description of this client scope in the GUI.
         * 
         * @return builder
         * 
         */
        public Builder description(String description) {
            return description(Output.of(description));
        }

        /**
         * @param guiOrder Specify order of the client scope in GUI (such as in Consent page) as integer.
         * 
         * @return builder
         * 
         */
        public Builder guiOrder(@Nullable Output guiOrder) {
            $.guiOrder = guiOrder;
            return this;
        }

        /**
         * @param guiOrder Specify order of the client scope in GUI (such as in Consent page) as integer.
         * 
         * @return builder
         * 
         */
        public Builder guiOrder(Integer guiOrder) {
            return guiOrder(Output.of(guiOrder));
        }

        /**
         * @param name The display name of this client scope in the GUI.
         * 
         * @return builder
         * 
         */
        public Builder name(@Nullable Output name) {
            $.name = name;
            return this;
        }

        /**
         * @param name The display name of this client scope in the GUI.
         * 
         * @return builder
         * 
         */
        public Builder name(String name) {
            return name(Output.of(name));
        }

        /**
         * @param realmId The realm this client scope belongs to.
         * 
         * @return builder
         * 
         */
        public Builder realmId(Output realmId) {
            $.realmId = realmId;
            return this;
        }

        /**
         * @param realmId The realm this client scope belongs to.
         * 
         * @return builder
         * 
         */
        public Builder realmId(String realmId) {
            return realmId(Output.of(realmId));
        }

        public ClientScopeArgs build() {
            if ($.realmId == null) {
                throw new MissingRequiredPropertyException("ClientScopeArgs", "realmId");
            }
            return $;
        }
    }

}