com.oracle.bmc.loganalytics.model

Class BucketCommandDescriptor

java.lang.Object

com.oracle.bmc.http.internal.ExplicitlySetBmcModel

com.oracle.bmc.loganalytics.model.AbstractCommandDescriptor

com.oracle.bmc.loganalytics.model.BucketCommandDescriptor

@Generated(value="OracleSDKGenerator",
           comments="API Version: 20200601")
public final class BucketCommandDescriptor
extends AbstractCommandDescriptor

Command descriptor for querylanguage BUCKET command.

Note: Objects should always be created or deserialized using the BucketCommandDescriptor.Builder. This model distinguishes fields that are null because they are unset from fields that are explicitly set to null. This is done in the setter methods of the BucketCommandDescriptor.Builder, which maintain a set of all explicitly set fields called ExplicitlySetBmcModel.__explicitlySet__. The hashCode() and equals(Object) methods are implemented to take ExplicitlySetBmcModel.__explicitlySet__ into account. The constructor, on the other hand, does not set ExplicitlySetBmcModel.__explicitlySet__ (since the constructor cannot distinguish explicit null from unset null).

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	BucketCommandDescriptor.Builder

Nested classes/interfaces inherited from class com.oracle.bmc.loganalytics.model.AbstractCommandDescriptor

AbstractCommandDescriptor.Name

Constructor Summary

Constructors

Constructor and Description
BucketCommandDescriptor(String displayQueryString, String internalQueryString, String category, List<AbstractField> referencedFields, List<AbstractField> declaredFields, Integer maxBuckets, BigDecimal span, List<BucketRange> ranges, String defaultValue) Deprecated.

Method Summary

Modifier and Type	Method and Description
static BucketCommandDescriptor.Builder	builder() Create a new builder.
boolean	equals(Object o)
String	getDefaultValue() Default value to use in place of null if a result does not fit into any of the specified / calculated ranges.
Integer	getMaxBuckets() number of auto calculated ranges to compute if specified.
List<BucketRange>	getRanges() List of the specified numeric ranges.
BigDecimal	getSpan() Size of each numeric range if specified.
int	hashCode()
BucketCommandDescriptor.Builder	toBuilder()
String	toString()
String	toString(boolean includeByteArrayContents) Return a string representation of the object.

Methods inherited from class com.oracle.bmc.loganalytics.model.AbstractCommandDescriptor

getCategory, getDeclaredFields, getDisplayQueryString, getInternalQueryString, getReferencedFields

Methods inherited from class com.oracle.bmc.http.internal.ExplicitlySetBmcModel

markPropertyAsExplicitlySet, wasPropertyExplicitlySet

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

BucketCommandDescriptor

@Deprecated
public BucketCommandDescriptor(String displayQueryString,
                                           String internalQueryString,
                                           String category,
                                           List<AbstractField> referencedFields,
                                           List<AbstractField> declaredFields,
                                           Integer maxBuckets,
                                           BigDecimal span,
                                           List<BucketRange> ranges,
                                           String defaultValue)

Deprecated.

Method Detail

builder

public static BucketCommandDescriptor.Builder builder()

Create a new builder.

toBuilder

public BucketCommandDescriptor.Builder toBuilder()

getMaxBuckets

public Integer getMaxBuckets()

number of auto calculated ranges to compute if specified.

Returns:

the value

getSpan

public BigDecimal getSpan()

Size of each numeric range if specified. Data type should match numeric field data type specified in the query string.

Returns:

the value

getRanges

public List<BucketRange> getRanges()

List of the specified numeric ranges.

Returns:

the value

getDefaultValue

public String getDefaultValue()

Default value to use in place of null if a result does not fit into any of the specified / calculated ranges.

Returns:

the value

toString

public String toString()

Overrides:

toString in class AbstractCommandDescriptor

toString

public String toString(boolean includeByteArrayContents)

Return a string representation of the object.

Overrides:

toString in class AbstractCommandDescriptor

Parameters:

includeByteArrayContents - true to include the full contents of byte arrays

Returns:

string representation

equals

public boolean equals(Object o)

Overrides:

equals in class AbstractCommandDescriptor

hashCode

public int hashCode()

Overrides:

hashCode in class AbstractCommandDescriptor