Package com.oracle.bmc.loganalytics.model

Class AbstractField

java.lang.Object

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

com.oracle.bmc.loganalytics.model.AbstractField

Direct Known Subclasses:

Field, FieldsAddRemoveField, FunctionField, SortField

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

Generic field defining all attributes common to all querylanguage fields.
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	Description
static class	AbstractField.Name	Field type classification.

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	Description
protected	AbstractField(String displayName, Boolean isDeclared, List<String> originalDisplayNames, String internalName, ValueType valueType, Boolean isGroupable, Boolean isDuration, String alias, String filterQueryString, String unitType)	Deprecated.

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
String	getAlias()	Alias of field if renamed by queryStrng.
String	getDisplayName()	Field display name - will be alias if field is renamed by queryStrng.
String	getFilterQueryString()	Query used to derive this field if specified.
String	getInternalName()	Internal identifier for the field.
Boolean	getIsDeclared()	Field denoting if this is a declaration of the field in the queryString.
Boolean	getIsDuration()	Identifies if this field format is a duration.
Boolean	getIsGroupable()	Identifies if this field can be used as a grouping field in any grouping command.
List<String>	getOriginalDisplayNames()	Same as displayName unless field renamed in which case this will hold the original display names for the field across all renames.
String	getUnitType()	Field denoting field unit type.
ValueType	getValueType()	Field denoting field data type.
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

AbstractField

@Deprecated
@ConstructorProperties({"displayName","isDeclared","originalDisplayNames","internalName","valueType","isGroupable","isDuration","alias","filterQueryString","unitType"})
protected AbstractField(String displayName,
                        Boolean isDeclared,
                        List<String> originalDisplayNames,
                        String internalName,
                        ValueType valueType,
                        Boolean isGroupable,
                        Boolean isDuration,
                        String alias,
                        String filterQueryString,
                        String unitType)

Deprecated.

Method Detail

getDisplayName

public String getDisplayName()

Field display name - will be alias if field is renamed by queryStrng.

Returns:

the value

getIsDeclared

public Boolean getIsDeclared()

Field denoting if this is a declaration of the field in the queryString.

Returns:

the value

getOriginalDisplayNames

public List<String> getOriginalDisplayNames()

Same as displayName unless field renamed in which case this will hold the original display names for the field across all renames.

Returns:

the value

getInternalName

public String getInternalName()

Internal identifier for the field.

Returns:

the value

getValueType

public ValueType getValueType()

Field denoting field data type.

Returns:

the value

getIsGroupable

public Boolean getIsGroupable()

Identifies if this field can be used as a grouping field in any grouping command.

Returns:

the value

getIsDuration

public Boolean getIsDuration()

Identifies if this field format is a duration.

Returns:

the value

getAlias

public String getAlias()

Alias of field if renamed by queryStrng.

Returns:

the value

getFilterQueryString

public String getFilterQueryString()

Query used to derive this field if specified.

Returns:

the value

getUnitType

public String getUnitType()

Field denoting field unit type.

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