RecalledData

class oci.log_analytics.models.RecalledData(**kwargs)

Bases: object

This is the information about recalled data

Attributes:

STATUS_FAILED

A constant which can be used with the status property of a RecalledData.

STATUS_PARTIAL_RECALLED

A constant which can be used with the status property of a RecalledData.

STATUS_PENDING

A constant which can be used with the status property of a RecalledData.

STATUS_RECALLED

A constant which can be used with the status property of a RecalledData.

collection_id

[Required] Gets the collection_id of this RecalledData.

created_by

[Required] Gets the created_by of this RecalledData.

log_sets

[Required] Gets the log_sets of this RecalledData.

not_recalled_data_in_bytes

[Required] Gets the not_recalled_data_in_bytes of this RecalledData.

percentage_complete

Gets the percentage_complete of this RecalledData.

purpose

[Required] Gets the purpose of this RecalledData.

query_string

[Required] Gets the query_string of this RecalledData.

recall_count

[Required] Gets the recall_count of this RecalledData.

status

[Required] Gets the status of this RecalledData.

storage_usage_in_bytes

[Required] Gets the storage_usage_in_bytes of this RecalledData.

time_data_ended

[Required] Gets the time_data_ended of this RecalledData.

time_data_started

[Required] Gets the time_data_started of this RecalledData.

time_recalled_data_ended

[Required] Gets the time_recalled_data_ended of this RecalledData.

time_recalled_data_started

[Required] Gets the time_recalled_data_started of this RecalledData.

time_started

[Required] Gets the time_started of this RecalledData.

Methods:

__init__(**kwargs)

Initializes a new RecalledData object with values from keyword arguments.

STATUS_FAILED = 'FAILED'

A constant which can be used with the status property of a RecalledData. This constant has a value of “FAILED”

STATUS_PARTIAL_RECALLED = 'PARTIAL_RECALLED'

A constant which can be used with the status property of a RecalledData. This constant has a value of “PARTIAL_RECALLED”

STATUS_PENDING = 'PENDING'

A constant which can be used with the status property of a RecalledData. This constant has a value of “PENDING”

STATUS_RECALLED = 'RECALLED'

A constant which can be used with the status property of a RecalledData. This constant has a value of “RECALLED”

__init__(**kwargs)

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

Parameters
  • time_data_ended (datetime) – The value to assign to the time_data_ended property of this RecalledData.

  • time_data_started (datetime) – The value to assign to the time_data_started property of this RecalledData.

  • time_started (datetime) – The value to assign to the time_started property of this RecalledData.

  • status (str) – The value to assign to the status property of this RecalledData. Allowed values for this property are: “RECALLED”, “PENDING”, “FAILED”, “PARTIAL_RECALLED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

  • recall_count (int) – The value to assign to the recall_count property of this RecalledData.

  • storage_usage_in_bytes (int) – The value to assign to the storage_usage_in_bytes property of this RecalledData.

  • not_recalled_data_in_bytes (int) – The value to assign to the not_recalled_data_in_bytes property of this RecalledData.

  • purpose (str) – The value to assign to the purpose property of this RecalledData.

  • query_string (str) – The value to assign to the query_string property of this RecalledData.

  • log_sets (str) – The value to assign to the log_sets property of this RecalledData.

  • created_by (str) – The value to assign to the created_by property of this RecalledData.

  • collection_id (int) – The value to assign to the collection_id property of this RecalledData.

  • time_recalled_data_started (datetime) – The value to assign to the time_recalled_data_started property of this RecalledData.

  • time_recalled_data_ended (datetime) – The value to assign to the time_recalled_data_ended property of this RecalledData.

  • percentage_complete (int) – The value to assign to the percentage_complete property of this RecalledData.

property collection_id

[Required] Gets the collection_id of this RecalledData. This is the id for the recalled data collection

Returns

The collection_id of this RecalledData.

Return type

int

property created_by

[Required] Gets the created_by of this RecalledData. This is the user who initiated the recall request

Returns

The created_by of this RecalledData.

Return type

str

property log_sets

[Required] Gets the log_sets of this RecalledData. This is the list of logsets associated with the recall

Returns

The log_sets of this RecalledData.

Return type

str

property not_recalled_data_in_bytes

[Required] Gets the not_recalled_data_in_bytes of this RecalledData. This is the size of the archival data not recalled yet within the specified time range

Returns

The not_recalled_data_in_bytes of this RecalledData.

Return type

int

property percentage_complete

Gets the percentage_complete of this RecalledData. This is the current progress percentage for the recalled data

Returns

The percentage_complete of this RecalledData.

Return type

int

property purpose

[Required] Gets the purpose of this RecalledData. This is the purpose of the recall

Returns

The purpose of this RecalledData.

Return type

str

property query_string

[Required] Gets the query_string of this RecalledData. This is the query associated with the recall

Returns

The query_string of this RecalledData.

Return type

str

property recall_count

[Required] Gets the recall_count of this RecalledData. This is the number of recall operations for this recall. Note one RecalledData can be merged from the results of several recall operations if the time duration of the results of the recall operations overlap.

Returns

The recall_count of this RecalledData.

Return type

int

property status

[Required] Gets the status of this RecalledData. This is the status of the recall

Allowed values for this property are: “RECALLED”, “PENDING”, “FAILED”, “PARTIAL_RECALLED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns

The status of this RecalledData.

Return type

str

property storage_usage_in_bytes

[Required] Gets the storage_usage_in_bytes of this RecalledData. This is the size in bytes

Returns

The storage_usage_in_bytes of this RecalledData.

Return type

int

property time_data_ended

[Required] Gets the time_data_ended of this RecalledData. This is the end of the time range of the related data

Returns

The time_data_ended of this RecalledData.

Return type

datetime

property time_data_started

[Required] Gets the time_data_started of this RecalledData. This is the start of the time range of the related data

Returns

The time_data_started of this RecalledData.

Return type

datetime

property time_recalled_data_ended

[Required] Gets the time_recalled_data_ended of this RecalledData. This is the recalled data end time

Returns

The time_recalled_data_ended of this RecalledData.

Return type

datetime

property time_recalled_data_started

[Required] Gets the time_recalled_data_started of this RecalledData. This is the recalled date start time

Returns

The time_recalled_data_started of this RecalledData.

Return type

datetime

property time_started

[Required] Gets the time_started of this RecalledData. This is the time when the first recall operation was started for this RecalledData

Returns

The time_started of this RecalledData.

Return type

datetime