Archiver

class oci.streaming.models.Archiver(**kwargs)

Bases: object

Represents the current state of the stream archiver.

LIFECYCLE_STATE_CREATING = 'CREATING'

A constant which can be used with the lifecycle_state property of a Archiver. This constant has a value of "CREATING"

LIFECYCLE_STATE_RUNNING = 'RUNNING'

A constant which can be used with the lifecycle_state property of a Archiver. This constant has a value of "RUNNING"

LIFECYCLE_STATE_STARTING = 'STARTING'

A constant which can be used with the lifecycle_state property of a Archiver. This constant has a value of "STARTING"

LIFECYCLE_STATE_STOPPED = 'STOPPED'

A constant which can be used with the lifecycle_state property of a Archiver. This constant has a value of "STOPPED"

LIFECYCLE_STATE_STOPPING = 'STOPPING'

A constant which can be used with the lifecycle_state property of a Archiver. This constant has a value of "STOPPING"

LIFECYCLE_STATE_UPDATING = 'UPDATING'

A constant which can be used with the lifecycle_state property of a Archiver. This constant has a value of "UPDATING"

START_POSITION_LATEST = 'LATEST'

A constant which can be used with the start_position property of a Archiver. This constant has a value of "LATEST"

START_POSITION_TRIM_HORIZON = 'TRIM_HORIZON'

A constant which can be used with the start_position property of a Archiver. This constant has a value of "TRIM_HORIZON"

__init__(**kwargs)

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

Parameters:
  • time_created (datetime) -- The value to assign to the time_created property of this Archiver.
  • lifecycle_state (str) -- The value to assign to the lifecycle_state property of this Archiver. Allowed values for this property are: "CREATING", "STOPPED", "STARTING", "RUNNING", "STOPPING", "UPDATING", 'UNKNOWN_ENUM_VALUE'. Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'.
  • bucket_name (str) -- The value to assign to the bucket_name property of this Archiver.
  • use_existing_bucket (bool) -- The value to assign to the use_existing_bucket property of this Archiver.
  • start_position (str) -- The value to assign to the start_position property of this Archiver. Allowed values for this property are: "LATEST", "TRIM_HORIZON", 'UNKNOWN_ENUM_VALUE'. Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'.
  • batch_rollover_size_in_mbs (int) -- The value to assign to the batch_rollover_size_in_mbs property of this Archiver.
  • batch_rollover_time_in_seconds (int) -- The value to assign to the batch_rollover_time_in_seconds property of this Archiver.
  • error (ArchiverError) -- The value to assign to the error property of this Archiver.
batch_rollover_size_in_mbs

Gets the batch_rollover_size_in_mbs of this Archiver. The batch rollover size in megabytes.

Returns:The batch_rollover_size_in_mbs of this Archiver.
Return type:int
batch_rollover_time_in_seconds

Gets the batch_rollover_time_in_seconds of this Archiver. The rollover time in seconds.

Returns:The batch_rollover_time_in_seconds of this Archiver.
Return type:int
bucket_name

Gets the bucket_name of this Archiver. The name of the bucket.

Returns:The bucket_name of this Archiver.
Return type:str
error

Gets the error of this Archiver. If an operation failed this property contained the last error occurred.

Returns:The error of this Archiver.
Return type:ArchiverError
lifecycle_state

Gets the lifecycle_state of this Archiver. The state of the stream archiver.

Allowed values for this property are: "CREATING", "STOPPED", "STARTING", "RUNNING", "STOPPING", "UPDATING", 'UNKNOWN_ENUM_VALUE'. Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'.

Returns:The lifecycle_state of this Archiver.
Return type:str
start_position

Gets the start_position of this Archiver. The start message.

Allowed values for this property are: "LATEST", "TRIM_HORIZON", 'UNKNOWN_ENUM_VALUE'. Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'.

Returns:The start_position of this Archiver.
Return type:str
time_created

Gets the time_created of this Archiver. Time when the resource was created.

Returns:The time_created of this Archiver.
Return type:datetime
use_existing_bucket

Gets the use_existing_bucket of this Archiver. The flag to create a new bucket or use existing one.

Returns:The use_existing_bucket of this Archiver.
Return type:bool