Class: Azure::Cosmosdb::Mgmt::V2020_04_01::Models::MongoDBCollectionGetPropertiesResource

Inherits:
Object
  • Object
show all
Includes:
MsRestAzure
Defined in:
lib/2020-04-01/generated/azure_mgmt_cosmosdb/models/mongo_dbcollection_get_properties_resource.rb

Overview

Model object.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Attribute Details

#_etag ⇒ String

etag required for optimistic concurrency control.

Returns:

  • (String) —

    A system generated property representing the resource



38
39
40
 
# File 'lib/2020-04-01/generated/azure_mgmt_cosmosdb/models/mongo_dbcollection_get_properties_resource.rb', line 38

def _etag
  @_etag
end

#_rid ⇒ String

Returns A system generated property. A unique identifier.

Returns:

  • (String) —

    A system generated property. A unique identifier.



30
31
32
 
# File 'lib/2020-04-01/generated/azure_mgmt_cosmosdb/models/mongo_dbcollection_get_properties_resource.rb', line 30

def _rid
  @_rid
end

#_ts ⇒ Object

timestamp of the resource.

Returns:

  • A system generated property that denotes the last updated



34
35
36
 
# File 'lib/2020-04-01/generated/azure_mgmt_cosmosdb/models/mongo_dbcollection_get_properties_resource.rb', line 34

def _ts
  @_ts
end

#analytical_storage_ttl ⇒ Integer

Returns Analytical TTL.

Returns:

  • (Integer) —

    Analytical TTL.



27
28
29
 
# File 'lib/2020-04-01/generated/azure_mgmt_cosmosdb/models/mongo_dbcollection_get_properties_resource.rb', line 27

def analytical_storage_ttl
  @analytical_storage_ttl
end

#id ⇒ String

Returns Name of the Cosmos DB MongoDB collection.

Returns:

  • (String) —

    Name of the Cosmos DB MongoDB collection



17
18
19
 
# File 'lib/2020-04-01/generated/azure_mgmt_cosmosdb/models/mongo_dbcollection_get_properties_resource.rb', line 17

def id
  @id
end

#indexes ⇒ Array<MongoIndex>

Returns List of index keys.

Returns:



24
25
26
 
# File 'lib/2020-04-01/generated/azure_mgmt_cosmosdb/models/mongo_dbcollection_get_properties_resource.rb', line 24

def indexes
  @indexes
end

#shard_key ⇒ Hash{String => String}

applied for the request.

Returns:

  • (Hash{String => String}) —

    A key-value pair of shard keys to be



21
22
23
 
# File 'lib/2020-04-01/generated/azure_mgmt_cosmosdb/models/mongo_dbcollection_get_properties_resource.rb', line 21

def shard_key
  @shard_key
end

Class Method Details

.mapper ⇒ Object

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



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
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
 
# File 'lib/2020-04-01/generated/azure_mgmt_cosmosdb/models/mongo_dbcollection_get_properties_resource.rb', line 45

def self.mapper()
  {
    client_side_validation: true,
    required: false,
    serialized_name: 'MongoDBCollectionGetProperties_resource',
    type: {
      name: 'Composite',
      class_name: 'MongoDBCollectionGetPropertiesResource',
      model_properties: {
        id: {
          client_side_validation: true,
          required: true,
          serialized_name: 'id',
          type: {
            name: 'String'
          }
        },
        shard_key: {
          client_side_validation: true,
          required: false,
          serialized_name: 'shardKey',
          type: {
            name: 'Dictionary',
            value: {
                client_side_validation: true,
                required: false,
                serialized_name: 'StringElementType',
                type: {
                  name: 'String'
                }
            }
          }
        },
        indexes: {
          client_side_validation: true,
          required: false,
          serialized_name: 'indexes',
          type: {
            name: 'Sequence',
            element: {
                client_side_validation: true,
                required: false,
                serialized_name: 'MongoIndexElementType',
                type: {
                  name: 'Composite',
                  class_name: 'MongoIndex'
                }
            }
          }
        },
        analytical_storage_ttl: {
          client_side_validation: true,
          required: false,
          serialized_name: 'analyticalStorageTtl',
          type: {
            name: 'Number'
          }
        },
        _rid: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: '_rid',
          type: {
            name: 'String'
          }
        },
        _ts: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: '_ts',
          type: {
            name: 'Object'
          }
        },
        _etag: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: '_etag',
          type: {
            name: 'String'
          }
        }
      }
    }
  }
end