Package com.launchdarkly.api.model

Class ApprovalRequestSetting

  • @Generated(value="org.openapitools.codegen.languages.JavaClientCodegen",
           date="2026-03-05T10:45:26.516033Z[Etc/UTC]",
           comments="Generator version: 7.18.0")
public class ApprovalRequestSetting
extends java.lang.Object
    Configuration that controls how changes to a resource are gated by approvals.

    • Field Detail

      • SERIALIZED_NAME_REQUIRED

        public static final java.lang.String SERIALIZED_NAME_REQUIRED
        See Also:
        Constant Field Values

      • SERIALIZED_NAME_BYPASS_APPROVALS_FOR_PENDING_CHANGES

        public static final java.lang.String SERIALIZED_NAME_BYPASS_APPROVALS_FOR_PENDING_CHANGES
        See Also:
        Constant Field Values

      • SERIALIZED_NAME_MIN_NUM_APPROVALS

        public static final java.lang.String SERIALIZED_NAME_MIN_NUM_APPROVALS
        See Also:
        Constant Field Values

      • SERIALIZED_NAME_CAN_REVIEW_OWN_REQUEST

        public static final java.lang.String SERIALIZED_NAME_CAN_REVIEW_OWN_REQUEST
        See Also:
        Constant Field Values

      • SERIALIZED_NAME_CAN_APPLY_DECLINED_CHANGES

        public static final java.lang.String SERIALIZED_NAME_CAN_APPLY_DECLINED_CHANGES
        See Also:
        Constant Field Values

      • SERIALIZED_NAME_AUTO_APPLY_APPROVED_CHANGES

        public static final java.lang.String SERIALIZED_NAME_AUTO_APPLY_APPROVED_CHANGES
        See Also:
        Constant Field Values

      • SERIALIZED_NAME_SERVICE_KIND

        public static final java.lang.String SERIALIZED_NAME_SERVICE_KIND
        See Also:
        Constant Field Values

      • SERIALIZED_NAME_SERVICE_CONFIG

        public static final java.lang.String SERIALIZED_NAME_SERVICE_CONFIG
        See Also:
        Constant Field Values

      • SERIALIZED_NAME_REQUIRED_APPROVAL_TAGS

        public static final java.lang.String SERIALIZED_NAME_REQUIRED_APPROVAL_TAGS
        See Also:
        Constant Field Values

      • SERIALIZED_NAME_SERVICE_KIND_CONFIGURATION_ID

        public static final java.lang.String SERIALIZED_NAME_SERVICE_KIND_CONFIGURATION_ID
        See Also:
        Constant Field Values

      • openapiFields

        public static java.util.HashSet<java.lang.String> openapiFields

      • openapiRequiredFields

        public static java.util.HashSet<java.lang.String> openapiRequiredFields

    • Constructor Detail

      • ApprovalRequestSetting

        public ApprovalRequestSetting()

    • Method Detail

      • getRequired

        @Nonnull
public java.lang.Boolean getRequired()
        If approvals are required for this environment
        Returns:
        required

      • setRequired

        public void setRequired​(@Nonnull
                        java.lang.Boolean required)

      • bypassApprovalsForPendingChanges

        public ApprovalRequestSetting bypassApprovalsForPendingChanges​(@Nonnull
                                                               java.lang.Boolean bypassApprovalsForPendingChanges)

      • getBypassApprovalsForPendingChanges

        @Nonnull
public java.lang.Boolean getBypassApprovalsForPendingChanges()
        Whether to skip approvals for pending changes
        Returns:
        bypassApprovalsForPendingChanges

      • setBypassApprovalsForPendingChanges

        public void setBypassApprovalsForPendingChanges​(@Nonnull
                                                java.lang.Boolean bypassApprovalsForPendingChanges)

      • minNumApprovals

        public ApprovalRequestSetting minNumApprovals​(@Nonnull
                                              java.lang.Integer minNumApprovals)

      • getMinNumApprovals

        @Nonnull
public java.lang.Integer getMinNumApprovals()
        Sets the amount of approvals required before a member can apply a change. The minimum is one and the maximum is five.
        Returns:
        minNumApprovals

      • setMinNumApprovals

        public void setMinNumApprovals​(@Nonnull
                               java.lang.Integer minNumApprovals)

      • canReviewOwnRequest

        public ApprovalRequestSetting canReviewOwnRequest​(@Nonnull
                                                  java.lang.Boolean canReviewOwnRequest)

      • getCanReviewOwnRequest

        @Nonnull
public java.lang.Boolean getCanReviewOwnRequest()
        Allow someone who makes an approval request to apply their own change
        Returns:
        canReviewOwnRequest

      • setCanReviewOwnRequest

        public void setCanReviewOwnRequest​(@Nonnull
                                   java.lang.Boolean canReviewOwnRequest)

      • canApplyDeclinedChanges

        public ApprovalRequestSetting canApplyDeclinedChanges​(@Nonnull
                                                      java.lang.Boolean canApplyDeclinedChanges)

      • getCanApplyDeclinedChanges

        @Nonnull
public java.lang.Boolean getCanApplyDeclinedChanges()
        Allow applying the change as long as at least one person has approved
        Returns:
        canApplyDeclinedChanges

      • setCanApplyDeclinedChanges

        public void setCanApplyDeclinedChanges​(@Nonnull
                                       java.lang.Boolean canApplyDeclinedChanges)

      • autoApplyApprovedChanges

        public ApprovalRequestSetting autoApplyApprovedChanges​(@Nullable
                                                       java.lang.Boolean autoApplyApprovedChanges)

      • getAutoApplyApprovedChanges

        @Nullable
public java.lang.Boolean getAutoApplyApprovedChanges()
        Automatically apply changes that have been approved by all reviewers. This field is only applicable for approval services other than LaunchDarkly.
        Returns:
        autoApplyApprovedChanges

      • setAutoApplyApprovedChanges

        public void setAutoApplyApprovedChanges​(@Nullable
                                        java.lang.Boolean autoApplyApprovedChanges)

      • getServiceKind

        @Nonnull
public java.lang.String getServiceKind()
        Which service to use for managing approvals
        Returns:
        serviceKind

      • setServiceKind

        public void setServiceKind​(@Nonnull
                           java.lang.String serviceKind)

      • serviceConfig

        public ApprovalRequestSetting serviceConfig​(@Nonnull
                                            java.util.Map<java.lang.String,​java.lang.Object> serviceConfig)

      • putServiceConfigItem

        public ApprovalRequestSetting putServiceConfigItem​(java.lang.String key,
                                                   java.lang.Object serviceConfigItem)

      • getServiceConfig

        @Nonnull
public java.util.Map<java.lang.String,​java.lang.Object> getServiceConfig()
        Arbitrary service-specific configuration
        Returns:
        serviceConfig

      • setServiceConfig

        public void setServiceConfig​(@Nonnull
                             java.util.Map<java.lang.String,​java.lang.Object> serviceConfig)

      • requiredApprovalTags

        public ApprovalRequestSetting requiredApprovalTags​(@Nonnull
                                                   java.util.List<java.lang.String> requiredApprovalTags)

      • addRequiredApprovalTagsItem

        public ApprovalRequestSetting addRequiredApprovalTagsItem​(java.lang.String requiredApprovalTagsItem)

      • getRequiredApprovalTags

        @Nonnull
public java.util.List<java.lang.String> getRequiredApprovalTags()
        Require approval only on flags with the provided tags. Otherwise all flags will require approval.
        Returns:
        requiredApprovalTags

      • setRequiredApprovalTags

        public void setRequiredApprovalTags​(@Nonnull
                                    java.util.List<java.lang.String> requiredApprovalTags)

      • serviceKindConfigurationId

        public ApprovalRequestSetting serviceKindConfigurationId​(@Nullable
                                                         java.lang.String serviceKindConfigurationId)

      • getServiceKindConfigurationId

        @Nullable
public java.lang.String getServiceKindConfigurationId()
        Optional integration configuration ID of a custom approval integration. This is an Enterprise-only feature.
        Returns:
        serviceKindConfigurationId

      • setServiceKindConfigurationId

        public void setServiceKindConfigurationId​(@Nullable
                                          java.lang.String serviceKindConfigurationId)

      • putAdditionalProperty

        public ApprovalRequestSetting putAdditionalProperty​(java.lang.String key,
                                                    java.lang.Object value)
        Set the additional (undeclared) property with the specified name and value. If the property does not already exist, create it otherwise replace it.
        Parameters:
        key - name of the property
        value - value of the property
        Returns:
        the ApprovalRequestSetting instance itself

      • getAdditionalProperties

        public java.util.Map<java.lang.String,​java.lang.Object> getAdditionalProperties()
        Return the additional (undeclared) property.
        Returns:
        a map of objects

      • getAdditionalProperty

        public java.lang.Object getAdditionalProperty​(java.lang.String key)
        Return the additional (undeclared) property with the specified name.
        Parameters:
        key - name of the property
        Returns:
        an object

      • equals

        public boolean equals​(java.lang.Object o)
        Overrides:
        equals in class java.lang.Object

      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class java.lang.Object

      • toString

        public java.lang.String toString()
        Overrides:
        toString in class java.lang.Object

      • validateJsonElement

        public static void validateJsonElement​(com.google.gson.JsonElement jsonElement)
                                throws java.io.IOException
        Validates the JSON Element and throws an exception if issues found
        Parameters:
        jsonElement - JSON Element
        Throws:
        java.io.IOException - if the JSON Element is invalid with respect to ApprovalRequestSetting

      • fromJson

        public static ApprovalRequestSetting fromJson​(java.lang.String jsonString)
                                       throws java.io.IOException
        Create an instance of ApprovalRequestSetting given an JSON string
        Parameters:
        jsonString - JSON string
        Returns:
        An instance of ApprovalRequestSetting
        Throws:
        java.io.IOException - if the JSON string is invalid with respect to ApprovalRequestSetting

      • toJson

        public java.lang.String toJson()
        Convert an instance of ApprovalRequestSetting to an JSON string
        Returns:
        JSON string