Class: Azure::DataBoxEdge::Mgmt::V2019_08_01::Models::Share

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

Overview

Represents a share on the Data Box Edge/Gateway device.

Instance Attribute Summary collapse

Attributes inherited from ARMBaseModel

#id, #name, #type

Class Method Summary collapse

Instance Attribute Details

#access_protocol ⇒ ShareAccessProtocol

Possible values include: ‘SMB’, ‘NFS’

Returns:



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

def access_protocol
  @access_protocol
end

#azure_container_info ⇒ AzureContainerInfo

Returns Azure container mapping for the share.

Returns:



27
28
29
 
# File 'lib/2019-08-01/generated/azure_mgmt_databoxedge/models/share.rb', line 27

def azure_container_info
  @azure_container_info
end

#client_access_rights ⇒ Array<ClientAccessRight>

corresponding access rights on the share(required for NFS protocol).

Returns:



39
40
41
 
# File 'lib/2019-08-01/generated/azure_mgmt_databoxedge/models/share.rb', line 39

def client_access_rights
  @client_access_rights
end

#data_policy ⇒ DataPolicy

‘Cloud’, ‘Local’

Returns:

  • (DataPolicy) —

    Data policy of the share. Possible values include:



49
50
51
 
# File 'lib/2019-08-01/generated/azure_mgmt_databoxedge/models/share.rb', line 49

def data_policy
  @data_policy
end

#description ⇒ String

Returns Description for the share.

Returns:

  • (String) —

    Description for the share.



16
17
18
 
# File 'lib/2019-08-01/generated/azure_mgmt_databoxedge/models/share.rb', line 16

def description
  @description
end

#monitoring_status ⇒ MonitoringStatus

Possible values include: ‘Enabled’, ‘Disabled’

Returns:



24
25
26
 
# File 'lib/2019-08-01/generated/azure_mgmt_databoxedge/models/share.rb', line 24

def monitoring_status
  @monitoring_status
end

#refresh_details ⇒ RefreshDetails

Returns Details of the refresh job on this share.

Returns:



42
43
44
 
# File 'lib/2019-08-01/generated/azure_mgmt_databoxedge/models/share.rb', line 42

def refresh_details
  @refresh_details
end

#share_mappings ⇒ Array<MountPointMap>

Returns Share mount point to the role.

Returns:



45
46
47
 
# File 'lib/2019-08-01/generated/azure_mgmt_databoxedge/models/share.rb', line 45

def share_mappings
  @share_mappings
end

#share_status ⇒ ShareStatus

include: ‘Offline’, ‘Unknown’, ‘OK’, ‘Updating’, ‘NeedsAttention’

Returns:

  • (ShareStatus) —

    Current status of the share. Possible values



20
21
22
 
# File 'lib/2019-08-01/generated/azure_mgmt_databoxedge/models/share.rb', line 20

def share_status
  @share_status
end

#user_access_rights ⇒ Array<UserAccessRight>

access rights on the share (required for SMB protocol).

Returns:



35
36
37
 
# File 'lib/2019-08-01/generated/azure_mgmt_databoxedge/models/share.rb', line 35

def user_access_rights
  @user_access_rights
end

Class Method Details

.mapper ⇒ Object

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



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
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
 
# File 'lib/2019-08-01/generated/azure_mgmt_databoxedge/models/share.rb', line 56

def self.mapper()
  {
    client_side_validation: true,
    required: false,
    serialized_name: 'Share',
    type: {
      name: 'Composite',
      class_name: 'Share',
      model_properties: {
        id: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'id',
          type: {
            name: 'String'
          }
        },
        name: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'name',
          type: {
            name: 'String'
          }
        },
        type: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'type',
          type: {
            name: 'String'
          }
        },
        description: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.description',
          type: {
            name: 'String'
          }
        },
        share_status: {
          client_side_validation: true,
          required: true,
          serialized_name: 'properties.shareStatus',
          type: {
            name: 'String'
          }
        },
        monitoring_status: {
          client_side_validation: true,
          required: true,
          serialized_name: 'properties.monitoringStatus',
          type: {
            name: 'String'
          }
        },
        azure_container_info: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.azureContainerInfo',
          type: {
            name: 'Composite',
            class_name: 'AzureContainerInfo'
          }
        },
        access_protocol: {
          client_side_validation: true,
          required: true,
          serialized_name: 'properties.accessProtocol',
          type: {
            name: 'String'
          }
        },
        user_access_rights: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.userAccessRights',
          type: {
            name: 'Sequence',
            element: {
                client_side_validation: true,
                required: false,
                serialized_name: 'UserAccessRightElementType',
                type: {
                  name: 'Composite',
                  class_name: 'UserAccessRight'
                }
            }
          }
        },
        client_access_rights: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.clientAccessRights',
          type: {
            name: 'Sequence',
            element: {
                client_side_validation: true,
                required: false,
                serialized_name: 'ClientAccessRightElementType',
                type: {
                  name: 'Composite',
                  class_name: 'ClientAccessRight'
                }
            }
          }
        },
        refresh_details: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.refreshDetails',
          type: {
            name: 'Composite',
            class_name: 'RefreshDetails'
          }
        },
        share_mappings: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'properties.shareMappings',
          type: {
            name: 'Sequence',
            element: {
                client_side_validation: true,
                required: false,
                serialized_name: 'MountPointMapElementType',
                type: {
                  name: 'Composite',
                  class_name: 'MountPointMap'
                }
            }
          }
        },
        data_policy: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.dataPolicy',
          type: {
            name: 'String'
          }
        }
      }
    }
  }
end