Class: OCI::Devops::Models::VbsAccessTokenConnection

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

Overview

The properties that define a connection of the type VBS_ACCESS_TOKEN. This type corresponds to a connection in Visual Builder Studio that is authenticated with a Personal Access Token.

Constant Summary

Constants inherited from Connection

Connection::CONNECTION_TYPE_ENUM, Connection::LIFECYCLE_STATE_ENUM

Instance Attribute Summary collapse

Attributes inherited from Connection

#compartment_id, #connection_type, #defined_tags, #description, #display_name, #freeform_tags, #id, #last_connection_validation_result, #lifecycle_details, #lifecycle_state, #project_id, #system_tags, #time_created, #time_updated

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from Connection

get_subtype

Constructor Details

#initialize(attributes = {}) ⇒ VbsAccessTokenConnection

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 proprety

  • :description (String) —

    The value to assign to the #description proprety

  • :display_name (String) —

    The value to assign to the #display_name proprety

  • :compartment_id (String) —

    The value to assign to the #compartment_id proprety

  • :project_id (String) —

    The value to assign to the #project_id proprety

  • :time_created (DateTime) —

    The value to assign to the #time_created proprety

  • :time_updated (DateTime) —

    The value to assign to the #time_updated proprety

  • :last_connection_validation_result (OCI::Devops::Models::ConnectionValidationResult) —

    The value to assign to the #last_connection_validation_result proprety

  • :lifecycle_details (String) —

    The value to assign to the #lifecycle_details proprety

  • :lifecycle_state (String) —

    The value to assign to the #lifecycle_state proprety

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

    The value to assign to the #freeform_tags proprety

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

    The value to assign to the #defined_tags proprety

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

    The value to assign to the #system_tags proprety

  • :access_token (String) —

    The value to assign to the #access_token property

  • :base_url (String) —

    The value to assign to the #base_url property



91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
 
# File 'lib/oci/devops/models/vbs_access_token_connection.rb', line 91

def initialize(attributes = {})
  return unless attributes.is_a?(Hash)

  attributes['connectionType'] = 'VBS_ACCESS_TOKEN'

  super(attributes)

  # convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }

  self.access_token = attributes[:'accessToken'] if attributes[:'accessToken']

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

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

  self.base_url = attributes[:'baseUrl'] if attributes[:'baseUrl']

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

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

Instance Attribute Details

#access_token ⇒ String

[Required] The OCID of personal access token saved in secret store.

Returns:

  • (String) 


16
17
18
 
# File 'lib/oci/devops/models/vbs_access_token_connection.rb', line 16

def access_token
  @access_token
end

#base_url ⇒ String

[Required] The Base URL of the hosted Visual Builder Studio server.

Returns:

  • (String) 


20
21
22
 
# File 'lib/oci/devops/models/vbs_access_token_connection.rb', line 20

def base_url
  @base_url
end

Class Method Details

.attribute_map ⇒ Object

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



23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
 
# File 'lib/oci/devops/models/vbs_access_token_connection.rb', line 23

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'id',
    'description': :'description',
    'display_name': :'displayName',
    'compartment_id': :'compartmentId',
    'project_id': :'projectId',
    'connection_type': :'connectionType',
    'time_created': :'timeCreated',
    'time_updated': :'timeUpdated',
    'last_connection_validation_result': :'lastConnectionValidationResult',
    'lifecycle_details': :'lifecycleDetails',
    'lifecycle_state': :'lifecycleState',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags',
    'system_tags': :'systemTags',
    'access_token': :'accessToken',
    'base_url': :'baseUrl'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
 
# File 'lib/oci/devops/models/vbs_access_token_connection.rb', line 47

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'String',
    'description': :'String',
    'display_name': :'String',
    'compartment_id': :'String',
    'project_id': :'String',
    'connection_type': :'String',
    'time_created': :'DateTime',
    'time_updated': :'DateTime',
    'last_connection_validation_result': :'OCI::Devops::Models::ConnectionValidationResult',
    'lifecycle_details': :'String',
    'lifecycle_state': :'String',
    'freeform_tags': :'Hash<String, String>',
    'defined_tags': :'Hash<String, Hash<String, Object>>',
    'system_tags': :'Hash<String, Hash<String, Object>>',
    'access_token': :'String',
    'base_url': :'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



121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
 
# File 'lib/oci/devops/models/vbs_access_token_connection.rb', line 121

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

  self.class == other.class &&
    id == other.id &&
    description == other.description &&
    display_name == other.display_name &&
    compartment_id == other.compartment_id &&
    project_id == other.project_id &&
    connection_type == other.connection_type &&
    time_created == other.time_created &&
    time_updated == other.time_updated &&
    last_connection_validation_result == other.last_connection_validation_result &&
    lifecycle_details == other.lifecycle_details &&
    lifecycle_state == other.lifecycle_state &&
    freeform_tags == other.freeform_tags &&
    defined_tags == other.defined_tags &&
    system_tags == other.system_tags &&
    access_token == other.access_token &&
    base_url == other.base_url
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



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

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


146
147
148
 
# File 'lib/oci/devops/models/vbs_access_token_connection.rb', line 146

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



155
156
157
 
# File 'lib/oci/devops/models/vbs_access_token_connection.rb', line 155

def hash
  [id, description, display_name, compartment_id, project_id, connection_type, time_created, time_updated, last_connection_validation_result, lifecycle_details, lifecycle_state, freeform_tags, defined_tags, system_tags, access_token, base_url].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



199
200
201
202
203
204
205
206
207
208
 
# File 'lib/oci/devops/models/vbs_access_token_connection.rb', line 199

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



193
194
195
 
# File 'lib/oci/devops/models/vbs_access_token_connection.rb', line 193

def to_s
  to_hash.to_s
end