QueryWorkRequest¶
- class oci.log_analytics.models.QueryWorkRequest(**kwargs)¶
Bases:
objectJob details outlining parameters specified when job was submitted.
Attributes:
A constant which can be used with the mode property of a QueryWorkRequest.
A constant which can be used with the mode property of a QueryWorkRequest.
A constant which can be used with the operation_type property of a QueryWorkRequest.
A constant which can be used with the operation_type property of a QueryWorkRequest.
A constant which can be used with the status property of a QueryWorkRequest.
A constant which can be used with the status property of a QueryWorkRequest.
A constant which can be used with the status property of a QueryWorkRequest.
A constant which can be used with the status property of a QueryWorkRequest.
A constant which can be used with the status property of a QueryWorkRequest.
A constant which can be used with the sub_system property of a QueryWorkRequest.
[Required] Gets the compartment_id of this QueryWorkRequest.
[Required] Gets the display_query_string of this QueryWorkRequest.
[Required] Gets the id of this QueryWorkRequest.
[Required] Gets the internal_query_string of this QueryWorkRequest.
[Required] Gets the mode of this QueryWorkRequest.
Gets the operation_type of this QueryWorkRequest.
Gets the percent_complete of this QueryWorkRequest.
Gets the scope_filters of this QueryWorkRequest.
Gets the status of this QueryWorkRequest.
[Required] Gets the sub_system of this QueryWorkRequest.
Gets the time_accepted of this QueryWorkRequest.
Gets the time_background_at of this QueryWorkRequest.
Gets the time_expires of this QueryWorkRequest.
Gets the time_filter of this QueryWorkRequest.
Gets the time_finished of this QueryWorkRequest.
[Required] Gets the time_started of this QueryWorkRequest.
Methods:
__init__(**kwargs)Initializes a new QueryWorkRequest object with values from keyword arguments.
- MODE_BACKGROUND = 'BACKGROUND'¶
A constant which can be used with the mode property of a QueryWorkRequest. This constant has a value of “BACKGROUND”
- MODE_FOREGROUND = 'FOREGROUND'¶
A constant which can be used with the mode property of a QueryWorkRequest. This constant has a value of “FOREGROUND”
- OPERATION_TYPE_EXECUTE_PURGE_JOB = 'EXECUTE_PURGE_JOB'¶
A constant which can be used with the operation_type property of a QueryWorkRequest. This constant has a value of “EXECUTE_PURGE_JOB”
- OPERATION_TYPE_EXECUTE_QUERY_JOB = 'EXECUTE_QUERY_JOB'¶
A constant which can be used with the operation_type property of a QueryWorkRequest. This constant has a value of “EXECUTE_QUERY_JOB”
- STATUS_ACCEPTED = 'ACCEPTED'¶
A constant which can be used with the status property of a QueryWorkRequest. This constant has a value of “ACCEPTED”
- STATUS_CANCELED = 'CANCELED'¶
A constant which can be used with the status property of a QueryWorkRequest. This constant has a value of “CANCELED”
- STATUS_FAILED = 'FAILED'¶
A constant which can be used with the status property of a QueryWorkRequest. This constant has a value of “FAILED”
- STATUS_IN_PROGRESS = 'IN_PROGRESS'¶
A constant which can be used with the status property of a QueryWorkRequest. This constant has a value of “IN_PROGRESS”
- STATUS_SUCCEEDED = 'SUCCEEDED'¶
A constant which can be used with the status property of a QueryWorkRequest. This constant has a value of “SUCCEEDED”
- SUB_SYSTEM_LOG = 'LOG'¶
A constant which can be used with the sub_system property of a QueryWorkRequest. This constant has a value of “LOG”
- __init__(**kwargs)¶
Initializes a new QueryWorkRequest object with values from keyword arguments. The following keyword arguments are supported (corresponding to the getters/setters of this class):
- Parameters
id (str) – The value to assign to the id property of this QueryWorkRequest.
compartment_id (str) – The value to assign to the compartment_id property of this QueryWorkRequest.
time_started (datetime) – The value to assign to the time_started property of this QueryWorkRequest.
time_accepted (datetime) – The value to assign to the time_accepted property of this QueryWorkRequest.
time_finished (datetime) – The value to assign to the time_finished property of this QueryWorkRequest.
time_expires (datetime) – The value to assign to the time_expires property of this QueryWorkRequest.
percent_complete (int) – The value to assign to the percent_complete property of this QueryWorkRequest.
status (str) – The value to assign to the status property of this QueryWorkRequest. Allowed values for this property are: “ACCEPTED”, “CANCELED”, “FAILED”, “IN_PROGRESS”, “SUCCEEDED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
operation_type (str) – The value to assign to the operation_type property of this QueryWorkRequest. Allowed values for this property are: “EXECUTE_QUERY_JOB”, “EXECUTE_PURGE_JOB”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
mode (str) – The value to assign to the mode property of this QueryWorkRequest. Allowed values for this property are: “FOREGROUND”, “BACKGROUND”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
time_background_at (datetime) – The value to assign to the time_background_at property of this QueryWorkRequest.
time_filter (oci.log_analytics.models.TimeRange) – The value to assign to the time_filter property of this QueryWorkRequest.
scope_filters (list[oci.log_analytics.models.ScopeFilter]) – The value to assign to the scope_filters property of this QueryWorkRequest.
sub_system (str) – The value to assign to the sub_system property of this QueryWorkRequest. Allowed values for this property are: “LOG”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
display_query_string (str) – The value to assign to the display_query_string property of this QueryWorkRequest.
internal_query_string (str) – The value to assign to the internal_query_string property of this QueryWorkRequest.
- property compartment_id¶
[Required] Gets the compartment_id of this QueryWorkRequest. Compartment Identifier OCID].
- Returns
The compartment_id of this QueryWorkRequest.
- Return type
str
- property display_query_string¶
[Required] Gets the display_query_string of this QueryWorkRequest. Display version of the user speciified queryString.
- Returns
The display_query_string of this QueryWorkRequest.
- Return type
str
- property id¶
[Required] Gets the id of this QueryWorkRequest. Unique OCID identifier to reference this query job work Request with.
- Returns
The id of this QueryWorkRequest.
- Return type
str
- property internal_query_string¶
[Required] Gets the internal_query_string of this QueryWorkRequest. Internal version of the user specified queryString.
- Returns
The internal_query_string of this QueryWorkRequest.
- Return type
str
- property mode¶
[Required] Gets the mode of this QueryWorkRequest. Current execution mode for the job.
Allowed values for this property are: “FOREGROUND”, “BACKGROUND”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
- Returns
The mode of this QueryWorkRequest.
- Return type
str
- property operation_type¶
Gets the operation_type of this QueryWorkRequest. Asynchronous action name.
Allowed values for this property are: “EXECUTE_QUERY_JOB”, “EXECUTE_PURGE_JOB”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
- Returns
The operation_type of this QueryWorkRequest.
- Return type
str
- property percent_complete¶
Gets the percent_complete of this QueryWorkRequest. Percentage progress completion of the query.
- Returns
The percent_complete of this QueryWorkRequest.
- Return type
int
- property scope_filters¶
Gets the scope_filters of this QueryWorkRequest. List of filters applied when the query executed.
- Returns
The scope_filters of this QueryWorkRequest.
- Return type
- property status¶
Gets the status of this QueryWorkRequest. Work request status.
Allowed values for this property are: “ACCEPTED”, “CANCELED”, “FAILED”, “IN_PROGRESS”, “SUCCEEDED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
- Returns
The status of this QueryWorkRequest.
- Return type
str
- property sub_system¶
[Required] Gets the sub_system of this QueryWorkRequest. Default subsystem to qualify fields with in the queryString if not specified.
Allowed values for this property are: “LOG”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
- Returns
The sub_system of this QueryWorkRequest.
- Return type
str
- property time_accepted¶
Gets the time_accepted of this QueryWorkRequest. When the work request was accepted. Should match timeStarted in all cases.
- Returns
The time_accepted of this QueryWorkRequest.
- Return type
datetime
- property time_background_at¶
Gets the time_background_at of this QueryWorkRequest. When the job was put in to the background.
- Returns
The time_background_at of this QueryWorkRequest.
- Return type
datetime
- property time_expires¶
Gets the time_expires of this QueryWorkRequest. When the job will expire.
- Returns
The time_expires of this QueryWorkRequest.
- Return type
datetime
- property time_filter¶
Gets the time_filter of this QueryWorkRequest.
- Returns
The time_filter of this QueryWorkRequest.
- Return type
- property time_finished¶
Gets the time_finished of this QueryWorkRequest. When the job finished execution.
- Returns
The time_finished of this QueryWorkRequest.
- Return type
datetime
- property time_started¶
[Required] Gets the time_started of this QueryWorkRequest. When the job was started.
- Returns
The time_started of this QueryWorkRequest.
- Return type
datetime