Class: OCI::Gdp::Models::GdpPipeline

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/gdp/models/gdp_pipeline.rb

Overview

Retrieves pipeline configuration information by identifier.

Constant Summary collapse

LIFECYCLE_STATE_ENUM = 
[
  LIFECYCLE_STATE_CREATING = 'CREATING'.freeze,
  LIFECYCLE_STATE_UPDATING = 'UPDATING'.freeze,
  LIFECYCLE_STATE_ACTIVE = 'ACTIVE'.freeze,
  LIFECYCLE_STATE_INACTIVE = 'INACTIVE'.freeze,
  LIFECYCLE_STATE_DELETING = 'DELETING'.freeze,
  LIFECYCLE_STATE_DELETED = 'DELETED'.freeze,
  LIFECYCLE_STATE_FAILED = 'FAILED'.freeze,
  LIFECYCLE_STATE_NEEDS_ATTENTION = 'NEEDS_ATTENTION'.freeze,
  LIFECYCLE_STATE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze
PIPELINE_TYPE_ENUM = 
[
  PIPELINE_TYPE_SENDER = 'SENDER'.freeze,
  PIPELINE_TYPE_RECEIVER = 'RECEIVER'.freeze,
  PIPELINE_TYPE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ GdpPipeline

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



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
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
 
# File 'lib/oci/gdp/models/gdp_pipeline.rb', line 219

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

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

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

  self.pipeline_type = attributes[:'pipelineType'] if attributes[:'pipelineType']

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

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

  self.file_types = attributes[:'fileTypes'] if attributes[:'fileTypes']

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

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

  self.authorization_details = attributes[:'authorizationDetails'] if attributes[:'authorizationDetails']

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

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

  self.bucket_details = attributes[:'bucketDetails'] if attributes[:'bucketDetails']

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

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

  self.peering_region = attributes[:'peeringRegion'] if attributes[:'peeringRegion']

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

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

  self.peered_gdp_pipeline_id = attributes[:'peeredGdpPipelineId'] if attributes[:'peeredGdpPipelineId']

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

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

  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.is_file_override_in_destination_enabled = attributes[:'isFileOverrideInDestinationEnabled'] unless attributes[:'isFileOverrideInDestinationEnabled'].nil?

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

  self.is_file_override_in_destination_enabled = attributes[:'is_file_override_in_destination_enabled'] unless attributes[:'is_file_override_in_destination_enabled'].nil?

  self.is_scanning_enabled = attributes[:'isScanningEnabled'] unless attributes[:'isScanningEnabled'].nil?

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

  self.is_scanning_enabled = attributes[:'is_scanning_enabled'] unless attributes[:'is_scanning_enabled'].nil?

  self.is_chunking_enabled = attributes[:'isChunkingEnabled'] unless attributes[:'isChunkingEnabled'].nil?

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

  self.is_chunking_enabled = attributes[:'is_chunking_enabled'] unless attributes[:'is_chunking_enabled'].nil?

  self.is_approval_needed = attributes[:'isApprovalNeeded'] unless attributes[:'isApprovalNeeded'].nil?

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

  self.is_approval_needed = attributes[:'is_approval_needed'] unless attributes[:'is_approval_needed'].nil?

  self.approval_key_vault_id = attributes[:'approvalKeyVaultId'] if attributes[:'approvalKeyVaultId']

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

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

  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

#approval_key_vault_id ⇒ String

The KMS vault OCID for the key to be used for file transfer approvals.

Returns:

  • (String) 


108
109
110
 
# File 'lib/oci/gdp/models/gdp_pipeline.rb', line 108

def approval_key_vault_id
  @approval_key_vault_id
end

#authorization_details ⇒ String

Authorization information about the pipeline being configured.

Returns:

  • (String) 


68
69
70
 
# File 'lib/oci/gdp/models/gdp_pipeline.rb', line 68

def authorization_details
  @authorization_details
end

#bucket_details ⇒ Array<OCI::Gdp::Models::BucketDetailsDefinition>

Information about the bucket in the pipeline being configured.

Returns:



72
73
74
 
# File 'lib/oci/gdp/models/gdp_pipeline.rb', line 72

def bucket_details
  @bucket_details
end

#compartment_id ⇒ String

[Required] The OCID of the compartment.

Returns:

  • (String) 


36
37
38
 
# File 'lib/oci/gdp/models/gdp_pipeline.rb', line 36

def compartment_id
  @compartment_id
end

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

[Required] Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {\"foo-namespace\": {\"bar-key\": \"value\"}}

Returns:

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


120
121
122
 
# File 'lib/oci/gdp/models/gdp_pipeline.rb', line 120

def defined_tags
  @defined_tags
end

#description ⇒ String

Short field input by customer for a description of the data pipeline use-case.

Returns:

  • (String) 


52
53
54
 
# File 'lib/oci/gdp/models/gdp_pipeline.rb', line 52

def description
  @description
end

#display_name ⇒ String

[Required] Pipeline short name.

Returns:

  • (String) 


48
49
50
 
# File 'lib/oci/gdp/models/gdp_pipeline.rb', line 48

def display_name
  @display_name
end

#file_types ⇒ Array<String>

List of file types allowed to be transferred in the pipeline according to the authorization details (e.g. .pdf, .xml, .doc).

Returns:

  • (Array<String>) 


64
65
66
 
# File 'lib/oci/gdp/models/gdp_pipeline.rb', line 64

def file_types
  @file_types
end

#freeform_tags ⇒ Hash<String, String>

[Required] Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {\"bar-key\": \"value\"}

Returns:

  • (Hash<String, String>) 


114
115
116
 
# File 'lib/oci/gdp/models/gdp_pipeline.rb', line 114

def freeform_tags
  @freeform_tags
end

#id ⇒ String

[Required] The OCID of the pipeline.

Returns:

  • (String) 


32
33
34
 
# File 'lib/oci/gdp/models/gdp_pipeline.rb', line 32

def id
  @id
end

#is_approval_needed ⇒ BOOLEAN

Determines whether file transfers need to go through an approval workflow.

Returns:

  • (BOOLEAN) 


104
105
106
 
# File 'lib/oci/gdp/models/gdp_pipeline.rb', line 104

def is_approval_needed
  @is_approval_needed
end

#is_chunking_enabled ⇒ BOOLEAN

Determines whether file must be chunked during the transfer. This is only a property of SENDER pipelines.

Returns:

  • (BOOLEAN) 


100
101
102
 
# File 'lib/oci/gdp/models/gdp_pipeline.rb', line 100

def is_chunking_enabled
  @is_chunking_enabled
end

#is_file_override_in_destination_enabled ⇒ BOOLEAN

Enable file override feature in destination bucket

Returns:

  • (BOOLEAN) 


92
93
94
 
# File 'lib/oci/gdp/models/gdp_pipeline.rb', line 92

def is_file_override_in_destination_enabled
  @is_file_override_in_destination_enabled
end

#is_scanning_enabled ⇒ BOOLEAN

Determines whether GDP Scanning should be enabled for the pipeline.

Returns:

  • (BOOLEAN) 


96
97
98
 
# File 'lib/oci/gdp/models/gdp_pipeline.rb', line 96

def is_scanning_enabled
  @is_scanning_enabled
end

#lifecycle_details ⇒ String

Additional details about the current state of the pipeline.

Returns:

  • (String) 


44
45
46
 
# File 'lib/oci/gdp/models/gdp_pipeline.rb', line 44

def lifecycle_details
  @lifecycle_details
end

#lifecycle_state ⇒ String

[Required] The current state of the pipeline.

Returns:

  • (String) 


40
41
42
 
# File 'lib/oci/gdp/models/gdp_pipeline.rb', line 40

def lifecycle_state
  @lifecycle_state
end

#peered_gdp_pipeline_id ⇒ String

OCID of the peered pipeline.

Returns:

  • (String) 


80
81
82
 
# File 'lib/oci/gdp/models/gdp_pipeline.rb', line 80

def peered_gdp_pipeline_id
  @peered_gdp_pipeline_id
end

#peering_region ⇒ String

[Required] Public region name where the peered pipeline exists.

Returns:

  • (String) 


76
77
78
 
# File 'lib/oci/gdp/models/gdp_pipeline.rb', line 76

def peering_region
  @peering_region
end

#pipeline_type ⇒ String

[Required] Type of pipeline. Can be SENDER or RECEIVER.

Returns:

  • (String) 


60
61
62
 
# File 'lib/oci/gdp/models/gdp_pipeline.rb', line 60

def pipeline_type
  @pipeline_type
end

#service_log_group_id ⇒ String

the OCID of the service log group.

Returns:

  • (String) 


56
57
58
 
# File 'lib/oci/gdp/models/gdp_pipeline.rb', line 56

def service_log_group_id
  @service_log_group_id
end

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

System tags for this resource. Each key is predefined and scoped to a namespace. Example: {\"orcl-cloud\": {\"free-tier-retained\": \"true\"}}

Returns:

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


126
127
128
 
# File 'lib/oci/gdp/models/gdp_pipeline.rb', line 126

def system_tags
  @system_tags
end

#time_created ⇒ DateTime

[Required] The time the the pipeline was created. An RFC3339 formatted datetime string.

Returns:

  • (DateTime) 


84
85
86
 
# File 'lib/oci/gdp/models/gdp_pipeline.rb', line 84

def time_created
  @time_created
end

#time_updated ⇒ DateTime

[Required] The time the pipeline was updated. An RFC3339 formatted datetime string.

Returns:

  • (DateTime) 


88
89
90
 
# File 'lib/oci/gdp/models/gdp_pipeline.rb', line 88

def time_updated
  @time_updated
end

Class Method Details

.attribute_map ⇒ Object

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



129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
 
# File 'lib/oci/gdp/models/gdp_pipeline.rb', line 129

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'id',
    'compartment_id': :'compartmentId',
    'lifecycle_state': :'lifecycleState',
    'lifecycle_details': :'lifecycleDetails',
    'display_name': :'displayName',
    'description': :'description',
    'service_log_group_id': :'serviceLogGroupId',
    'pipeline_type': :'pipelineType',
    'file_types': :'fileTypes',
    'authorization_details': :'authorizationDetails',
    'bucket_details': :'bucketDetails',
    'peering_region': :'peeringRegion',
    'peered_gdp_pipeline_id': :'peeredGdpPipelineId',
    'time_created': :'timeCreated',
    'time_updated': :'timeUpdated',
    'is_file_override_in_destination_enabled': :'isFileOverrideInDestinationEnabled',
    'is_scanning_enabled': :'isScanningEnabled',
    'is_chunking_enabled': :'isChunkingEnabled',
    'is_approval_needed': :'isApprovalNeeded',
    'approval_key_vault_id': :'approvalKeyVaultId',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags',
    'system_tags': :'systemTags'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



160
161
162
163
164
165
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/gdp/models/gdp_pipeline.rb', line 160

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'String',
    'compartment_id': :'String',
    'lifecycle_state': :'String',
    'lifecycle_details': :'String',
    'display_name': :'String',
    'description': :'String',
    'service_log_group_id': :'String',
    'pipeline_type': :'String',
    'file_types': :'Array<String>',
    'authorization_details': :'String',
    'bucket_details': :'Array<OCI::Gdp::Models::BucketDetailsDefinition>',
    'peering_region': :'String',
    'peered_gdp_pipeline_id': :'String',
    'time_created': :'DateTime',
    'time_updated': :'DateTime',
    'is_file_override_in_destination_enabled': :'BOOLEAN',
    'is_scanning_enabled': :'BOOLEAN',
    'is_chunking_enabled': :'BOOLEAN',
    'is_approval_needed': :'BOOLEAN',
    'approval_key_vault_id': :'String',
    '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



389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
 
# File 'lib/oci/gdp/models/gdp_pipeline.rb', line 389

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

  self.class == other.class &&
    id == other.id &&
    compartment_id == other.compartment_id &&
    lifecycle_state == other.lifecycle_state &&
    lifecycle_details == other.lifecycle_details &&
    display_name == other.display_name &&
    description == other.description &&
    service_log_group_id == other.service_log_group_id &&
    pipeline_type == other.pipeline_type &&
    file_types == other.file_types &&
    authorization_details == other.authorization_details &&
    bucket_details == other.bucket_details &&
    peering_region == other.peering_region &&
    peered_gdp_pipeline_id == other.peered_gdp_pipeline_id &&
    time_created == other.time_created &&
    time_updated == other.time_updated &&
    is_file_override_in_destination_enabled == other.is_file_override_in_destination_enabled &&
    is_scanning_enabled == other.is_scanning_enabled &&
    is_chunking_enabled == other.is_chunking_enabled &&
    is_approval_needed == other.is_approval_needed &&
    approval_key_vault_id == other.approval_key_vault_id &&
    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



441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
 
# File 'lib/oci/gdp/models/gdp_pipeline.rb', line 441

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


421
422
423
 
# File 'lib/oci/gdp/models/gdp_pipeline.rb', line 421

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



430
431
432
 
# File 'lib/oci/gdp/models/gdp_pipeline.rb', line 430

def hash
  [id, compartment_id, lifecycle_state, lifecycle_details, display_name, description, service_log_group_id, pipeline_type, file_types, authorization_details, bucket_details, peering_region, peered_gdp_pipeline_id, time_created, time_updated, is_file_override_in_destination_enabled, is_scanning_enabled, is_chunking_enabled, is_approval_needed, approval_key_vault_id, 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



474
475
476
477
478
479
480
481
482
483
 
# File 'lib/oci/gdp/models/gdp_pipeline.rb', line 474

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



468
469
470
 
# File 'lib/oci/gdp/models/gdp_pipeline.rb', line 468

def to_s
  to_hash.to_s
end