IndexSummary¶

class oci.nosql.models.IndexSummary(**kwargs)¶

Bases: object

Information about an index.

Methods

__init__(**kwargs) Initializes a new IndexSummary object with values from keyword arguments.

Attributes

`keys`	Gets the keys of this IndexSummary.
`lifecycle_details`	Gets the lifecycle_details of this IndexSummary.
`lifecycle_state`	Gets the lifecycle_state of this IndexSummary.
`name`	Gets the name of this IndexSummary.

__init__(**kwargs)¶

Initializes a new IndexSummary object with values from keyword arguments. The following keyword arguments are supported (corresponding to the getters/setters of this class):

Parameters:

name (str) – The value to assign to the name property of this IndexSummary.
keys (list[oci.nosql.models.IndexKey]) – The value to assign to the keys property of this IndexSummary.
lifecycle_state (str) – The value to assign to the lifecycle_state property of this IndexSummary.
lifecycle_details (str) – The value to assign to the lifecycle_details property of this IndexSummary.

keys¶

Gets the keys of this IndexSummary. A set of keys for a secondary index.

Returns:	The keys of this IndexSummary.
Return type:	list[oci.nosql.models.IndexKey]

lifecycle_details¶

Gets the lifecycle_details of this IndexSummary. A message describing the current state in more detail.

Returns:	The lifecycle_details of this IndexSummary.
Return type:	str

lifecycle_state¶

Gets the lifecycle_state of this IndexSummary. The state of an index.

Returns:	The lifecycle_state of this IndexSummary.
Return type:	str

name¶

Gets the name of this IndexSummary. Index name.

Returns:	The name of this IndexSummary.
Return type:	str