Class RepositoryBranchProtection


  • public class RepositoryBranchProtection
    extends com.pulumi.resources.CustomResource
    A Forgejo branch protection rule for a repository.
    • Nested Class Summary

      • Nested classes/interfaces inherited from class com.pulumi.resources.CustomResource

        com.pulumi.resources.CustomResource.CustomResourceInternal
      • Nested classes/interfaces inherited from class com.pulumi.resources.Resource

        com.pulumi.resources.Resource.LazyField<T extends java.lang.Object>, com.pulumi.resources.Resource.LazyFields, com.pulumi.resources.Resource.ResourceInternal
    • Field Summary

      • Fields inherited from class com.pulumi.resources.Resource

        childResources, remote
    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      com.pulumi.core.Output<java.util.Optional<java.util.List<java.lang.String>>> approvalsWhitelistTeams()  
      com.pulumi.core.Output<java.util.Optional<java.util.List<java.lang.String>>> approvalsWhitelistUsernames()  
      com.pulumi.core.Output<java.util.Optional<java.lang.Boolean>> blockOnOfficialReviewRequests()  
      com.pulumi.core.Output<java.util.Optional<java.lang.Boolean>> blockOnOutdatedBranch()  
      com.pulumi.core.Output<java.util.Optional<java.lang.Boolean>> blockOnRejectedReviews()  
      com.pulumi.core.Output<java.lang.String> created()  
      com.pulumi.core.Output<java.util.Optional<java.lang.Boolean>> dismissStaleApprovals()  
      com.pulumi.core.Output<java.util.Optional<java.lang.Boolean>> enableApprovalsWhitelist()  
      com.pulumi.core.Output<java.util.Optional<java.lang.Boolean>> enableMergeWhitelist()  
      com.pulumi.core.Output<java.util.Optional<java.lang.Boolean>> enablePush()  
      com.pulumi.core.Output<java.util.Optional<java.lang.Boolean>> enablePushWhitelist()  
      com.pulumi.core.Output<java.util.Optional<java.lang.Boolean>> enableStatusCheck()  
      static RepositoryBranchProtection get​(java.lang.String name, com.pulumi.core.Output<java.lang.String> id, com.pulumi.resources.CustomResourceOptions options)
      Get an existing Host resource's state with the given name, ID, and optional extra properties used to qualify the lookup.
      com.pulumi.core.Output<java.util.Optional<java.util.List<java.lang.String>>> mergeWhitelistTeams()  
      com.pulumi.core.Output<java.util.Optional<java.util.List<java.lang.String>>> mergeWhitelistUsernames()  
      com.pulumi.core.Output<java.lang.String> name()  
      com.pulumi.core.Output<java.lang.String> owner()  
      com.pulumi.core.Output<java.util.Optional<java.lang.String>> protectedFilePatterns()  
      com.pulumi.core.Output<java.util.Optional<java.lang.Boolean>> pushWhitelistDeployKeys()  
      com.pulumi.core.Output<java.util.Optional<java.util.List<java.lang.String>>> pushWhitelistTeams()  
      com.pulumi.core.Output<java.util.Optional<java.util.List<java.lang.String>>> pushWhitelistUsernames()  
      com.pulumi.core.Output<java.lang.String> repository()  
      com.pulumi.core.Output<java.util.Optional<java.lang.Integer>> requiredApprovals()  
      com.pulumi.core.Output<java.util.Optional<java.lang.Boolean>> requireSignedCommits()  
      com.pulumi.core.Output<java.util.Optional<java.util.List<java.lang.String>>> statusCheckContexts()  
      com.pulumi.core.Output<java.util.Optional<java.lang.String>> unprotectedFilePatterns()  
      com.pulumi.core.Output<java.lang.String> updated()  
      • Methods inherited from class com.pulumi.resources.CustomResource

        getId, id, idFuture
      • Methods inherited from class com.pulumi.resources.Resource

        getChildResources, getResourceName, getResourceType, getUrn, pulumiChildResources, pulumiResourceName, pulumiResourceType, urn
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Constructor Detail

      • RepositoryBranchProtection

        public RepositoryBranchProtection​(java.lang.String name)
        Parameters:
        name - The _unique_ name of the resulting resource.
      • RepositoryBranchProtection

        public RepositoryBranchProtection​(java.lang.String name,
                                          RepositoryBranchProtectionArgs args)
        Parameters:
        name - The _unique_ name of the resulting resource.
        args - The arguments to use to populate this resource's properties.
      • RepositoryBranchProtection

        public RepositoryBranchProtection​(java.lang.String name,
                                          RepositoryBranchProtectionArgs args,
                                          @Nullable
                                          com.pulumi.resources.CustomResourceOptions options)
        Parameters:
        name - The _unique_ name of the resulting resource.
        args - The arguments to use to populate this resource's properties.
        options - A bag of options that control this resource's behavior.
    • Method Detail

      • approvalsWhitelistTeams

        public com.pulumi.core.Output<java.util.Optional<java.util.List<java.lang.String>>> approvalsWhitelistTeams()
        Returns:
        Teams whose approvals count.
      • approvalsWhitelistUsernames

        public com.pulumi.core.Output<java.util.Optional<java.util.List<java.lang.String>>> approvalsWhitelistUsernames()
        Returns:
        Users whose approvals count.
      • blockOnOfficialReviewRequests

        public com.pulumi.core.Output<java.util.Optional<java.lang.Boolean>> blockOnOfficialReviewRequests()
        Returns:
        Whether official review requests block merging.
      • blockOnOutdatedBranch

        public com.pulumi.core.Output<java.util.Optional<java.lang.Boolean>> blockOnOutdatedBranch()
        Returns:
        Whether outdated branches block merging.
      • blockOnRejectedReviews

        public com.pulumi.core.Output<java.util.Optional<java.lang.Boolean>> blockOnRejectedReviews()
        Returns:
        Whether rejected reviews block merging.
      • created

        public com.pulumi.core.Output<java.lang.String> created()
      • dismissStaleApprovals

        public com.pulumi.core.Output<java.util.Optional<java.lang.Boolean>> dismissStaleApprovals()
        Returns:
        Whether stale approvals are dismissed after new commits.
      • enableApprovalsWhitelist

        public com.pulumi.core.Output<java.util.Optional<java.lang.Boolean>> enableApprovalsWhitelist()
        Returns:
        Whether review approvals are limited to the approval whitelist.
      • enableMergeWhitelist

        public com.pulumi.core.Output<java.util.Optional<java.lang.Boolean>> enableMergeWhitelist()
        Returns:
        Whether merging is limited to the merge whitelist.
      • enablePush

        public com.pulumi.core.Output<java.util.Optional<java.lang.Boolean>> enablePush()
        Returns:
        Whether protected branches can be pushed to directly.
      • enablePushWhitelist

        public com.pulumi.core.Output<java.util.Optional<java.lang.Boolean>> enablePushWhitelist()
        Returns:
        Whether direct pushes are limited to the push whitelist.
      • enableStatusCheck

        public com.pulumi.core.Output<java.util.Optional<java.lang.Boolean>> enableStatusCheck()
        Returns:
        Whether status checks are required before merge.
      • mergeWhitelistTeams

        public com.pulumi.core.Output<java.util.Optional<java.util.List<java.lang.String>>> mergeWhitelistTeams()
        Returns:
        Teams allowed to merge.
      • mergeWhitelistUsernames

        public com.pulumi.core.Output<java.util.Optional<java.util.List<java.lang.String>>> mergeWhitelistUsernames()
        Returns:
        Users allowed to merge.
      • name

        public com.pulumi.core.Output<java.lang.String> name()
        Returns:
        Protected branch name or rule pattern.
      • owner

        public com.pulumi.core.Output<java.lang.String> owner()
        Returns:
        Repository owner.
      • protectedFilePatterns

        public com.pulumi.core.Output<java.util.Optional<java.lang.String>> protectedFilePatterns()
        Returns:
        Protected file patterns.
      • pushWhitelistDeployKeys

        public com.pulumi.core.Output<java.util.Optional<java.lang.Boolean>> pushWhitelistDeployKeys()
        Returns:
        Whether deploy keys may push directly.
      • pushWhitelistTeams

        public com.pulumi.core.Output<java.util.Optional<java.util.List<java.lang.String>>> pushWhitelistTeams()
        Returns:
        Teams allowed to push directly.
      • pushWhitelistUsernames

        public com.pulumi.core.Output<java.util.Optional<java.util.List<java.lang.String>>> pushWhitelistUsernames()
        Returns:
        Users allowed to push directly.
      • repository

        public com.pulumi.core.Output<java.lang.String> repository()
        Returns:
        Repository name.
      • requireSignedCommits

        public com.pulumi.core.Output<java.util.Optional<java.lang.Boolean>> requireSignedCommits()
        Returns:
        Whether commits must be signed.
      • requiredApprovals

        public com.pulumi.core.Output<java.util.Optional<java.lang.Integer>> requiredApprovals()
        Returns:
        Number of required approving reviews.
      • statusCheckContexts

        public com.pulumi.core.Output<java.util.Optional<java.util.List<java.lang.String>>> statusCheckContexts()
        Returns:
        Required status check contexts.
      • unprotectedFilePatterns

        public com.pulumi.core.Output<java.util.Optional<java.lang.String>> unprotectedFilePatterns()
        Returns:
        Unprotected file patterns.
      • updated

        public com.pulumi.core.Output<java.lang.String> updated()
      • get

        public static RepositoryBranchProtection get​(java.lang.String name,
                                                     com.pulumi.core.Output<java.lang.String> id,
                                                     @Nullable
                                                     com.pulumi.resources.CustomResourceOptions options)
        Get an existing Host resource's state with the given name, ID, and optional extra properties used to qualify the lookup.
        Parameters:
        name - The _unique_ name of the resulting resource.
        id - The _unique_ provider ID of the resource to lookup.
        options - Optional settings to control the behavior of the CustomResource.