com.pulumi.github.IssueLabel Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of github Show documentation
A Pulumi package for creating and managing github cloud resources.
There is a newer version: 6.5.0
// *** 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.Export;
import com.pulumi.core.annotations.ResourceType;
import com.pulumi.core.internal.Codegen;
import com.pulumi.github.IssueLabelArgs;
import com.pulumi.github.Utilities;
import com.pulumi.github.inputs.IssueLabelState;
import java.lang.String;
import java.util.Optional;
import javax.annotation.Nullable;

/**
 * Provides a GitHub issue label resource.
 * 
 * This resource allows you to create and manage issue labels within your
 * GitHub organization.
 * 
 * Issue labels are keyed off of their "name", so pre-existing issue labels result
 * in a 422 HTTP error if they exist outside of Pulumi. Normally this would not
 * be an issue, except new repositories are created with a "default" set of labels,
 * and those labels easily conflict with custom ones.
 * 
 * This resource will first check if the label exists, and then issue an update,
 * otherwise it will create.
 * 
 * ## Example Usage
 * 
 * <!--Start PulumiCodeChooser -->
 *  * {@code
 * package generated_program;
 * 
 * import com.pulumi.Context;
 * import com.pulumi.Pulumi;
 * import com.pulumi.core.Output;
 * import com.pulumi.github.IssueLabel;
 * import com.pulumi.github.IssueLabelArgs;
 * 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 {
 *     public static void main(String[] args) {
 *         Pulumi.run(App::stack);
 *     }
 * 
 *     public static void stack(Context ctx) {
 *         // Create a new, red colored label
 *         var testRepo = new IssueLabel("testRepo", IssueLabelArgs.builder()
 *             .repository("test-repo")
 *             .name("Urgent")
 *             .color("FF0000")
 *             .build());
 * 
 *     }
 * }
 * }
 * 
 * <!--End PulumiCodeChooser -->
 * 
 * ## Import
 * 
 * GitHub Issue Labels can be imported using an ID made up of `repository:name`, e.g.
 * 
 * ```sh
 * $ pulumi import github:index/issueLabel:IssueLabel panic_label terraform:panic
 * ```
 * 
 */
@ResourceType(type="github:index/issueLabel:IssueLabel")
public class IssueLabel extends com.pulumi.resources.CustomResource {
    /**
     * A 6 character hex code, **without the leading #**, identifying the color of the label.
     * 
     */
    @Export(name="color", refs={String.class}, tree="[0]")
    private Output color;

    /**
     * @return A 6 character hex code, **without the leading #**, identifying the color of the label.
     * 
     */
    public Output color() {
        return this.color;
    }
    /**
     * A short description of the label.
     * 
     */
    @Export(name="description", refs={String.class}, tree="[0]")
    private Output description;

    /**
     * @return A short description of the label.
     * 
     */
    public Output> description() {
        return Codegen.optional(this.description);
    }
    @Export(name="etag", refs={String.class}, tree="[0]")
    private Output etag;

    public Output etag() {
        return this.etag;
    }
    /**
     * The name of the label.
     * 
     */
    @Export(name="name", refs={String.class}, tree="[0]")
    private Output name;

    /**
     * @return The name of the label.
     * 
     */
    public Output name() {
        return this.name;
    }
    /**
     * The GitHub repository
     * 
     */
    @Export(name="repository", refs={String.class}, tree="[0]")
    private Output repository;

    /**
     * @return The GitHub repository
     * 
     */
    public Output repository() {
        return this.repository;
    }
    /**
     * The URL to the issue label
     * 
     */
    @Export(name="url", refs={String.class}, tree="[0]")
    private Output url;

    /**
     * @return The URL to the issue label
     * 
     */
    public Output url() {
        return this.url;
    }

    /**
     *
     * @param name The _unique_ name of the resulting resource.
     */
    public IssueLabel(java.lang.String name) {
        this(name, IssueLabelArgs.Empty);
    }
    /**
     *
     * @param name The _unique_ name of the resulting resource.
     * @param args The arguments to use to populate this resource's properties.
     */
    public IssueLabel(java.lang.String name, IssueLabelArgs 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 IssueLabel(java.lang.String name, IssueLabelArgs args, @Nullable com.pulumi.resources.CustomResourceOptions options) {
        super("github:index/issueLabel:IssueLabel", name, makeArgs(args, options), makeResourceOptions(options, Codegen.empty()), false);
    }

    private IssueLabel(java.lang.String name, Output id, @Nullable IssueLabelState state, @Nullable com.pulumi.resources.CustomResourceOptions options) {
        super("github:index/issueLabel:IssueLabel", name, state, makeResourceOptions(options, id), false);
    }

    private static IssueLabelArgs makeArgs(IssueLabelArgs args, @Nullable com.pulumi.resources.CustomResourceOptions options) {
        if (options != null && options.getUrn().isPresent()) {
            return null;
        }
        return args == null ? IssueLabelArgs.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 IssueLabel get(java.lang.String name, Output id, @Nullable IssueLabelState state, @Nullable com.pulumi.resources.CustomResourceOptions options) {
        return new IssueLabel(name, id, state, options);
    }
}