public class GetRecordsFromCollectionRequest extends Object implements org.apache.avro.generic.IndexedRecord
GPUdb.getRecordsFromCollectionRaw(GetRecordsFromCollectionRequest)
.
GPUdb.deleteRecords(DeleteRecordsRequest)
.
offset
and limit
parameters.
Modifier and Type | Class and Description |
---|---|
static class |
GetRecordsFromCollectionRequest.Encoding
Specifies the encoding for returned records; either 'binary' or 'json'.
|
static class |
GetRecordsFromCollectionRequest.Options
return_record_ids: If 'true' then return GPUdb's internal record id along with each returned record. |
Constructor and Description |
---|
GetRecordsFromCollectionRequest()
Constructs a GetRecordsFromCollectionRequest object with default parameters.
|
GetRecordsFromCollectionRequest(String tableName,
long offset,
long limit,
Map<String,String> options)
Constructs a GetRecordsFromCollectionRequest object with the specified parameters.
|
GetRecordsFromCollectionRequest(String tableName,
long offset,
long limit,
String encoding,
Map<String,String> options)
Constructs a GetRecordsFromCollectionRequest object with the specified parameters.
|
Modifier and Type | Method and Description |
---|---|
boolean |
equals(Object obj)
The Raw version of this method can be used to specify the encoding scheme of the response.
|
Object |
get(int index)
This method supports the Avro framework and is not intended to be called directly by the user.
|
static org.apache.avro.Schema |
getClassSchema()
This method supports the Avro framework and is not intended to be called directly by the user.
|
String |
getEncoding()
The Raw version of this method can be used to specify the encoding scheme of the response.
|
long |
getLimit()
The Raw version of this method can be used to specify the encoding scheme of the response.
|
long |
getOffset()
The Raw version of this method can be used to specify the encoding scheme of the response.
|
Map<String,String> |
getOptions()
The Raw version of this method can be used to specify the encoding scheme of the response.
|
org.apache.avro.Schema |
getSchema()
This method supports the Avro framework and is not intended to be called directly by the user.
|
String |
getTableName()
The Raw version of this method can be used to specify the encoding scheme of the response.
|
int |
hashCode()
The Raw version of this method can be used to specify the encoding scheme of the response.
|
void |
put(int index,
Object value)
This method supports the Avro framework and is not intended to be called directly by the user.
|
GetRecordsFromCollectionRequest |
setEncoding(String encoding)
The Raw version of this method can be used to specify the encoding scheme of the response.
|
GetRecordsFromCollectionRequest |
setLimit(long limit)
The Raw version of this method can be used to specify the encoding scheme of the response.
|
GetRecordsFromCollectionRequest |
setOffset(long offset)
The Raw version of this method can be used to specify the encoding scheme of the response.
|
GetRecordsFromCollectionRequest |
setOptions(Map<String,String> options)
The Raw version of this method can be used to specify the encoding scheme of the response.
|
GetRecordsFromCollectionRequest |
setTableName(String tableName)
The Raw version of this method can be used to specify the encoding scheme of the response.
|
String |
toString()
The Raw version of this method can be used to specify the encoding scheme of the response.
|
public GetRecordsFromCollectionRequest()
public GetRecordsFromCollectionRequest(String tableName, long offset, long limit, Map<String,String> options)
tableName
- Name of the collection or table from which records are to be retrieved. Must be an existing GPUdb
collection or table.offset
- A positive integer indicating the number of initial results to skip (this can be useful for paging through the
results). The minimum allowed value is 0. The maximum allowed value is MAX_INT.limit
- A positive integer indicating the maximum number of results to be returned, or END_OF_SET (-9999) to indicate
that the max number of results should be returned.options
- public GetRecordsFromCollectionRequest(String tableName, long offset, long limit, String encoding, Map<String,String> options)
tableName
- Name of the collection or table from which records are to be retrieved. Must be an existing GPUdb
collection or table.offset
- A positive integer indicating the number of initial results to skip (this can be useful for paging through the
results). The minimum allowed value is 0. The maximum allowed value is MAX_INT.limit
- A positive integer indicating the maximum number of results to be returned, or END_OF_SET (-9999) to indicate
that the max number of results should be returned.encoding
- Specifies the encoding for returned records; either 'binary' or 'json'. Values: binary, json.options
- public static org.apache.avro.Schema getClassSchema()
public String getTableName()
public GetRecordsFromCollectionRequest setTableName(String tableName)
tableName
- Name of the collection or table from which records are to be retrieved. Must be an existing GPUdb
collection or table.this
to mimic the builder pattern.public long getOffset()
public GetRecordsFromCollectionRequest setOffset(long offset)
offset
- A positive integer indicating the number of initial results to skip (this can be useful for paging through the
results). The minimum allowed value is 0. The maximum allowed value is MAX_INT.this
to mimic the builder pattern.public long getLimit()
public GetRecordsFromCollectionRequest setLimit(long limit)
limit
- A positive integer indicating the maximum number of results to be returned, or END_OF_SET (-9999) to indicate
that the max number of results should be returned.this
to mimic the builder pattern.public String getEncoding()
public GetRecordsFromCollectionRequest setEncoding(String encoding)
encoding
- Specifies the encoding for returned records; either 'binary' or 'json'. Values: binary, json.this
to mimic the builder pattern.public Map<String,String> getOptions()
public GetRecordsFromCollectionRequest setOptions(Map<String,String> options)
options
- this
to mimic the builder pattern.public org.apache.avro.Schema getSchema()
getSchema
in interface org.apache.avro.generic.GenericContainer
public Object get(int index)
get
in interface org.apache.avro.generic.IndexedRecord
index
- the position of the field to getIndexOutOfBoundsException
public void put(int index, Object value)
put
in interface org.apache.avro.generic.IndexedRecord
index
- the position of the field to setvalue
- the value to setIndexOutOfBoundsException
public boolean equals(Object obj)
public String toString()
Copyright © 2016. All rights reserved.