public class FilterByValueRequest extends Object implements org.apache.avro.generic.IndexedRecord
GPUdb.filterByValue(FilterByValueRequest)
.
Calculates which objects from a table has a particular value for a particular column. The input parameters provide a way to specify either a String or a Double valued column and a desired value for the column on which the filter is performed. The operation is synchronous, meaning that a response will not be returned until all the objects are fully available. The response payload provides the count of the resulting set. A new result view which satisfies the input filter restriction specification is also created with a view name passed in as part of the input payload. Although this functionality can also be accomplished with the standard filter function, it is more efficient.
Modifier and Type | Class and Description |
---|---|
static class |
FilterByValueRequest.Options
Optional parameters.
|
Constructor and Description |
---|
FilterByValueRequest()
Constructs a FilterByValueRequest object with default parameters.
|
FilterByValueRequest(String tableName,
String viewName,
boolean isString,
double value,
String valueStr,
String columnName,
Map<String,String> options)
Constructs a FilterByValueRequest object with the specified parameters.
|
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.
|
static org.apache.avro.Schema |
getClassSchema()
This method supports the Avro framework and is not intended to be called
directly by the user.
|
String |
getColumnName() |
boolean |
getIsString() |
Map<String,String> |
getOptions() |
org.apache.avro.Schema |
getSchema()
This method supports the Avro framework and is not intended to be called
directly by the user.
|
String |
getTableName() |
double |
getValue() |
String |
getValueStr() |
String |
getViewName() |
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.
|
FilterByValueRequest |
setColumnName(String columnName) |
FilterByValueRequest |
setIsString(boolean isString) |
FilterByValueRequest |
setOptions(Map<String,String> options) |
FilterByValueRequest |
setTableName(String tableName) |
FilterByValueRequest |
setValue(double value) |
FilterByValueRequest |
setValueStr(String valueStr) |
FilterByValueRequest |
setViewName(String viewName) |
String |
toString() |
public FilterByValueRequest()
public FilterByValueRequest(String tableName, String viewName, boolean isString, double value, String valueStr, String columnName, Map<String,String> options)
tableName
- Name of an existing table on which to perform the
calculation, in [schema_name.]table_name format, using
standard name resolution rules.viewName
- If provided, then this will be the name of the view
containing the results, in [schema_name.]view_name
format, using standard name resolution rules and meeting table naming criteria. Must not be
an already existing table or view. The default value
is ''.isString
- Indicates whether the value being searched for is
string or numeric.value
- The value to search for. The default value is 0.valueStr
- The string value to search for. The default value is
''.columnName
- Name of a column on which the filter by value would
be applied.options
- Optional parameters.
CREATE_TEMP_TABLE
: If true
, a unique temporary
table name will be generated in the sys_temp schema and
used in place of viewName
. This is always
allowed even if the caller does not have permission to
create tables. The generated name is returned in qualified_view_name
.
Supported values:
The default value is FALSE
.
COLLECTION_NAME
: [DEPRECATED--please specify the
containing schema for the view as part of viewName
and use GPUdb.createSchema(CreateSchemaRequest)
to
create the schema if non-existent] Name of a schema for
the newly created view. If the schema is non-existent,
it will be automatically created.
Map
.public static org.apache.avro.Schema getClassSchema()
public String getTableName()
public FilterByValueRequest setTableName(String tableName)
tableName
- Name of an existing table on which to perform the
calculation, in [schema_name.]table_name format, using
standard name resolution rules.this
to mimic the builder pattern.public String getViewName()
public FilterByValueRequest setViewName(String viewName)
viewName
- If provided, then this will be the name of the view
containing the results, in [schema_name.]view_name
format, using standard name resolution rules and meeting table naming criteria. Must not be
an already existing table or view. The default value
is ''.this
to mimic the builder pattern.public boolean getIsString()
public FilterByValueRequest setIsString(boolean isString)
isString
- Indicates whether the value being searched for is
string or numeric.this
to mimic the builder pattern.public double getValue()
public FilterByValueRequest setValue(double value)
value
- The value to search for. The default value is 0.this
to mimic the builder pattern.public String getValueStr()
public FilterByValueRequest setValueStr(String valueStr)
valueStr
- The string value to search for. The default value is
''.this
to mimic the builder pattern.public String getColumnName()
public FilterByValueRequest setColumnName(String columnName)
columnName
- Name of a column on which the filter by value would
be applied.this
to mimic the builder pattern.public Map<String,String> getOptions()
CREATE_TEMP_TABLE
: If true
, a unique temporary table
name will be generated in the sys_temp schema and used in place
of viewName
. This is always allowed even if the caller
does not have permission to create tables. The generated name is
returned in qualified_view_name
.
Supported values:
The default value is FALSE
.
COLLECTION_NAME
: [DEPRECATED--please specify the containing
schema for the view as part of viewName
and use GPUdb.createSchema(CreateSchemaRequest)
to create the
schema if non-existent] Name of a schema for the newly created
view. If the schema is non-existent, it will be automatically
created.
Map
.public FilterByValueRequest setOptions(Map<String,String> options)
options
- Optional parameters.
CREATE_TEMP_TABLE
: If true
, a unique temporary
table name will be generated in the sys_temp schema and
used in place of viewName
. This is always
allowed even if the caller does not have permission to
create tables. The generated name is returned in qualified_view_name
.
Supported values:
The default value is FALSE
.
COLLECTION_NAME
: [DEPRECATED--please specify the
containing schema for the view as part of viewName
and use GPUdb.createSchema(CreateSchemaRequest)
to
create the schema if non-existent] Name of a schema for
the newly created view. If the schema is non-existent,
it will be automatically created.
Map
.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
Copyright © 2024. All rights reserved.