Class: OCI::FileStorage::Models::ExportSummary

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/file_storage/models/export_summary.rb

Overview

Summary information for an export.

Constant Summary collapse

LIFECYCLE_STATE_ENUM = 
[
  LIFECYCLE_STATE_CREATING = 'CREATING'.freeze,
  LIFECYCLE_STATE_ACTIVE = 'ACTIVE'.freeze,
  LIFECYCLE_STATE_DELETING = 'DELETING'.freeze,
  LIFECYCLE_STATE_DELETED = 'DELETED'.freeze,
  LIFECYCLE_STATE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ ExportSummary

Initializes the object

Parameters:

  • attributes (Hash) (defaults to: {}) —

    Model attributes in the form of hash

Options Hash (attributes):



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
 
# File 'lib/oci/file_storage/models/export_summary.rb', line 108

def initialize(attributes = {})
  return unless attributes.is_a?(Hash)

  # convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }

  self.export_set_id = attributes[:'exportSetId'] if attributes[:'exportSetId']

  raise 'You cannot provide both :exportSetId and :export_set_id' if attributes.key?(:'exportSetId') && attributes.key?(:'export_set_id')

  self.export_set_id = attributes[:'export_set_id'] if attributes[:'export_set_id']

  self.file_system_id = attributes[:'fileSystemId'] if attributes[:'fileSystemId']

  raise 'You cannot provide both :fileSystemId and :file_system_id' if attributes.key?(:'fileSystemId') && attributes.key?(:'file_system_id')

  self.file_system_id = attributes[:'file_system_id'] if attributes[:'file_system_id']

  self.id = attributes[:'id'] if attributes[:'id']

  self.lifecycle_state = attributes[:'lifecycleState'] if attributes[:'lifecycleState']

  raise 'You cannot provide both :lifecycleState and :lifecycle_state' if attributes.key?(:'lifecycleState') && attributes.key?(:'lifecycle_state')

  self.lifecycle_state = attributes[:'lifecycle_state'] if attributes[:'lifecycle_state']

  self.path = attributes[:'path'] if attributes[:'path']

  self.is_idmap_groups_for_sys_auth = attributes[:'isIdmapGroupsForSysAuth'] unless attributes[:'isIdmapGroupsForSysAuth'].nil?

  raise 'You cannot provide both :isIdmapGroupsForSysAuth and :is_idmap_groups_for_sys_auth' if attributes.key?(:'isIdmapGroupsForSysAuth') && attributes.key?(:'is_idmap_groups_for_sys_auth')

  self.is_idmap_groups_for_sys_auth = attributes[:'is_idmap_groups_for_sys_auth'] unless attributes[:'is_idmap_groups_for_sys_auth'].nil?

  self.time_created = attributes[:'timeCreated'] if attributes[:'timeCreated']

  raise 'You cannot provide both :timeCreated and :time_created' if attributes.key?(:'timeCreated') && attributes.key?(:'time_created')

  self.time_created = attributes[:'time_created'] if attributes[:'time_created']

  self.locks = attributes[:'locks'] if attributes[:'locks']
end

Instance Attribute Details

#export_set_id ⇒ String

[Required] The OCID of this export's export set.

Returns:

  • (String) 


23
24
25
 
# File 'lib/oci/file_storage/models/export_summary.rb', line 23

def export_set_id
  @export_set_id
end

#file_system_id ⇒ String

[Required] The OCID of this export's file system.

Returns:

  • (String) 


27
28
29
 
# File 'lib/oci/file_storage/models/export_summary.rb', line 27

def file_system_id
  @file_system_id
end

#id ⇒ String

[Required] The OCID of this export.

Returns:

  • (String) 


31
32
33
 
# File 'lib/oci/file_storage/models/export_summary.rb', line 31

def id
  @id
end

#is_idmap_groups_for_sys_auth ⇒ BOOLEAN

Whether or not the export should use ID mapping for Unix groups rather than the group list provided within an NFS request's RPC header. When this flag is true the Unix UID from the RPC header is used to retrieve the list of secondary groups from a the ID mapping subsystem. The primary GID is always taken from the RPC header. If ID mapping is not configured, incorrectly configured, unavailable, or cannot be used to determine a list of secondary groups then an empty secondary group list is used for authorization. If the number of groups exceeds the limit of 256 groups, the list retrieved from LDAP is truncated to the first 256 groups read.

Returns:

  • (BOOLEAN) 


48
49
50
 
# File 'lib/oci/file_storage/models/export_summary.rb', line 48

def is_idmap_groups_for_sys_auth
  @is_idmap_groups_for_sys_auth
end

#lifecycle_state ⇒ String

[Required] The current state of this export.

Returns:

  • (String) 


35
36
37
 
# File 'lib/oci/file_storage/models/export_summary.rb', line 35

def lifecycle_state
  @lifecycle_state
end

#locks ⇒ Array<OCI::FileStorage::Models::ResourceLock>

Locks associated with this resource.

Returns:



60
61
62
 
# File 'lib/oci/file_storage/models/export_summary.rb', line 60

def locks
  @locks
end

#path ⇒ String

[Required] Path used to access the associated file system.

Avoid entering confidential information.

Example: /mediafiles

Returns:

  • (String) 


44
45
46
 
# File 'lib/oci/file_storage/models/export_summary.rb', line 44

def path
  @path
end

#time_created ⇒ DateTime

[Required] The date and time the export was created, expressed in RFC 3339 timestamp format.

Example: 2016-08-25T21:10:29.600Z

Returns:

  • (DateTime) 


56
57
58
 
# File 'lib/oci/file_storage/models/export_summary.rb', line 56

def time_created
  @time_created
end

Class Method Details

.attribute_map ⇒ Object

Attribute mapping from ruby-style variable name to JSON key.



63
64
65
66
67
68
69
70
71
72
73
74
75
76
 
# File 'lib/oci/file_storage/models/export_summary.rb', line 63

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'export_set_id': :'exportSetId',
    'file_system_id': :'fileSystemId',
    'id': :'id',
    'lifecycle_state': :'lifecycleState',
    'path': :'path',
    'is_idmap_groups_for_sys_auth': :'isIdmapGroupsForSysAuth',
    'time_created': :'timeCreated',
    'locks': :'locks'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



79
80
81
82
83
84
85
86
87
88
89
90
91
92
 
# File 'lib/oci/file_storage/models/export_summary.rb', line 79

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'export_set_id': :'String',
    'file_system_id': :'String',
    'id': :'String',
    'lifecycle_state': :'String',
    'path': :'String',
    'is_idmap_groups_for_sys_auth': :'BOOLEAN',
    'time_created': :'DateTime',
    'locks': :'Array<OCI::FileStorage::Models::ResourceLock>'
    # rubocop:enable Style/SymbolLiteral
  }
end

Instance Method Details

#==(other) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • other (Object) —

    the other object to be compared



171
172
173
174
175
176
177
178
179
180
181
182
183
 
# File 'lib/oci/file_storage/models/export_summary.rb', line 171

def ==(other)
  return true if equal?(other)

  self.class == other.class &&
    export_set_id == other.export_set_id &&
    file_system_id == other.file_system_id &&
    id == other.id &&
    lifecycle_state == other.lifecycle_state &&
    path == other.path &&
    is_idmap_groups_for_sys_auth == other.is_idmap_groups_for_sys_auth &&
    time_created == other.time_created &&
    locks == other.locks
end

#build_from_hash(attributes) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
 
# File 'lib/oci/file_storage/models/export_summary.rb', line 208

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)

  self.class.swagger_types.each_pair do |key, type|
    if type =~ /^Array<(.*)>/i
      # check to ensure the input is an array given that the the attribute
      # is documented as an array but the input is not
      if attributes[self.class.attribute_map[key]].is_a?(Array)
        public_method("#{key}=").call(
          attributes[self.class.attribute_map[key]]
            .map { |v| OCI::Internal::Util.convert_to_type(Regexp.last_match(1), v) }
        )
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      public_method("#{key}=").call(
        OCI::Internal::Util.convert_to_type(type, attributes[self.class.attribute_map[key]])
      )
    end
    # or else data not found in attributes(hash), not an issue as the data can be optional
  end

  self
end

#eql?(other) ⇒ Boolean

Parameters:

  • other (Object) —

    the other object to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


188
189
190
 
# File 'lib/oci/file_storage/models/export_summary.rb', line 188

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



197
198
199
 
# File 'lib/oci/file_storage/models/export_summary.rb', line 197

def hash
  [export_set_id, file_system_id, id, lifecycle_state, path, is_idmap_groups_for_sys_auth, time_created, locks].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



241
242
243
244
245
246
247
248
249
250
 
# File 'lib/oci/file_storage/models/export_summary.rb', line 241

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = public_method(attr).call
    next if value.nil? && !instance_variable_defined?("@#{attr}")

    hash[param] = _to_hash(value)
  end
  hash
end

#to_s ⇒ String

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



235
236
237
 
# File 'lib/oci/file_storage/models/export_summary.rb', line 235

def to_s
  to_hash.to_s
end