Class: OCI::Bds::Models::ResourcePrincipalConfiguration

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/bds/models/resource_principal_configuration.rb

Overview

Resource Principal Session Token Details.

Constant Summary collapse

LIFECYCLE_STATE_ENUM = 
[
  LIFECYCLE_STATE_CREATING = 'CREATING'.freeze,
  LIFECYCLE_STATE_ACTIVE = 'ACTIVE'.freeze,
  LIFECYCLE_STATE_UPDATING = 'UPDATING'.freeze,
  LIFECYCLE_STATE_DELETING = 'DELETING'.freeze,
  LIFECYCLE_STATE_DELETED = 'DELETED'.freeze,
  LIFECYCLE_STATE_FAILED = 'FAILED'.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 = {}) ⇒ ResourcePrincipalConfiguration

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :id (String) —

    The value to assign to the #id property

  • :bds_instance_id (String) —

    The value to assign to the #bds_instance_id property

  • :display_name (String) —

    The value to assign to the #display_name property

  • :secret_id (String) —

    The value to assign to the #secret_id property

  • :session_token_life_span_duration_in_hours (Integer) —

    The value to assign to the #session_token_life_span_duration_in_hours property

  • :lifecycle_state (String) —

    The value to assign to the #lifecycle_state property

  • :time_token_refreshed (DateTime) —

    The value to assign to the #time_token_refreshed property

  • :time_token_expiry (DateTime) —

    The value to assign to the #time_token_expiry property

  • :time_created (DateTime) —

    The value to assign to the #time_created property

  • :time_updated (DateTime) —

    The value to assign to the #time_updated property



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
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
 
# File 'lib/oci/bds/models/resource_principal_configuration.rb', line 115

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

  self.bds_instance_id = attributes[:'bdsInstanceId'] if attributes[:'bdsInstanceId']

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

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

  self.display_name = attributes[:'displayName'] if attributes[:'displayName']

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

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

  self.secret_id = attributes[:'secretId'] if attributes[:'secretId']

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

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

  self.session_token_life_span_duration_in_hours = attributes[:'sessionTokenLifeSpanDurationInHours'] if attributes[:'sessionTokenLifeSpanDurationInHours']

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

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

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

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

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

  self.time_token_expiry = attributes[:'timeTokenExpiry'] if attributes[:'timeTokenExpiry']

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

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

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

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

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

Instance Attribute Details

#bds_instance_id ⇒ String

[Required] The OCID of the bdsInstance which is the parent resource id.

Returns:

  • (String) 


28
29
30
 
# File 'lib/oci/bds/models/resource_principal_configuration.rb', line 28

def bds_instance_id
  @bds_instance_id
end

#display_name ⇒ String

[Required] A user-friendly name. Only ASCII alphanumeric characters with no spaces allowed. The name does not have to be unique, and it may be changed. Avoid entering confidential information.

Returns:

  • (String) 


32
33
34
 
# File 'lib/oci/bds/models/resource_principal_configuration.rb', line 32

def display_name
  @display_name
end

#id ⇒ String

[Required] The id of the ResourcePrincipalConfiguration defined under BDS resources, not OCID.

Returns:

  • (String) 


24
25
26
 
# File 'lib/oci/bds/models/resource_principal_configuration.rb', line 24

def id
  @id
end

#lifecycle_state ⇒ String

[Required] The state of the ResourcePrincipalConfiguration.

Returns:

  • (String) 


44
45
46
 
# File 'lib/oci/bds/models/resource_principal_configuration.rb', line 44

def lifecycle_state
  @lifecycle_state
end

#secret_id ⇒ String

The secretId for the clusterAdminPassword.

Returns:

  • (String) 


36
37
38
 
# File 'lib/oci/bds/models/resource_principal_configuration.rb', line 36

def secret_id
  @secret_id
end

#session_token_life_span_duration_in_hours ⇒ Integer

[Required] Life span in hours of each resource principal session token.

Returns:

  • (Integer) 


40
41
42
 
# File 'lib/oci/bds/models/resource_principal_configuration.rb', line 40

def session_token_life_span_duration_in_hours
  @session_token_life_span_duration_in_hours
end

#time_created ⇒ DateTime

[Required] The time the ResourcePrincipalConfiguration was created, shown as an RFC 3339 formatted datetime string.

Returns:

  • (DateTime) 


56
57
58
 
# File 'lib/oci/bds/models/resource_principal_configuration.rb', line 56

def time_created
  @time_created
end

#time_token_expiry ⇒ DateTime

the time the resource principal session token will expired, shown as an rfc 3339 formatted datetime string.

Returns:

  • (DateTime) 


52
53
54
 
# File 'lib/oci/bds/models/resource_principal_configuration.rb', line 52

def time_token_expiry
  @time_token_expiry
end

#time_token_refreshed ⇒ DateTime

the time the resource principal session token was refreshed, shown as an rfc 3339 formatted datetime string.

Returns:

  • (DateTime) 


48
49
50
 
# File 'lib/oci/bds/models/resource_principal_configuration.rb', line 48

def time_token_refreshed
  @time_token_refreshed
end

#time_updated ⇒ DateTime

[Required] The time the ResourcePrincipalConfiguration was updated, shown as an RFC 3339 formatted datetime string.

Returns:

  • (DateTime) 


61
62
63
 
# File 'lib/oci/bds/models/resource_principal_configuration.rb', line 61

def time_updated
  @time_updated
end

Class Method Details

.attribute_map ⇒ Object

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



64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
 
# File 'lib/oci/bds/models/resource_principal_configuration.rb', line 64

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'id',
    'bds_instance_id': :'bdsInstanceId',
    'display_name': :'displayName',
    'secret_id': :'secretId',
    'session_token_life_span_duration_in_hours': :'sessionTokenLifeSpanDurationInHours',
    'lifecycle_state': :'lifecycleState',
    'time_token_refreshed': :'timeTokenRefreshed',
    'time_token_expiry': :'timeTokenExpiry',
    'time_created': :'timeCreated',
    'time_updated': :'timeUpdated'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
 
# File 'lib/oci/bds/models/resource_principal_configuration.rb', line 82

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'String',
    'bds_instance_id': :'String',
    'display_name': :'String',
    'secret_id': :'String',
    'session_token_life_span_duration_in_hours': :'Integer',
    'lifecycle_state': :'String',
    'time_token_refreshed': :'DateTime',
    'time_token_expiry': :'DateTime',
    'time_created': :'DateTime',
    'time_updated': :'DateTime'
    # 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



198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
 
# File 'lib/oci/bds/models/resource_principal_configuration.rb', line 198

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

  self.class == other.class &&
    id == other.id &&
    bds_instance_id == other.bds_instance_id &&
    display_name == other.display_name &&
    secret_id == other.secret_id &&
    session_token_life_span_duration_in_hours == other.session_token_life_span_duration_in_hours &&
    lifecycle_state == other.lifecycle_state &&
    time_token_refreshed == other.time_token_refreshed &&
    time_token_expiry == other.time_token_expiry &&
    time_created == other.time_created &&
    time_updated == other.time_updated
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



237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
 
# File 'lib/oci/bds/models/resource_principal_configuration.rb', line 237

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


217
218
219
 
# File 'lib/oci/bds/models/resource_principal_configuration.rb', line 217

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



226
227
228
 
# File 'lib/oci/bds/models/resource_principal_configuration.rb', line 226

def hash
  [id, bds_instance_id, display_name, secret_id, session_token_life_span_duration_in_hours, lifecycle_state, time_token_refreshed, time_token_expiry, time_created, time_updated].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



270
271
272
273
274
275
276
277
278
279
 
# File 'lib/oci/bds/models/resource_principal_configuration.rb', line 270

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



264
265
266
 
# File 'lib/oci/bds/models/resource_principal_configuration.rb', line 264

def to_s
  to_hash.to_s
end