com.pulumi.github.BranchProtectionV3Args Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of github Show documentation
Show all versions of github Show documentation
A Pulumi package for creating and managing github cloud resources.
// *** 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.github;
import com.pulumi.core.Output;
import com.pulumi.core.annotations.Import;
import com.pulumi.exceptions.MissingRequiredPropertyException;
import com.pulumi.github.inputs.BranchProtectionV3RequiredPullRequestReviewsArgs;
import com.pulumi.github.inputs.BranchProtectionV3RequiredStatusChecksArgs;
import com.pulumi.github.inputs.BranchProtectionV3RestrictionsArgs;
import java.lang.Boolean;
import java.lang.String;
import java.util.Objects;
import java.util.Optional;
import javax.annotation.Nullable;
public final class BranchProtectionV3Args extends com.pulumi.resources.ResourceArgs {
public static final BranchProtectionV3Args Empty = new BranchProtectionV3Args();
/**
* The Git branch to protect.
*
*/
@Import(name="branch", required=true)
private Output branch;
/**
* @return The Git branch to protect.
*
*/
public Output branch() {
return this.branch;
}
/**
* Boolean, setting this to `true` enforces status checks for repository administrators.
*
*/
@Import(name="enforceAdmins")
private @Nullable Output enforceAdmins;
/**
* @return Boolean, setting this to `true` enforces status checks for repository administrators.
*
*/
public Optional> enforceAdmins() {
return Optional.ofNullable(this.enforceAdmins);
}
/**
* The GitHub repository name.
*
*/
@Import(name="repository", required=true)
private Output repository;
/**
* @return The GitHub repository name.
*
*/
public Output repository() {
return this.repository;
}
/**
* Boolean, setting this to `true` requires all conversations on code must be resolved before a pull request can be merged.
*
*/
@Import(name="requireConversationResolution")
private @Nullable Output requireConversationResolution;
/**
* @return Boolean, setting this to `true` requires all conversations on code must be resolved before a pull request can be merged.
*
*/
public Optional> requireConversationResolution() {
return Optional.ofNullable(this.requireConversationResolution);
}
/**
* Boolean, setting this to `true` requires all commits to be signed with GPG.
*
*/
@Import(name="requireSignedCommits")
private @Nullable Output requireSignedCommits;
/**
* @return Boolean, setting this to `true` requires all commits to be signed with GPG.
*
*/
public Optional> requireSignedCommits() {
return Optional.ofNullable(this.requireSignedCommits);
}
/**
* Enforce restrictions for pull request reviews. See Required Pull Request Reviews below for details.
*
*/
@Import(name="requiredPullRequestReviews")
private @Nullable Output requiredPullRequestReviews;
/**
* @return Enforce restrictions for pull request reviews. See Required Pull Request Reviews below for details.
*
*/
public Optional> requiredPullRequestReviews() {
return Optional.ofNullable(this.requiredPullRequestReviews);
}
/**
* Enforce restrictions for required status checks. See Required Status Checks below for details.
*
*/
@Import(name="requiredStatusChecks")
private @Nullable Output requiredStatusChecks;
/**
* @return Enforce restrictions for required status checks. See Required Status Checks below for details.
*
*/
public Optional> requiredStatusChecks() {
return Optional.ofNullable(this.requiredStatusChecks);
}
/**
* Enforce restrictions for the users and teams that may push to the branch. See Restrictions below for details.
*
*/
@Import(name="restrictions")
private @Nullable Output restrictions;
/**
* @return Enforce restrictions for the users and teams that may push to the branch. See Restrictions below for details.
*
*/
public Optional> restrictions() {
return Optional.ofNullable(this.restrictions);
}
private BranchProtectionV3Args() {}
private BranchProtectionV3Args(BranchProtectionV3Args $) {
this.branch = $.branch;
this.enforceAdmins = $.enforceAdmins;
this.repository = $.repository;
this.requireConversationResolution = $.requireConversationResolution;
this.requireSignedCommits = $.requireSignedCommits;
this.requiredPullRequestReviews = $.requiredPullRequestReviews;
this.requiredStatusChecks = $.requiredStatusChecks;
this.restrictions = $.restrictions;
}
public static Builder builder() {
return new Builder();
}
public static Builder builder(BranchProtectionV3Args defaults) {
return new Builder(defaults);
}
public static final class Builder {
private BranchProtectionV3Args $;
public Builder() {
$ = new BranchProtectionV3Args();
}
public Builder(BranchProtectionV3Args defaults) {
$ = new BranchProtectionV3Args(Objects.requireNonNull(defaults));
}
/**
* @param branch The Git branch to protect.
*
* @return builder
*
*/
public Builder branch(Output branch) {
$.branch = branch;
return this;
}
/**
* @param branch The Git branch to protect.
*
* @return builder
*
*/
public Builder branch(String branch) {
return branch(Output.of(branch));
}
/**
* @param enforceAdmins Boolean, setting this to `true` enforces status checks for repository administrators.
*
* @return builder
*
*/
public Builder enforceAdmins(@Nullable Output enforceAdmins) {
$.enforceAdmins = enforceAdmins;
return this;
}
/**
* @param enforceAdmins Boolean, setting this to `true` enforces status checks for repository administrators.
*
* @return builder
*
*/
public Builder enforceAdmins(Boolean enforceAdmins) {
return enforceAdmins(Output.of(enforceAdmins));
}
/**
* @param repository The GitHub repository name.
*
* @return builder
*
*/
public Builder repository(Output repository) {
$.repository = repository;
return this;
}
/**
* @param repository The GitHub repository name.
*
* @return builder
*
*/
public Builder repository(String repository) {
return repository(Output.of(repository));
}
/**
* @param requireConversationResolution Boolean, setting this to `true` requires all conversations on code must be resolved before a pull request can be merged.
*
* @return builder
*
*/
public Builder requireConversationResolution(@Nullable Output requireConversationResolution) {
$.requireConversationResolution = requireConversationResolution;
return this;
}
/**
* @param requireConversationResolution Boolean, setting this to `true` requires all conversations on code must be resolved before a pull request can be merged.
*
* @return builder
*
*/
public Builder requireConversationResolution(Boolean requireConversationResolution) {
return requireConversationResolution(Output.of(requireConversationResolution));
}
/**
* @param requireSignedCommits Boolean, setting this to `true` requires all commits to be signed with GPG.
*
* @return builder
*
*/
public Builder requireSignedCommits(@Nullable Output requireSignedCommits) {
$.requireSignedCommits = requireSignedCommits;
return this;
}
/**
* @param requireSignedCommits Boolean, setting this to `true` requires all commits to be signed with GPG.
*
* @return builder
*
*/
public Builder requireSignedCommits(Boolean requireSignedCommits) {
return requireSignedCommits(Output.of(requireSignedCommits));
}
/**
* @param requiredPullRequestReviews Enforce restrictions for pull request reviews. See Required Pull Request Reviews below for details.
*
* @return builder
*
*/
public Builder requiredPullRequestReviews(@Nullable Output requiredPullRequestReviews) {
$.requiredPullRequestReviews = requiredPullRequestReviews;
return this;
}
/**
* @param requiredPullRequestReviews Enforce restrictions for pull request reviews. See Required Pull Request Reviews below for details.
*
* @return builder
*
*/
public Builder requiredPullRequestReviews(BranchProtectionV3RequiredPullRequestReviewsArgs requiredPullRequestReviews) {
return requiredPullRequestReviews(Output.of(requiredPullRequestReviews));
}
/**
* @param requiredStatusChecks Enforce restrictions for required status checks. See Required Status Checks below for details.
*
* @return builder
*
*/
public Builder requiredStatusChecks(@Nullable Output requiredStatusChecks) {
$.requiredStatusChecks = requiredStatusChecks;
return this;
}
/**
* @param requiredStatusChecks Enforce restrictions for required status checks. See Required Status Checks below for details.
*
* @return builder
*
*/
public Builder requiredStatusChecks(BranchProtectionV3RequiredStatusChecksArgs requiredStatusChecks) {
return requiredStatusChecks(Output.of(requiredStatusChecks));
}
/**
* @param restrictions Enforce restrictions for the users and teams that may push to the branch. See Restrictions below for details.
*
* @return builder
*
*/
public Builder restrictions(@Nullable Output restrictions) {
$.restrictions = restrictions;
return this;
}
/**
* @param restrictions Enforce restrictions for the users and teams that may push to the branch. See Restrictions below for details.
*
* @return builder
*
*/
public Builder restrictions(BranchProtectionV3RestrictionsArgs restrictions) {
return restrictions(Output.of(restrictions));
}
public BranchProtectionV3Args build() {
if ($.branch == null) {
throw new MissingRequiredPropertyException("BranchProtectionV3Args", "branch");
}
if ($.repository == null) {
throw new MissingRequiredPropertyException("BranchProtectionV3Args", "repository");
}
return $;
}
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy