Class: OCI::ContainerInstances::Models::CreateLinuxContainerInstanceSecurityContextDetails

Inherits:
CreateContainerInstanceSecurityContextDetails show all
Defined in:
lib/oci/container_instances/models/create_linux_container_instance_security_context_details.rb

Overview

Security context for all containers in a Linux container instance.

Constant Summary collapse

FS_GROUP_CHANGE_POLICY_ENUM = 
[
  FS_GROUP_CHANGE_POLICY_ALWAYS = 'ALWAYS'.freeze,
  FS_GROUP_CHANGE_POLICY_ON_ROOT_MISMATCH = 'ON_ROOT_MISMATCH'.freeze
].freeze

Instance Attribute Summary collapse

Attributes inherited from CreateContainerInstanceSecurityContextDetails

#security_context_type

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from CreateContainerInstanceSecurityContextDetails

get_subtype

Constructor Details

#initialize(attributes = {}) ⇒ CreateLinuxContainerInstanceSecurityContextDetails

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :fs_group (Integer) —

    The value to assign to the #fs_group property

  • :fs_group_change_policy (String) —

    The value to assign to the #fs_group_change_policy property



57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
 
# File 'lib/oci/container_instances/models/create_linux_container_instance_security_context_details.rb', line 57

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.fs_group = attributes[:'fsGroup'] if attributes[:'fsGroup']

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

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

  self.fs_group_change_policy = attributes[:'fsGroupChangePolicy'] if attributes[:'fsGroupChangePolicy']
  self.fs_group_change_policy = "ALWAYS" if fs_group_change_policy.nil? && !attributes.key?(:'fsGroupChangePolicy') # rubocop:disable Style/StringLiterals

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

  self.fs_group_change_policy = attributes[:'fs_group_change_policy'] if attributes[:'fs_group_change_policy']
  self.fs_group_change_policy = "ALWAYS" if fs_group_change_policy.nil? && !attributes.key?(:'fsGroupChangePolicy') && !attributes.key?(:'fs_group_change_policy') # rubocop:disable Style/StringLiterals
end

Instance Attribute Details

#fs_group ⇒ Integer

A special supplemental group that applies to all containers in the container instance. Some volume types allow the container instance to change ownership of the volume. The owning GID will be the fsGroup, the setgid bit will be set (new files will be owned by the fsGroup), and the permission bits are OR'd with rw-rw—-. If unset, the container instance will not modify the ownership and permissions of volumes.

Returns:

  • (Integer) 


20
21
22
 
# File 'lib/oci/container_instances/models/create_linux_container_instance_security_context_details.rb', line 20

def fs_group
  @fs_group
end

#fs_group_change_policy ⇒ String

Defines behavior of changing ownership and permission of the volume before being exposed inside the containers. This only applies to volumes which support fsGroup ownership and permissions, and will have no effect on ephemeral volumes. ON_ROOT_MISMATCH only changes permissions and ownership if the permission and ownership of the root directory does not match the expected permissions and ownership of the volume. This can improve container instance start times. ALWAYS changes permission and ownership of the volume when it is mounted. If unset, ALWAYS is used.

Returns:

  • (String) 


25
26
27
 
# File 'lib/oci/container_instances/models/create_linux_container_instance_security_context_details.rb', line 25

def fs_group_change_policy
  @fs_group_change_policy
end

Class Method Details

.attribute_map ⇒ Object

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



28
29
30
31
32
33
34
35
36
 
# File 'lib/oci/container_instances/models/create_linux_container_instance_security_context_details.rb', line 28

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'security_context_type': :'securityContextType',
    'fs_group': :'fsGroup',
    'fs_group_change_policy': :'fsGroupChangePolicy'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



39
40
41
42
43
44
45
46
47
 
# File 'lib/oci/container_instances/models/create_linux_container_instance_security_context_details.rb', line 39

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'security_context_type': :'String',
    'fs_group': :'Integer',
    'fs_group_change_policy': :'String'
    # 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



97
98
99
100
101
102
103
104
 
# File 'lib/oci/container_instances/models/create_linux_container_instance_security_context_details.rb', line 97

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

  self.class == other.class &&
    security_context_type == other.security_context_type &&
    fs_group == other.fs_group &&
    fs_group_change_policy == other.fs_group_change_policy
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



129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
 
# File 'lib/oci/container_instances/models/create_linux_container_instance_security_context_details.rb', line 129

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


109
110
111
 
# File 'lib/oci/container_instances/models/create_linux_container_instance_security_context_details.rb', line 109

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



118
119
120
 
# File 'lib/oci/container_instances/models/create_linux_container_instance_security_context_details.rb', line 118

def hash
  [security_context_type, fs_group, fs_group_change_policy].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



162
163
164
165
166
167
168
169
170
171
 
# File 'lib/oci/container_instances/models/create_linux_container_instance_security_context_details.rb', line 162

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



156
157
158
 
# File 'lib/oci/container_instances/models/create_linux_container_instance_security_context_details.rb', line 156

def to_s
  to_hash.to_s
end