Class: OCI::Devops::Models::Trigger

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

Overview

Trigger the deployment pipeline to deploy the artifact. 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

TRIGGER_SOURCE_ENUM = 
[
  TRIGGER_SOURCE_GITHUB = 'GITHUB'.freeze,
  TRIGGER_SOURCE_GITLAB = 'GITLAB'.freeze,
  TRIGGER_SOURCE_GITLAB_SERVER = 'GITLAB_SERVER'.freeze,
  TRIGGER_SOURCE_BITBUCKET_CLOUD = 'BITBUCKET_CLOUD'.freeze,
  TRIGGER_SOURCE_BITBUCKET_SERVER = 'BITBUCKET_SERVER'.freeze,
  TRIGGER_SOURCE_VBS = 'VBS'.freeze,
  TRIGGER_SOURCE_DEVOPS_CODE_REPOSITORY = 'DEVOPS_CODE_REPOSITORY'.freeze,
  TRIGGER_SOURCE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze
LIFECYCLE_STATE_ENUM = 
[
  LIFECYCLE_STATE_ACTIVE = 'ACTIVE'.freeze,
  LIFECYCLE_STATE_DELETING = 'DELETING'.freeze,
  LIFECYCLE_STATE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Trigger

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 property

  • :display_name (String) —

    The value to assign to the #display_name property

  • :description (String) —

    The value to assign to the #description property

  • :project_id (String) —

    The value to assign to the #project_id property

  • :compartment_id (String) —

    The value to assign to the #compartment_id property

  • :trigger_source (String) —

    The value to assign to the #trigger_source property

  • :time_created (DateTime) —

    The value to assign to the #time_created property

  • :time_updated (DateTime) —

    The value to assign to the #time_updated property

  • :lifecycle_state (String) —

    The value to assign to the #lifecycle_state property

  • :lifecycle_details (String) —

    The value to assign to the #lifecycle_details property

  • :actions (Array<OCI::Devops::Models::TriggerAction>) —

    The value to assign to the #actions 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

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

    The value to assign to the #system_tags property



171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
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
 
# File 'lib/oci/devops/models/trigger.rb', line 171

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

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

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

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

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

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

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

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

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

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

  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

#actions ⇒ Array<OCI::Devops::Models::TriggerAction>

[Required] The list of actions that are to be performed for this trigger.

Returns:



72
73
74
 
# File 'lib/oci/devops/models/trigger.rb', line 72

def actions
  @actions
end

#compartment_id ⇒ String

[Required] The OCID of the compartment that contains the trigger.

Returns:

  • (String) 


48
49
50
 
# File 'lib/oci/devops/models/trigger.rb', line 48

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


80
81
82
 
# File 'lib/oci/devops/models/trigger.rb', line 80

def defined_tags
  @defined_tags
end

#description ⇒ String

Description about the trigger.

Returns:

  • (String) 


40
41
42
 
# File 'lib/oci/devops/models/trigger.rb', line 40

def description
  @description
end

#display_name ⇒ String

Trigger display name. Avoid entering confidential information.

Returns:

  • (String) 


36
37
38
 
# File 'lib/oci/devops/models/trigger.rb', line 36

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


76
77
78
 
# File 'lib/oci/devops/models/trigger.rb', line 76

def freeform_tags
  @freeform_tags
end

#id ⇒ String

[Required] Unique identifier that is immutable on creation.

Returns:

  • (String) 


32
33
34
 
# File 'lib/oci/devops/models/trigger.rb', line 32

def id
  @id
end

#lifecycle_details ⇒ String

A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state.

Returns:

  • (String) 


68
69
70
 
# File 'lib/oci/devops/models/trigger.rb', line 68

def lifecycle_details
  @lifecycle_details
end

#lifecycle_state ⇒ String

The current state of the trigger.

Returns:

  • (String) 


64
65
66
 
# File 'lib/oci/devops/models/trigger.rb', line 64

def lifecycle_state
  @lifecycle_state
end

#project_id ⇒ String

[Required] The OCID of the DevOps project to which the trigger belongs to.

Returns:

  • (String) 


44
45
46
 
# File 'lib/oci/devops/models/trigger.rb', line 44

def project_id
  @project_id
end

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

Usage of system tag keys. These predefined keys are scoped to namespaces. See Resource Tags. Example: {\"orcl-cloud\": {\"free-tier-retained\": \"true\"}}

Returns:

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


84
85
86
 
# File 'lib/oci/devops/models/trigger.rb', line 84

def system_tags
  @system_tags
end

#time_created ⇒ DateTime

The time the trigger was created. Format defined by RFC3339.

Returns:

  • (DateTime) 


56
57
58
 
# File 'lib/oci/devops/models/trigger.rb', line 56

def time_created
  @time_created
end

#time_updated ⇒ DateTime

The time the trigger was updated. Format defined by RFC3339.

Returns:

  • (DateTime) 


60
61
62
 
# File 'lib/oci/devops/models/trigger.rb', line 60

def time_updated
  @time_updated
end

#trigger_source ⇒ String

[Required] Source of the trigger.

Returns:

  • (String) 


52
53
54
 
# File 'lib/oci/devops/models/trigger.rb', line 52

def trigger_source
  @trigger_source
end

Class Method Details

.attribute_map ⇒ Object

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



87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
 
# File 'lib/oci/devops/models/trigger.rb', line 87

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'id',
    'display_name': :'displayName',
    'description': :'description',
    'project_id': :'projectId',
    'compartment_id': :'compartmentId',
    'trigger_source': :'triggerSource',
    'time_created': :'timeCreated',
    'time_updated': :'timeUpdated',
    'lifecycle_state': :'lifecycleState',
    'lifecycle_details': :'lifecycleDetails',
    'actions': :'actions',
    '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.



135
136
137
138
139
140
141
142
143
144
145
146
147
148
 
# File 'lib/oci/devops/models/trigger.rb', line 135

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

  return 'OCI::Devops::Models::GitlabTrigger' if type == 'GITLAB'
  return 'OCI::Devops::Models::VbsTrigger' if type == 'VBS'
  return 'OCI::Devops::Models::BitbucketServerTrigger' if type == 'BITBUCKET_SERVER'
  return 'OCI::Devops::Models::GitlabServerTrigger' if type == 'GITLAB_SERVER'
  return 'OCI::Devops::Models::GithubTrigger' if type == 'GITHUB'
  return 'OCI::Devops::Models::DevopsCodeRepositoryTrigger' if type == 'DEVOPS_CODE_REPOSITORY'
  return 'OCI::Devops::Models::BitbucketCloudTrigger' if type == 'BITBUCKET_CLOUD'

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

.swagger_types ⇒ Object

Attribute type mapping.



109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
 
# File 'lib/oci/devops/models/trigger.rb', line 109

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'String',
    'display_name': :'String',
    'description': :'String',
    'project_id': :'String',
    'compartment_id': :'String',
    'trigger_source': :'String',
    'time_created': :'DateTime',
    'time_updated': :'DateTime',
    'lifecycle_state': :'String',
    'lifecycle_details': :'String',
    'actions': :'Array<OCI::Devops::Models::TriggerAction>',
    '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



283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
 
# File 'lib/oci/devops/models/trigger.rb', line 283

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

  self.class == other.class &&
    id == other.id &&
    display_name == other.display_name &&
    description == other.description &&
    project_id == other.project_id &&
    compartment_id == other.compartment_id &&
    trigger_source == other.trigger_source &&
    time_created == other.time_created &&
    time_updated == other.time_updated &&
    lifecycle_state == other.lifecycle_state &&
    lifecycle_details == other.lifecycle_details &&
    actions == other.actions &&
    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



326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
 
# File 'lib/oci/devops/models/trigger.rb', line 326

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


306
307
308
 
# File 'lib/oci/devops/models/trigger.rb', line 306

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



315
316
317
 
# File 'lib/oci/devops/models/trigger.rb', line 315

def hash
  [id, display_name, description, project_id, compartment_id, trigger_source, time_created, time_updated, lifecycle_state, lifecycle_details, actions, 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



359
360
361
362
363
364
365
366
367
368
 
# File 'lib/oci/devops/models/trigger.rb', line 359

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



353
354
355
 
# File 'lib/oci/devops/models/trigger.rb', line 353

def to_s
  to_hash.to_s
end