Class: OCI::ResourceManager::Models::ConfigurationSourceProvider

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

Overview

The properties that define a configuration source provider. For more information, see Managing Configuration Source Providers.

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

Constant Summary collapse

LIFECYCLE_STATE_ENUM = 
[
  LIFECYCLE_STATE_ACTIVE = 'ACTIVE'.freeze,
  LIFECYCLE_STATE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze
CONFIG_SOURCE_PROVIDER_TYPE_ENUM = 
[
  CONFIG_SOURCE_PROVIDER_TYPE_BITBUCKET_CLOUD_ACCESS_TOKEN = 'BITBUCKET_CLOUD_ACCESS_TOKEN'.freeze,
  CONFIG_SOURCE_PROVIDER_TYPE_BITBUCKET_SERVER_ACCESS_TOKEN = 'BITBUCKET_SERVER_ACCESS_TOKEN'.freeze,
  CONFIG_SOURCE_PROVIDER_TYPE_GITLAB_ACCESS_TOKEN = 'GITLAB_ACCESS_TOKEN'.freeze,
  CONFIG_SOURCE_PROVIDER_TYPE_GITHUB_ACCESS_TOKEN = 'GITHUB_ACCESS_TOKEN'.freeze,
  CONFIG_SOURCE_PROVIDER_TYPE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ ConfigurationSourceProvider

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



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
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
 
# File 'lib/oci/resource_manager/models/configuration_source_provider.rb', line 195

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

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

  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.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.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) 


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

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) 


67
68
69
 
# File 'lib/oci/resource_manager/models/configuration_source_provider.rb', line 67

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>>) 


101
102
103
 
# File 'lib/oci/resource_manager/models/configuration_source_provider.rb', line 101

def defined_tags
  @defined_tags
end

#description ⇒ String

Description of the configuration source provider.

Returns:

  • (String) 


44
45
46
 
# File 'lib/oci/resource_manager/models/configuration_source_provider.rb', line 44

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) 


40
41
42
 
# File 'lib/oci/resource_manager/models/configuration_source_provider.rb', line 40

def display_name
  @display_name
end

#email ⇒ String

Atlassian account email used for Bitbucket Cloud API token authentication.

Returns:

  • (String) 


78
79
80
 
# File 'lib/oci/resource_manager/models/configuration_source_provider.rb', line 78

def email
  @email
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>) 


94
95
96
 
# File 'lib/oci/resource_manager/models/configuration_source_provider.rb', line 94

def freeform_tags
  @freeform_tags
end

#id ⇒ String

The OCID of the configuration source provider.

Returns:

  • (String) 


31
32
33
 
# File 'lib/oci/resource_manager/models/configuration_source_provider.rb', line 31

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) 


83
84
85
 
# File 'lib/oci/resource_manager/models/configuration_source_provider.rb', line 83

def is_migration_required
  @is_migration_required
end

#lifecycle_state ⇒ String

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

Returns:

  • (String) 


58
59
60
 
# File 'lib/oci/resource_manager/models/configuration_source_provider.rb', line 58

def lifecycle_state
  @lifecycle_state
end

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

Returns:



70
71
72
 
# File 'lib/oci/resource_manager/models/configuration_source_provider.rb', line 70

def private_server_config_details
  @private_server_config_details
end

#secret_id ⇒ String

Secret ocid which is used to authorize the user.

Returns:

  • (String) 


87
88
89
 
# File 'lib/oci/resource_manager/models/configuration_source_provider.rb', line 87

def secret_id
  @secret_id
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>>) 


108
109
110
 
# File 'lib/oci/resource_manager/models/configuration_source_provider.rb', line 108

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) 


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

def time_created
  @time_created
end

#username ⇒ String

Username which is used to authorize the user.

Returns:

  • (String) 


74
75
76
 
# File 'lib/oci/resource_manager/models/configuration_source_provider.rb', line 74

def username
  @username
end

Class Method Details

.attribute_map ⇒ Object

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



111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
 
# File 'lib/oci/resource_manager/models/configuration_source_provider.rb', line 111

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',
    'username': :'username',
    'email': :'email',
    'is_migration_required': :'isMigrationRequired',
    'secret_id': :'secretId',
    '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.



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

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

  return 'OCI::ResourceManager::Models::GithubAccessTokenConfigurationSourceProvider' if type == 'GITHUB_ACCESS_TOKEN'
  return 'OCI::ResourceManager::Models::GitlabAccessTokenConfigurationSourceProvider' if type == 'GITLAB_ACCESS_TOKEN'
  return 'OCI::ResourceManager::Models::BitbucketCloudEmailApiTokenConfigurationSourceProvider' if type == 'BITBUCKET_CLOUD_ACCESS_TOKEN'
  return 'OCI::ResourceManager::Models::BitbucketServerAccessTokenConfigurationSourceProvider' if type == 'BITBUCKET_SERVER_ACCESS_TOKEN'

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

.swagger_types ⇒ Object

Attribute type mapping.



134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
 
# File 'lib/oci/resource_manager/models/configuration_source_provider.rb', line 134

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',
    'username': :'String',
    'email': :'String',
    'is_migration_required': :'BOOLEAN',
    'secret_id': :'String',
    '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



309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
 
# File 'lib/oci/resource_manager/models/configuration_source_provider.rb', line 309

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 &&
    username == other.username &&
    email == other.email &&
    is_migration_required == other.is_migration_required &&
    secret_id == other.secret_id &&
    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



353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
 
# File 'lib/oci/resource_manager/models/configuration_source_provider.rb', line 353

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


333
334
335
 
# File 'lib/oci/resource_manager/models/configuration_source_provider.rb', line 333

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



342
343
344
 
# File 'lib/oci/resource_manager/models/configuration_source_provider.rb', line 342

def hash
  [id, compartment_id, display_name, description, time_created, lifecycle_state, config_source_provider_type, private_server_config_details, username, email, is_migration_required, secret_id, 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



386
387
388
389
390
391
392
393
394
395
 
# File 'lib/oci/resource_manager/models/configuration_source_provider.rb', line 386

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



380
381
382
 
# File 'lib/oci/resource_manager/models/configuration_source_provider.rb', line 380

def to_s
  to_hash.to_s
end