Class: OCI::Adm::Models::JenkinsPipelineConfiguration

Inherits:
VerifyConfiguration show all
Defined in:
lib/oci/adm/models/jenkins_pipeline_configuration.rb

Overview

Extends a Verify configuration with appropriate data to reach and use the build service provided by a Jenkins Pipeline.

Constant Summary

Constants inherited from VerifyConfiguration

VerifyConfiguration::BUILD_SERVICE_TYPE_ENUM

Instance Attribute Summary collapse

Attributes inherited from VerifyConfiguration

#build_service_type

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from VerifyConfiguration

get_subtype

Constructor Details

#initialize(attributes = {}) ⇒ JenkinsPipelineConfiguration

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :username (String) —

    The value to assign to the #username property

  • :pat_secret_id (String) —

    The value to assign to the #pat_secret_id property

  • :jenkins_url (String) —

    The value to assign to the #jenkins_url property

  • :job_name (String) —

    The value to assign to the #job_name property

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

    The value to assign to the #additional_parameters property



73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
 
# File 'lib/oci/adm/models/jenkins_pipeline_configuration.rb', line 73

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

  attributes['buildServiceType'] = 'JENKINS_PIPELINE'

  super(attributes)

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

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

  self.pat_secret_id = attributes[:'patSecretId'] if attributes[:'patSecretId']

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

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

  self.jenkins_url = attributes[:'jenkinsUrl'] if attributes[:'jenkinsUrl']

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

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

  self.job_name = attributes[:'jobName'] if attributes[:'jobName']

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

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

  self.additional_parameters = attributes[:'additionalParameters'] if attributes[:'additionalParameters']

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

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

Instance Attribute Details

#additional_parameters ⇒ Hash<String, String>

Additional key-value pairs passed as parameters to the build service when running an experiment.

Returns:

  • (Hash<String, String>) 


32
33
34
 
# File 'lib/oci/adm/models/jenkins_pipeline_configuration.rb', line 32

def additional_parameters
  @additional_parameters
end

#jenkins_url ⇒ String

[Required] The URL that locates the Jenkins pipeline.

Returns:

  • (String) 


24
25
26
 
# File 'lib/oci/adm/models/jenkins_pipeline_configuration.rb', line 24

def jenkins_url
  @jenkins_url
end

#job_name ⇒ String

[Required] The name of the Jenkins pipeline job that identifies the build pipeline.

Returns:

  • (String) 


28
29
30
 
# File 'lib/oci/adm/models/jenkins_pipeline_configuration.rb', line 28

def job_name
  @job_name
end

#pat_secret_id ⇒ String

[Required] The Oracle Cloud Identifier (OCID) of the Private Access Token (PAT) Secret. The PAT provides the credentials to access the Jenkins Pipeline.

Returns:

  • (String) 


20
21
22
 
# File 'lib/oci/adm/models/jenkins_pipeline_configuration.rb', line 20

def pat_secret_id
  @pat_secret_id
end

#username ⇒ String

[Required] The username that will be used to authenticate with Jenkins.

Returns:

  • (String) 


14
15
16
 
# File 'lib/oci/adm/models/jenkins_pipeline_configuration.rb', line 14

def username
  @username
end

Class Method Details

.attribute_map ⇒ Object

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



35
36
37
38
39
40
41
42
43
44
45
46
 
# File 'lib/oci/adm/models/jenkins_pipeline_configuration.rb', line 35

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'build_service_type': :'buildServiceType',
    'username': :'username',
    'pat_secret_id': :'patSecretId',
    'jenkins_url': :'jenkinsUrl',
    'job_name': :'jobName',
    'additional_parameters': :'additionalParameters'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



49
50
51
52
53
54
55
56
57
58
59
60
 
# File 'lib/oci/adm/models/jenkins_pipeline_configuration.rb', line 49

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'build_service_type': :'String',
    'username': :'String',
    'pat_secret_id': :'String',
    'jenkins_url': :'String',
    'job_name': :'String',
    'additional_parameters': :'Hash<String, 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



117
118
119
120
121
122
123
124
125
126
127
 
# File 'lib/oci/adm/models/jenkins_pipeline_configuration.rb', line 117

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

  self.class == other.class &&
    build_service_type == other.build_service_type &&
    username == other.username &&
    pat_secret_id == other.pat_secret_id &&
    jenkins_url == other.jenkins_url &&
    job_name == other.job_name &&
    additional_parameters == other.additional_parameters
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



152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
 
# File 'lib/oci/adm/models/jenkins_pipeline_configuration.rb', line 152

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


132
133
134
 
# File 'lib/oci/adm/models/jenkins_pipeline_configuration.rb', line 132

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



141
142
143
 
# File 'lib/oci/adm/models/jenkins_pipeline_configuration.rb', line 141

def hash
  [build_service_type, username, pat_secret_id, jenkins_url, job_name, additional_parameters].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



185
186
187
188
189
190
191
192
193
194
 
# File 'lib/oci/adm/models/jenkins_pipeline_configuration.rb', line 185

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



179
180
181
 
# File 'lib/oci/adm/models/jenkins_pipeline_configuration.rb', line 179

def to_s
  to_hash.to_s
end