Class: OCI::Gdp::Models::CreateGdpPipelineDetails

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

Overview

The information about the new pipeline.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ CreateGdpPipelineDetails

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



149
150
151
152
153
154
155
156
157
158
159
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
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
 
# File 'lib/oci/gdp/models/create_gdp_pipeline_details.rb', line 149

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.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.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.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.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.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']
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) 


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

def approval_key_vault_id
  @approval_key_vault_id
end

#authorization_details ⇒ String

Authorization information about the pipeline being configured.

Returns:

  • (String) 


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

def authorization_details
  @authorization_details
end

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

[Required] Information about the bucket in the pipeline being configured.

Returns:



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

def bucket_details
  @bucket_details
end

#compartment_id ⇒ String

[Required] The OCID of the compartment.

Returns:

  • (String) 


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

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. Example: {\"foo-namespace\": {\"bar-key\": \"value\"}}

Returns:

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


77
78
79
 
# File 'lib/oci/gdp/models/create_gdp_pipeline_details.rb', line 77

def defined_tags
  @defined_tags
end

#description ⇒ String

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

Returns:

  • (String) 


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

def description
  @description
end

#display_name ⇒ String

[Required] Pipeline short name.

Returns:

  • (String) 


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

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


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

def file_types
  @file_types
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. Example: {\"bar-key\": \"value\"}

Returns:

  • (Hash<String, String>) 


71
72
73
 
# File 'lib/oci/gdp/models/create_gdp_pipeline_details.rb', line 71

def freeform_tags
  @freeform_tags
end

#is_approval_needed ⇒ BOOLEAN

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

Returns:

  • (BOOLEAN) 


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

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) 


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

def is_chunking_enabled
  @is_chunking_enabled
end

#is_file_override_in_destination_enabled ⇒ BOOLEAN

Enable file override feature in destination bucket

Returns:

  • (BOOLEAN) 


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

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) 


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

def is_scanning_enabled
  @is_scanning_enabled
end

#peering_region ⇒ String

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

Returns:

  • (String) 


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

def peering_region
  @peering_region
end

#pipeline_type ⇒ String

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

Returns:

  • (String) 


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

def pipeline_type
  @pipeline_type
end

#service_log_group_id ⇒ String

the OCID of the service log group.

Returns:

  • (String) 


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

def service_log_group_id
  @service_log_group_id
end

Class Method Details

.attribute_map ⇒ Object

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



80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
 
# File 'lib/oci/gdp/models/create_gdp_pipeline_details.rb', line 80

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'compartment_id': :'compartmentId',
    'display_name': :'displayName',
    'description': :'description',
    'service_log_group_id': :'serviceLogGroupId',
    'pipeline_type': :'pipelineType',
    'file_types': :'fileTypes',
    'bucket_details': :'bucketDetails',
    'peering_region': :'peeringRegion',
    'authorization_details': :'authorizationDetails',
    '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'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
 
# File 'lib/oci/gdp/models/create_gdp_pipeline_details.rb', line 104

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'compartment_id': :'String',
    'display_name': :'String',
    'description': :'String',
    'service_log_group_id': :'String',
    'pipeline_type': :'String',
    'file_types': :'Array<String>',
    'bucket_details': :'Array<OCI::Gdp::Models::BucketDetailsDefinition>',
    'peering_region': :'String',
    'authorization_details': :'String',
    '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>>'
    # 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



255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
 
# File 'lib/oci/gdp/models/create_gdp_pipeline_details.rb', line 255

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

  self.class == other.class &&
    compartment_id == other.compartment_id &&
    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 &&
    bucket_details == other.bucket_details &&
    peering_region == other.peering_region &&
    authorization_details == other.authorization_details &&
    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
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



300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
 
# File 'lib/oci/gdp/models/create_gdp_pipeline_details.rb', line 300

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


280
281
282
 
# File 'lib/oci/gdp/models/create_gdp_pipeline_details.rb', line 280

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



289
290
291
 
# File 'lib/oci/gdp/models/create_gdp_pipeline_details.rb', line 289

def hash
  [compartment_id, display_name, description, service_log_group_id, pipeline_type, file_types, bucket_details, peering_region, authorization_details, is_file_override_in_destination_enabled, is_scanning_enabled, is_chunking_enabled, is_approval_needed, approval_key_vault_id, freeform_tags, defined_tags].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



333
334
335
336
337
338
339
340
341
342
 
# File 'lib/oci/gdp/models/create_gdp_pipeline_details.rb', line 333

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



327
328
329
 
# File 'lib/oci/gdp/models/create_gdp_pipeline_details.rb', line 327

def to_s
  to_hash.to_s
end