Class: OCI::DataScience::Models::CreateJobDetails

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/data_science/models/create_job_details.rb

Overview

Parameters needed to create a new job.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ CreateJobDetails

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
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
158
159
160
161
162
163
164
165
166
167
168
 
# File 'lib/oci/data_science/models/create_job_details.rb', line 107

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

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

  self.project_id = attributes[:'project_id'] if attributes[:'project_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.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.job_configuration_details = attributes[:'jobConfigurationDetails'] if attributes[:'jobConfigurationDetails']

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

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

  self.job_infrastructure_configuration_details = attributes[:'jobInfrastructureConfigurationDetails'] if attributes[:'jobInfrastructureConfigurationDetails']

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

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

  self.job_log_configuration_details = attributes[:'jobLogConfigurationDetails'] if attributes[:'jobLogConfigurationDetails']

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

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

  self.job_storage_mount_configuration_details_list = attributes[:'jobStorageMountConfigurationDetailsList'] if attributes[:'jobStorageMountConfigurationDetailsList']

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

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

  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

#compartment_id ⇒ String

[Required] The OCID of the compartment where you want to create the job.

Returns:

  • (String) 


18
19
20
 
# File 'lib/oci/data_science/models/create_job_details.rb', line 18

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. See Resource Tags. Example: {\"Operations\": {\"CostCenter\": \"42\"}}

Returns:

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


53
54
55
 
# File 'lib/oci/data_science/models/create_job_details.rb', line 53

def defined_tags
  @defined_tags
end

#description ⇒ String

A short description of the job.

Returns:

  • (String) 


26
27
28
 
# File 'lib/oci/data_science/models/create_job_details.rb', line 26

def description
  @description
end

#display_name ⇒ String

A user-friendly display name for the resource.

Returns:

  • (String) 


22
23
24
 
# File 'lib/oci/data_science/models/create_job_details.rb', line 22

def display_name
  @display_name
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. See Resource Tags. Example: {\"Department\": \"Finance\"}

Returns:

  • (Hash<String, String>) 


47
48
49
 
# File 'lib/oci/data_science/models/create_job_details.rb', line 47

def freeform_tags
  @freeform_tags
end

#job_configuration_details ⇒ OCI::DataScience::Models::JobConfigurationDetails

This attribute is required.

Returns:



30
31
32
 
# File 'lib/oci/data_science/models/create_job_details.rb', line 30

def job_configuration_details
  @job_configuration_details
end

#job_infrastructure_configuration_details ⇒ OCI::DataScience::Models::JobInfrastructureConfigurationDetails

This attribute is required.

Returns:



34
35
36
 
# File 'lib/oci/data_science/models/create_job_details.rb', line 34

def job_infrastructure_configuration_details
  @job_infrastructure_configuration_details
end

#job_log_configuration_details ⇒ OCI::DataScience::Models::JobLogConfigurationDetails

Returns:



37
38
39
 
# File 'lib/oci/data_science/models/create_job_details.rb', line 37

def job_log_configuration_details
  @job_log_configuration_details
end

#job_storage_mount_configuration_details_list ⇒ Array<OCI::DataScience::Models::StorageMountConfigurationDetails>

Collection of JobStorageMountConfigurationDetails.

Returns:



41
42
43
 
# File 'lib/oci/data_science/models/create_job_details.rb', line 41

def job_storage_mount_configuration_details_list
  @job_storage_mount_configuration_details_list
end

#project_id ⇒ String

[Required] The OCID of the project to associate the job with.

Returns:

  • (String) 


14
15
16
 
# File 'lib/oci/data_science/models/create_job_details.rb', line 14

def project_id
  @project_id
end

Class Method Details

.attribute_map ⇒ Object

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



56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
 
# File 'lib/oci/data_science/models/create_job_details.rb', line 56

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'project_id': :'projectId',
    'compartment_id': :'compartmentId',
    'display_name': :'displayName',
    'description': :'description',
    'job_configuration_details': :'jobConfigurationDetails',
    'job_infrastructure_configuration_details': :'jobInfrastructureConfigurationDetails',
    'job_log_configuration_details': :'jobLogConfigurationDetails',
    'job_storage_mount_configuration_details_list': :'jobStorageMountConfigurationDetailsList',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
 
# File 'lib/oci/data_science/models/create_job_details.rb', line 74

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'project_id': :'String',
    'compartment_id': :'String',
    'display_name': :'String',
    'description': :'String',
    'job_configuration_details': :'OCI::DataScience::Models::JobConfigurationDetails',
    'job_infrastructure_configuration_details': :'OCI::DataScience::Models::JobInfrastructureConfigurationDetails',
    'job_log_configuration_details': :'OCI::DataScience::Models::JobLogConfigurationDetails',
    'job_storage_mount_configuration_details_list': :'Array<OCI::DataScience::Models::StorageMountConfigurationDetails>',
    '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



177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
 
# File 'lib/oci/data_science/models/create_job_details.rb', line 177

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

  self.class == other.class &&
    project_id == other.project_id &&
    compartment_id == other.compartment_id &&
    display_name == other.display_name &&
    description == other.description &&
    job_configuration_details == other.job_configuration_details &&
    job_infrastructure_configuration_details == other.job_infrastructure_configuration_details &&
    job_log_configuration_details == other.job_log_configuration_details &&
    job_storage_mount_configuration_details_list == other.job_storage_mount_configuration_details_list &&
    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



216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
 
# File 'lib/oci/data_science/models/create_job_details.rb', line 216

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


196
197
198
 
# File 'lib/oci/data_science/models/create_job_details.rb', line 196

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



205
206
207
 
# File 'lib/oci/data_science/models/create_job_details.rb', line 205

def hash
  [project_id, compartment_id, display_name, description, job_configuration_details, job_infrastructure_configuration_details, job_log_configuration_details, job_storage_mount_configuration_details_list, 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



249
250
251
252
253
254
255
256
257
258
 
# File 'lib/oci/data_science/models/create_job_details.rb', line 249

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



243
244
245
 
# File 'lib/oci/data_science/models/create_job_details.rb', line 243

def to_s
  to_hash.to_s
end