Class: OCI::ContainerEngine::Models::CredentialRotationStatus

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/container_engine/models/credential_rotation_status.rb

Overview

Information regarding cluster's credential rotation.

Constant Summary collapse

STATUS_ENUM = 
[
  STATUS_IN_PROGRESS = 'IN_PROGRESS'.freeze,
  STATUS_WAITING = 'WAITING'.freeze,
  STATUS_COMPLETED = 'COMPLETED'.freeze,
  STATUS_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze
STATUS_DETAILS_ENUM = 
[
  STATUS_DETAILS_ISSUING_NEW_CREDENTIALS = 'ISSUING_NEW_CREDENTIALS'.freeze,
  STATUS_DETAILS_NEW_CREDENTIALS_ISSUED = 'NEW_CREDENTIALS_ISSUED'.freeze,
  STATUS_DETAILS_RETIRING_OLD_CREDENTIALS = 'RETIRING_OLD_CREDENTIALS'.freeze,
  STATUS_DETAILS_COMPLETED = 'COMPLETED'.freeze,
  STATUS_DETAILS_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ CredentialRotationStatus

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
 
# File 'lib/oci/container_engine/models/credential_rotation_status.rb', line 79

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

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

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

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

  self.status_details = attributes[:'statusDetails'] if attributes[:'statusDetails']

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

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

Instance Attribute Details

#status ⇒ String

[Required] Credential rotation status of a kubernetes cluster IN_PROGRESS: Issuing new credentials to kubernetes cluster control plane and worker nodes or retiring old credentials from kubernetes cluster control plane and worker nodes. WAITING: Waiting for customer to invoke the complete rotation action or the automcatic complete rotation action. COMPLETED: New credentials are functional on kuberentes cluster.

Returns:

  • (String) 


37
38
39
 
# File 'lib/oci/container_engine/models/credential_rotation_status.rb', line 37

def status
  @status
end

#status_details ⇒ String

[Required] Details of a kuberenetes cluster credential rotation status: ISSUING_NEW_CREDENTIALS: Credential rotation is in progress. Starting to issue new credentials to kubernetes cluster control plane and worker nodes. NEW_CREDENTIALS_ISSUED: New credentials are added. At this stage cluster has both old and new credentials and is awaiting old credentials retirement. RETIRING_OLD_CREDENTIALS: Retirement of old credentials is in progress. Starting to remove old credentials from kubernetes cluster control plane and worker nodes. COMPLETED: Credential rotation is complete. Old credentials are retired.

Returns:

  • (String) 


46
47
48
 
# File 'lib/oci/container_engine/models/credential_rotation_status.rb', line 46

def status_details
  @status_details
end

#time_auto_completion_scheduled ⇒ DateTime

The time by which retirement of old credentials should start.

Returns:

  • (DateTime) 


29
30
31
 
# File 'lib/oci/container_engine/models/credential_rotation_status.rb', line 29

def time_auto_completion_scheduled
  @time_auto_completion_scheduled
end

Class Method Details

.attribute_map ⇒ Object

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



49
50
51
52
53
54
55
56
57
 
# File 'lib/oci/container_engine/models/credential_rotation_status.rb', line 49

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'time_auto_completion_scheduled': :'timeAutoCompletionScheduled',
    'status': :'status',
    'status_details': :'statusDetails'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



60
61
62
63
64
65
66
67
68
 
# File 'lib/oci/container_engine/models/credential_rotation_status.rb', line 60

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'time_auto_completion_scheduled': :'DateTime',
    'status': :'String',
    'status_details': :'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



133
134
135
136
137
138
139
140
 
# File 'lib/oci/container_engine/models/credential_rotation_status.rb', line 133

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

  self.class == other.class &&
    time_auto_completion_scheduled == other.time_auto_completion_scheduled &&
    status == other.status &&
    status_details == other.status_details
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



165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
 
# File 'lib/oci/container_engine/models/credential_rotation_status.rb', line 165

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


145
146
147
 
# File 'lib/oci/container_engine/models/credential_rotation_status.rb', line 145

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



154
155
156
 
# File 'lib/oci/container_engine/models/credential_rotation_status.rb', line 154

def hash
  [time_auto_completion_scheduled, status, status_details].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



198
199
200
201
202
203
204
205
206
207
 
# File 'lib/oci/container_engine/models/credential_rotation_status.rb', line 198

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



192
193
194
 
# File 'lib/oci/container_engine/models/credential_rotation_status.rb', line 192

def to_s
  to_hash.to_s
end