com.pulumi.splunk.inputs.OutputsTcpGroupState 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.
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.splunk.inputs;
import com.pulumi.core.Output;
import com.pulumi.core.annotations.Import;
import com.pulumi.splunk.inputs.OutputsTcpGroupAclArgs;
import java.lang.Boolean;
import java.lang.Integer;
import java.lang.String;
import java.util.List;
import java.util.Objects;
import java.util.Optional;
import javax.annotation.Nullable;
public final class OutputsTcpGroupState extends com.pulumi.resources.ResourceArgs {
public static final OutputsTcpGroupState Empty = new OutputsTcpGroupState();
/**
* 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);
}
/**
* If true, forwarder sends compressed data. If set to true, the receiver port must also have compression turned on.
*
*/
@Import(name="compressed")
private @Nullable Output compressed;
/**
* @return If true, forwarder sends compressed data. If set to true, the receiver port must also have compression turned on.
*
*/
public Optional> compressed() {
return Optional.ofNullable(this.compressed);
}
/**
* If true, disables the group.
*
*/
@Import(name="disabled")
private @Nullable Output disabled;
/**
* @return If true, disables the group.
*
*/
public Optional> disabled() {
return Optional.ofNullable(this.disabled);
}
/**
* If set to a positive number, wait the specified number of seconds before throwing out all new events until the output queue has space. Defaults to -1 (do not drop events).
* <br>CAUTION: Do not set this value to a positive integer if you are monitoring files.
* Setting this to -1 or 0 causes the output queue to block when it gets full, which causes further blocking up the processing chain. If any target group queue is blocked, no more data reaches any other target group.
* Using auto load-balancing is the best way to minimize this condition, because, in that case, multiple receivers must be down (or jammed up) before queue blocking can occur.
*
*/
@Import(name="dropEventsOnQueueFull")
private @Nullable Output dropEventsOnQueueFull;
/**
* @return If set to a positive number, wait the specified number of seconds before throwing out all new events until the output queue has space. Defaults to -1 (do not drop events).
* <br>CAUTION: Do not set this value to a positive integer if you are monitoring files.
* Setting this to -1 or 0 causes the output queue to block when it gets full, which causes further blocking up the processing chain. If any target group queue is blocked, no more data reaches any other target group.
* Using auto load-balancing is the best way to minimize this condition, because, in that case, multiple receivers must be down (or jammed up) before queue blocking can occur.
*
*/
public Optional> dropEventsOnQueueFull() {
return Optional.ofNullable(this.dropEventsOnQueueFull);
}
/**
* How often (in seconds) to send a heartbeat packet to the receiving server.
* Heartbeats are only sent if sendCookedData=true. Defaults to 30 seconds.
*
*/
@Import(name="heartbeatFrequency")
private @Nullable Output heartbeatFrequency;
/**
* @return How often (in seconds) to send a heartbeat packet to the receiving server.
* Heartbeats are only sent if sendCookedData=true. Defaults to 30 seconds.
*
*/
public Optional> heartbeatFrequency() {
return Optional.ofNullable(this.heartbeatFrequency);
}
/**
* Specify an integer or integer[KB|MB|GB].
* <br>Sets the maximum size of the forwarder output queue. It also sets the maximum size of the wait queue to 3x this value, if you have enabled indexer acknowledgment (useACK=true).
* Although the wait queue and the output queues are both configured by this attribute, they are separate queues. The setting determines the maximum size of the queue in-memory (RAM) buffer.
* For heavy forwarders sending parsed data, maxQueueSize is the maximum number of events. Since events are typically much shorter than data blocks, the memory consumed by the queue on a parsing forwarder is likely to be much smaller than on a non-parsing forwarder, if you use this version of the setting.
* If specified as a lone integer (for example, maxQueueSize=100), maxQueueSize indicates the maximum number of queued events (for parsed data) or blocks of data (for unparsed data). A block of data is approximately 64KB. For non-parsing forwarders, such as universal forwarders, that send unparsed data, maxQueueSize is the maximum number of data blocks.
* If specified as an integer followed by KB, MB, or GB (for example, maxQueueSize=100MB), maxQueueSize indicates the maximum RAM allocated to the queue buffer. Defaults to 500KB (which means a maximum size of 500KB for the output queue and 1500KB for the wait queue, if any).
*
*/
@Import(name="maxQueueSize")
private @Nullable Output maxQueueSize;
/**
* @return Specify an integer or integer[KB|MB|GB].
* <br>Sets the maximum size of the forwarder output queue. It also sets the maximum size of the wait queue to 3x this value, if you have enabled indexer acknowledgment (useACK=true).
* Although the wait queue and the output queues are both configured by this attribute, they are separate queues. The setting determines the maximum size of the queue in-memory (RAM) buffer.
* For heavy forwarders sending parsed data, maxQueueSize is the maximum number of events. Since events are typically much shorter than data blocks, the memory consumed by the queue on a parsing forwarder is likely to be much smaller than on a non-parsing forwarder, if you use this version of the setting.
* If specified as a lone integer (for example, maxQueueSize=100), maxQueueSize indicates the maximum number of queued events (for parsed data) or blocks of data (for unparsed data). A block of data is approximately 64KB. For non-parsing forwarders, such as universal forwarders, that send unparsed data, maxQueueSize is the maximum number of data blocks.
* If specified as an integer followed by KB, MB, or GB (for example, maxQueueSize=100MB), maxQueueSize indicates the maximum RAM allocated to the queue buffer. Defaults to 500KB (which means a maximum size of 500KB for the output queue and 1500KB for the wait queue, if any).
*
*/
public Optional> maxQueueSize() {
return Optional.ofNullable(this.maxQueueSize);
}
/**
* Valid values: (tcpout | syslog). Specifies the type of output processor.
*
*/
@Import(name="method")
private @Nullable Output method;
/**
* @return Valid values: (tcpout | syslog). Specifies the type of output processor.
*
*/
public Optional> method() {
return Optional.ofNullable(this.method);
}
/**
* The name of the group of receivers.
*
*/
@Import(name="name")
private @Nullable Output name;
/**
* @return The name of the group of receivers.
*
*/
public Optional> name() {
return Optional.ofNullable(this.name);
}
/**
* If true, events are cooked (processed by Splunk software). If false, events are raw and untouched prior to sending. Defaults to true.
* Set to false if you are sending to a third-party system.
*
*/
@Import(name="sendCookedData")
private @Nullable Output sendCookedData;
/**
* @return If true, events are cooked (processed by Splunk software). If false, events are raw and untouched prior to sending. Defaults to true.
* Set to false if you are sending to a third-party system.
*
*/
public Optional> sendCookedData() {
return Optional.ofNullable(this.sendCookedData);
}
/**
* Comma-separated list of servers to include in the group.
*
*/
@Import(name="servers")
private @Nullable Output> servers;
/**
* @return Comma-separated list of servers to include in the group.
*
*/
public Optional>> servers() {
return Optional.ofNullable(this.servers);
}
/**
* Token value generated by the indexer after configuration.
*
*/
@Import(name="token")
private @Nullable Output token;
/**
* @return Token value generated by the indexer after configuration.
*
*/
public Optional> token() {
return Optional.ofNullable(this.token);
}
private OutputsTcpGroupState() {}
private OutputsTcpGroupState(OutputsTcpGroupState $) {
this.acl = $.acl;
this.compressed = $.compressed;
this.disabled = $.disabled;
this.dropEventsOnQueueFull = $.dropEventsOnQueueFull;
this.heartbeatFrequency = $.heartbeatFrequency;
this.maxQueueSize = $.maxQueueSize;
this.method = $.method;
this.name = $.name;
this.sendCookedData = $.sendCookedData;
this.servers = $.servers;
this.token = $.token;
}
public static Builder builder() {
return new Builder();
}
public static Builder builder(OutputsTcpGroupState defaults) {
return new Builder(defaults);
}
public static final class Builder {
private OutputsTcpGroupState $;
public Builder() {
$ = new OutputsTcpGroupState();
}
public Builder(OutputsTcpGroupState defaults) {
$ = new OutputsTcpGroupState(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(OutputsTcpGroupAclArgs acl) {
return acl(Output.of(acl));
}
/**
* @param compressed If true, forwarder sends compressed data. If set to true, the receiver port must also have compression turned on.
*
* @return builder
*
*/
public Builder compressed(@Nullable Output compressed) {
$.compressed = compressed;
return this;
}
/**
* @param compressed If true, forwarder sends compressed data. If set to true, the receiver port must also have compression turned on.
*
* @return builder
*
*/
public Builder compressed(Boolean compressed) {
return compressed(Output.of(compressed));
}
/**
* @param disabled If true, disables the group.
*
* @return builder
*
*/
public Builder disabled(@Nullable Output disabled) {
$.disabled = disabled;
return this;
}
/**
* @param disabled If true, disables the group.
*
* @return builder
*
*/
public Builder disabled(Boolean disabled) {
return disabled(Output.of(disabled));
}
/**
* @param dropEventsOnQueueFull If set to a positive number, wait the specified number of seconds before throwing out all new events until the output queue has space. Defaults to -1 (do not drop events).
* <br>CAUTION: Do not set this value to a positive integer if you are monitoring files.
* Setting this to -1 or 0 causes the output queue to block when it gets full, which causes further blocking up the processing chain. If any target group queue is blocked, no more data reaches any other target group.
* Using auto load-balancing is the best way to minimize this condition, because, in that case, multiple receivers must be down (or jammed up) before queue blocking can occur.
*
* @return builder
*
*/
public Builder dropEventsOnQueueFull(@Nullable Output dropEventsOnQueueFull) {
$.dropEventsOnQueueFull = dropEventsOnQueueFull;
return this;
}
/**
* @param dropEventsOnQueueFull If set to a positive number, wait the specified number of seconds before throwing out all new events until the output queue has space. Defaults to -1 (do not drop events).
* <br>CAUTION: Do not set this value to a positive integer if you are monitoring files.
* Setting this to -1 or 0 causes the output queue to block when it gets full, which causes further blocking up the processing chain. If any target group queue is blocked, no more data reaches any other target group.
* Using auto load-balancing is the best way to minimize this condition, because, in that case, multiple receivers must be down (or jammed up) before queue blocking can occur.
*
* @return builder
*
*/
public Builder dropEventsOnQueueFull(Integer dropEventsOnQueueFull) {
return dropEventsOnQueueFull(Output.of(dropEventsOnQueueFull));
}
/**
* @param heartbeatFrequency How often (in seconds) to send a heartbeat packet to the receiving server.
* Heartbeats are only sent if sendCookedData=true. Defaults to 30 seconds.
*
* @return builder
*
*/
public Builder heartbeatFrequency(@Nullable Output heartbeatFrequency) {
$.heartbeatFrequency = heartbeatFrequency;
return this;
}
/**
* @param heartbeatFrequency How often (in seconds) to send a heartbeat packet to the receiving server.
* Heartbeats are only sent if sendCookedData=true. Defaults to 30 seconds.
*
* @return builder
*
*/
public Builder heartbeatFrequency(Integer heartbeatFrequency) {
return heartbeatFrequency(Output.of(heartbeatFrequency));
}
/**
* @param maxQueueSize Specify an integer or integer[KB|MB|GB].
* <br>Sets the maximum size of the forwarder output queue. It also sets the maximum size of the wait queue to 3x this value, if you have enabled indexer acknowledgment (useACK=true).
* Although the wait queue and the output queues are both configured by this attribute, they are separate queues. The setting determines the maximum size of the queue in-memory (RAM) buffer.
* For heavy forwarders sending parsed data, maxQueueSize is the maximum number of events. Since events are typically much shorter than data blocks, the memory consumed by the queue on a parsing forwarder is likely to be much smaller than on a non-parsing forwarder, if you use this version of the setting.
* If specified as a lone integer (for example, maxQueueSize=100), maxQueueSize indicates the maximum number of queued events (for parsed data) or blocks of data (for unparsed data). A block of data is approximately 64KB. For non-parsing forwarders, such as universal forwarders, that send unparsed data, maxQueueSize is the maximum number of data blocks.
* If specified as an integer followed by KB, MB, or GB (for example, maxQueueSize=100MB), maxQueueSize indicates the maximum RAM allocated to the queue buffer. Defaults to 500KB (which means a maximum size of 500KB for the output queue and 1500KB for the wait queue, if any).
*
* @return builder
*
*/
public Builder maxQueueSize(@Nullable Output maxQueueSize) {
$.maxQueueSize = maxQueueSize;
return this;
}
/**
* @param maxQueueSize Specify an integer or integer[KB|MB|GB].
* <br>Sets the maximum size of the forwarder output queue. It also sets the maximum size of the wait queue to 3x this value, if you have enabled indexer acknowledgment (useACK=true).
* Although the wait queue and the output queues are both configured by this attribute, they are separate queues. The setting determines the maximum size of the queue in-memory (RAM) buffer.
* For heavy forwarders sending parsed data, maxQueueSize is the maximum number of events. Since events are typically much shorter than data blocks, the memory consumed by the queue on a parsing forwarder is likely to be much smaller than on a non-parsing forwarder, if you use this version of the setting.
* If specified as a lone integer (for example, maxQueueSize=100), maxQueueSize indicates the maximum number of queued events (for parsed data) or blocks of data (for unparsed data). A block of data is approximately 64KB. For non-parsing forwarders, such as universal forwarders, that send unparsed data, maxQueueSize is the maximum number of data blocks.
* If specified as an integer followed by KB, MB, or GB (for example, maxQueueSize=100MB), maxQueueSize indicates the maximum RAM allocated to the queue buffer. Defaults to 500KB (which means a maximum size of 500KB for the output queue and 1500KB for the wait queue, if any).
*
* @return builder
*
*/
public Builder maxQueueSize(String maxQueueSize) {
return maxQueueSize(Output.of(maxQueueSize));
}
/**
* @param method Valid values: (tcpout | syslog). Specifies the type of output processor.
*
* @return builder
*
*/
public Builder method(@Nullable Output method) {
$.method = method;
return this;
}
/**
* @param method Valid values: (tcpout | syslog). Specifies the type of output processor.
*
* @return builder
*
*/
public Builder method(String method) {
return method(Output.of(method));
}
/**
* @param name The name of the group of receivers.
*
* @return builder
*
*/
public Builder name(@Nullable Output name) {
$.name = name;
return this;
}
/**
* @param name The name of the group of receivers.
*
* @return builder
*
*/
public Builder name(String name) {
return name(Output.of(name));
}
/**
* @param sendCookedData If true, events are cooked (processed by Splunk software). If false, events are raw and untouched prior to sending. Defaults to true.
* Set to false if you are sending to a third-party system.
*
* @return builder
*
*/
public Builder sendCookedData(@Nullable Output sendCookedData) {
$.sendCookedData = sendCookedData;
return this;
}
/**
* @param sendCookedData If true, events are cooked (processed by Splunk software). If false, events are raw and untouched prior to sending. Defaults to true.
* Set to false if you are sending to a third-party system.
*
* @return builder
*
*/
public Builder sendCookedData(Boolean sendCookedData) {
return sendCookedData(Output.of(sendCookedData));
}
/**
* @param servers Comma-separated list of servers to include in the group.
*
* @return builder
*
*/
public Builder servers(@Nullable Output> servers) {
$.servers = servers;
return this;
}
/**
* @param servers Comma-separated list of servers to include in the group.
*
* @return builder
*
*/
public Builder servers(List servers) {
return servers(Output.of(servers));
}
/**
* @param servers Comma-separated list of servers to include in the group.
*
* @return builder
*
*/
public Builder servers(String... servers) {
return servers(List.of(servers));
}
/**
* @param token Token value generated by the indexer after configuration.
*
* @return builder
*
*/
public Builder token(@Nullable Output token) {
$.token = token;
return this;
}
/**
* @param token Token value generated by the indexer after configuration.
*
* @return builder
*
*/
public Builder token(String token) {
return token(Output.of(token));
}
public OutputsTcpGroupState build() {
return $;
}
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy