Class: OCI::FileStorage::Models::CreateExportDetails

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

Overview

Details for creating the export.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ CreateExportDetails

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



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

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_options = attributes[:'exportOptions'] if attributes[:'exportOptions']

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

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

  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.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?
end

Instance Attribute Details

#export_options ⇒ Array<OCI::FileStorage::Models::ClientOptions>

Export options for the new export. If left unspecified, defaults to:

   [
     {
        \"source\" : \"0.0.0.0/0\",
        \"requirePrivilegedSourcePort\" : false,
        \"access\": \"READ_WRITE\",
        \"identitySquash\": \"NONE\",
        \"anonymousUid\": 65534,
        \"anonymousGid\": 65534,
        \"isAnonymousAccessAllowed\": false,
        \"allowedAuth\": [\"SYS\"]
      }
   ]

Note: Mount targets do not have Internet-routable IP addresses. Therefore they will not be reachable from the Internet, even if an associated ClientOptions item has a source of 0.0.0.0/0.

If set to the empty array then the export will not be visible to any clients.

The export's exportOptions can be changed after creation using the UpdateExport operation.

Returns:



39
40
41
 
# File 'lib/oci/file_storage/models/create_export_details.rb', line 39

def export_options
  @export_options
end

#export_set_id ⇒ String

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

Returns:

  • (String) 


43
44
45
 
# File 'lib/oci/file_storage/models/create_export_details.rb', line 43

def export_set_id
  @export_set_id
end

#file_system_id ⇒ String

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

Returns:

  • (String) 


47
48
49
 
# File 'lib/oci/file_storage/models/create_export_details.rb', line 47

def file_system_id
  @file_system_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) 


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

def is_idmap_groups_for_sys_auth
  @is_idmap_groups_for_sys_auth
end

#path ⇒ String

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

Avoid entering confidential information.

Example: /mediafiles

Returns:

  • (String) 


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

def path
  @path
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
 
# File 'lib/oci/file_storage/models/create_export_details.rb', line 63

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'export_options': :'exportOptions',
    'export_set_id': :'exportSetId',
    'file_system_id': :'fileSystemId',
    'path': :'path',
    'is_idmap_groups_for_sys_auth': :'isIdmapGroupsForSysAuth'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



76
77
78
79
80
81
82
83
84
85
86
 
# File 'lib/oci/file_storage/models/create_export_details.rb', line 76

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'export_options': :'Array<OCI::FileStorage::Models::ClientOptions>',
    'export_set_id': :'String',
    'file_system_id': :'String',
    'path': :'String',
    'is_idmap_groups_for_sys_auth': :'BOOLEAN'
    # 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



139
140
141
142
143
144
145
146
147
148
 
# File 'lib/oci/file_storage/models/create_export_details.rb', line 139

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

  self.class == other.class &&
    export_options == other.export_options &&
    export_set_id == other.export_set_id &&
    file_system_id == other.file_system_id &&
    path == other.path &&
    is_idmap_groups_for_sys_auth == other.is_idmap_groups_for_sys_auth
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



173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
 
# File 'lib/oci/file_storage/models/create_export_details.rb', line 173

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


153
154
155
 
# File 'lib/oci/file_storage/models/create_export_details.rb', line 153

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



162
163
164
 
# File 'lib/oci/file_storage/models/create_export_details.rb', line 162

def hash
  [export_options, export_set_id, file_system_id, path, is_idmap_groups_for_sys_auth].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



206
207
208
209
210
211
212
213
214
215
 
# File 'lib/oci/file_storage/models/create_export_details.rb', line 206

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



200
201
202
 
# File 'lib/oci/file_storage/models/create_export_details.rb', line 200

def to_s
  to_hash.to_s
end