Class: OCI::ContainerInstances::Models::LinuxSecurityContext

Inherits:
SecurityContext
  • Object
show all
Defined in:
lib/oci/container_instances/models/linux_security_context.rb

Overview

Security context for Linux container.

Constant Summary

Constants inherited from SecurityContext

SecurityContext::SECURITY_CONTEXT_TYPE_ENUM

Instance Attribute Summary collapse

Attributes inherited from SecurityContext

#security_context_type

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from SecurityContext

get_subtype

Constructor Details

#initialize(attributes = {}) ⇒ LinuxSecurityContext

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



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
 
# File 'lib/oci/container_instances/models/linux_security_context.rb', line 66

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

  attributes['securityContextType'] = 'LINUX'

  super(attributes)

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

  self.run_as_user = attributes[:'runAsUser'] if attributes[:'runAsUser']

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

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

  self.run_as_group = attributes[:'runAsGroup'] if attributes[:'runAsGroup']

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

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

  self.is_non_root_user_check_enabled = attributes[:'isNonRootUserCheckEnabled'] unless attributes[:'isNonRootUserCheckEnabled'].nil?

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

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

  self.is_root_file_system_readonly = attributes[:'isRootFileSystemReadonly'] unless attributes[:'isRootFileSystemReadonly'].nil?

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

  self.is_root_file_system_readonly = attributes[:'is_root_file_system_readonly'] unless attributes[:'is_root_file_system_readonly'].nil?
end

Instance Attribute Details

#is_non_root_user_check_enabled ⇒ BOOLEAN

Indicates if the container must run as a non-root user. If true, the service validates the container image at runtime to ensure that it is not going to run with UID 0 (root) and fails the container instance creation if the validation fails.

Returns:

  • (BOOLEAN) 


24
25
26
 
# File 'lib/oci/container_instances/models/linux_security_context.rb', line 24

def is_non_root_user_check_enabled
  @is_non_root_user_check_enabled
end

#is_root_file_system_readonly ⇒ BOOLEAN

Determines if the container will have a read-only root file system. Default value is false.

Returns:

  • (BOOLEAN) 


28
29
30
 
# File 'lib/oci/container_instances/models/linux_security_context.rb', line 28

def is_root_file_system_readonly
  @is_root_file_system_readonly
end

#run_as_group ⇒ Integer

The group ID (GID) to run the entrypoint process of the container. Uses runtime default if not provided.

Returns:

  • (Integer) 


19
20
21
 
# File 'lib/oci/container_instances/models/linux_security_context.rb', line 19

def run_as_group
  @run_as_group
end

#run_as_user ⇒ Integer

The user ID (UID) to run the entrypoint process of the container. Defaults to user specified UID in container image metadata if not provided. This must be provided if runAsGroup is provided.

Returns:

  • (Integer) 


15
16
17
 
# File 'lib/oci/container_instances/models/linux_security_context.rb', line 15

def run_as_user
  @run_as_user
end

Class Method Details

.attribute_map ⇒ Object

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



31
32
33
34
35
36
37
38
39
40
41
 
# File 'lib/oci/container_instances/models/linux_security_context.rb', line 31

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'security_context_type': :'securityContextType',
    'run_as_user': :'runAsUser',
    'run_as_group': :'runAsGroup',
    'is_non_root_user_check_enabled': :'isNonRootUserCheckEnabled',
    'is_root_file_system_readonly': :'isRootFileSystemReadonly'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



44
45
46
47
48
49
50
51
52
53
54
 
# File 'lib/oci/container_instances/models/linux_security_context.rb', line 44

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'security_context_type': :'String',
    'run_as_user': :'Integer',
    'run_as_group': :'Integer',
    'is_non_root_user_check_enabled': :'BOOLEAN',
    'is_root_file_system_readonly': :'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



108
109
110
111
112
113
114
115
116
117
 
# File 'lib/oci/container_instances/models/linux_security_context.rb', line 108

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

  self.class == other.class &&
    security_context_type == other.security_context_type &&
    run_as_user == other.run_as_user &&
    run_as_group == other.run_as_group &&
    is_non_root_user_check_enabled == other.is_non_root_user_check_enabled &&
    is_root_file_system_readonly == other.is_root_file_system_readonly
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



142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
 
# File 'lib/oci/container_instances/models/linux_security_context.rb', line 142

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


122
123
124
 
# File 'lib/oci/container_instances/models/linux_security_context.rb', line 122

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



131
132
133
 
# File 'lib/oci/container_instances/models/linux_security_context.rb', line 131

def hash
  [security_context_type, run_as_user, run_as_group, is_non_root_user_check_enabled, is_root_file_system_readonly].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



175
176
177
178
179
180
181
182
183
184
 
# File 'lib/oci/container_instances/models/linux_security_context.rb', line 175

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



169
170
171
 
# File 'lib/oci/container_instances/models/linux_security_context.rb', line 169

def to_s
  to_hash.to_s
end