Package com.oracle.bmc.loganalytics.model

Class GeoStatsCommandDescriptor

java.lang.Object

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

com.oracle.bmc.loganalytics.model.AbstractCommandDescriptor

com.oracle.bmc.loganalytics.model.GeoStatsCommandDescriptor

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

Command descriptor for querylanguage GEOSTATS command.

This is similiar to STATS with some built in functions for City, State and Country by Coordinates.
Note: Objects should always be created or deserialized using the GeoStatsCommandDescriptor.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 GeoStatsCommandDescriptor.Builder, which maintain a set of all explicitly set fields called GeoStatsCommandDescriptor.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	GeoStatsCommandDescriptor.Builder
static class	GeoStatsCommandDescriptor.Include	Indicates which coordinates to show.

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

GeoStatsCommandDescriptor(String displayQueryString, String internalQueryString, String category, List<AbstractField> referencedFields, List<AbstractField> declaredFields, Boolean isHidden, GeoStatsCommandDescriptor.Include include, AbstractField cityField, AbstractField regionField, AbstractField countryField, AbstractField continentField, AbstractField coordinatesField, List<AbstractField> groupByFields, List<FunctionField> functions)

Deprecated.

Method Summary

Modifier and Type	Method	Description
static GeoStatsCommandDescriptor.Builder	builder()	Create a new builder.
boolean	equals(Object o)
AbstractField	getCityField()	The city field to use.
AbstractField	getContinentField()	The continent field to use.
AbstractField	getCoordinatesField()	The coordinates field to use.
AbstractField	getCountryField()	The country field to use.
List<FunctionField>	getFunctions()	Statistical functions specified in the query string.
List<AbstractField>	getGroupByFields()	Group by fields if specified in the query string.
GeoStatsCommandDescriptor.Include	getInclude()	Indicates which coordinates to show.
AbstractField	getRegionField()	The region field to use.
int	hashCode()
GeoStatsCommandDescriptor.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

GeoStatsCommandDescriptor

@Deprecated
public GeoStatsCommandDescriptor(String displayQueryString,
                                 String internalQueryString,
                                 String category,
                                 List<AbstractField> referencedFields,
                                 List<AbstractField> declaredFields,
                                 Boolean isHidden,
                                 GeoStatsCommandDescriptor.Include include,
                                 AbstractField cityField,
                                 AbstractField regionField,
                                 AbstractField countryField,
                                 AbstractField continentField,
                                 AbstractField coordinatesField,
                                 List<AbstractField> groupByFields,
                                 List<FunctionField> functions)

Deprecated.

Method Detail

builder

public static GeoStatsCommandDescriptor.Builder builder()

Create a new builder.

toBuilder

public GeoStatsCommandDescriptor.Builder toBuilder()

getInclude

public GeoStatsCommandDescriptor.Include getInclude()

Indicates which coordinates to show.

Either client, server, client and server or custom. If custom is specified at least one of coordinatesField, regionField or countryField is required. Defaults to client.

Returns:

the value

getCityField

public AbstractField getCityField()

The city field to use.

Only applicable when include = CUSTOM.

Returns:

the value

getRegionField

public AbstractField getRegionField()

The region field to use.

Only applicable when include = CUSTOM.

Returns:

the value

getCountryField

public AbstractField getCountryField()

The country field to use.

Only applicable when include = CUSTOM.

Returns:

the value

getContinentField

public AbstractField getContinentField()

The continent field to use.

Only applicable when include = CUSTOM.

Returns:

the value

getCoordinatesField

public AbstractField getCoordinatesField()

The coordinates field to use.

Only applicable when include = CUSTOM.

Returns:

the value

getGroupByFields

public List<AbstractField> getGroupByFields()

Group by fields if specified in the query string.

Required if include = CUSTOM.

Returns:

the value

getFunctions

public List<FunctionField> getFunctions()

Statistical functions specified in the query string.

At least 1 is required for a GEOSTATS 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