Class: OCI::Gdp::Models::GdpPipelineSummary

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

Overview

Retrieves summary pipeline configuration information by identifier.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ GdpPipelineSummary

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

  • :compartment_id (String) —

    The value to assign to the #compartment_id property

  • :lifecycle_state (String) —

    The value to assign to the #lifecycle_state property

  • :display_name (String) —

    The value to assign to the #display_name property

  • :description (String) —

    The value to assign to the #description property

  • :service_log_group_id (String) —

    The value to assign to the #service_log_group_id property

  • :pipeline_type (String) —

    The value to assign to the #pipeline_type property

  • :peering_region (String) —

    The value to assign to the #peering_region property

  • :authorization_details (String) —

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

  • :is_file_override_in_destination_enabled (BOOLEAN) —

    The value to assign to the #is_file_override_in_destination_enabled property

  • :is_scanning_enabled (BOOLEAN) —

    The value to assign to the #is_scanning_enabled property

  • :is_chunking_enabled (BOOLEAN) —

    The value to assign to the #is_chunking_enabled property

  • :is_approval_needed (BOOLEAN) —

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



165
166
167
168
169
170
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
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
 
# File 'lib/oci/gdp/models/gdp_pipeline_summary.rb', line 165

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

#authorization_details ⇒ String

Free-text field containing tracking information for approval tracking.

Returns:

  • (String) 


45
46
47
 
# File 'lib/oci/gdp/models/gdp_pipeline_summary.rb', line 45

def authorization_details
  @authorization_details
end

#compartment_id ⇒ String

[Required] The OCID of the compartment.

Returns:

  • (String) 


17
18
19
 
# File 'lib/oci/gdp/models/gdp_pipeline_summary.rb', line 17

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


81
82
83
 
# File 'lib/oci/gdp/models/gdp_pipeline_summary.rb', line 81

def defined_tags
  @defined_tags
end

#description ⇒ String

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

Returns:

  • (String) 


29
30
31
 
# File 'lib/oci/gdp/models/gdp_pipeline_summary.rb', line 29

def description
  @description
end

#display_name ⇒ String

[Required] Pipeline short name.

Returns:

  • (String) 


25
26
27
 
# File 'lib/oci/gdp/models/gdp_pipeline_summary.rb', line 25

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


75
76
77
 
# File 'lib/oci/gdp/models/gdp_pipeline_summary.rb', line 75

def freeform_tags
  @freeform_tags
end

#id ⇒ String

[Required] The OCID of the pipeline.

Returns:

  • (String) 


13
14
15
 
# File 'lib/oci/gdp/models/gdp_pipeline_summary.rb', line 13

def id
  @id
end

#is_approval_needed ⇒ BOOLEAN

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

Returns:

  • (BOOLEAN) 


69
70
71
 
# File 'lib/oci/gdp/models/gdp_pipeline_summary.rb', line 69

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) 


65
66
67
 
# File 'lib/oci/gdp/models/gdp_pipeline_summary.rb', line 65

def is_chunking_enabled
  @is_chunking_enabled
end

#is_file_override_in_destination_enabled ⇒ BOOLEAN

Enable file override feature in destination bucket

Returns:

  • (BOOLEAN) 


57
58
59
 
# File 'lib/oci/gdp/models/gdp_pipeline_summary.rb', line 57

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) 


61
62
63
 
# File 'lib/oci/gdp/models/gdp_pipeline_summary.rb', line 61

def is_scanning_enabled
  @is_scanning_enabled
end

#lifecycle_state ⇒ String

[Required] The current state of the pipeline.

Returns:

  • (String) 


21
22
23
 
# File 'lib/oci/gdp/models/gdp_pipeline_summary.rb', line 21

def lifecycle_state
  @lifecycle_state
end

#peering_region ⇒ String

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

Returns:

  • (String) 


41
42
43
 
# File 'lib/oci/gdp/models/gdp_pipeline_summary.rb', line 41

def peering_region
  @peering_region
end

#pipeline_type ⇒ String

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

Returns:

  • (String) 


37
38
39
 
# File 'lib/oci/gdp/models/gdp_pipeline_summary.rb', line 37

def pipeline_type
  @pipeline_type
end

#service_log_group_id ⇒ String

the OCID of the service log group.

Returns:

  • (String) 


33
34
35
 
# File 'lib/oci/gdp/models/gdp_pipeline_summary.rb', line 33

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


87
88
89
 
# File 'lib/oci/gdp/models/gdp_pipeline_summary.rb', line 87

def system_tags
  @system_tags
end

#time_created ⇒ DateTime

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

Returns:

  • (DateTime) 


49
50
51
 
# File 'lib/oci/gdp/models/gdp_pipeline_summary.rb', line 49

def time_created
  @time_created
end

#time_updated ⇒ DateTime

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

Returns:

  • (DateTime) 


53
54
55
 
# File 'lib/oci/gdp/models/gdp_pipeline_summary.rb', line 53

def time_updated
  @time_updated
end

Class Method Details

.attribute_map ⇒ Object

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



90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
 
# File 'lib/oci/gdp/models/gdp_pipeline_summary.rb', line 90

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'id',
    'compartment_id': :'compartmentId',
    'lifecycle_state': :'lifecycleState',
    'display_name': :'displayName',
    'description': :'description',
    'service_log_group_id': :'serviceLogGroupId',
    'pipeline_type': :'pipelineType',
    'peering_region': :'peeringRegion',
    'authorization_details': :'authorizationDetails',
    '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',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags',
    'system_tags': :'systemTags'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
 
# File 'lib/oci/gdp/models/gdp_pipeline_summary.rb', line 116

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'String',
    'compartment_id': :'String',
    'lifecycle_state': :'String',
    'display_name': :'String',
    'description': :'String',
    'service_log_group_id': :'String',
    'pipeline_type': :'String',
    'peering_region': :'String',
    'authorization_details': :'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',
    '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



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

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

  self.class == other.class &&
    id == other.id &&
    compartment_id == other.compartment_id &&
    lifecycle_state == other.lifecycle_state &&
    display_name == other.display_name &&
    description == other.description &&
    service_log_group_id == other.service_log_group_id &&
    pipeline_type == other.pipeline_type &&
    peering_region == other.peering_region &&
    authorization_details == other.authorization_details &&
    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 &&
    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/gdp/models/gdp_pipeline_summary.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/gdp/models/gdp_pipeline_summary.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/gdp/models/gdp_pipeline_summary.rb', line 315

def hash
  [id, compartment_id, lifecycle_state, display_name, description, service_log_group_id, pipeline_type, peering_region, authorization_details, time_created, time_updated, is_file_override_in_destination_enabled, is_scanning_enabled, is_chunking_enabled, is_approval_needed, 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/gdp/models/gdp_pipeline_summary.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/gdp/models/gdp_pipeline_summary.rb', line 353

def to_s
  to_hash.to_s
end