StorageWorkRequest

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

Bases: object

This shows the storage work request details.

Attributes

DATA_TYPE_LOG A constant which can be used with the data_type property of a StorageWorkRequest.
DATA_TYPE_LOOKUP A constant which can be used with the data_type property of a StorageWorkRequest.
OPERATION_TYPE_ARCHIVE_STORAGE_DATA A constant which can be used with the operation_type property of a StorageWorkRequest.
OPERATION_TYPE_CLEANUP_ARCHIVAL_STORAGE_DATA A constant which can be used with the operation_type property of a StorageWorkRequest.
OPERATION_TYPE_OFFBOARD_TENANCY A constant which can be used with the operation_type property of a StorageWorkRequest.
OPERATION_TYPE_PURGE_STORAGE_DATA A constant which can be used with the operation_type property of a StorageWorkRequest.
OPERATION_TYPE_RECALL_ARCHIVED_STORAGE_DATA A constant which can be used with the operation_type property of a StorageWorkRequest.
OPERATION_TYPE_RELEASE_RECALLED_STORAGE_DATA A constant which can be used with the operation_type property of a StorageWorkRequest.
STATUS_ACCEPTED A constant which can be used with the status property of a StorageWorkRequest.
STATUS_CANCELED A constant which can be used with the status property of a StorageWorkRequest.
STATUS_FAILED A constant which can be used with the status property of a StorageWorkRequest.
STATUS_IN_PROGRESS A constant which can be used with the status property of a StorageWorkRequest.
STATUS_SUCCEEDED A constant which can be used with the status property of a StorageWorkRequest.
compartment_id [Required] Gets the compartment_id of this StorageWorkRequest.
compartment_id_in_subtree Gets the compartment_id_in_subtree of this StorageWorkRequest.
data_type [Required] Gets the data_type of this StorageWorkRequest.
id [Required] Gets the id of this StorageWorkRequest.
operation_details Gets the operation_details of this StorageWorkRequest.
operation_type [Required] Gets the operation_type of this StorageWorkRequest.
percent_complete Gets the percent_complete of this StorageWorkRequest.
policy_id Gets the policy_id of this StorageWorkRequest.
policy_name Gets the policy_name of this StorageWorkRequest.
purge_query_string Gets the purge_query_string of this StorageWorkRequest.
status [Required] Gets the status of this StorageWorkRequest.
status_details Gets the status_details of this StorageWorkRequest.
storage_usage_in_bytes Gets the storage_usage_in_bytes of this StorageWorkRequest.
time_accepted Gets the time_accepted of this StorageWorkRequest.
time_data_ended [Required] Gets the time_data_ended of this StorageWorkRequest.
time_data_started Gets the time_data_started of this StorageWorkRequest.
time_expires Gets the time_expires of this StorageWorkRequest.
time_finished Gets the time_finished of this StorageWorkRequest.
time_started Gets the time_started of this StorageWorkRequest.

Methods

__init__(**kwargs) Initializes a new StorageWorkRequest object with values from keyword arguments.
DATA_TYPE_LOG = 'LOG'

A constant which can be used with the data_type property of a StorageWorkRequest. This constant has a value of “LOG”

DATA_TYPE_LOOKUP = 'LOOKUP'

A constant which can be used with the data_type property of a StorageWorkRequest. This constant has a value of “LOOKUP”

OPERATION_TYPE_ARCHIVE_STORAGE_DATA = 'ARCHIVE_STORAGE_DATA'

A constant which can be used with the operation_type property of a StorageWorkRequest. This constant has a value of “ARCHIVE_STORAGE_DATA”

OPERATION_TYPE_CLEANUP_ARCHIVAL_STORAGE_DATA = 'CLEANUP_ARCHIVAL_STORAGE_DATA'

A constant which can be used with the operation_type property of a StorageWorkRequest. This constant has a value of “CLEANUP_ARCHIVAL_STORAGE_DATA”

OPERATION_TYPE_OFFBOARD_TENANCY = 'OFFBOARD_TENANCY'

A constant which can be used with the operation_type property of a StorageWorkRequest. This constant has a value of “OFFBOARD_TENANCY”

OPERATION_TYPE_PURGE_STORAGE_DATA = 'PURGE_STORAGE_DATA'

A constant which can be used with the operation_type property of a StorageWorkRequest. This constant has a value of “PURGE_STORAGE_DATA”

OPERATION_TYPE_RECALL_ARCHIVED_STORAGE_DATA = 'RECALL_ARCHIVED_STORAGE_DATA'

A constant which can be used with the operation_type property of a StorageWorkRequest. This constant has a value of “RECALL_ARCHIVED_STORAGE_DATA”

OPERATION_TYPE_RELEASE_RECALLED_STORAGE_DATA = 'RELEASE_RECALLED_STORAGE_DATA'

A constant which can be used with the operation_type property of a StorageWorkRequest. This constant has a value of “RELEASE_RECALLED_STORAGE_DATA”

STATUS_ACCEPTED = 'ACCEPTED'

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

STATUS_CANCELED = 'CANCELED'

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

STATUS_FAILED = 'FAILED'

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

STATUS_IN_PROGRESS = 'IN_PROGRESS'

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

STATUS_SUCCEEDED = 'SUCCEEDED'

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

__init__(**kwargs)

Initializes a new StorageWorkRequest 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 StorageWorkRequest.
  • compartment_id (str) – The value to assign to the compartment_id property of this StorageWorkRequest.
  • time_started (datetime) – The value to assign to the time_started property of this StorageWorkRequest.
  • time_accepted (datetime) – The value to assign to the time_accepted property of this StorageWorkRequest.
  • time_finished (datetime) – The value to assign to the time_finished property of this StorageWorkRequest.
  • time_expires (datetime) – The value to assign to the time_expires property of this StorageWorkRequest.
  • percent_complete (int) – The value to assign to the percent_complete property of this StorageWorkRequest.
  • status (str) – The value to assign to the status property of this StorageWorkRequest. 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’.
  • time_data_started (datetime) – The value to assign to the time_data_started property of this StorageWorkRequest.
  • time_data_ended (datetime) – The value to assign to the time_data_ended property of this StorageWorkRequest.
  • purge_query_string (str) – The value to assign to the purge_query_string property of this StorageWorkRequest.
  • data_type (str) – The value to assign to the data_type property of this StorageWorkRequest. Allowed values for this property are: “LOG”, “LOOKUP”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
  • status_details (str) – The value to assign to the status_details property of this StorageWorkRequest.
  • operation_details (str) – The value to assign to the operation_details property of this StorageWorkRequest.
  • policy_name (str) – The value to assign to the policy_name property of this StorageWorkRequest.
  • policy_id (str) – The value to assign to the policy_id property of this StorageWorkRequest.
  • storage_usage_in_bytes (int) – The value to assign to the storage_usage_in_bytes property of this StorageWorkRequest.
  • compartment_id_in_subtree (bool) – The value to assign to the compartment_id_in_subtree property of this StorageWorkRequest.
  • operation_type (str) – The value to assign to the operation_type property of this StorageWorkRequest. Allowed values for this property are: “OFFBOARD_TENANCY”, “PURGE_STORAGE_DATA”, “RECALL_ARCHIVED_STORAGE_DATA”, “RELEASE_RECALLED_STORAGE_DATA”, “ARCHIVE_STORAGE_DATA”, “CLEANUP_ARCHIVAL_STORAGE_DATA”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
compartment_id

[Required] Gets the compartment_id of this StorageWorkRequest. Compartment Identifier OCID].

Returns:The compartment_id of this StorageWorkRequest.
Return type:str
compartment_id_in_subtree

Gets the compartment_id_in_subtree of this StorageWorkRequest. If true, purge child compartments data, only applicable to purge request

Returns:The compartment_id_in_subtree of this StorageWorkRequest.
Return type:bool
data_type

[Required] Gets the data_type of this StorageWorkRequest. Thie is the type of data to be purged

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

Returns:The data_type of this StorageWorkRequest.
Return type:str
id

[Required] Gets the id of this StorageWorkRequest. This is the OCID of the storage work Request.

Returns:The id of this StorageWorkRequest.
Return type:str
operation_details

Gets the operation_details of this StorageWorkRequest. This provides more detailed info about the work request if applicable

Returns:The operation_details of this StorageWorkRequest.
Return type:str
operation_type

[Required] Gets the operation_type of this StorageWorkRequest. This is the type of the work request.

Allowed values for this property are: “OFFBOARD_TENANCY”, “PURGE_STORAGE_DATA”, “RECALL_ARCHIVED_STORAGE_DATA”, “RELEASE_RECALLED_STORAGE_DATA”, “ARCHIVE_STORAGE_DATA”, “CLEANUP_ARCHIVAL_STORAGE_DATA”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns:The operation_type of this StorageWorkRequest.
Return type:str
percent_complete

Gets the percent_complete of this StorageWorkRequest. Percentage progress completion of the work request.

Returns:The percent_complete of this StorageWorkRequest.
Return type:int
policy_id

Gets the policy_id of this StorageWorkRequest. This is the purge policy ID if applicable

Returns:The policy_id of this StorageWorkRequest.
Return type:str
policy_name

Gets the policy_name of this StorageWorkRequest. This is the policy name if applicable (e.g. purge policy)

Returns:The policy_name of this StorageWorkRequest.
Return type:str
purge_query_string

Gets the purge_query_string of this StorageWorkRequest. This is the solr query used to filter data for purge, ‘*’ means all

Returns:The purge_query_string of this StorageWorkRequest.
Return type:str
status

[Required] Gets the status of this StorageWorkRequest. This is the 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 StorageWorkRequest.
Return type:str
status_details

Gets the status_details of this StorageWorkRequest. This provides more detailed status if applicable

Returns:The status_details of this StorageWorkRequest.
Return type:str
storage_usage_in_bytes

Gets the storage_usage_in_bytes of this StorageWorkRequest. This is the data usage in bytes if applicable

Returns:The storage_usage_in_bytes of this StorageWorkRequest.
Return type:int
time_accepted

Gets the time_accepted of this StorageWorkRequest. When the work request was accepted. Should match timeStarted in all cases.

Returns:The time_accepted of this StorageWorkRequest.
Return type:datetime
time_data_ended

[Required] Gets the time_data_ended of this StorageWorkRequest. This is the end of the time interval

Returns:The time_data_ended of this StorageWorkRequest.
Return type:datetime
time_data_started

Gets the time_data_started of this StorageWorkRequest. This is the start of the time interval

Returns:The time_data_started of this StorageWorkRequest.
Return type:datetime
time_expires

Gets the time_expires of this StorageWorkRequest. When the work request will expire.

Returns:The time_expires of this StorageWorkRequest.
Return type:datetime
time_finished

Gets the time_finished of this StorageWorkRequest. When the work request finished execution.

Returns:The time_finished of this StorageWorkRequest.
Return type:datetime
time_started

Gets the time_started of this StorageWorkRequest. When the work request started.

Returns:The time_started of this StorageWorkRequest.
Return type:datetime