Class: OCI::DataCatalog::Models::Pattern

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/data_catalog/models/pattern.rb

Overview

A pattern is a data selector or filter which can provide a singular, logical entity view aggregating multiple physical data artifacts for ease of use.

Constant Summary collapse

LIFECYCLE_STATE_ENUM = 
[
  LIFECYCLE_STATE_CREATING = 'CREATING'.freeze,
  LIFECYCLE_STATE_ACTIVE = 'ACTIVE'.freeze,
  LIFECYCLE_STATE_INACTIVE = 'INACTIVE'.freeze,
  LIFECYCLE_STATE_UPDATING = 'UPDATING'.freeze,
  LIFECYCLE_STATE_DELETING = 'DELETING'.freeze,
  LIFECYCLE_STATE_DELETED = 'DELETED'.freeze,
  LIFECYCLE_STATE_FAILED = 'FAILED'.freeze,
  LIFECYCLE_STATE_MOVING = 'MOVING'.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 = {}) ⇒ Pattern

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :key (String) —

    The value to assign to the #key property

  • :display_name (String) —

    The value to assign to the #display_name property

  • :description (String) —

    The value to assign to the #description property

  • :catalog_id (String) —

    The value to assign to the #catalog_id property

  • :lifecycle_state (String) —

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

  • :created_by_id (String) —

    The value to assign to the #created_by_id property

  • :updated_by_id (String) —

    The value to assign to the #updated_by_id property

  • :expression (String) —

    The value to assign to the #expression property

  • :file_path_prefix (String) —

    The value to assign to the #file_path_prefix property

  • :check_file_path_list (Array<String>) —

    The value to assign to the #check_file_path_list property

  • :is_enable_check_failure_limit (BOOLEAN) —

    The value to assign to the #is_enable_check_failure_limit property

  • :check_failure_limit (Integer) —

    The value to assign to the #check_failure_limit property

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

    The value to assign to the #properties property



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
249
250
251
252
253
254
255
256
257
 
# File 'lib/oci/data_catalog/models/pattern.rb', line 176

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

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

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

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

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

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

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

  self.updated_by_id = attributes[:'updatedById'] if attributes[:'updatedById']

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

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

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

  self.file_path_prefix = attributes[:'filePathPrefix'] if attributes[:'filePathPrefix']

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

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

  self.check_file_path_list = attributes[:'checkFilePathList'] if attributes[:'checkFilePathList']

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

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

  self.is_enable_check_failure_limit = attributes[:'isEnableCheckFailureLimit'] unless attributes[:'isEnableCheckFailureLimit'].nil?
  self.is_enable_check_failure_limit = false if is_enable_check_failure_limit.nil? && !attributes.key?(:'isEnableCheckFailureLimit') # rubocop:disable Style/StringLiterals

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

  self.is_enable_check_failure_limit = attributes[:'is_enable_check_failure_limit'] unless attributes[:'is_enable_check_failure_limit'].nil?
  self.is_enable_check_failure_limit = false if is_enable_check_failure_limit.nil? && !attributes.key?(:'isEnableCheckFailureLimit') && !attributes.key?(:'is_enable_check_failure_limit') # rubocop:disable Style/StringLiterals

  self.check_failure_limit = attributes[:'checkFailureLimit'] if attributes[:'checkFailureLimit']

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

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

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

Instance Attribute Details

#catalog_id ⇒ String

The data catalog's OCID.

Returns:

  • (String) 


42
43
44
 
# File 'lib/oci/data_catalog/models/pattern.rb', line 42

def catalog_id
  @catalog_id
end

#check_failure_limit ⇒ Integer

The maximum number of UNMATCHED files, in checkFilePathList, above which the check fails. Optional, if checkFilePathList is provided - but if isEnableCheckFailureLimit is set to true it is required.

Returns:

  • (Integer) 


100
101
102
 
# File 'lib/oci/data_catalog/models/pattern.rb', line 100

def check_failure_limit
  @check_failure_limit
end

#check_file_path_list ⇒ Array<String>

List of file paths against which the pattern can be tried, as a check. This documents, for reference purposes, some example objects a pattern is meant to work with. If isEnableCheckFailureLimit is set to true, this will be run as a validation during the request, such that if the check fails the request fails. If isEnableCheckFailureLimit instead is set to (the default) false, a pattern will still be created or updated even if the check fails, with a lifecycleState of FAILED.

Returns:

  • (Array<String>) 


88
89
90
 
# File 'lib/oci/data_catalog/models/pattern.rb', line 88

def check_file_path_list
  @check_file_path_list
end

#created_by_id ⇒ String

OCID of the user who created the pattern.

Returns:

  • (String) 


61
62
63
 
# File 'lib/oci/data_catalog/models/pattern.rb', line 61

def created_by_id
  @created_by_id
end

#description ⇒ String

Detailed description of the pattern.

Returns:

  • (String) 


38
39
40
 
# File 'lib/oci/data_catalog/models/pattern.rb', line 38

def description
  @description
end

#display_name ⇒ String

A user-friendly display name. Does not have to be unique, and it's changeable. Avoid entering confidential information.

Returns:

  • (String) 


34
35
36
 
# File 'lib/oci/data_catalog/models/pattern.rb', line 34

def display_name
  @display_name
end

#expression ⇒ String

Input string which drives the selection process, allowing for fine-grained control using qualifiers. Refer to the user documentation for details of the format and examples. A pattern cannot include both a prefix and an expression.

Returns:

  • (String) 


72
73
74
 
# File 'lib/oci/data_catalog/models/pattern.rb', line 72

def expression
  @expression
end

#file_path_prefix ⇒ String

Input string which drives the selection process. Refer to the user documentation for details of the format and examples. A pattern cannot include both a prefix and an expression.

Returns:

  • (String) 


79
80
81
 
# File 'lib/oci/data_catalog/models/pattern.rb', line 79

def file_path_prefix
  @file_path_prefix
end

#is_enable_check_failure_limit ⇒ BOOLEAN

Indicates whether the pattern check, against the checkFilePathList, will fail the request if the count of UNMATCHED files is above the checkFailureLimit.

Returns:

  • (BOOLEAN) 


94
95
96
 
# File 'lib/oci/data_catalog/models/pattern.rb', line 94

def is_enable_check_failure_limit
  @is_enable_check_failure_limit
end

#key ⇒ String

[Required] Unique pattern key that is immutable.

Returns:

  • (String) 


28
29
30
 
# File 'lib/oci/data_catalog/models/pattern.rb', line 28

def key
  @key
end

#lifecycle_state ⇒ String

The current state of the pattern.

Returns:

  • (String) 


46
47
48
 
# File 'lib/oci/data_catalog/models/pattern.rb', line 46

def lifecycle_state
  @lifecycle_state
end

#properties ⇒ Hash<String, Hash<String, String>>

A map of maps that contains the properties which are specific to the pattern type. Each pattern type definition defines it's set of required and optional properties. Example: {\"properties\": { \"default\": { \"tbd\"}}}

Returns:

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


107
108
109
 
# File 'lib/oci/data_catalog/models/pattern.rb', line 107

def properties
  @properties
end

#time_created ⇒ DateTime

The date and time the pattern was created, in the format defined by RFC3339. Example: 2019-03-25T21:10:29.600Z

Returns:

  • (DateTime) 


52
53
54
 
# File 'lib/oci/data_catalog/models/pattern.rb', line 52

def time_created
  @time_created
end

#time_updated ⇒ DateTime

The last time that any change was made to the pattern. An RFC3339 formatted datetime string.

Returns:

  • (DateTime) 


57
58
59
 
# File 'lib/oci/data_catalog/models/pattern.rb', line 57

def time_updated
  @time_updated
end

#updated_by_id ⇒ String

OCID of the user who last modified the pattern.

Returns:

  • (String) 


65
66
67
 
# File 'lib/oci/data_catalog/models/pattern.rb', line 65

def updated_by_id
  @updated_by_id
end

Class Method Details

.attribute_map ⇒ Object

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



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

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'key': :'key',
    'display_name': :'displayName',
    'description': :'description',
    'catalog_id': :'catalogId',
    'lifecycle_state': :'lifecycleState',
    'time_created': :'timeCreated',
    'time_updated': :'timeUpdated',
    'created_by_id': :'createdById',
    'updated_by_id': :'updatedById',
    'expression': :'expression',
    'file_path_prefix': :'filePathPrefix',
    'check_file_path_list': :'checkFilePathList',
    'is_enable_check_failure_limit': :'isEnableCheckFailureLimit',
    'check_failure_limit': :'checkFailureLimit',
    'properties': :'properties'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
 
# File 'lib/oci/data_catalog/models/pattern.rb', line 133

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'key': :'String',
    'display_name': :'String',
    'description': :'String',
    'catalog_id': :'String',
    'lifecycle_state': :'String',
    'time_created': :'DateTime',
    'time_updated': :'DateTime',
    'created_by_id': :'String',
    'updated_by_id': :'String',
    'expression': :'String',
    'file_path_prefix': :'String',
    'check_file_path_list': :'Array<String>',
    'is_enable_check_failure_limit': :'BOOLEAN',
    'check_failure_limit': :'Integer',
    'properties': :'Hash<String, 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



279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
 
# File 'lib/oci/data_catalog/models/pattern.rb', line 279

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

  self.class == other.class &&
    key == other.key &&
    display_name == other.display_name &&
    description == other.description &&
    catalog_id == other.catalog_id &&
    lifecycle_state == other.lifecycle_state &&
    time_created == other.time_created &&
    time_updated == other.time_updated &&
    created_by_id == other.created_by_id &&
    updated_by_id == other.updated_by_id &&
    expression == other.expression &&
    file_path_prefix == other.file_path_prefix &&
    check_file_path_list == other.check_file_path_list &&
    is_enable_check_failure_limit == other.is_enable_check_failure_limit &&
    check_failure_limit == other.check_failure_limit &&
    properties == other.properties
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



323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
 
# File 'lib/oci/data_catalog/models/pattern.rb', line 323

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


303
304
305
 
# File 'lib/oci/data_catalog/models/pattern.rb', line 303

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



312
313
314
 
# File 'lib/oci/data_catalog/models/pattern.rb', line 312

def hash
  [key, display_name, description, catalog_id, lifecycle_state, time_created, time_updated, created_by_id, updated_by_id, expression, file_path_prefix, check_file_path_list, is_enable_check_failure_limit, check_failure_limit, properties].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



356
357
358
359
360
361
362
363
364
365
 
# File 'lib/oci/data_catalog/models/pattern.rb', line 356

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



350
351
352
 
# File 'lib/oci/data_catalog/models/pattern.rb', line 350

def to_s
  to_hash.to_s
end