Class: OCI::Adm::Models::GitHubActionsConfiguration

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

Overview

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

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

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :repository_url (String) —

    The value to assign to the #repository_url property

  • :pat_secret_id (String) —

    The value to assign to the #pat_secret_id property

  • :username (String) —

    The value to assign to the #username property

  • :workflow_name (String) —

    The value to assign to the #workflow_name property

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

    The value to assign to the #additional_parameters property



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
109
110
111
 
# File 'lib/oci/adm/models/git_hub_actions_configuration.rb', line 76

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

  attributes['buildServiceType'] = 'GITHUB_ACTIONS'

  super(attributes)

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

  self.repository_url = attributes[:'repositoryUrl'] if attributes[:'repositoryUrl']

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

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

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

  self.workflow_name = attributes[:'workflowName'] if attributes[:'workflowName']

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

  self.workflow_name = attributes[:'workflow_name'] if attributes[:'workflow_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>) 


35
36
37
 
# File 'lib/oci/adm/models/git_hub_actions_configuration.rb', line 35

def additional_parameters
  @additional_parameters
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 GitHub Action.

Returns:

  • (String) 


23
24
25
 
# File 'lib/oci/adm/models/git_hub_actions_configuration.rb', line 23

def pat_secret_id
  @pat_secret_id
end

#repository_url ⇒ String

[Required] The location of the repository where the GitHub Actions is defined. For Non-Enterprise GitHub the expected format is github.com/[owner]/[repoName] For Enterprise GitHub the expected format is http(s):///api/v3/repos//[repoName]

Returns:

  • (String) 


17
18
19
 
# File 'lib/oci/adm/models/git_hub_actions_configuration.rb', line 17

def repository_url
  @repository_url
end

#username ⇒ String

[Required] The username that will trigger the GitHub Action.

Returns:

  • (String) 


27
28
29
 
# File 'lib/oci/adm/models/git_hub_actions_configuration.rb', line 27

def username
  @username
end

#workflow_name ⇒ String

[Required] The name of the GitHub Actions workflow that defines the build pipeline.

Returns:

  • (String) 


31
32
33
 
# File 'lib/oci/adm/models/git_hub_actions_configuration.rb', line 31

def workflow_name
  @workflow_name
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/adm/models/git_hub_actions_configuration.rb', line 38

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'build_service_type': :'buildServiceType',
    'repository_url': :'repositoryUrl',
    'pat_secret_id': :'patSecretId',
    'username': :'username',
    'workflow_name': :'workflowName',
    'additional_parameters': :'additionalParameters'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



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

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



120
121
122
123
124
125
126
127
128
129
130
 
# File 'lib/oci/adm/models/git_hub_actions_configuration.rb', line 120

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

  self.class == other.class &&
    build_service_type == other.build_service_type &&
    repository_url == other.repository_url &&
    pat_secret_id == other.pat_secret_id &&
    username == other.username &&
    workflow_name == other.workflow_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



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

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


135
136
137
 
# File 'lib/oci/adm/models/git_hub_actions_configuration.rb', line 135

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



144
145
146
 
# File 'lib/oci/adm/models/git_hub_actions_configuration.rb', line 144

def hash
  [build_service_type, repository_url, pat_secret_id, username, workflow_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



188
189
190
191
192
193
194
195
196
197
 
# File 'lib/oci/adm/models/git_hub_actions_configuration.rb', line 188

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



182
183
184
 
# File 'lib/oci/adm/models/git_hub_actions_configuration.rb', line 182

def to_s
  to_hash.to_s
end