com.oracle.bmc.loganalytics.model

Class HighlightCommandDescriptor

java.lang.Object

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

com.oracle.bmc.loganalytics.model.AbstractCommandDescriptor

com.oracle.bmc.loganalytics.model.HighlightCommandDescriptor

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

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

Method Summary

Modifier and Type	Method and Description
static HighlightCommandDescriptor.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 specified to highlight with the same color if matches found.
List<String>	getKeywords() List of terms or phrases to highlight if found.
int	hashCode()
HighlightCommandDescriptor.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

HighlightCommandDescriptor

@Deprecated
public HighlightCommandDescriptor(String displayQueryString,
                                              String internalQueryString,
                                              String category,
                                              List<AbstractField> referencedFields,
                                              List<AbstractField> declaredFields,
                                              Boolean isHidden,
                                              String color,
                                              List<String> fields,
                                              List<String> keywords)

Deprecated.

Method Detail

builder

public static HighlightCommandDescriptor.Builder builder()

Create a new builder.

toBuilder

public HighlightCommandDescriptor.Builder toBuilder()

getColor

public String getColor()

User specified color to highlight matches with if found.

Returns:

the value

getFields

public List<String> getFields()

List of fields specified to highlight with the same color if matches found.

Returns:

the value

getKeywords

public List<String> getKeywords()

List of terms or phrases to highlight if found.

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