Class: Azure::Cosmosdb::Mgmt::V2019_08_01::Models::ConsistencyPolicy

Inherits:
Object
  • Object
show all
Includes:
MsRestAzure
Defined in:
lib/2019-08-01/generated/azure_mgmt_cosmosdb/models/consistency_policy.rb

Overview

The consistency policy for the Cosmos DB database account.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Attribute Details

#default_consistency_levelDefaultConsistencyLevel

configuration settings of the Cosmos DB account. Possible values include: ‘Eventual’, ‘Session’, ‘BoundedStaleness’, ‘Strong’, ‘ConsistentPrefix’

Returns:



19
20
21
# File 'lib/2019-08-01/generated/azure_mgmt_cosmosdb/models/consistency_policy.rb', line 19

def default_consistency_level
  @default_consistency_level
end

#max_interval_in_secondsInteger

level, this value represents the time amount of staleness (in seconds) tolerated. Accepted range for this value is 5 - 86400. Required when defaultConsistencyPolicy is set to ‘BoundedStaleness’.

Returns:

  • (Integer)

    When used with the Bounded Staleness consistency



31
32
33
# File 'lib/2019-08-01/generated/azure_mgmt_cosmosdb/models/consistency_policy.rb', line 31

def max_interval_in_seconds
  @max_interval_in_seconds
end

#max_staleness_prefixInteger

level, this value represents the number of stale requests tolerated. Accepted range for this value is 1 – 2,147,483,647. Required when defaultConsistencyPolicy is set to ‘BoundedStaleness’.

Returns:

  • (Integer)

    When used with the Bounded Staleness consistency



25
26
27
# File 'lib/2019-08-01/generated/azure_mgmt_cosmosdb/models/consistency_policy.rb', line 25

def max_staleness_prefix
  @max_staleness_prefix
end

Class Method Details

.mapperObject

Mapper for ConsistencyPolicy class as Ruby Hash. This will be used for serialization/deserialization.



38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
# File 'lib/2019-08-01/generated/azure_mgmt_cosmosdb/models/consistency_policy.rb', line 38

def self.mapper()
  {
    client_side_validation: true,
    required: false,
    serialized_name: 'ConsistencyPolicy',
    type: {
      name: 'Composite',
      class_name: 'ConsistencyPolicy',
      model_properties: {
        default_consistency_level: {
          client_side_validation: true,
          required: true,
          serialized_name: 'defaultConsistencyLevel',
          type: {
            name: 'Enum',
            module: 'DefaultConsistencyLevel'
          }
        },
        max_staleness_prefix: {
          client_side_validation: true,
          required: false,
          serialized_name: 'maxStalenessPrefix',
          constraints: {
            InclusiveMaximum: 2147483647,
            InclusiveMinimum: 1
          },
          type: {
            name: 'Number'
          }
        },
        max_interval_in_seconds: {
          client_side_validation: true,
          required: false,
          serialized_name: 'maxIntervalInSeconds',
          constraints: {
            InclusiveMaximum: 86400,
            InclusiveMinimum: 5
          },
          type: {
            name: 'Number'
          }
        }
      }
    }
  }
end