Class: OCI::DataLabelingService::Models::SnapshotDatasetDetails

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/data_labeling_service/models/snapshot_dataset_details.rb

Overview

Allows outputting the latest records paired with annotations and write them to object storage.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ SnapshotDatasetDetails

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
 
# File 'lib/oci/data_labeling_service/models/snapshot_dataset_details.rb', line 60

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

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

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

  self.are_unannotated_records_included = attributes[:'areUnannotatedRecordsIncluded'] unless attributes[:'areUnannotatedRecordsIncluded'].nil?

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

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

  self.export_details = attributes[:'exportDetails'] if attributes[:'exportDetails']

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

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

  self.export_format = attributes[:'exportFormat'] if attributes[:'exportFormat']

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

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

Instance Attribute Details

#are_annotations_included ⇒ BOOLEAN

[Required] Whether annotations are to be included in the export dataset digest.

Returns:

  • (BOOLEAN) 


13
14
15
 
# File 'lib/oci/data_labeling_service/models/snapshot_dataset_details.rb', line 13

def are_annotations_included
  @are_annotations_included
end

#are_unannotated_records_included ⇒ BOOLEAN

[Required] Whether to include records that have yet to be annotated in the export dataset digest.

Returns:

  • (BOOLEAN) 


17
18
19
 
# File 'lib/oci/data_labeling_service/models/snapshot_dataset_details.rb', line 17

def are_unannotated_records_included
  @are_unannotated_records_included
end

#export_details ⇒ OCI::DataLabelingService::Models::ObjectStorageSnapshotExportDetails

This attribute is required.

Returns:



21
22
23
 
# File 'lib/oci/data_labeling_service/models/snapshot_dataset_details.rb', line 21

def export_details
  @export_details
end

#export_format ⇒ OCI::DataLabelingService::Models::ExportFormat

Returns:



24
25
26
 
# File 'lib/oci/data_labeling_service/models/snapshot_dataset_details.rb', line 24

def export_format
  @export_format
end

Class Method Details

.attribute_map ⇒ Object

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



27
28
29
30
31
32
33
34
35
36
 
# File 'lib/oci/data_labeling_service/models/snapshot_dataset_details.rb', line 27

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'are_annotations_included': :'areAnnotationsIncluded',
    'are_unannotated_records_included': :'areUnannotatedRecordsIncluded',
    'export_details': :'exportDetails',
    'export_format': :'exportFormat'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



39
40
41
42
43
44
45
46
47
48
 
# File 'lib/oci/data_labeling_service/models/snapshot_dataset_details.rb', line 39

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'are_annotations_included': :'BOOLEAN',
    'are_unannotated_records_included': :'BOOLEAN',
    'export_details': :'OCI::DataLabelingService::Models::ObjectStorageSnapshotExportDetails',
    'export_format': :'OCI::DataLabelingService::Models::ExportFormat'
    # 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



98
99
100
101
102
103
104
105
106
 
# File 'lib/oci/data_labeling_service/models/snapshot_dataset_details.rb', line 98

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

  self.class == other.class &&
    are_annotations_included == other.are_annotations_included &&
    are_unannotated_records_included == other.are_unannotated_records_included &&
    export_details == other.export_details &&
    export_format == other.export_format
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



131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
 
# File 'lib/oci/data_labeling_service/models/snapshot_dataset_details.rb', line 131

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


111
112
113
 
# File 'lib/oci/data_labeling_service/models/snapshot_dataset_details.rb', line 111

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



120
121
122
 
# File 'lib/oci/data_labeling_service/models/snapshot_dataset_details.rb', line 120

def hash
  [are_annotations_included, are_unannotated_records_included, export_details, export_format].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



164
165
166
167
168
169
170
171
172
173
 
# File 'lib/oci/data_labeling_service/models/snapshot_dataset_details.rb', line 164

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



158
159
160
 
# File 'lib/oci/data_labeling_service/models/snapshot_dataset_details.rb', line 158

def to_s
  to_hash.to_s
end