com.pulumi.akamai.inputs.GetPropertyRulesBuilderRulesV20240109BehaviorVisitorPrioritizationFifo Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of akamai Show documentation
A Pulumi package for creating and managing akamai 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.akamai.inputs;

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


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

    public static final GetPropertyRulesBuilderRulesV20240109BehaviorVisitorPrioritizationFifo Empty = new GetPropertyRulesBuilderRulesV20240109BehaviorVisitorPrioritizationFifo();

    /**
     * This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
     * 
     */
    @Import(name="accessTitle")
    private @Nullable String accessTitle;

    /**
     * @return This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
     * 
     */
    public Optional accessTitle() {
        return Optional.ofNullable(this.accessTitle);
    }

    /**
     * This identifies the Visitor Prioritization FIFO shared policy to use with this behavior. You can list available shared policies with the `Cloudlets API`.
     * 
     */
    @Import(name="cloudletSharedPolicy")
    private @Nullable Integer cloudletSharedPolicy;

    /**
     * @return This identifies the Visitor Prioritization FIFO shared policy to use with this behavior. You can list available shared policies with the `Cloudlets API`.
     * 
     */
    public Optional cloudletSharedPolicy() {
        return Optional.ofNullable(this.cloudletSharedPolicy);
    }

    /**
     * This specifies a domain for all session cookies. In case you configure many property hostnames, this may be their common domain. Make sure the user agent accepts the custom domain for any request matching the `visitorPrioritizationFifo` behavior. Don't use top level domains (TLDs).
     * 
     */
    @Import(name="customCookieDomain")
    private @Nullable String customCookieDomain;

    /**
     * @return This specifies a domain for all session cookies. In case you configure many property hostnames, this may be their common domain. Make sure the user agent accepts the custom domain for any request matching the `visitorPrioritizationFifo` behavior. Don't use top level domains (TLDs).
     * 
     */
    public Optional customCookieDomain() {
        return Optional.ofNullable(this.customCookieDomain);
    }

    /**
     * This specifies how to set the domain used to establish a session with the visitor.
     * 
     */
    @Import(name="domainConfig")
    private @Nullable String domainConfig;

    /**
     * @return This specifies how to set the domain used to establish a session with the visitor.
     * 
     */
    public Optional domainConfig() {
        return Optional.ofNullable(this.domainConfig);
    }

    /**
     * Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
     * 
     */
    @Import(name="locked")
    private @Nullable Boolean locked;

    /**
     * @return Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
     * 
     */
    public Optional locked() {
        return Optional.ofNullable(this.locked);
    }

    /**
     * Whether the queue session should prolong automatically when the `sessionDuration` expires  and the visitor remains active.
     * 
     */
    @Import(name="sessionAutoProlong")
    private @Nullable Boolean sessionAutoProlong;

    /**
     * @return Whether the queue session should prolong automatically when the `sessionDuration` expires  and the visitor remains active.
     * 
     */
    public Optional sessionAutoProlong() {
        return Optional.ofNullable(this.sessionAutoProlong);
    }

    /**
     * Specifies the number of seconds users remain in the waiting room queue.
     * 
     */
    @Import(name="sessionDuration")
    private @Nullable Integer sessionDuration;

    /**
     * @return Specifies the number of seconds users remain in the waiting room queue.
     * 
     */
    public Optional sessionDuration() {
        return Optional.ofNullable(this.sessionDuration);
    }

    /**
     * This option is for internal usage only.
     * 
     */
    @Import(name="templateUuid")
    private @Nullable String templateUuid;

    /**
     * @return This option is for internal usage only.
     * 
     */
    public Optional templateUuid() {
        return Optional.ofNullable(this.templateUuid);
    }

    /**
     * A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
     * 
     */
    @Import(name="uuid")
    private @Nullable String uuid;

    /**
     * @return A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
     * 
     */
    public Optional uuid() {
        return Optional.ofNullable(this.uuid);
    }

    /**
     * This specifies the base paths to static resources such as `JavaScript`, `CSS`, or image files for the `Waiting Room Main Page` requests. The option supports the `*` wildcard wildcard that matches zero or more characters. Requests matching any of these paths aren't blocked, but marked as Waiting Room Assets and passed through to the origin. See the `visitorPrioritizationRequest` match criteria to further customize these requests.
     * 
     */
    @Import(name="waitingRoomAssetsPaths")
    private @Nullable List waitingRoomAssetsPaths;

    /**
     * @return This specifies the base paths to static resources such as `JavaScript`, `CSS`, or image files for the `Waiting Room Main Page` requests. The option supports the `*` wildcard wildcard that matches zero or more characters. Requests matching any of these paths aren't blocked, but marked as Waiting Room Assets and passed through to the origin. See the `visitorPrioritizationRequest` match criteria to further customize these requests.
     * 
     */
    public Optional> waitingRoomAssetsPaths() {
        return Optional.ofNullable(this.waitingRoomAssetsPaths);
    }

    /**
     * This specifies the path to the waiting room main page on the origin server, for example `/vp/waiting-room.html`. When the request is marked as `Waiting Room Main Page` and blocked, the visitor enters the waiting room. The behavior sets the outgoing request path to the `waitingRoomPath` and modifies the cache key accordingly. See the `visitorPrioritizationRequest` match criteria to further customize these requests.
     * 
     */
    @Import(name="waitingRoomPath")
    private @Nullable String waitingRoomPath;

    /**
     * @return This specifies the path to the waiting room main page on the origin server, for example `/vp/waiting-room.html`. When the request is marked as `Waiting Room Main Page` and blocked, the visitor enters the waiting room. The behavior sets the outgoing request path to the `waitingRoomPath` and modifies the cache key accordingly. See the `visitorPrioritizationRequest` match criteria to further customize these requests.
     * 
     */
    public Optional waitingRoomPath() {
        return Optional.ofNullable(this.waitingRoomPath);
    }

    /**
     * This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
     * 
     */
    @Import(name="waitingRoomTitle")
    private @Nullable String waitingRoomTitle;

    /**
     * @return This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
     * 
     */
    public Optional waitingRoomTitle() {
        return Optional.ofNullable(this.waitingRoomTitle);
    }

    private GetPropertyRulesBuilderRulesV20240109BehaviorVisitorPrioritizationFifo() {}

    private GetPropertyRulesBuilderRulesV20240109BehaviorVisitorPrioritizationFifo(GetPropertyRulesBuilderRulesV20240109BehaviorVisitorPrioritizationFifo $) {
        this.accessTitle = $.accessTitle;
        this.cloudletSharedPolicy = $.cloudletSharedPolicy;
        this.customCookieDomain = $.customCookieDomain;
        this.domainConfig = $.domainConfig;
        this.locked = $.locked;
        this.sessionAutoProlong = $.sessionAutoProlong;
        this.sessionDuration = $.sessionDuration;
        this.templateUuid = $.templateUuid;
        this.uuid = $.uuid;
        this.waitingRoomAssetsPaths = $.waitingRoomAssetsPaths;
        this.waitingRoomPath = $.waitingRoomPath;
        this.waitingRoomTitle = $.waitingRoomTitle;
    }

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

    public static final class Builder {
        private GetPropertyRulesBuilderRulesV20240109BehaviorVisitorPrioritizationFifo $;

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

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

        /**
         * @param accessTitle This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
         * 
         * @return builder
         * 
         */
        public Builder accessTitle(@Nullable String accessTitle) {
            $.accessTitle = accessTitle;
            return this;
        }

        /**
         * @param cloudletSharedPolicy This identifies the Visitor Prioritization FIFO shared policy to use with this behavior. You can list available shared policies with the `Cloudlets API`.
         * 
         * @return builder
         * 
         */
        public Builder cloudletSharedPolicy(@Nullable Integer cloudletSharedPolicy) {
            $.cloudletSharedPolicy = cloudletSharedPolicy;
            return this;
        }

        /**
         * @param customCookieDomain This specifies a domain for all session cookies. In case you configure many property hostnames, this may be their common domain. Make sure the user agent accepts the custom domain for any request matching the `visitorPrioritizationFifo` behavior. Don't use top level domains (TLDs).
         * 
         * @return builder
         * 
         */
        public Builder customCookieDomain(@Nullable String customCookieDomain) {
            $.customCookieDomain = customCookieDomain;
            return this;
        }

        /**
         * @param domainConfig This specifies how to set the domain used to establish a session with the visitor.
         * 
         * @return builder
         * 
         */
        public Builder domainConfig(@Nullable String domainConfig) {
            $.domainConfig = domainConfig;
            return this;
        }

        /**
         * @param locked Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
         * 
         * @return builder
         * 
         */
        public Builder locked(@Nullable Boolean locked) {
            $.locked = locked;
            return this;
        }

        /**
         * @param sessionAutoProlong Whether the queue session should prolong automatically when the `sessionDuration` expires  and the visitor remains active.
         * 
         * @return builder
         * 
         */
        public Builder sessionAutoProlong(@Nullable Boolean sessionAutoProlong) {
            $.sessionAutoProlong = sessionAutoProlong;
            return this;
        }

        /**
         * @param sessionDuration Specifies the number of seconds users remain in the waiting room queue.
         * 
         * @return builder
         * 
         */
        public Builder sessionDuration(@Nullable Integer sessionDuration) {
            $.sessionDuration = sessionDuration;
            return this;
        }

        /**
         * @param templateUuid This option is for internal usage only.
         * 
         * @return builder
         * 
         */
        public Builder templateUuid(@Nullable String templateUuid) {
            $.templateUuid = templateUuid;
            return this;
        }

        /**
         * @param uuid A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
         * 
         * @return builder
         * 
         */
        public Builder uuid(@Nullable String uuid) {
            $.uuid = uuid;
            return this;
        }

        /**
         * @param waitingRoomAssetsPaths This specifies the base paths to static resources such as `JavaScript`, `CSS`, or image files for the `Waiting Room Main Page` requests. The option supports the `*` wildcard wildcard that matches zero or more characters. Requests matching any of these paths aren't blocked, but marked as Waiting Room Assets and passed through to the origin. See the `visitorPrioritizationRequest` match criteria to further customize these requests.
         * 
         * @return builder
         * 
         */
        public Builder waitingRoomAssetsPaths(@Nullable List waitingRoomAssetsPaths) {
            $.waitingRoomAssetsPaths = waitingRoomAssetsPaths;
            return this;
        }

        /**
         * @param waitingRoomAssetsPaths This specifies the base paths to static resources such as `JavaScript`, `CSS`, or image files for the `Waiting Room Main Page` requests. The option supports the `*` wildcard wildcard that matches zero or more characters. Requests matching any of these paths aren't blocked, but marked as Waiting Room Assets and passed through to the origin. See the `visitorPrioritizationRequest` match criteria to further customize these requests.
         * 
         * @return builder
         * 
         */
        public Builder waitingRoomAssetsPaths(String... waitingRoomAssetsPaths) {
            return waitingRoomAssetsPaths(List.of(waitingRoomAssetsPaths));
        }

        /**
         * @param waitingRoomPath This specifies the path to the waiting room main page on the origin server, for example `/vp/waiting-room.html`. When the request is marked as `Waiting Room Main Page` and blocked, the visitor enters the waiting room. The behavior sets the outgoing request path to the `waitingRoomPath` and modifies the cache key accordingly. See the `visitorPrioritizationRequest` match criteria to further customize these requests.
         * 
         * @return builder
         * 
         */
        public Builder waitingRoomPath(@Nullable String waitingRoomPath) {
            $.waitingRoomPath = waitingRoomPath;
            return this;
        }

        /**
         * @param waitingRoomTitle This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
         * 
         * @return builder
         * 
         */
        public Builder waitingRoomTitle(@Nullable String waitingRoomTitle) {
            $.waitingRoomTitle = waitingRoomTitle;
            return this;
        }

        public GetPropertyRulesBuilderRulesV20240109BehaviorVisitorPrioritizationFifo build() {
            return $;
        }
    }

}