com.oracle.bmc.loganalytics.model

Class AbstractCommandDescriptor

java.lang.Object

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

com.oracle.bmc.loganalytics.model.AbstractCommandDescriptor

Direct Known Subclasses:

AddFieldsCommandDescriptor, AddInsightsCommandDescriptor, AnomalyCommandDescriptor, BottomCommandDescriptor, BucketCommandDescriptor, ClassifyCommandDescriptor, ClusterCommandDescriptor, ClusterCompareCommandDescriptor, ClusterDetailsCommandDescriptor, ClusterSplitCommandDescriptor, CommandDescriptor, CompareCommandDescriptor, CreateTableCommandDescriptor, CreateViewCommandDescriptor, DedupCommandDescriptor, DeleteCommandDescriptor, DeltaCommandDescriptor, DemoModeCommandDescriptor, DistinctCommandDescriptor, EvalCommandDescriptor, EventStatsCommandDescriptor, ExtractCommandDescriptor, FieldsCommandDescriptor, FieldSummaryCommandDescriptor, FrequentCommandDescriptor, GeoStatsCommandDescriptor, HeadCommandDescriptor, HighlightCommandDescriptor, HighlightGroupsCommandDescriptor, HighlightRowsCommandDescriptor, JsonExtractCommandDescriptor, LinkCommandDescriptor, LinkDetailsCommandDescriptor, LookupCommandDescriptor, MacroCommandDescriptor, MapCommandDescriptor, ModuleCommandDescriptor, MultiSearchCommandDescriptor, NlpCommandDescriptor, OutlierCommandDescriptor, RareCommandDescriptor, RegexCommandDescriptor, RenameCommandDescriptor, SearchCommandDescriptor, SearchLookupCommandDescriptor, SequenceCommandDescriptor, SortCommandDescriptor, StatsCommandDescriptor, TailCommandDescriptor, TimeClusterCommandDescriptor, TimeCompareCommandDescriptor, TimeStatsCommandDescriptor, TopCommandDescriptor, WhereCommandDescriptor, XmlExtractCommandDescriptor

@Generated(value="OracleSDKGenerator",
           comments="API Version: 20200601")
public class AbstractCommandDescriptor
extends com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

Generic command descriptor defining all attributes common to all querylanguage commands for parse output.
Note: Objects should always be created or deserialized using the 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 Builder, which maintain a set of all explicitly set fields called 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 and Description
static class	AbstractCommandDescriptor.Name Name of querylanguage command

Field Summary

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

EXPLICITLY_SET_FILTER_NAME, EXPLICITLY_SET_PROPERTY_NAME

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractCommandDescriptor(String displayQueryString, String internalQueryString, String category, List<AbstractField> referencedFields, List<AbstractField> declaredFields, Boolean isHidden) Deprecated.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object o)
String	getCategory() querylanguage command designation for example; reporting vs filtering
List<AbstractField>	getDeclaredFields() Fields declared in command fragment from user specified query string.
String	getDisplayQueryString() Command fragment display string from user specified query string formatted by query builder.
String	getInternalQueryString() Command fragment internal string from user specified query string formatted by query builder.
Boolean	getIsHidden() Field denoting if this is a hidden command that is not shown in the query string.
List<AbstractField>	getReferencedFields() Fields referenced in command fragment from user specified query string.
int	hashCode()
String	toString()
String	toString(boolean includeByteArrayContents) Return a string representation of the object.

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

AbstractCommandDescriptor

@Deprecated
 @ConstructorProperties(value={"displayQueryString","internalQueryString","category","referencedFields","declaredFields","isHidden"})
protected AbstractCommandDescriptor(String displayQueryString,
                                                                                                                                                                                      String internalQueryString,
                                                                                                                                                                                      String category,
                                                                                                                                                                                      List<AbstractField> referencedFields,
                                                                                                                                                                                      List<AbstractField> declaredFields,
                                                                                                                                                                                      Boolean isHidden)

Deprecated.

Method Detail

getDisplayQueryString

public String getDisplayQueryString()

Command fragment display string from user specified query string formatted by query builder.

Returns:

the value

getInternalQueryString

public String getInternalQueryString()

Command fragment internal string from user specified query string formatted by query builder.

Returns:

the value

getCategory

public String getCategory()

querylanguage command designation for example; reporting vs filtering

Returns:

the value

getReferencedFields

public List<AbstractField> getReferencedFields()

Fields referenced in command fragment from user specified query string.

Returns:

the value

getDeclaredFields

public List<AbstractField> getDeclaredFields()

Fields declared in command fragment from user specified query string.

Returns:

the value

getIsHidden

public Boolean getIsHidden()

Field denoting if this is a hidden command that is not shown in the query string.

Returns:

the value

toString

public String toString()

Overrides:

toString in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

toString

public String toString(boolean includeByteArrayContents)

Return a string representation of the object.

Parameters:

includeByteArrayContents - true to include the full contents of byte arrays

Returns:

string representation

equals

public boolean equals(Object o)

Overrides:

equals in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

hashCode

public int hashCode()

Overrides:

hashCode in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel