GetIndexesRequest

class borneo.GetIndexesRequest

Bases: Request

Represents the argument of a NoSQLHandle.get_indexes() operation which returns the information of a specific index or all indexes of the specified table, as returned in GetIndexesResult.

The table name is a required parameter.

Methods Summary

get_compartment()	Cloud service only.
get_index_name()	Gets the index name to use for the request.
get_table_name()	Returns the table name to use for the operation.
get_timeout()	Returns the timeout to use for the operation, in milliseconds.
set_compartment(compartment)	Cloud service only.
set_index_name(index_name)	Sets the index name to use for the request.
set_table_name(table_name)	Sets the table name to use for the request.
set_timeout(timeout_ms)	Sets the request timeout value, in milliseconds.

Methods Documentation

get_compartment()

Cloud service only.

Get the compartment id or name if set for the request.

Returns:

compartment id or name if set for the request, otherwise None if not set.

Return type:

str

get_index_name()

Gets the index name to use for the request.

Returns:

the index name.

Return type:

str

get_table_name()

Returns the table name to use for the operation.

Returns:

the table name, or None if not set.

Returns:

str

get_timeout()

Returns the timeout to use for the operation, in milliseconds. A value of 0 indicates that the timeout has not been set.

Returns:

the timeout value.

Return type:

int

set_compartment(compartment)

Cloud service only.

Sets the name or id of a compartment to be used for this operation.

The compartment may be specified as either a name (or path for nested compartments) or as an id (OCID). A name (vs id) can only be used when authenticated using a specific user identity. It is not available if authenticated as an Instance Principal which can be done when calling the service from a compute instance in the Oracle Cloud Infrastructure. See borneo.iam.SignatureProvider.create_with_instance_principal().

Parameters:

compartment (str) – the compartment name or id. If using a nested compartment, specify the full compartment path compartmentA.compartmentB, but exclude the name of the root compartment (tenant).

Returns:

self.

Raises:

IllegalArgumentException – raises the exception if compartment is not a str.

set_index_name(index_name)

Sets the index name to use for the request. If not set, this request will return all indexes of the table.

Parameters:

index_name (str) – the index name.

Returns:

self.

Raises:

IllegalArgumentException – raises the exception if index_name is not a string.

set_table_name(table_name)

Sets the table name to use for the request.

Parameters:

table_name (str) – the table name. This is a required parameter.

Returns:

self.

Raises:

IllegalArgumentException – raises the exception if table_name is not a string.

set_timeout(timeout_ms)

Sets the request timeout value, in milliseconds. This overrides any default value set in NoSQLHandleConfig. The value must be positive.

Parameters:

timeout_ms (int) – the timeout value, in milliseconds.

Returns:

self.

Raises:

IllegalArgumentException – raises the exception if the timeout value is less than or equal to 0.