OverlappingRecallSummary¶
- class oci.log_analytics.models.OverlappingRecallSummary(**kwargs)¶
Bases:
objectThis is the information about overlapping recall requests
Attributes:
A constant which can be used with the status property of a OverlappingRecallSummary.
A constant which can be used with the status property of a OverlappingRecallSummary.
A constant which can be used with the status property of a OverlappingRecallSummary.
A constant which can be used with the status property of a OverlappingRecallSummary.
[Required] Gets the collection_id of this OverlappingRecallSummary.
[Required] Gets the created_by of this OverlappingRecallSummary.
[Required] Gets the log_sets of this OverlappingRecallSummary.
[Required] Gets the purpose of this OverlappingRecallSummary.
[Required] Gets the query_string of this OverlappingRecallSummary.
[Required] Gets the recall_id of this OverlappingRecallSummary.
[Required] Gets the status of this OverlappingRecallSummary.
[Required] Gets the time_data_ended of this OverlappingRecallSummary.
[Required] Gets the time_data_started of this OverlappingRecallSummary.
[Required] Gets the time_started of this OverlappingRecallSummary.
Methods:
__init__(**kwargs)Initializes a new OverlappingRecallSummary object with values from keyword arguments.
- STATUS_FAILED = 'FAILED'¶
A constant which can be used with the status property of a OverlappingRecallSummary. This constant has a value of “FAILED”
- STATUS_PARTIAL_RECALLED = 'PARTIAL_RECALLED'¶
A constant which can be used with the status property of a OverlappingRecallSummary. This constant has a value of “PARTIAL_RECALLED”
- STATUS_PENDING = 'PENDING'¶
A constant which can be used with the status property of a OverlappingRecallSummary. This constant has a value of “PENDING”
- STATUS_RECALLED = 'RECALLED'¶
A constant which can be used with the status property of a OverlappingRecallSummary. This constant has a value of “RECALLED”
- __init__(**kwargs)¶
Initializes a new OverlappingRecallSummary object with values from keyword arguments. The following keyword arguments are supported (corresponding to the getters/setters of this class):
- Parameters
time_data_started (datetime) – The value to assign to the time_data_started property of this OverlappingRecallSummary.
time_data_ended (datetime) – The value to assign to the time_data_ended property of this OverlappingRecallSummary.
time_started (datetime) – The value to assign to the time_started property of this OverlappingRecallSummary.
status (str) – The value to assign to the status property of this OverlappingRecallSummary. 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’.
purpose (str) – The value to assign to the purpose property of this OverlappingRecallSummary.
query_string (str) – The value to assign to the query_string property of this OverlappingRecallSummary.
log_sets (str) – The value to assign to the log_sets property of this OverlappingRecallSummary.
created_by (str) – The value to assign to the created_by property of this OverlappingRecallSummary.
collection_id (int) – The value to assign to the collection_id property of this OverlappingRecallSummary.
recall_id (int) – The value to assign to the recall_id property of this OverlappingRecallSummary.
- property collection_id¶
[Required] Gets the collection_id of this OverlappingRecallSummary. This is the id of the associated recalled data collection
- Returns
The collection_id of this OverlappingRecallSummary.
- Return type
int
- property created_by¶
[Required] Gets the created_by of this OverlappingRecallSummary. This is the user who initiated the recall request
- Returns
The created_by of this OverlappingRecallSummary.
- Return type
str
- property log_sets¶
[Required] Gets the log_sets of this OverlappingRecallSummary. This is the list of logsets associated with this recall
- Returns
The log_sets of this OverlappingRecallSummary.
- Return type
str
- property purpose¶
[Required] Gets the purpose of this OverlappingRecallSummary. This is the purpose of the recall
- Returns
The purpose of this OverlappingRecallSummary.
- Return type
str
- property query_string¶
[Required] Gets the query_string of this OverlappingRecallSummary. This is the query associated with the recall
- Returns
The query_string of this OverlappingRecallSummary.
- Return type
str
- property recall_id¶
[Required] Gets the recall_id of this OverlappingRecallSummary. This is the id for the recall request
- Returns
The recall_id of this OverlappingRecallSummary.
- Return type
int
- property status¶
[Required] Gets the status of this OverlappingRecallSummary. 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 OverlappingRecallSummary.
- Return type
str
- property time_data_ended¶
[Required] Gets the time_data_ended of this OverlappingRecallSummary. This is the end of the time range of the archival data
- Returns
The time_data_ended of this OverlappingRecallSummary.
- Return type
datetime
- property time_data_started¶
[Required] Gets the time_data_started of this OverlappingRecallSummary. This is the start of the time range of the archival data
- Returns
The time_data_started of this OverlappingRecallSummary.
- Return type
datetime
- property time_started¶
[Required] Gets the time_started of this OverlappingRecallSummary. This is the time when the recall operation was started for this recall request
- Returns
The time_started of this OverlappingRecallSummary.
- Return type
datetime