Package cm_api :: Package endpoints :: Module types :: Class ApiSnapshotPolicy

Class ApiSnapshotPolicy

   object --+    
            |    
BaseApiObject --+
                |
               ApiSnapshotPolicy

Instance Methods

[hide private]

Inherited from BaseApiObject: __init__, __setattr__, __str__, to_json_dict

Inherited from BaseApiObject (private): _check_attr, _get_resource_root, _set_attrs, _update

Inherited from object: __delattr__, __format__, __getattribute__, __hash__, __new__, __reduce__, __reduce_ex__, __repr__, __sizeof__, __subclasshook__

Class Methods

[hide private]

Inherited from BaseApiObject: from_json_dict

Inherited from BaseApiObject (private): _get_attributes

Static Methods

[hide private]

Inherited from BaseApiObject: init

Class Variables

[hide private]

_ATTRIBUTES = {'alertOnAbort': None, 'alertOnFail': None, 'ale...

Inherited from BaseApiObject (private): _WHITELIST

Instance Variables

[hide private]

alert_on_abort
whether to generate alerts on abort of snapshot creation/deletion activity.

alert_on_fail
whether to generate alerts on failure of snapshot creation/deletion activity.

alert_on_start
whether to generate alerts on start of snapshot creation/deletion activity.

alert_on_success
whether to generate alerts on successful completion of snapshot creation/deletion activity.

int

daily_snapshots
Number of daily snapshots to be retained (default: 0).

int

day_of_month
Day of the month that monthly and yearly snapshots should be created.

int

day_of_week
Day of the week that weekly snapshots should be created.

str

description
Description of the snapshot policy.

ApiHBaseSnapshotPolicyArguments

hbaseArguments
HBase specific arguments for the replication job.

ApiHdfsSnapshotPolicyArguments

hdfsArguments
HDFS specific arguments for the replication job.

int

hour_of_day
Hour in the day that daily, weekly, monthly and yearly snapshots should be created.

int

hourly_snapshots
Number of hourly snapshots to be retained (default: 0).

list of int

hours_for_hourly_snapshots
Hours of the day that hourly snapshots should be created.

int

minute_of_hour
Minute in the hour that hourly, daily, weekly, monthly and yearly snapshots should be created.

int

month_of_year
Month of the year that yearly snapshots should be created.

int

monthly_snapshots
Number of monthly snapshots to be retained (default: 0).

str

name
Name of the snapshot policy.

paused
whether to run the policy on schedule

int

weekly_snapshots
Number of weekly snapshots to be retained (default: 0).

int

yearly_snapshots
Number of yearly snapshots to be retained (default: 0).

Properties

[hide private]

Inherited from object: __class__

Class Variable Details

[hide private]

_ATTRIBUTES

Value:

{'alertOnAbort': None,
 'alertOnFail': None,
 'alertOnStart': None,
 'alertOnSuccess': None,
 'dailySnapshots': None,
 'dayOfMonth': None,
 'dayOfWeek': None,
 'description': None,
...

Instance Variable Details

[hide private]

day_of_month

Day of the month that monthly and yearly snapshots should be created. Values from 1 to 31 are allowed. Additionally 0 to -30 can be used to specify offsets from the last day of the month (default: 1).

Type:: int

day_of_week

Day of the week that weekly snapshots should be created. Valid values are 1 to 7, 1 representing Sunday (default: 1).

Type:: int

hour_of_day

Hour in the day that daily, weekly, monthly and yearly snapshots should be created. Valid values are 0 to 23 (default: 0).

Type:: int

hours_for_hourly_snapshots

Hours of the day that hourly snapshots should be created. Valid values are 0 to 23. If this list is empty, then hourly snapshots are created for every hour.

Type:: list of int

minute_of_hour

Minute in the hour that hourly, daily, weekly, monthly and yearly snapshots should be created. Valid values are 0 to 59 (default: 0).

Type:: int

month_of_year

Month of the year that yearly snapshots should be created. Valid values are 1 to 12, 1 representing January (default: 1).

Type:: int