Class: OCI::DataFlow::Models::UpdateApplicationDetails

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/data_flow/models/update_application_details.rb

Overview

The update application details.

Constant Summary collapse

LANGUAGE_ENUM = 
[
  LANGUAGE_SCALA = 'SCALA'.freeze,
  LANGUAGE_JAVA = 'JAVA'.freeze,
  LANGUAGE_PYTHON = 'PYTHON'.freeze,
  LANGUAGE_SQL = 'SQL'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ UpdateApplicationDetails

Initializes the object

Parameters:

  • (defaults to: {})

    Model attributes in the form of hash

Options Hash (attributes):

  • :class_name (String) —

    The value to assign to the #class_name property

  • :file_uri (String) —

    The value to assign to the #file_uri property

  • :spark_version (String) —

    The value to assign to the #spark_version property

  • :language (String) —

    The value to assign to the #language property

  • :archive_uri (String) —

    The value to assign to the #archive_uri property

  • :arguments (Array<String>) —

    The value to assign to the #arguments property

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

    The value to assign to the #configuration property

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

    The value to assign to the #defined_tags property

  • :description (String) —

    The value to assign to the #description property

  • :display_name (String) —

    The value to assign to the #display_name property

  • :driver_shape (String) —

    The value to assign to the #driver_shape property

  • :execute (String) —

    The value to assign to the #execute property

  • :executor_shape (String) —

    The value to assign to the #executor_shape property

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

    The value to assign to the #freeform_tags property

  • :logs_bucket_uri (String) —

    The value to assign to the #logs_bucket_uri property

  • :num_executors (Integer) —

    The value to assign to the #num_executors property

  • :parameters (Array<OCI::DataFlow::Models::ApplicationParameter>) —

    The value to assign to the #parameters property

  • :private_endpoint_id (String) —

    The value to assign to the #private_endpoint_id property

  • :warehouse_bucket_uri (String) —

    The value to assign to the #warehouse_bucket_uri property



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
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
 
# File 'lib/oci/data_flow/models/update_application_details.rb', line 218

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

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

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

  self.file_uri = attributes[:'fileUri'] if attributes[:'fileUri']

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

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

  self.spark_version = attributes[:'sparkVersion'] if attributes[:'sparkVersion']

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

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

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

  self.archive_uri = attributes[:'archiveUri'] if attributes[:'archiveUri']

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

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

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

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

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

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

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

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

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

  self.executor_shape = attributes[:'executorShape'] if attributes[:'executorShape']

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

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

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

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

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

  self.num_executors = attributes[:'numExecutors'] if attributes[:'numExecutors']

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

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

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

  self.private_endpoint_id = attributes[:'privateEndpointId'] if attributes[:'privateEndpointId']

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

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

  self.warehouse_bucket_uri = attributes[:'warehouseBucketUri'] if attributes[:'warehouseBucketUri']

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

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

Instance Attribute Details

#archive_uri ⇒ String

An Oracle Cloud Infrastructure URI of an archive.zip file containing custom dependencies that may be used to support the execution a Python, Java, or Scala application. See docs.cloud.oracle.com/iaas/Content/API/SDKDocs/hdfsconnector.htm#uriformat.

Returns:



43
44
45
 
# File 'lib/oci/data_flow/models/update_application_details.rb', line 43

def archive_uri
  @archive_uri
end

#arguments ⇒ Array<String>

The arguments passed to the running application as command line arguments. An argument is either a plain text or a placeholder. Placeholders are replaced using values from the parameters map. Each placeholder specified must be represented in the parameters map else the request (POST or PUT) will fail with a HTTP 400 status code. Placeholders are specified as ‘Service Api Spec`, where name is the name of the parameter. Example: `[ "–input", "$input_file", "–name", "John Doe" ]` If "input_file" has a value of "mydata.xml", then the value above will be translated to `–input mydata.xml –name "John Doe"`

Returns:



55
56
57
 
# File 'lib/oci/data_flow/models/update_application_details.rb', line 55

def arguments
  @arguments
end

#class_name ⇒ String

The class for the application.

Returns:



21
22
23
 
# File 'lib/oci/data_flow/models/update_application_details.rb', line 21

def class_name
  @class_name
end

#configuration ⇒ Hash<String, String>

The Spark configuration passed to the running process. See spark.apache.org/docs/latest/configuration.html#available-properties. Example: { "spark.app.name" : "My App Name", "spark.shuffle.io.maxRetries" : "4" } Note: Not all Spark properties are permitted to be set. Attempting to set a property that is not allowed to be overwritten will cause a 400 status to be returned.

Returns:



64
65
66
 
# File 'lib/oci/data_flow/models/update_application_details.rb', line 64

def configuration
  @configuration
end

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

Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: ‘{"CostCenter": "42"}`

Returns:



70
71
72
 
# File 'lib/oci/data_flow/models/update_application_details.rb', line 70

def defined_tags
  @defined_tags
end

#description ⇒ String

A user-friendly description. Avoid entering confidential information.

Returns:



75
76
77
 
# File 'lib/oci/data_flow/models/update_application_details.rb', line 75

def description
  @description
end

#display_name ⇒ String

A user-friendly name. It does not have to be unique. Avoid entering confidential information.

Returns:



80
81
82
 
# File 'lib/oci/data_flow/models/update_application_details.rb', line 80

def display_name
  @display_name
end

#driver_shape ⇒ String

The VM shape for the driver. Sets the driver cores and memory.

Returns:



85
86
87
 
# File 'lib/oci/data_flow/models/update_application_details.rb', line 85

def driver_shape
  @driver_shape
end

#execute ⇒ String

The input used for spark-submit command. For more details see spark.apache.org/docs/latest/submitting-applications.html#launching-applications-with-spark-submit. Supported options include --class, --file, --jars, --conf, --py-files, and main application file with arguments. Example: “–jars oci://path/to/a.jar,oci://path/to/b.jar –files oci://path/to/a.json,oci://path/to/b.csv –py-files oci://path/to/a.py,oci://path/to/b.py –conf spark.sql.crossJoin.enabled=true –class org.apache.spark.examples.SparkPi oci://path/to/main.jar 10“ Note: If execute is specified together with applicationId, className, configuration, fileUri, language, arguments, parameters during application create/update, or run create/submit, Data Flow service will use derived information from execute input only.

Returns:



94
95
96
 
# File 'lib/oci/data_flow/models/update_application_details.rb', line 94

def execute
  @execute
end

#executor_shape ⇒ String

The VM shape for the executors. Sets the executor cores and memory.

Returns:



99
100
101
 
# File 'lib/oci/data_flow/models/update_application_details.rb', line 99

def executor_shape
  @executor_shape
end

#file_uri ⇒ String

An Oracle Cloud Infrastructure URI of the file containing the application to execute. See docs.cloud.oracle.com/iaas/Content/API/SDKDocs/hdfsconnector.htm#uriformat.

Returns:



27
28
29
 
# File 'lib/oci/data_flow/models/update_application_details.rb', line 27

def file_uri
  @file_uri
end

#freeform_tags ⇒ Hash<String, String>

Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: ‘"Finance"`

Returns:



106
107
108
 
# File 'lib/oci/data_flow/models/update_application_details.rb', line 106

def freeform_tags
  @freeform_tags
end

#language ⇒ String

The Spark language.

Returns:



37
38
39
 
# File 'lib/oci/data_flow/models/update_application_details.rb', line 37

def language
  @language
end

#logs_bucket_uri ⇒ String

An Oracle Cloud Infrastructure URI of the bucket where the Spark job logs are to be uploaded. See docs.cloud.oracle.com/iaas/Content/API/SDKDocs/hdfsconnector.htm#uriformat.

Returns:



112
113
114
 
# File 'lib/oci/data_flow/models/update_application_details.rb', line 112

def logs_bucket_uri
  @logs_bucket_uri
end

#num_executors ⇒ Integer

The number of executor VMs requested.

Returns:



117
118
119
 
# File 'lib/oci/data_flow/models/update_application_details.rb', line 117

def num_executors
  @num_executors
end

#parameters ⇒ Array<OCI::DataFlow::Models::ApplicationParameter>

An array of name/value pairs used to fill placeholders found in properties like Application.arguments. The name must be a string of one or more word characters (a-z, A-Z, 0-9, _). The value can be a string of 0 or more characters of any kind. Example: [ { name: "iterations", value: "10"}, { name: "input_file", value: "mydata.xml" }, { name: "variable_x", value: "$x"} ]

Returns:



125
126
127
 
# File 'lib/oci/data_flow/models/update_application_details.rb', line 125

def parameters
  @parameters
end

#private_endpoint_id ⇒ String

The OCID of a private endpoint.

Returns:



130
131
132
 
# File 'lib/oci/data_flow/models/update_application_details.rb', line 130

def private_endpoint_id
  @private_endpoint_id
end

#spark_version ⇒ String

The Spark version utilized to run the application.

Returns:



32
33
34
 
# File 'lib/oci/data_flow/models/update_application_details.rb', line 32

def spark_version
  @spark_version
end

#warehouse_bucket_uri ⇒ String

An Oracle Cloud Infrastructure URI of the bucket to be used as default warehouse directory for BATCH SQL runs. See docs.cloud.oracle.com/iaas/Content/API/SDKDocs/hdfsconnector.htm#uriformat.

Returns:



137
138
139
 
# File 'lib/oci/data_flow/models/update_application_details.rb', line 137

def warehouse_bucket_uri
  @warehouse_bucket_uri
end

Class Method Details

.attribute_map ⇒ Object

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



140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
 
# File 'lib/oci/data_flow/models/update_application_details.rb', line 140

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'class_name': :'className',
    'file_uri': :'fileUri',
    'spark_version': :'sparkVersion',
    'language': :'language',
    'archive_uri': :'archiveUri',
    'arguments': :'arguments',
    'configuration': :'configuration',
    'defined_tags': :'definedTags',
    'description': :'description',
    'display_name': :'displayName',
    'driver_shape': :'driverShape',
    'execute': :'execute',
    'executor_shape': :'executorShape',
    'freeform_tags': :'freeformTags',
    'logs_bucket_uri': :'logsBucketUri',
    'num_executors': :'numExecutors',
    'parameters': :'parameters',
    'private_endpoint_id': :'privateEndpointId',
    'warehouse_bucket_uri': :'warehouseBucketUri'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



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
 
# File 'lib/oci/data_flow/models/update_application_details.rb', line 167

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'class_name': :'String',
    'file_uri': :'String',
    'spark_version': :'String',
    'language': :'String',
    'archive_uri': :'String',
    'arguments': :'Array<String>',
    'configuration': :'Hash<String, String>',
    'defined_tags': :'Hash<String, Hash<String, Object>>',
    'description': :'String',
    'display_name': :'String',
    'driver_shape': :'String',
    'execute': :'String',
    'executor_shape': :'String',
    'freeform_tags': :'Hash<String, String>',
    'logs_bucket_uri': :'String',
    'num_executors': :'Integer',
    'parameters': :'Array<OCI::DataFlow::Models::ApplicationParameter>',
    'private_endpoint_id': :'String',
    'warehouse_bucket_uri': :'String'
    # rubocop:enable Style/SymbolLiteral
  }
end

Instance Method Details

#==(other) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • the other object to be compared



330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
 
# File 'lib/oci/data_flow/models/update_application_details.rb', line 330

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

  self.class == other.class &&
    class_name == other.class_name &&
    file_uri == other.file_uri &&
    spark_version == other.spark_version &&
    language == other.language &&
    archive_uri == other.archive_uri &&
    arguments == other.arguments &&
    configuration == other.configuration &&
    defined_tags == other.defined_tags &&
    description == other.description &&
    display_name == other.display_name &&
    driver_shape == other.driver_shape &&
    execute == other.execute &&
    executor_shape == other.executor_shape &&
    freeform_tags == other.freeform_tags &&
    logs_bucket_uri == other.logs_bucket_uri &&
    num_executors == other.num_executors &&
    parameters == other.parameters &&
    private_endpoint_id == other.private_endpoint_id &&
    warehouse_bucket_uri == other.warehouse_bucket_uri
end

#build_from_hash(attributes) ⇒ Object

Builds the object from hash

Parameters:

  • Model attributes in the form of hash

Returns:

  • Returns the model itself



378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
 
# File 'lib/oci/data_flow/models/update_application_details.rb', line 378

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:

  • the other object to be compared

Returns:

See Also:

  • `==` method


358
359
360
 
# File 'lib/oci/data_flow/models/update_application_details.rb', line 358

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • Hash code



367
368
369
 
# File 'lib/oci/data_flow/models/update_application_details.rb', line 367

def hash
  [class_name, file_uri, spark_version, language, archive_uri, arguments, configuration, defined_tags, description, display_name, driver_shape, execute, executor_shape, freeform_tags, logs_bucket_uri, num_executors, parameters, private_endpoint_id, warehouse_bucket_uri].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • Returns the object in the form of hash



411
412
413
414
415
416
417
418
419
420
 
# File 'lib/oci/data_flow/models/update_application_details.rb', line 411

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 presentation of the object



405
406
407
 
# File 'lib/oci/data_flow/models/update_application_details.rb', line 405

def to_s
  to_hash.to_s
end