models.entity_schema_proto module

class models.entity_schema_proto.EntitySchemaProto(attributes_descriptor=None, enable_rollup=None, flush_interval_secs=None, is_internal_schema=None, largest_flush_interval_secs=None, name=None, rollup_granularity_vec=None, schema_descriptive_name=None, schema_help_text=None, time_series_descriptor_vec=None, time_to_live_secs=None, version=None)

Bases: object

Implementation of the ‘EntitySchemaProto’ model.

Specifies the meta-data associated with entity such as the list of attributes and time series data.

Attributes:

attributes_descriptor (EntitySchemaProtoAttributesDescriptor):

Specifies a list of attributes about an entity.

enable_rollup (bool): Timeseries for an entity schema is rolled up

based on this setting. Rollup is disabled by default. Rollups cannot be done for metrics with value_type other than kInt64 or kDouble.

flush_interval_secs (int): Defines the interval used to flush in

memory stats to scribe table. During this time if the stats server is down before flushing, it could loose some of the stats. Modules can flush any critical stats via AddEntitiesStats API. But this should be used very judiciously as it causes lot of overhead for stats.

is_internal_schema (bool): Specifies if this schema should be

displayed in Advanced Diagnostics of the Cohesity Dashboard. If false, the schema is displayed.

largest_flush_interval_secs (int): Use can change the flush interval

secs via gflag and this store the largest interval seconds set. This is used to round up the timestamp to this flush interval secs during range scan.

name (string): Specifies a name that uniquely identifies an entity

schema such as ‘kBridgeClusterStats’. Name cannot have ‘:’ as character.

rollup_granularity_vec (list of EntitySchemaProto_Granularity): TODO:

type description here.

schema_descriptive_name (string): Specifies the name of the Schema as

displayed in Advanced Diagnostics of the Cohesity Dashboard. For example for the ‘kBridgeClusterStats’ Schema, the descriptive name is ‘Cluster Physical Stats’.

schema_help_text (string): Specifies an optional informational

description about the schema.

time_series_descriptor_vec (list of

EntitySchemaProtoTimeSeriesDescriptor): Array of Time Series. List of time series of data (set of data points) for metrics.

time_to_live_secs (int): Specifies how long the timeseries data of

this. After expiry the entire data point(all metrics) is garbage collected.

version (long|int): Specifies the version of the entity schema.

classmethod from_dictionary(dictionary)

Creates an instance of this model from a dictionary

Args:

dictionary (dictionary): A dictionary representation of the object as obtained from the deserialization of the server’s response. The keys MUST match property names in the API description.

Returns:

object: An instance of this structure class.