com.pulumi.gitlab.ProjectVariableArgs Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of gitlab Show documentation
Show all versions of gitlab Show documentation
A Pulumi package for creating and managing GitLab 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.gitlab;
import com.pulumi.core.Output;
import com.pulumi.core.annotations.Import;
import com.pulumi.exceptions.MissingRequiredPropertyException;
import java.lang.Boolean;
import java.lang.String;
import java.util.Objects;
import java.util.Optional;
import javax.annotation.Nullable;
public final class ProjectVariableArgs extends com.pulumi.resources.ResourceArgs {
public static final ProjectVariableArgs Empty = new ProjectVariableArgs();
/**
* The description of the variable.
*
*/
@Import(name="description")
private @Nullable Output description;
/**
* @return The description of the variable.
*
*/
public Optional> description() {
return Optional.ofNullable(this.description);
}
/**
* The environment scope of the variable. Defaults to all environment (`*`). Note that in Community Editions of Gitlab, values other than `*` will cause inconsistent plans.
*
*/
@Import(name="environmentScope")
private @Nullable Output environmentScope;
/**
* @return The environment scope of the variable. Defaults to all environment (`*`). Note that in Community Editions of Gitlab, values other than `*` will cause inconsistent plans.
*
*/
public Optional> environmentScope() {
return Optional.ofNullable(this.environmentScope);
}
/**
* The name of the variable.
*
*/
@Import(name="key", required=true)
private Output key;
/**
* @return The name of the variable.
*
*/
public Output key() {
return this.key;
}
/**
* If set to `true`, the value of the variable will be hidden in job logs. The value must meet the [masking requirements](https://docs.gitlab.com/ee/ci/variables/#masked-variables). Defaults to `false`.
*
*/
@Import(name="masked")
private @Nullable Output masked;
/**
* @return If set to `true`, the value of the variable will be hidden in job logs. The value must meet the [masking requirements](https://docs.gitlab.com/ee/ci/variables/#masked-variables). Defaults to `false`.
*
*/
public Optional> masked() {
return Optional.ofNullable(this.masked);
}
/**
* The name or id of the project.
*
*/
@Import(name="project", required=true)
private Output project;
/**
* @return The name or id of the project.
*
*/
public Output project() {
return this.project;
}
/**
* If set to `true`, the variable will be passed only to pipelines running on protected branches and tags. Defaults to `false`.
*
*/
@Import(name="protected")
private @Nullable Output protected_;
/**
* @return If set to `true`, the variable will be passed only to pipelines running on protected branches and tags. Defaults to `false`.
*
*/
public Optional> protected_() {
return Optional.ofNullable(this.protected_);
}
/**
* Whether the variable is treated as a raw string. Default: false. When true, variables in the value are not expanded.
*
*/
@Import(name="raw")
private @Nullable Output raw;
/**
* @return Whether the variable is treated as a raw string. Default: false. When true, variables in the value are not expanded.
*
*/
public Optional> raw() {
return Optional.ofNullable(this.raw);
}
/**
* The value of the variable.
*
*/
@Import(name="value", required=true)
private Output value;
/**
* @return The value of the variable.
*
*/
public Output value() {
return this.value;
}
/**
* The type of a variable. Valid values are: `env_var`, `file`. Default is `env_var`.
*
*/
@Import(name="variableType")
private @Nullable Output variableType;
/**
* @return The type of a variable. Valid values are: `env_var`, `file`. Default is `env_var`.
*
*/
public Optional> variableType() {
return Optional.ofNullable(this.variableType);
}
private ProjectVariableArgs() {}
private ProjectVariableArgs(ProjectVariableArgs $) {
this.description = $.description;
this.environmentScope = $.environmentScope;
this.key = $.key;
this.masked = $.masked;
this.project = $.project;
this.protected_ = $.protected_;
this.raw = $.raw;
this.value = $.value;
this.variableType = $.variableType;
}
public static Builder builder() {
return new Builder();
}
public static Builder builder(ProjectVariableArgs defaults) {
return new Builder(defaults);
}
public static final class Builder {
private ProjectVariableArgs $;
public Builder() {
$ = new ProjectVariableArgs();
}
public Builder(ProjectVariableArgs defaults) {
$ = new ProjectVariableArgs(Objects.requireNonNull(defaults));
}
/**
* @param description The description of the variable.
*
* @return builder
*
*/
public Builder description(@Nullable Output description) {
$.description = description;
return this;
}
/**
* @param description The description of the variable.
*
* @return builder
*
*/
public Builder description(String description) {
return description(Output.of(description));
}
/**
* @param environmentScope The environment scope of the variable. Defaults to all environment (`*`). Note that in Community Editions of Gitlab, values other than `*` will cause inconsistent plans.
*
* @return builder
*
*/
public Builder environmentScope(@Nullable Output environmentScope) {
$.environmentScope = environmentScope;
return this;
}
/**
* @param environmentScope The environment scope of the variable. Defaults to all environment (`*`). Note that in Community Editions of Gitlab, values other than `*` will cause inconsistent plans.
*
* @return builder
*
*/
public Builder environmentScope(String environmentScope) {
return environmentScope(Output.of(environmentScope));
}
/**
* @param key The name of the variable.
*
* @return builder
*
*/
public Builder key(Output key) {
$.key = key;
return this;
}
/**
* @param key The name of the variable.
*
* @return builder
*
*/
public Builder key(String key) {
return key(Output.of(key));
}
/**
* @param masked If set to `true`, the value of the variable will be hidden in job logs. The value must meet the [masking requirements](https://docs.gitlab.com/ee/ci/variables/#masked-variables). Defaults to `false`.
*
* @return builder
*
*/
public Builder masked(@Nullable Output masked) {
$.masked = masked;
return this;
}
/**
* @param masked If set to `true`, the value of the variable will be hidden in job logs. The value must meet the [masking requirements](https://docs.gitlab.com/ee/ci/variables/#masked-variables). Defaults to `false`.
*
* @return builder
*
*/
public Builder masked(Boolean masked) {
return masked(Output.of(masked));
}
/**
* @param project The name or id of the project.
*
* @return builder
*
*/
public Builder project(Output project) {
$.project = project;
return this;
}
/**
* @param project The name or id of the project.
*
* @return builder
*
*/
public Builder project(String project) {
return project(Output.of(project));
}
/**
* @param protected_ If set to `true`, the variable will be passed only to pipelines running on protected branches and tags. Defaults to `false`.
*
* @return builder
*
*/
public Builder protected_(@Nullable Output protected_) {
$.protected_ = protected_;
return this;
}
/**
* @param protected_ If set to `true`, the variable will be passed only to pipelines running on protected branches and tags. Defaults to `false`.
*
* @return builder
*
*/
public Builder protected_(Boolean protected_) {
return protected_(Output.of(protected_));
}
/**
* @param raw Whether the variable is treated as a raw string. Default: false. When true, variables in the value are not expanded.
*
* @return builder
*
*/
public Builder raw(@Nullable Output raw) {
$.raw = raw;
return this;
}
/**
* @param raw Whether the variable is treated as a raw string. Default: false. When true, variables in the value are not expanded.
*
* @return builder
*
*/
public Builder raw(Boolean raw) {
return raw(Output.of(raw));
}
/**
* @param value The value of the variable.
*
* @return builder
*
*/
public Builder value(Output value) {
$.value = value;
return this;
}
/**
* @param value The value of the variable.
*
* @return builder
*
*/
public Builder value(String value) {
return value(Output.of(value));
}
/**
* @param variableType The type of a variable. Valid values are: `env_var`, `file`. Default is `env_var`.
*
* @return builder
*
*/
public Builder variableType(@Nullable Output variableType) {
$.variableType = variableType;
return this;
}
/**
* @param variableType The type of a variable. Valid values are: `env_var`, `file`. Default is `env_var`.
*
* @return builder
*
*/
public Builder variableType(String variableType) {
return variableType(Output.of(variableType));
}
public ProjectVariableArgs build() {
if ($.key == null) {
throw new MissingRequiredPropertyException("ProjectVariableArgs", "key");
}
if ($.project == null) {
throw new MissingRequiredPropertyException("ProjectVariableArgs", "project");
}
if ($.value == null) {
throw new MissingRequiredPropertyException("ProjectVariableArgs", "value");
}
return $;
}
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy