com.oracle.bmc.nosql.model

Class QueryDetails

java.lang.Object

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

com.oracle.bmc.nosql.model.QueryDetails

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

All the information surrounding a query, including the query statement, limits, consistency, and so forth.
Note: Objects should always be created or deserialized using the QueryDetails.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 QueryDetails.Builder, which maintain a set of all explicitly set fields called QueryDetails.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	QueryDetails.Builder
static class	QueryDetails.Consistency Consistency requirement for a read operation.

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
QueryDetails(String compartmentId, String statement, Boolean isPrepared, QueryDetails.Consistency consistency, Integer maxReadInKBs, Map<String,Object> variables, Integer timeoutInMs) Deprecated.

Method Summary

Modifier and Type	Method and Description
static QueryDetails.Builder	builder() Create a new builder.
boolean	equals(Object o)
String	getCompartmentId() Compartment OCID, to provide context for a table name in the given statement.
QueryDetails.Consistency	getConsistency() Consistency requirement for a read operation.
Boolean	getIsPrepared() If true, the statement is a prepared statement.
Integer	getMaxReadInKBs() A limit on the total amount of data read during this operation, in KB.
String	getStatement() A NoSQL SQL query statement; or a Base64-encoded prepared statement.
Integer	getTimeoutInMs() Timeout setting for the query.
Map<String,Object>	getVariables() A map of prepared statement variables to values.
int	hashCode()
QueryDetails.Builder	toBuilder()
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

QueryDetails

@Deprecated
 @ConstructorProperties(value={"compartmentId","statement","isPrepared","consistency","maxReadInKBs","variables","timeoutInMs"})
public QueryDetails(String compartmentId,
                                                                                                                                                                 String statement,
                                                                                                                                                                 Boolean isPrepared,
                                                                                                                                                                 QueryDetails.Consistency consistency,
                                                                                                                                                                 Integer maxReadInKBs,
                                                                                                                                                                 Map<String,Object> variables,
                                                                                                                                                                 Integer timeoutInMs)

Deprecated.

Method Detail

builder

public static QueryDetails.Builder builder()

Create a new builder.

toBuilder

public QueryDetails.Builder toBuilder()

getCompartmentId

public String getCompartmentId()

Compartment OCID, to provide context for a table name in the given statement.

Returns:

the value

getStatement

public String getStatement()

A NoSQL SQL query statement; or a Base64-encoded prepared statement.

Returns:

the value

getIsPrepared

public Boolean getIsPrepared()

If true, the statement is a prepared statement.

Returns:

the value

getConsistency

public QueryDetails.Consistency getConsistency()

Consistency requirement for a read operation.

Returns:

the value

getMaxReadInKBs

public Integer getMaxReadInKBs()

A limit on the total amount of data read during this operation, in KB.

Returns:

the value

getVariables

public Map<String,Object> getVariables()

A map of prepared statement variables to values.

Returns:

the value

getTimeoutInMs

public Integer getTimeoutInMs()

Timeout setting for the query.

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