Package com.oracle.bmc.loganalytics.model

Class TimeClusterCommandDescriptor

java.lang.Object

com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

com.oracle.bmc.loganalytics.model.AbstractCommandDescriptor

com.oracle.bmc.loganalytics.model.TimeClusterCommandDescriptor

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

Command descriptor for querylanguage TIMECLUSTER command.
Note: Objects should always be created or deserialized using the TimeClusterCommandDescriptor.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 TimeClusterCommandDescriptor.Builder, which maintain a set of all explicitly set fields called TimeClusterCommandDescriptor.Builder.__explicitlySet__. The hashCode() and equals(Object) methods are implemented to take the explicitly set fields into account. The constructor, on the other hand, does not take the explicitly set fields into account (since the constructor cannot distinguish explicit null from unset null).

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	TimeClusterCommandDescriptor.Builder

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

AbstractCommandDescriptor.Name

Field Summary

Fields inherited from class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

EXPLICITLY_SET_FILTER_NAME, EXPLICITLY_SET_PROPERTY_NAME

Constructor Summary

Constructors

Constructor	Description
TimeClusterCommandDescriptor(String displayQueryString, String internalQueryString, String category, List<AbstractField> referencedFields, List<AbstractField> declaredFields, Boolean isHidden, AbstractField time, String span, List<AbstractField> groupByFields, List<FunctionField> functions)	Deprecated.

Method Summary

Modifier and Type	Method	Description
static TimeClusterCommandDescriptor.Builder	builder()	Create a new builder.
boolean	equals(Object o)
List<FunctionField>	getFunctions()	Statistical functions specified in the query string.
List<AbstractField>	getGroupByFields()	Group by fields specified in the query string.
String	getSpan()	Option to control the size of buckets in the timeseries.
AbstractField	getTime()	Optional timestamp datatype field if specified.
int	hashCode()
TimeClusterCommandDescriptor.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, getIsHidden, getReferencedFields

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

markPropertyAsExplicitlySet, wasPropertyExplicitlySet

Methods inherited from class java.lang.Object

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

Constructor Detail

TimeClusterCommandDescriptor

@Deprecated
public TimeClusterCommandDescriptor(String displayQueryString,
                                    String internalQueryString,
                                    String category,
                                    List<AbstractField> referencedFields,
                                    List<AbstractField> declaredFields,
                                    Boolean isHidden,
                                    AbstractField time,
                                    String span,
                                    List<AbstractField> groupByFields,
                                    List<FunctionField> functions)

Deprecated.

Method Detail

builder

public static TimeClusterCommandDescriptor.Builder builder()

Create a new builder.

toBuilder

public TimeClusterCommandDescriptor.Builder toBuilder()

getTime

public AbstractField getTime()

Optional timestamp datatype field if specified.

Default field is ‘Start Time’.

Returns:

the value

getSpan

public String getSpan()

Option to control the size of buckets in the timeseries.

Will be adjusted to a larger span if time range is very large.

Returns:

the value

getGroupByFields

public List<AbstractField> getGroupByFields()

Group by fields specified in the query string.

Returns:

the value

getFunctions

public List<FunctionField> getFunctions()

Statistical functions specified in the query string.

Atleast 1 is required for a TIMECLUSTER command.

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