DataObjectQuery¶
-
class
oci.opsi.models.
DataObjectQuery
(**kwargs)¶ Bases:
object
Information required to form and execute query on a data object.
Attributes
QUERY_TYPE_STANDARD_QUERY
A constant which can be used with the query_type property of a DataObjectQuery. QUERY_TYPE_TEMPLATIZED_QUERY
A constant which can be used with the query_type property of a DataObjectQuery. bind_params
Gets the bind_params of this DataObjectQuery. query_execution_timeout_in_seconds
Gets the query_execution_timeout_in_seconds of this DataObjectQuery. query_type
[Required] Gets the query_type of this DataObjectQuery. Methods
__init__
(**kwargs)Initializes a new DataObjectQuery object with values from keyword arguments. get_subtype
(object_dictionary)Given the hash representation of a subtype of this class, use the info in the hash to return the class of the subtype. -
QUERY_TYPE_STANDARD_QUERY
= 'STANDARD_QUERY'¶ A constant which can be used with the query_type property of a DataObjectQuery. This constant has a value of “STANDARD_QUERY”
-
QUERY_TYPE_TEMPLATIZED_QUERY
= 'TEMPLATIZED_QUERY'¶ A constant which can be used with the query_type property of a DataObjectQuery. This constant has a value of “TEMPLATIZED_QUERY”
-
__init__
(**kwargs)¶ Initializes a new DataObjectQuery object with values from keyword arguments. This class has the following subclasses and if you are using this class as input to a service operations then you should favor using a subclass over the base class:
The following keyword arguments are supported (corresponding to the getters/setters of this class):
Parameters: - query_type (str) – The value to assign to the query_type property of this DataObjectQuery. Allowed values for this property are: “TEMPLATIZED_QUERY”, “STANDARD_QUERY”
- bind_params (list[oci.opsi.models.DataObjectBindParameter]) – The value to assign to the bind_params property of this DataObjectQuery.
- query_execution_timeout_in_seconds (float) – The value to assign to the query_execution_timeout_in_seconds property of this DataObjectQuery.
-
bind_params
¶ Gets the bind_params of this DataObjectQuery. List of bind parameters to be applied in the query.
Returns: The bind_params of this DataObjectQuery. Return type: list[oci.opsi.models.DataObjectBindParameter]
-
static
get_subtype
(object_dictionary)¶ Given the hash representation of a subtype of this class, use the info in the hash to return the class of the subtype.
-
query_execution_timeout_in_seconds
¶ Gets the query_execution_timeout_in_seconds of this DataObjectQuery. Timeout (in seconds) to be set for the data object query execution.
Returns: The query_execution_timeout_in_seconds of this DataObjectQuery. Return type: float
-
query_type
¶ [Required] Gets the query_type of this DataObjectQuery. Type of Query
Allowed values for this property are: “TEMPLATIZED_QUERY”, “STANDARD_QUERY”
Returns: The query_type of this DataObjectQuery. Return type: str
-