ReplicaStatsRequest

class borneo.ReplicaStatsRequest

Bases: Request

Cloud service only

Represents the argument of a NoSQLHandle.get_replica_stats(). operation which returns stats information for one, or all replicas of a replicated table, returned in ReplicaStatsResult. This information includes a time series of replica stats, as found in ReplicaStatsResult.ReplicaStats.

It is possible to return a range of stats records or, by default, only the most recent stats records if start_time is not specified. Replica stats records are created on a regular basis and maintained for a period of time. Only records for time periods that have completed are returned so that a user never sees changing data for a specific range.

Added in version 5.4.2.

Methods Summary

get_compartment()	Get the compartment id or name if set for the request.
get_limit()	Gets the limit to the number of replica stats records returned per replica (region).
get_replica_name()	Returns the replica name.
get_start_time()	Get the start time to use for the request in milliseconds since the epoch in UTC time
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)	Sets the name or id of a compartment to be used for this operation.
set_limit(limit)	Sets the limit to the number of replica stats records returned per replica (region).
set_replica_name(replica_name)	Sets the replica name(region) to be used to query for stats information.
set_start_time(start_time)	Sets the start time to use for the request in milliseconds since the Epoch in UTC time.
set_table_name(table_name)	Sets the table name to use for the operation.
set_timeout(timeout_ms)	Sets the request timeout value, in milliseconds.

Methods Documentation

get_compartment()

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

Cloud service only.

Returns:

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

Return type:

str

get_limit()

Gets the limit to the number of replica stats records returned per replica (region). Returns 0 if not set.

Returns:

the limit

Return type:

int

get_replica_name()

Returns the replica name.

Returns:

the replica name, or None if not set.

Returns:

str

get_start_time()

Get the start time to use for the request in milliseconds since the epoch in UTC time

Returns:

the start_time

Return type:

int

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)

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_limit(limit)

Sets the limit to the number of replica stats records returned per replica (region). The default value is 1000.

Param:

limit the limit

Returns:

self

set_replica_name(replica_name)

Sets the replica name(region) to be used to query for stats information. If not set information for all replicas is returned.

Parameters:

replica_name (str) – the name of the replica.

Returns:

self.

Raises:

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

set_start_time(start_time)

Sets the start time to use for the request in milliseconds since the Epoch in UTC time. If no start time is set for this request the most recent complete stats records are returned, the number of records is up to limit set by ReplicaStatsRequest.set_limit()

:param start_time the start_time :type start_time: int :returns: self.

set_table_name(table_name)

Sets the table name to use for the operation.

Parameters:

table_name (str) – the name of the table.

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.