Package com.oracle.bmc.loganalytics.model

Class HighlightGroupsCommandDescriptor

java.lang.Object

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

com.oracle.bmc.loganalytics.model.AbstractCommandDescriptor

com.oracle.bmc.loganalytics.model.HighlightGroupsCommandDescriptor

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

Command descriptor for querylanguage HIGHLIGHTGROUPS command.
Note: Objects should always be created or deserialized using the HighlightGroupsCommandDescriptor.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 HighlightGroupsCommandDescriptor.Builder, which maintain a set of all explicitly set fields called HighlightGroupsCommandDescriptor.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	HighlightGroupsCommandDescriptor.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
HighlightGroupsCommandDescriptor(String displayQueryString, String internalQueryString, String category, List<AbstractField> referencedFields, List<AbstractField> declaredFields, Boolean isHidden, String color, String priority, List<String> matchOnly, List<String> fields, List<String> keywords, List<ParseQueryOutput> subQueries)	Deprecated.

Method Summary

Modifier and Type	Method	Description
static HighlightGroupsCommandDescriptor.Builder	builder()	Create a new builder.
boolean	equals(Object o)
String	getColor()	User specified color to highlight matches with if found.
List<String>	getFields()	List of fields to search for terms or phrases to highlight.
List<String>	getKeywords()	List of terms or phrases to highlight if found.
List<String>	getMatchOnly()	List of fields to search for terms or phrases to highlight.
String	getPriority()	User specified priority assigned to highlighted matches if found.
List<ParseQueryOutput>	getSubQueries()	List of subQueries specified as highlightgroups command arguments
int	hashCode()
HighlightGroupsCommandDescriptor.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

HighlightGroupsCommandDescriptor

@Deprecated
public HighlightGroupsCommandDescriptor(String displayQueryString,
                                        String internalQueryString,
                                        String category,
                                        List<AbstractField> referencedFields,
                                        List<AbstractField> declaredFields,
                                        Boolean isHidden,
                                        String color,
                                        String priority,
                                        List<String> matchOnly,
                                        List<String> fields,
                                        List<String> keywords,
                                        List<ParseQueryOutput> subQueries)

Deprecated.

Method Detail

builder

public static HighlightGroupsCommandDescriptor.Builder builder()

Create a new builder.

toBuilder

public HighlightGroupsCommandDescriptor.Builder toBuilder()

getColor

public String getColor()

User specified color to highlight matches with if found.

Returns:

the value

getPriority

public String getPriority()

User specified priority assigned to highlighted matches if found.

Returns:

the value

getMatchOnly

public List<String> getMatchOnly()

List of fields to search for terms or phrases to highlight.

If not specified all string fields are scanned.

Returns:

the value

getFields

public List<String> getFields()

List of fields to search for terms or phrases to highlight.

Returns:

the value

getKeywords

public List<String> getKeywords()

List of terms or phrases to highlight if found.

Returns:

the value

getSubQueries

public List<ParseQueryOutput> getSubQueries()

List of subQueries specified as highlightgroups command arguments

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