RawExecuteSqlResponse (Kinetica Java API 7.2.3.1 API)

java.lang.Object
- com.gpudb.protocol.RawExecuteSqlResponse

All Implemented Interfaces:

org.apache.avro.generic.GenericContainer, org.apache.avro.generic.IndexedRecord
```
public class RawExecuteSqlResponse
extends Object
implements org.apache.avro.generic.IndexedRecord
```
A set of results returned by GPUdb.executeSqlRaw.

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`RawExecuteSqlResponse.HasMoreRecords` A set of string constants for the `RawExecuteSqlResponse` parameter `hasMoreRecords`.
`static class`	`RawExecuteSqlResponse.Info` A set of string constants for the `RawExecuteSqlResponse` parameter `info`.

Constructor Summary

Constructors
Constructor and Description

RawExecuteSqlResponse()
Constructs a RawExecuteSqlResponse object with default parameters.

Constructors
Constructor and Description
`RawExecuteSqlResponse()` Constructs a RawExecuteSqlResponse object with default parameters.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(Object obj)`
`Object`	`get(int index)` This method supports the Avro framework and is not intended to be called directly by the user.
`ByteBuffer`	`getBinaryEncodedResponse()` Avro binary encoded response.
`static org.apache.avro.Schema`	`getClassSchema()` This method supports the Avro framework and is not intended to be called directly by the user.
`long`	`getCountAffected()` The number of objects/records affected.
`boolean`	`getHasMoreRecords()` Too many records.
`Map<String,String>`	`getInfo()` Additional information.
`String`	`getJsonEncodedResponse()` Avro JSON encoded response.
`String`	`getPagingTable()` Name of the table that has the result records of the query.
`String`	`getResponseSchemaStr()` Avro schema of `binaryEncodedResponse` or `jsonEncodedResponse`.
`org.apache.avro.Schema`	`getSchema()` This method supports the Avro framework and is not intended to be called directly by the user.
`long`	`getTotalNumberOfRecords()` Total/Filtered number of records.
`int`	`hashCode()`
`void`	`put(int index, Object value)` This method supports the Avro framework and is not intended to be called directly by the user.
`RawExecuteSqlResponse`	`setBinaryEncodedResponse(ByteBuffer binaryEncodedResponse)` Avro binary encoded response.
`RawExecuteSqlResponse`	`setCountAffected(long countAffected)` The number of objects/records affected.
`RawExecuteSqlResponse`	`setHasMoreRecords(boolean hasMoreRecords)` Too many records.
`RawExecuteSqlResponse`	`setInfo(Map<String,String> info)` Additional information.
`RawExecuteSqlResponse`	`setJsonEncodedResponse(String jsonEncodedResponse)` Avro JSON encoded response.
`RawExecuteSqlResponse`	`setPagingTable(String pagingTable)` Name of the table that has the result records of the query.
`RawExecuteSqlResponse`	`setResponseSchemaStr(String responseSchemaStr)` Avro schema of `binaryEncodedResponse` or `jsonEncodedResponse`.
`RawExecuteSqlResponse`	`setTotalNumberOfRecords(long totalNumberOfRecords)` Total/Filtered number of records.
`String`	`toString()`

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - RawExecuteSqlResponse
```
public RawExecuteSqlResponse()
```
    Constructs a RawExecuteSqlResponse object with default parameters.
- Method Detail
  - getClassSchema
```
public static org.apache.avro.Schema getClassSchema()
```
    This method supports the Avro framework and is not intended to be called directly by the user.
    
    Returns:
    
    The schema for the class.
  - getCountAffected
```
public long getCountAffected()
```
    The number of objects/records affected.
    
    Returns:
    
    The current value of countAffected.
  - setCountAffected
```
public RawExecuteSqlResponse setCountAffected(long countAffected)
```
    The number of objects/records affected.
    
    Parameters:
    
    countAffected - The new value for countAffected.
    
    Returns:
    
    this to mimic the builder pattern.
  - getResponseSchemaStr
```
public String getResponseSchemaStr()
```
    Avro schema of binaryEncodedResponse or jsonEncodedResponse.
    
    Returns:
    
    The current value of responseSchemaStr.
  - setResponseSchemaStr
```
public RawExecuteSqlResponse setResponseSchemaStr(String responseSchemaStr)
```
    Avro schema of binaryEncodedResponse or jsonEncodedResponse.
    
    Parameters:
    
    responseSchemaStr - The new value for responseSchemaStr.
    
    Returns:
    
    this to mimic the builder pattern.
  - getBinaryEncodedResponse
```
public ByteBuffer getBinaryEncodedResponse()
```
    Avro binary encoded response.
    
    Returns:
    
    The current value of binaryEncodedResponse.
  - setBinaryEncodedResponse
```
public RawExecuteSqlResponse setBinaryEncodedResponse(ByteBuffer binaryEncodedResponse)
```
    Avro binary encoded response.
    
    Parameters:
    
    binaryEncodedResponse - The new value for binaryEncodedResponse.
    
    Returns:
    
    this to mimic the builder pattern.
  - getJsonEncodedResponse
```
public String getJsonEncodedResponse()
```
    Avro JSON encoded response.
    
    Returns:
    
    The current value of jsonEncodedResponse.
  - setJsonEncodedResponse
```
public RawExecuteSqlResponse setJsonEncodedResponse(String jsonEncodedResponse)
```
    Avro JSON encoded response.
    
    Parameters:
    
    jsonEncodedResponse - The new value for jsonEncodedResponse.
    
    Returns:
    
    this to mimic the builder pattern.
  - getTotalNumberOfRecords
```
public long getTotalNumberOfRecords()
```
    Total/Filtered number of records.
    
    Returns:
    
    The current value of totalNumberOfRecords.
  - setTotalNumberOfRecords
```
public RawExecuteSqlResponse setTotalNumberOfRecords(long totalNumberOfRecords)
```
    Total/Filtered number of records.
    
    Parameters:
    
    totalNumberOfRecords - The new value for totalNumberOfRecords.
    
    Returns:
    
    this to mimic the builder pattern.
  - getHasMoreRecords
```
public boolean getHasMoreRecords()
```
    Too many records. Returned a partial set. Supported values:
    - true
    - false
    Returns:
    
    The current value of hasMoreRecords.
  - setHasMoreRecords
```
public RawExecuteSqlResponse setHasMoreRecords(boolean hasMoreRecords)
```
    Too many records. Returned a partial set. Supported values:
    - true
    - false
    Parameters:
    
    hasMoreRecords - The new value for hasMoreRecords.
    
    Returns:
    
    this to mimic the builder pattern.
  - getPagingTable
```
public String getPagingTable()
```
    Name of the table that has the result records of the query. Valid, when hasMoreRecords is TRUE. The caller should clear this and all tables in RESULT_TABLE_LIST when they are done querying.
    
    Returns:
    
    The current value of pagingTable.
  - setPagingTable
```
public RawExecuteSqlResponse setPagingTable(String pagingTable)
```
    Name of the table that has the result records of the query. Valid, when hasMoreRecords is TRUE. The caller should clear this and all tables in RESULT_TABLE_LIST when they are done querying.
    
    Parameters:
    
    pagingTable - The new value for pagingTable.
    
    Returns:
    
    this to mimic the builder pattern.
  - getInfo
```
public Map<String,String> getInfo()
```
    Additional information.
    - COUNT: Number of records without final limits applied
    - RESULT_TABLE_LIST: List of tables, comma-separated, in addition to the pagingTable, created as result of the query. These should be cleared by the caller when they are done querying.
    The default value is an empty Map.
    Returns:
    
    The current value of info.
  - setInfo
```
public RawExecuteSqlResponse setInfo(Map<String,String> info)
```
    Additional information.
    - COUNT: Number of records without final limits applied
    - RESULT_TABLE_LIST: List of tables, comma-separated, in addition to the pagingTable, created as result of the query. These should be cleared by the caller when they are done querying.
    The default value is an empty Map.
    Parameters:
    
    info - The new value for info.
    
    Returns:
    
    this to mimic the builder pattern.
  - getSchema
```
public org.apache.avro.Schema getSchema()
```
    This method supports the Avro framework and is not intended to be called directly by the user.
    
    Specified by:
    
    getSchema in interface org.apache.avro.generic.GenericContainer
    
    Returns:
    
    The schema object describing this class.
  - get
```
public Object get(int index)
```
    This method supports the Avro framework and is not intended to be called directly by the user.
    
    Specified by:
    
    get in interface org.apache.avro.generic.IndexedRecord
    
    Parameters:
    
    index - the position of the field to get
    
    Returns:
    
    value of the field with the given index.
    
    Throws:
    
    IndexOutOfBoundsException
  - put
```
public void put(int index,
                Object value)
```
    This method supports the Avro framework and is not intended to be called directly by the user.
    
    Specified by:
    
    put in interface org.apache.avro.generic.IndexedRecord
    
    Parameters:
    
    index - the position of the field to set
    
    value - the value to set
    
    Throws:
    
    IndexOutOfBoundsException
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object

Class RawExecuteSqlResponse

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

RawExecuteSqlResponse

Method Detail

getClassSchema

getCountAffected

setCountAffected

getResponseSchemaStr

setResponseSchemaStr

getBinaryEncodedResponse

setBinaryEncodedResponse

getJsonEncodedResponse

setJsonEncodedResponse

getTotalNumberOfRecords

setTotalNumberOfRecords

getHasMoreRecords

setHasMoreRecords

getPagingTable

setPagingTable

getInfo

setInfo

getSchema

get

put

equals

toString

hashCode