Class: OCI::ResourceManager::Models::ConfigurationSourceProviderSummary

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/resource_manager/models/configuration_source_provider_summary.rb

Overview

Summary information for a configuration source provider.

This class has direct subclasses. If you are using this class as input to a service operations then you should favor using a subclass over the base class

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ ConfigurationSourceProviderSummary

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
 
# File 'lib/oci/resource_manager/models/configuration_source_provider_summary.rb', line 158

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

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

  self.compartment_id = attributes[:'compartment_id'] if attributes[:'compartment_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.description = attributes[:'description'] if attributes[:'description']

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

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

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

  self.private_server_config_details = attributes[:'privateServerConfigDetails'] if attributes[:'privateServerConfigDetails']

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

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

  self.is_migration_required = attributes[:'isMigrationRequired'] unless attributes[:'isMigrationRequired'].nil?

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

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

  self.freeform_tags = attributes[:'freeformTags'] if attributes[:'freeformTags']

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

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

  self.defined_tags = attributes[:'definedTags'] if attributes[:'definedTags']

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

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

  self.system_tags = attributes[:'systemTags'] if attributes[:'systemTags']

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

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

Instance Attribute Details

#compartment_id ⇒ String

The OCID of the compartment where the configuration source provider is located.

Returns:

  • (String) 


19
20
21
 
# File 'lib/oci/resource_manager/models/configuration_source_provider_summary.rb', line 19

def compartment_id
  @compartment_id
end

#config_source_provider_type ⇒ String

[Required] The type of configuration source provider. The BITBUCKET_CLOUD_ACCESS_TOKEN type corresponds to Bitbucket Cloud. The BITBUCKET_SERVER_ACCESS_TOKEN type corresponds to Bitbucket Server. The GITLAB_ACCESS_TOKEN type corresponds to GitLab. The GITHUB_ACCESS_TOKEN type corresponds to GitHub.

Returns:

  • (String) 


51
52
53
 
# File 'lib/oci/resource_manager/models/configuration_source_provider_summary.rb', line 51

def config_source_provider_type
  @config_source_provider_type
end

#defined_tags ⇒ Hash<String, Hash<String, Object>>

Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {\"Operations\": {\"CostCenter\": \"42\"}}

Returns:

  • (Hash<String, Hash<String, Object>>) 


73
74
75
 
# File 'lib/oci/resource_manager/models/configuration_source_provider_summary.rb', line 73

def defined_tags
  @defined_tags
end

#description ⇒ String

General description of the configuration source provider.

Returns:

  • (String) 


28
29
30
 
# File 'lib/oci/resource_manager/models/configuration_source_provider_summary.rb', line 28

def description
  @description
end

#display_name ⇒ String

A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.

Returns:

  • (String) 


24
25
26
 
# File 'lib/oci/resource_manager/models/configuration_source_provider_summary.rb', line 24

def display_name
  @display_name
end

#freeform_tags ⇒ Hash<String, String>

Free-form tags associated with the resource. Each tag is a key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {\"Department\": \"Finance\"}

Returns:

  • (Hash<String, String>) 


66
67
68
 
# File 'lib/oci/resource_manager/models/configuration_source_provider_summary.rb', line 66

def freeform_tags
  @freeform_tags
end

#id ⇒ String

The OCID of the configuration source provider.

Returns:

  • (String) 


15
16
17
 
# File 'lib/oci/resource_manager/models/configuration_source_provider_summary.rb', line 15

def id
  @id
end

#is_migration_required ⇒ BOOLEAN

Indicates whether this configuration source provider uses legacy Bitbucket Cloud username/app-password credentials and must be migrated.

Returns:

  • (BOOLEAN) 


59
60
61
 
# File 'lib/oci/resource_manager/models/configuration_source_provider_summary.rb', line 59

def is_migration_required
  @is_migration_required
end

#lifecycle_state ⇒ String

Current state of the specified configuration source provider. For more information about configuration source provider lifecycle states in Resource Manager, see Key Concepts.

Returns:

  • (String) 


42
43
44
 
# File 'lib/oci/resource_manager/models/configuration_source_provider_summary.rb', line 42

def lifecycle_state
  @lifecycle_state
end

#private_server_config_details ⇒ OCI::ResourceManager::Models::PrivateServerConfigDetails

Returns:



54
55
56
 
# File 'lib/oci/resource_manager/models/configuration_source_provider_summary.rb', line 54

def private_server_config_details
  @private_server_config_details
end

#system_tags ⇒ Hash<String, Hash<String, Object>>

The system tags associated with this resource, if any. The system tags are set by Oracle cloud infrastructure services. Each key is predefined and scoped to namespaces. For more information, see Resource Tags. Example: {orcl-cloud: {free-tier-retain: true}}

Returns:

  • (Hash<String, Hash<String, Object>>) 


80
81
82
 
# File 'lib/oci/resource_manager/models/configuration_source_provider_summary.rb', line 80

def system_tags
  @system_tags
end

#time_created ⇒ DateTime

The date and time when the configuration source provider was created. Format is defined by RFC3339. Example: 2020-01-25T21:10:29.600Z

Returns:

  • (DateTime) 


35
36
37
 
# File 'lib/oci/resource_manager/models/configuration_source_provider_summary.rb', line 35

def time_created
  @time_created
end

Class Method Details

.attribute_map ⇒ Object

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



83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
 
# File 'lib/oci/resource_manager/models/configuration_source_provider_summary.rb', line 83

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'id',
    'compartment_id': :'compartmentId',
    'display_name': :'displayName',
    'description': :'description',
    'time_created': :'timeCreated',
    'lifecycle_state': :'lifecycleState',
    'config_source_provider_type': :'configSourceProviderType',
    'private_server_config_details': :'privateServerConfigDetails',
    'is_migration_required': :'isMigrationRequired',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags',
    'system_tags': :'systemTags'
    # rubocop:enable Style/SymbolLiteral
  }
end

.get_subtype(object_hash) ⇒ Object

Given the hash representation of a subtype of this class, use the info in the hash to return the class of the subtype.



127
128
129
130
131
132
133
134
135
136
137
 
# File 'lib/oci/resource_manager/models/configuration_source_provider_summary.rb', line 127

def self.get_subtype(object_hash)
  type = object_hash[:'configSourceProviderType'] # rubocop:disable Style/SymbolLiteral

  return 'OCI::ResourceManager::Models::GitlabAccessTokenConfigurationSourceProviderSummary' if type == 'GITLAB_ACCESS_TOKEN'
  return 'OCI::ResourceManager::Models::BitbucketServerAccessTokenConfigurationSourceProviderSummary' if type == 'BITBUCKET_SERVER_ACCESS_TOKEN'
  return 'OCI::ResourceManager::Models::BitbucketCloudEmailApiTokenConfigurationSourceProviderSummary' if type == 'BITBUCKET_CLOUD_ACCESS_TOKEN'
  return 'OCI::ResourceManager::Models::GithubAccessTokenConfigurationSourceProviderSummary' if type == 'GITHUB_ACCESS_TOKEN'

  # TODO: Log a warning when the subtype is not found.
  'OCI::ResourceManager::Models::ConfigurationSourceProviderSummary'
end

.swagger_types ⇒ Object

Attribute type mapping.



103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
 
# File 'lib/oci/resource_manager/models/configuration_source_provider_summary.rb', line 103

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'String',
    'compartment_id': :'String',
    'display_name': :'String',
    'description': :'String',
    'time_created': :'DateTime',
    'lifecycle_state': :'String',
    'config_source_provider_type': :'String',
    'private_server_config_details': :'OCI::ResourceManager::Models::PrivateServerConfigDetails',
    'is_migration_required': :'BOOLEAN',
    'freeform_tags': :'Hash<String, String>',
    'defined_tags': :'Hash<String, Hash<String, Object>>',
    'system_tags': :'Hash<String, Hash<String, Object>>'
    # 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



236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
 
# File 'lib/oci/resource_manager/models/configuration_source_provider_summary.rb', line 236

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

  self.class == other.class &&
    id == other.id &&
    compartment_id == other.compartment_id &&
    display_name == other.display_name &&
    description == other.description &&
    time_created == other.time_created &&
    lifecycle_state == other.lifecycle_state &&
    config_source_provider_type == other.config_source_provider_type &&
    private_server_config_details == other.private_server_config_details &&
    is_migration_required == other.is_migration_required &&
    freeform_tags == other.freeform_tags &&
    defined_tags == other.defined_tags &&
    system_tags == other.system_tags
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



277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
 
# File 'lib/oci/resource_manager/models/configuration_source_provider_summary.rb', line 277

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


257
258
259
 
# File 'lib/oci/resource_manager/models/configuration_source_provider_summary.rb', line 257

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



266
267
268
 
# File 'lib/oci/resource_manager/models/configuration_source_provider_summary.rb', line 266

def hash
  [id, compartment_id, display_name, description, time_created, lifecycle_state, config_source_provider_type, private_server_config_details, is_migration_required, freeform_tags, defined_tags, system_tags].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



310
311
312
313
314
315
316
317
318
319
 
# File 'lib/oci/resource_manager/models/configuration_source_provider_summary.rb', line 310

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



304
305
306
 
# File 'lib/oci/resource_manager/models/configuration_source_provider_summary.rb', line 304

def to_s
  to_hash.to_s
end