com.pulumi.gitlab.RepositoryFile 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.
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.gitlab;
import com.pulumi.core.Output;
import com.pulumi.core.annotations.Export;
import com.pulumi.core.annotations.ResourceType;
import com.pulumi.core.internal.Codegen;
import com.pulumi.gitlab.RepositoryFileArgs;
import com.pulumi.gitlab.Utilities;
import com.pulumi.gitlab.inputs.RepositoryFileState;
import java.lang.Boolean;
import java.lang.Integer;
import java.lang.String;
import java.util.Optional;
import javax.annotation.Nullable;
/**
* ## Example Usage
*
* <!--Start PulumiCodeChooser -->
*
* {@code
* package generated_program;
*
* import com.pulumi.Context;
* import com.pulumi.Pulumi;
* import com.pulumi.core.Output;
* import com.pulumi.gitlab.Group;
* import com.pulumi.gitlab.GroupArgs;
* import com.pulumi.gitlab.Project;
* import com.pulumi.gitlab.ProjectArgs;
* import com.pulumi.gitlab.RepositoryFile;
* import com.pulumi.gitlab.RepositoryFileArgs;
* import java.util.List;
* import java.util.ArrayList;
* import java.util.Map;
* import java.io.File;
* import java.nio.file.Files;
* import java.nio.file.Paths;
*
* public class App }{{@code
* public static void main(String[] args) }{{@code
* Pulumi.run(App::stack);
* }}{@code
*
* public static void stack(Context ctx) }{{@code
* var this_ = new Group("this", GroupArgs.builder()
* .name("example")
* .path("example")
* .description("An example group")
* .build());
*
* var thisProject = new Project("thisProject", ProjectArgs.builder()
* .name("example")
* .namespaceId(this_.id())
* .initializeWithReadme(true)
* .build());
*
* var thisRepositoryFile = new RepositoryFile("thisRepositoryFile", RepositoryFileArgs.builder()
* .project(thisProject.id())
* .filePath("meow.txt")
* .branch("main")
* .content(StdFunctions.base64encode(Base64encodeArgs.builder()
* .input("Meow goes the cat")
* .build()).result())
* .authorEmail("terraform}{@literal @}{@code example.com")
* .authorName("Terraform")
* .commitMessage("feature: add meow file")
* .build());
*
* var readme = new RepositoryFile("readme", RepositoryFileArgs.builder()
* .project(thisProject.id())
* .filePath("readme.txt")
* .branch("main")
* .content("Meow goes the cat")
* .authorEmail("terraform}{@literal @}{@code example.com")
* .authorName("Terraform")
* .commitMessage("feature: add readme file")
* .build());
*
* var readmeForDogs = new RepositoryFile("readmeForDogs", RepositoryFileArgs.builder()
* .project(thisProject.id())
* .filePath("readme.txt")
* .branch("main")
* .content("Bark goes the dog")
* .authorEmail("terraform}{@literal @}{@code example.com")
* .authorName("Terraform")
* .commitMessage("feature: update readme file")
* .overwriteOnCreate(true)
* .build());
*
* }}{@code
* }}{@code
* }
*
* <!--End PulumiCodeChooser -->
*
* ## Import
*
* A Repository File can be imported using an id made up of `<project-id>:<branch-name>:<file-path>`, e.g.
*
* ```sh
* $ pulumi import gitlab:index/repositoryFile:RepositoryFile this 1:main:foo/bar.txt
* ```
*
*/
@ResourceType(type="gitlab:index/repositoryFile:RepositoryFile")
public class RepositoryFile extends com.pulumi.resources.CustomResource {
/**
* Email of the commit author.
*
*/
@Export(name="authorEmail", refs={String.class}, tree="[0]")
private Output authorEmail;
/**
* @return Email of the commit author.
*
*/
public Output> authorEmail() {
return Codegen.optional(this.authorEmail);
}
/**
* Name of the commit author.
*
*/
@Export(name="authorName", refs={String.class}, tree="[0]")
private Output authorName;
/**
* @return Name of the commit author.
*
*/
public Output> authorName() {
return Codegen.optional(this.authorName);
}
/**
* The blob id.
*
*/
@Export(name="blobId", refs={String.class}, tree="[0]")
private Output blobId;
/**
* @return The blob id.
*
*/
public Output blobId() {
return this.blobId;
}
/**
* Name of the branch to which to commit to.
*
*/
@Export(name="branch", refs={String.class}, tree="[0]")
private Output branch;
/**
* @return Name of the branch to which to commit to.
*
*/
public Output branch() {
return this.branch;
}
/**
* The commit id.
*
*/
@Export(name="commitId", refs={String.class}, tree="[0]")
private Output commitId;
/**
* @return The commit id.
*
*/
public Output commitId() {
return this.commitId;
}
/**
* Commit message.
*
*/
@Export(name="commitMessage", refs={String.class}, tree="[0]")
private Output commitMessage;
/**
* @return Commit message.
*
*/
public Output> commitMessage() {
return Codegen.optional(this.commitMessage);
}
/**
* File content.
*
*/
@Export(name="content", refs={String.class}, tree="[0]")
private Output content;
/**
* @return File content.
*
*/
public Output content() {
return this.content;
}
/**
* File content sha256 digest.
*
*/
@Export(name="contentSha256", refs={String.class}, tree="[0]")
private Output contentSha256;
/**
* @return File content sha256 digest.
*
*/
public Output contentSha256() {
return this.contentSha256;
}
/**
* Create commit message.
*
*/
@Export(name="createCommitMessage", refs={String.class}, tree="[0]")
private Output createCommitMessage;
/**
* @return Create commit message.
*
*/
public Output> createCommitMessage() {
return Codegen.optional(this.createCommitMessage);
}
/**
* Delete Commit message.
*
*/
@Export(name="deleteCommitMessage", refs={String.class}, tree="[0]")
private Output deleteCommitMessage;
/**
* @return Delete Commit message.
*
*/
public Output> deleteCommitMessage() {
return Codegen.optional(this.deleteCommitMessage);
}
/**
* The file content encoding. Default value is `base64`. Valid values are: `base64`, `text`.
*
*/
@Export(name="encoding", refs={String.class}, tree="[0]")
private Output encoding;
/**
* @return The file content encoding. Default value is `base64`. Valid values are: `base64`, `text`.
*
*/
public Output> encoding() {
return Codegen.optional(this.encoding);
}
/**
* Enables or disables the execute flag on the file. **Note**: requires GitLab 14.10 or newer.
*
*/
@Export(name="executeFilemode", refs={Boolean.class}, tree="[0]")
private Output executeFilemode;
/**
* @return Enables or disables the execute flag on the file. **Note**: requires GitLab 14.10 or newer.
*
*/
public Output> executeFilemode() {
return Codegen.optional(this.executeFilemode);
}
/**
* The filename.
*
*/
@Export(name="fileName", refs={String.class}, tree="[0]")
private Output fileName;
/**
* @return The filename.
*
*/
public Output fileName() {
return this.fileName;
}
/**
* The full path of the file. It must be relative to the root of the project without a leading slash `/` or `./`.
*
*/
@Export(name="filePath", refs={String.class}, tree="[0]")
private Output filePath;
/**
* @return The full path of the file. It must be relative to the root of the project without a leading slash `/` or `./`.
*
*/
public Output filePath() {
return this.filePath;
}
/**
* The last known commit id.
*
*/
@Export(name="lastCommitId", refs={String.class}, tree="[0]")
private Output lastCommitId;
/**
* @return The last known commit id.
*
*/
public Output lastCommitId() {
return this.lastCommitId;
}
/**
* Enable overwriting existing files, defaults to `false`. This attribute is only used during `create` and must be use carefully. We suggest to use `imports` whenever possible and limit the use of this attribute for when the project was imported on the same `apply`. This attribute is not supported during a resource import.
*
*/
@Export(name="overwriteOnCreate", refs={Boolean.class}, tree="[0]")
private Output overwriteOnCreate;
/**
* @return Enable overwriting existing files, defaults to `false`. This attribute is only used during `create` and must be use carefully. We suggest to use `imports` whenever possible and limit the use of this attribute for when the project was imported on the same `apply`. This attribute is not supported during a resource import.
*
*/
public Output> overwriteOnCreate() {
return Codegen.optional(this.overwriteOnCreate);
}
/**
* The name or ID of the project.
*
*/
@Export(name="project", refs={String.class}, tree="[0]")
private Output project;
/**
* @return The name or ID of the project.
*
*/
public Output project() {
return this.project;
}
/**
* The name of branch, tag or commit.
*
*/
@Export(name="ref", refs={String.class}, tree="[0]")
private Output ref;
/**
* @return The name of branch, tag or commit.
*
*/
public Output ref() {
return this.ref;
}
/**
* The file size.
*
*/
@Export(name="size", refs={Integer.class}, tree="[0]")
private Output size;
/**
* @return The file size.
*
*/
public Output size() {
return this.size;
}
/**
* Name of the branch to start the new commit from.
*
*/
@Export(name="startBranch", refs={String.class}, tree="[0]")
private Output startBranch;
/**
* @return Name of the branch to start the new commit from.
*
*/
public Output> startBranch() {
return Codegen.optional(this.startBranch);
}
/**
* Update commit message.
*
*/
@Export(name="updateCommitMessage", refs={String.class}, tree="[0]")
private Output updateCommitMessage;
/**
* @return Update commit message.
*
*/
public Output> updateCommitMessage() {
return Codegen.optional(this.updateCommitMessage);
}
/**
*
* @param name The _unique_ name of the resulting resource.
*/
public RepositoryFile(java.lang.String name) {
this(name, RepositoryFileArgs.Empty);
}
/**
*
* @param name The _unique_ name of the resulting resource.
* @param args The arguments to use to populate this resource's properties.
*/
public RepositoryFile(java.lang.String name, RepositoryFileArgs args) {
this(name, args, null);
}
/**
*
* @param name The _unique_ name of the resulting resource.
* @param args The arguments to use to populate this resource's properties.
* @param options A bag of options that control this resource's behavior.
*/
public RepositoryFile(java.lang.String name, RepositoryFileArgs args, @Nullable com.pulumi.resources.CustomResourceOptions options) {
super("gitlab:index/repositoryFile:RepositoryFile", name, makeArgs(args, options), makeResourceOptions(options, Codegen.empty()), false);
}
private RepositoryFile(java.lang.String name, Output id, @Nullable RepositoryFileState state, @Nullable com.pulumi.resources.CustomResourceOptions options) {
super("gitlab:index/repositoryFile:RepositoryFile", name, state, makeResourceOptions(options, id), false);
}
private static RepositoryFileArgs makeArgs(RepositoryFileArgs args, @Nullable com.pulumi.resources.CustomResourceOptions options) {
if (options != null && options.getUrn().isPresent()) {
return null;
}
return args == null ? RepositoryFileArgs.Empty : args;
}
private static com.pulumi.resources.CustomResourceOptions makeResourceOptions(@Nullable com.pulumi.resources.CustomResourceOptions options, @Nullable Output id) {
var defaultOptions = com.pulumi.resources.CustomResourceOptions.builder()
.version(Utilities.getVersion())
.build();
return com.pulumi.resources.CustomResourceOptions.merge(defaultOptions, options, id);
}
/**
* Get an existing Host resource's state with the given name, ID, and optional extra
* properties used to qualify the lookup.
*
* @param name The _unique_ name of the resulting resource.
* @param id The _unique_ provider ID of the resource to lookup.
* @param state
* @param options Optional settings to control the behavior of the CustomResource.
*/
public static RepositoryFile get(java.lang.String name, Output id, @Nullable RepositoryFileState state, @Nullable com.pulumi.resources.CustomResourceOptions options) {
return new RepositoryFile(name, id, state, options);
}
}