Class: OCI::Devops::Models::CreateConnectionDetails

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/devops/models/create_connection_details.rb

Overview

The details for creating a connection.

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 = {}) ⇒ CreateConnectionDetails

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :description (String) —

    The value to assign to the #description property

  • :display_name (String) —

    The value to assign to the #display_name property

  • :project_id (String) —

    The value to assign to the #project_id property

  • :connection_type (String) —

    The value to assign to the #connection_type property

  • :freeform_tags (Hash<String, String>) —

    The value to assign to the #freeform_tags property

  • :defined_tags (Hash<String, Hash<String, Object>>) —

    The value to assign to the #defined_tags property



97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
 
# File 'lib/oci/devops/models/create_connection_details.rb', line 97

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

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

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

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

  self.connection_type = attributes[:'connectionType'] if attributes[:'connectionType']

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

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

  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']
end

Instance Attribute Details

#connection_type ⇒ String

[Required] The type of connection.

Returns:

  • (String) 


27
28
29
 
# File 'lib/oci/devops/models/create_connection_details.rb', line 27

def connection_type
  @connection_type
end

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

Defined tags for this resource. Each key is predefined and scoped to a namespace. See Resource Tags. Example: {\"foo-namespace\": {\"bar-key\": \"value\"}}

Returns:

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


35
36
37
 
# File 'lib/oci/devops/models/create_connection_details.rb', line 35

def defined_tags
  @defined_tags
end

#description ⇒ String

Optional description about the connection.

Returns:

  • (String) 


15
16
17
 
# File 'lib/oci/devops/models/create_connection_details.rb', line 15

def description
  @description
end

#display_name ⇒ String

Optional connection display name. Avoid entering confidential information.

Returns:

  • (String) 


19
20
21
 
# File 'lib/oci/devops/models/create_connection_details.rb', line 19

def display_name
  @display_name
end

#freeform_tags ⇒ Hash<String, String>

Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. See Resource Tags. Example: {\"bar-key\": \"value\"}

Returns:

  • (Hash<String, String>) 


31
32
33
 
# File 'lib/oci/devops/models/create_connection_details.rb', line 31

def freeform_tags
  @freeform_tags
end

#project_id ⇒ String

[Required] The OCID of the DevOps project.

Returns:

  • (String) 


23
24
25
 
# File 'lib/oci/devops/models/create_connection_details.rb', line 23

def project_id
  @project_id
end

Class Method Details

.attribute_map ⇒ Object

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



38
39
40
41
42
43
44
45
46
47
48
49
 
# File 'lib/oci/devops/models/create_connection_details.rb', line 38

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'description': :'description',
    'display_name': :'displayName',
    'project_id': :'projectId',
    'connection_type': :'connectionType',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags'
    # 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.



70
71
72
73
74
75
76
77
78
79
80
81
82
 
# File 'lib/oci/devops/models/create_connection_details.rb', line 70

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

  return 'OCI::Devops::Models::CreateVbsAccessTokenConnectionDetails' if type == 'VBS_ACCESS_TOKEN'
  return 'OCI::Devops::Models::CreateGitlabServerAccessTokenConnectionDetails' if type == 'GITLAB_SERVER_ACCESS_TOKEN'
  return 'OCI::Devops::Models::CreateBitbucketServerAccessTokenConnectionDetails' if type == 'BITBUCKET_SERVER_ACCESS_TOKEN'
  return 'OCI::Devops::Models::CreateGithubAccessTokenConnectionDetails' if type == 'GITHUB_ACCESS_TOKEN'
  return 'OCI::Devops::Models::CreateBitbucketCloudAppPasswordConnectionDetails' if type == 'BITBUCKET_CLOUD_APP_PASSWORD'
  return 'OCI::Devops::Models::CreateGitlabAccessTokenConnectionDetails' if type == 'GITLAB_ACCESS_TOKEN'

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

.swagger_types ⇒ Object

Attribute type mapping.



52
53
54
55
56
57
58
59
60
61
62
63
 
# File 'lib/oci/devops/models/create_connection_details.rb', line 52

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'description': :'String',
    'display_name': :'String',
    'project_id': :'String',
    'connection_type': :'String',
    'freeform_tags': :'Hash<String, String>',
    'defined_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



143
144
145
146
147
148
149
150
151
152
153
 
# File 'lib/oci/devops/models/create_connection_details.rb', line 143

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

  self.class == other.class &&
    description == other.description &&
    display_name == other.display_name &&
    project_id == other.project_id &&
    connection_type == other.connection_type &&
    freeform_tags == other.freeform_tags &&
    defined_tags == other.defined_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



178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
 
# File 'lib/oci/devops/models/create_connection_details.rb', line 178

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


158
159
160
 
# File 'lib/oci/devops/models/create_connection_details.rb', line 158

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



167
168
169
 
# File 'lib/oci/devops/models/create_connection_details.rb', line 167

def hash
  [description, display_name, project_id, connection_type, freeform_tags, defined_tags].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



211
212
213
214
215
216
217
218
219
220
 
# File 'lib/oci/devops/models/create_connection_details.rb', line 211

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



205
206
207
 
# File 'lib/oci/devops/models/create_connection_details.rb', line 205

def to_s
  to_hash.to_s
end