UploadFileSummary¶

class oci.log_analytics.models.UploadFileSummary(**kwargs)¶

Bases: object

Details of Upload File.

Attributes

`STATUS_FAILED`	A constant which can be used with the status property of a UploadFileSummary.
`STATUS_IN_PROGRESS`	A constant which can be used with the status property of a UploadFileSummary.
`STATUS_SUCCESSFUL`	A constant which can be used with the status property of a UploadFileSummary.
`chunks_consumed`	Gets the chunks_consumed of this UploadFileSummary.
`chunks_fail`	Gets the chunks_fail of this UploadFileSummary.
`chunks_success`	Gets the chunks_success of this UploadFileSummary.
`entity_name`	Gets the entity_name of this UploadFileSummary.
`entity_type`	Gets the entity_type of this UploadFileSummary.
`failure_details`	Gets the failure_details of this UploadFileSummary.
`log_group_id`	Gets the log_group_id of this UploadFileSummary.
`log_group_name`	Gets the log_group_name of this UploadFileSummary.
`log_namespace`	Gets the log_namespace of this UploadFileSummary.
`name`	[Required] Gets the name of this UploadFileSummary.
`reference`	[Required] Gets the reference of this UploadFileSummary.
`source_name`	Gets the source_name of this UploadFileSummary.
`status`	Gets the status of this UploadFileSummary.
`time_started`	Gets the time_started of this UploadFileSummary.
`total_chunks`	Gets the total_chunks of this UploadFileSummary.

Methods

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

STATUS_FAILED = 'FAILED'¶: A constant which can be used with the status property of a UploadFileSummary. This constant has a value of “FAILED”

STATUS_IN_PROGRESS = 'IN_PROGRESS'¶: A constant which can be used with the status property of a UploadFileSummary. This constant has a value of “IN_PROGRESS”

STATUS_SUCCESSFUL = 'SUCCESSFUL'¶: A constant which can be used with the status property of a UploadFileSummary. This constant has a value of “SUCCESSFUL”

__init__(**kwargs)¶

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

Parameters:

reference (str) – The value to assign to the reference property of this UploadFileSummary.
name (str) – The value to assign to the name property of this UploadFileSummary.
status (str) – The value to assign to the status property of this UploadFileSummary. Allowed values for this property are: “IN_PROGRESS”, “SUCCESSFUL”, “FAILED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
total_chunks (float) – The value to assign to the total_chunks property of this UploadFileSummary.
chunks_consumed (float) – The value to assign to the chunks_consumed property of this UploadFileSummary.
chunks_success (float) – The value to assign to the chunks_success property of this UploadFileSummary.
chunks_fail (float) – The value to assign to the chunks_fail property of this UploadFileSummary.
time_started (datetime) – The value to assign to the time_started property of this UploadFileSummary.
source_name (str) – The value to assign to the source_name property of this UploadFileSummary.
entity_type (str) – The value to assign to the entity_type property of this UploadFileSummary.
entity_name (str) – The value to assign to the entity_name property of this UploadFileSummary.
log_namespace (str) – The value to assign to the log_namespace property of this UploadFileSummary.
log_group_id (str) – The value to assign to the log_group_id property of this UploadFileSummary.
log_group_name (str) – The value to assign to the log_group_name property of this UploadFileSummary.
failure_details (str) – The value to assign to the failure_details property of this UploadFileSummary.

chunks_consumed¶

Gets the chunks_consumed of this UploadFileSummary. Number of chunks processed.

Returns:	The chunks_consumed of this UploadFileSummary.
Return type:	float

chunks_fail¶

Gets the chunks_fail of this UploadFileSummary. Number of chunks failed processing.

Returns:	The chunks_fail of this UploadFileSummary.
Return type:	float

chunks_success¶

Gets the chunks_success of this UploadFileSummary. Number of chunks processed successfully.

Returns:	The chunks_success of this UploadFileSummary.
Return type:	float

entity_name¶

Gets the entity_name of this UploadFileSummary. Name of the entity associated with the file.

Returns:	The entity_name of this UploadFileSummary.
Return type:	str

entity_type¶

Gets the entity_type of this UploadFileSummary. Name of the entity type.

Returns:	The entity_type of this UploadFileSummary.
Return type:	str

failure_details¶

Gets the failure_details of this UploadFileSummary. The details about upload processing failure.

Returns:	The failure_details of this UploadFileSummary.
Return type:	str

log_group_id¶

Gets the log_group_id of this UploadFileSummary. Log group OCID associated with the file.

Returns:	The log_group_id of this UploadFileSummary.
Return type:	str

log_group_name¶

Gets the log_group_name of this UploadFileSummary. Name of the log group associated with the file.

Returns:	The log_group_name of this UploadFileSummary.
Return type:	str

log_namespace¶

Gets the log_namespace of this UploadFileSummary. (Deprecated) Name of the log namespace associated with the file.

Returns:	The log_namespace of this UploadFileSummary.
Return type:	str

name¶

[Required] Gets the name of this UploadFileSummary. Name of the file

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

reference¶

[Required] Gets the reference of this UploadFileSummary. Unique internal identifier to refer upload file.

Returns:	The reference of this UploadFileSummary.
Return type:	str

source_name¶

Gets the source_name of this UploadFileSummary. Name of the log source used for processing this file.

Returns:	The source_name of this UploadFileSummary.
Return type:	str

status¶

Gets the status of this UploadFileSummary. Processing status of the file.

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

Returns:	The status of this UploadFileSummary.
Return type:	str

time_started¶

Gets the time_started of this UploadFileSummary. The time when this file processing started.

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

total_chunks¶

Gets the total_chunks of this UploadFileSummary. Number of estimated chunks for this file. A chunk is a portion of the log file used for the processing.

Returns:	The total_chunks of this UploadFileSummary.
Return type:	float