com.pulumi.splunk.inputs.AppsLocalState Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of splunk Show documentation
Show all versions of splunk Show documentation
A Pulumi package for creating and managing splunk 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.splunk.inputs;
import com.pulumi.core.Output;
import com.pulumi.core.annotations.Import;
import com.pulumi.splunk.inputs.AppsLocalAclArgs;
import java.lang.Boolean;
import java.lang.String;
import java.util.Objects;
import java.util.Optional;
import javax.annotation.Nullable;
public final class AppsLocalState extends com.pulumi.resources.ResourceArgs {
public static final AppsLocalState Empty = new AppsLocalState();
/**
* The app/user context that is the namespace for the resource
*
*/
@Import(name="acl")
private @Nullable Output acl;
/**
* @return The app/user context that is the namespace for the resource
*
*/
public Optional> acl() {
return Optional.ofNullable(this.acl);
}
/**
* Splunkbase session token for operations like install and update that require login. Use auth or session when installing or updating an app through Splunkbase.
*
*/
@Import(name="auth")
private @Nullable Output auth;
/**
* @return Splunkbase session token for operations like install and update that require login. Use auth or session when installing or updating an app through Splunkbase.
*
*/
public Optional> auth() {
return Optional.ofNullable(this.auth);
}
/**
* For apps posted to Splunkbase, use your Splunk account username. For internal apps, include your name and contact information.
*
*/
@Import(name="author")
private @Nullable Output author;
/**
* @return For apps posted to Splunkbase, use your Splunk account username. For internal apps, include your name and contact information.
*
*/
public Optional> author() {
return Optional.ofNullable(this.author);
}
/**
* Custom setup complete indication:
* <br>true = Custom app setup complete.
* <br>false = Custom app setup not complete.
*
*/
@Import(name="configured")
private @Nullable Output configured;
/**
* @return Custom setup complete indication:
* <br>true = Custom app setup complete.
* <br>false = Custom app setup not complete.
*
*/
public Optional> configured() {
return Optional.ofNullable(this.configured);
}
/**
* Short app description also displayed below the app title in Splunk Web Launcher.
*
*/
@Import(name="description")
private @Nullable Output description;
/**
* @return Short app description also displayed below the app title in Splunk Web Launcher.
*
*/
public Optional> description() {
return Optional.ofNullable(this.description);
}
/**
* Custom app name. Overrides name when installing an app from a file where filename is set to true. See also filename.
*
*/
@Import(name="explicitAppname")
private @Nullable Output explicitAppname;
/**
* @return Custom app name. Overrides name when installing an app from a file where filename is set to true. See also filename.
*
*/
public Optional> explicitAppname() {
return Optional.ofNullable(this.explicitAppname);
}
/**
* Indicates whether to use the name value as the app source location.
* <br>true indicates that name is a path to a file to install.
* <br>false indicates that name is the literal app name and that the app is created from Splunkbase using a template.
*
*/
@Import(name="filename")
private @Nullable Output filename;
/**
* @return Indicates whether to use the name value as the app source location.
* <br>true indicates that name is a path to a file to install.
* <br>false indicates that name is the literal app name and that the app is created from Splunkbase using a template.
*
*/
public Optional> filename() {
return Optional.ofNullable(this.filename);
}
/**
* App name displayed in Splunk Web, from five to eighty characters excluding the prefix "Splunk for".
*
*/
@Import(name="label")
private @Nullable Output label;
/**
* @return App name displayed in Splunk Web, from five to eighty characters excluding the prefix "Splunk for".
*
*/
public Optional> label() {
return Optional.ofNullable(this.label);
}
/**
* Literal app name or path for the file to install, depending on the value of filename.
* <br>filename = false indicates that name is the literal app name and that the app is created from Splunkbase using a template.
* <br>filename = true indicates that name is the URL or path to the local .tar, .tgz or .spl file. If name is the Splunkbase URL, set auth or session to authenticate the request.
* The app folder name cannot include spaces or special characters.
*
*/
@Import(name="name")
private @Nullable Output name;
/**
* @return Literal app name or path for the file to install, depending on the value of filename.
* <br>filename = false indicates that name is the literal app name and that the app is created from Splunkbase using a template.
* <br>filename = true indicates that name is the URL or path to the local .tar, .tgz or .spl file. If name is the Splunkbase URL, set auth or session to authenticate the request.
* The app folder name cannot include spaces or special characters.
*
*/
public Optional> name() {
return Optional.ofNullable(this.name);
}
/**
* Login session token for installing or updating an app on Splunkbase. Alternatively, use auth.
*
*/
@Import(name="session")
private @Nullable Output session;
/**
* @return Login session token for installing or updating an app on Splunkbase. Alternatively, use auth.
*
*/
public Optional> session() {
return Optional.ofNullable(this.session);
}
/**
* File-based update indication:
* <br>true specifies that filename should be used to update an existing app. If not specified, update defaults to
* <br>false, which indicates that filename should not be used to update an existing app.
*
*/
@Import(name="update")
private @Nullable Output update;
/**
* @return File-based update indication:
* <br>true specifies that filename should be used to update an existing app. If not specified, update defaults to
* <br>false, which indicates that filename should not be used to update an existing app.
*
*/
public Optional> update() {
return Optional.ofNullable(this.update);
}
/**
* App version.
*
*/
@Import(name="version")
private @Nullable Output version;
/**
* @return App version.
*
*/
public Optional> version() {
return Optional.ofNullable(this.version);
}
/**
* Indicates whether the app is visible and navigable from Splunk Web.
* <br>true = App is visible and navigable.
* <br>false = App is not visible or navigable.
*
*/
@Import(name="visible")
private @Nullable Output visible;
/**
* @return Indicates whether the app is visible and navigable from Splunk Web.
* <br>true = App is visible and navigable.
* <br>false = App is not visible or navigable.
*
*/
public Optional> visible() {
return Optional.ofNullable(this.visible);
}
private AppsLocalState() {}
private AppsLocalState(AppsLocalState $) {
this.acl = $.acl;
this.auth = $.auth;
this.author = $.author;
this.configured = $.configured;
this.description = $.description;
this.explicitAppname = $.explicitAppname;
this.filename = $.filename;
this.label = $.label;
this.name = $.name;
this.session = $.session;
this.update = $.update;
this.version = $.version;
this.visible = $.visible;
}
public static Builder builder() {
return new Builder();
}
public static Builder builder(AppsLocalState defaults) {
return new Builder(defaults);
}
public static final class Builder {
private AppsLocalState $;
public Builder() {
$ = new AppsLocalState();
}
public Builder(AppsLocalState defaults) {
$ = new AppsLocalState(Objects.requireNonNull(defaults));
}
/**
* @param acl The app/user context that is the namespace for the resource
*
* @return builder
*
*/
public Builder acl(@Nullable Output acl) {
$.acl = acl;
return this;
}
/**
* @param acl The app/user context that is the namespace for the resource
*
* @return builder
*
*/
public Builder acl(AppsLocalAclArgs acl) {
return acl(Output.of(acl));
}
/**
* @param auth Splunkbase session token for operations like install and update that require login. Use auth or session when installing or updating an app through Splunkbase.
*
* @return builder
*
*/
public Builder auth(@Nullable Output auth) {
$.auth = auth;
return this;
}
/**
* @param auth Splunkbase session token for operations like install and update that require login. Use auth or session when installing or updating an app through Splunkbase.
*
* @return builder
*
*/
public Builder auth(String auth) {
return auth(Output.of(auth));
}
/**
* @param author For apps posted to Splunkbase, use your Splunk account username. For internal apps, include your name and contact information.
*
* @return builder
*
*/
public Builder author(@Nullable Output author) {
$.author = author;
return this;
}
/**
* @param author For apps posted to Splunkbase, use your Splunk account username. For internal apps, include your name and contact information.
*
* @return builder
*
*/
public Builder author(String author) {
return author(Output.of(author));
}
/**
* @param configured Custom setup complete indication:
* <br>true = Custom app setup complete.
* <br>false = Custom app setup not complete.
*
* @return builder
*
*/
public Builder configured(@Nullable Output configured) {
$.configured = configured;
return this;
}
/**
* @param configured Custom setup complete indication:
* <br>true = Custom app setup complete.
* <br>false = Custom app setup not complete.
*
* @return builder
*
*/
public Builder configured(Boolean configured) {
return configured(Output.of(configured));
}
/**
* @param description Short app description also displayed below the app title in Splunk Web Launcher.
*
* @return builder
*
*/
public Builder description(@Nullable Output description) {
$.description = description;
return this;
}
/**
* @param description Short app description also displayed below the app title in Splunk Web Launcher.
*
* @return builder
*
*/
public Builder description(String description) {
return description(Output.of(description));
}
/**
* @param explicitAppname Custom app name. Overrides name when installing an app from a file where filename is set to true. See also filename.
*
* @return builder
*
*/
public Builder explicitAppname(@Nullable Output explicitAppname) {
$.explicitAppname = explicitAppname;
return this;
}
/**
* @param explicitAppname Custom app name. Overrides name when installing an app from a file where filename is set to true. See also filename.
*
* @return builder
*
*/
public Builder explicitAppname(String explicitAppname) {
return explicitAppname(Output.of(explicitAppname));
}
/**
* @param filename Indicates whether to use the name value as the app source location.
* <br>true indicates that name is a path to a file to install.
* <br>false indicates that name is the literal app name and that the app is created from Splunkbase using a template.
*
* @return builder
*
*/
public Builder filename(@Nullable Output filename) {
$.filename = filename;
return this;
}
/**
* @param filename Indicates whether to use the name value as the app source location.
* <br>true indicates that name is a path to a file to install.
* <br>false indicates that name is the literal app name and that the app is created from Splunkbase using a template.
*
* @return builder
*
*/
public Builder filename(Boolean filename) {
return filename(Output.of(filename));
}
/**
* @param label App name displayed in Splunk Web, from five to eighty characters excluding the prefix "Splunk for".
*
* @return builder
*
*/
public Builder label(@Nullable Output label) {
$.label = label;
return this;
}
/**
* @param label App name displayed in Splunk Web, from five to eighty characters excluding the prefix "Splunk for".
*
* @return builder
*
*/
public Builder label(String label) {
return label(Output.of(label));
}
/**
* @param name Literal app name or path for the file to install, depending on the value of filename.
* <br>filename = false indicates that name is the literal app name and that the app is created from Splunkbase using a template.
* <br>filename = true indicates that name is the URL or path to the local .tar, .tgz or .spl file. If name is the Splunkbase URL, set auth or session to authenticate the request.
* The app folder name cannot include spaces or special characters.
*
* @return builder
*
*/
public Builder name(@Nullable Output name) {
$.name = name;
return this;
}
/**
* @param name Literal app name or path for the file to install, depending on the value of filename.
* <br>filename = false indicates that name is the literal app name and that the app is created from Splunkbase using a template.
* <br>filename = true indicates that name is the URL or path to the local .tar, .tgz or .spl file. If name is the Splunkbase URL, set auth or session to authenticate the request.
* The app folder name cannot include spaces or special characters.
*
* @return builder
*
*/
public Builder name(String name) {
return name(Output.of(name));
}
/**
* @param session Login session token for installing or updating an app on Splunkbase. Alternatively, use auth.
*
* @return builder
*
*/
public Builder session(@Nullable Output session) {
$.session = session;
return this;
}
/**
* @param session Login session token for installing or updating an app on Splunkbase. Alternatively, use auth.
*
* @return builder
*
*/
public Builder session(String session) {
return session(Output.of(session));
}
/**
* @param update File-based update indication:
* <br>true specifies that filename should be used to update an existing app. If not specified, update defaults to
* <br>false, which indicates that filename should not be used to update an existing app.
*
* @return builder
*
*/
public Builder update(@Nullable Output update) {
$.update = update;
return this;
}
/**
* @param update File-based update indication:
* <br>true specifies that filename should be used to update an existing app. If not specified, update defaults to
* <br>false, which indicates that filename should not be used to update an existing app.
*
* @return builder
*
*/
public Builder update(Boolean update) {
return update(Output.of(update));
}
/**
* @param version App version.
*
* @return builder
*
*/
public Builder version(@Nullable Output version) {
$.version = version;
return this;
}
/**
* @param version App version.
*
* @return builder
*
*/
public Builder version(String version) {
return version(Output.of(version));
}
/**
* @param visible Indicates whether the app is visible and navigable from Splunk Web.
* <br>true = App is visible and navigable.
* <br>false = App is not visible or navigable.
*
* @return builder
*
*/
public Builder visible(@Nullable Output visible) {
$.visible = visible;
return this;
}
/**
* @param visible Indicates whether the app is visible and navigable from Splunk Web.
* <br>true = App is visible and navigable.
* <br>false = App is not visible or navigable.
*
* @return builder
*
*/
public Builder visible(Boolean visible) {
return visible(Output.of(visible));
}
public AppsLocalState build() {
return $;
}
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy