Class: OCI::UsageApi::Models::CreateScheduleDetails

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/usage_api/models/create_schedule_details.rb

Overview

The saved schedule.

Constant Summary collapse

OUTPUT_FILE_FORMAT_ENUM = 
[
  OUTPUT_FILE_FORMAT_CSV = 'CSV'.freeze,
  OUTPUT_FILE_FORMAT_PDF = 'PDF'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ CreateScheduleDetails

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



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
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
 
# File 'lib/oci/usage_api/models/create_schedule_details.rb', line 120

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

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

  self.output_file_format = attributes[:'outputFileFormat'] if attributes[:'outputFileFormat']
  self.output_file_format = "CSV" if output_file_format.nil? && !attributes.key?(:'outputFileFormat') # rubocop:disable Style/StringLiterals

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

  self.output_file_format = attributes[:'output_file_format'] if attributes[:'output_file_format']
  self.output_file_format = "CSV" if output_file_format.nil? && !attributes.key?(:'outputFileFormat') && !attributes.key?(:'output_file_format') # rubocop:disable Style/StringLiterals

  self.saved_report_id = attributes[:'savedReportId'] if attributes[:'savedReportId']

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

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

  self.result_location = attributes[:'resultLocation'] if attributes[:'resultLocation']

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

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

  self.schedule_recurrences = attributes[:'scheduleRecurrences'] if attributes[:'scheduleRecurrences']

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

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

  self.time_scheduled = attributes[:'timeScheduled'] if attributes[:'timeScheduled']

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

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

  self.query_properties = attributes[:'queryProperties'] if attributes[:'queryProperties']

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

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

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

Returns:

  • (String) 


22
23
24
 
# File 'lib/oci/usage_api/models/create_schedule_details.rb', line 22

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

Returns:

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


63
64
65
 
# File 'lib/oci/usage_api/models/create_schedule_details.rb', line 63

def defined_tags
  @defined_tags
end

#description ⇒ String

The description of the schedule.

Returns:

  • (String) 


26
27
28
 
# File 'lib/oci/usage_api/models/create_schedule_details.rb', line 26

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

Returns:

  • (Hash<String, String>) 


58
59
60
 
# File 'lib/oci/usage_api/models/create_schedule_details.rb', line 58

def freeform_tags
  @freeform_tags
end

#name ⇒ String

[Required] The unique name of the user-created schedule.

Returns:

  • (String) 


18
19
20
 
# File 'lib/oci/usage_api/models/create_schedule_details.rb', line 18

def name
  @name
end

#output_file_format ⇒ String

Specifies supported output file format.

Returns:

  • (String) 


30
31
32
 
# File 'lib/oci/usage_api/models/create_schedule_details.rb', line 30

def output_file_format
  @output_file_format
end

#query_properties ⇒ OCI::UsageApi::Models::QueryProperties

Returns:



52
53
54
 
# File 'lib/oci/usage_api/models/create_schedule_details.rb', line 52

def query_properties
  @query_properties
end

#result_location ⇒ OCI::UsageApi::Models::ResultLocation

This attribute is required.

Returns:



38
39
40
 
# File 'lib/oci/usage_api/models/create_schedule_details.rb', line 38

def result_location
  @result_location
end

#saved_report_id ⇒ String

The saved report id which can also be used to generate query.

Returns:

  • (String) 


34
35
36
 
# File 'lib/oci/usage_api/models/create_schedule_details.rb', line 34

def saved_report_id
  @saved_report_id
end

#schedule_recurrences ⇒ String

[Required] Specifies the frequency according to when the schedule will be run, in the x-obmcs-recurring-time format described in RFC 5545 section 3.3.10. Supported values are : ONE_TIME, DAILY, WEEKLY and MONTHLY.

Returns:

  • (String) 


45
46
47
 
# File 'lib/oci/usage_api/models/create_schedule_details.rb', line 45

def schedule_recurrences
  @schedule_recurrences
end

#time_scheduled ⇒ DateTime

[Required] The date and time of the first time job execution.

Returns:

  • (DateTime) 


49
50
51
 
# File 'lib/oci/usage_api/models/create_schedule_details.rb', line 49

def time_scheduled
  @time_scheduled
end

Class Method Details

.attribute_map ⇒ Object

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



66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
 
# File 'lib/oci/usage_api/models/create_schedule_details.rb', line 66

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'name': :'name',
    'compartment_id': :'compartmentId',
    'description': :'description',
    'output_file_format': :'outputFileFormat',
    'saved_report_id': :'savedReportId',
    'result_location': :'resultLocation',
    'schedule_recurrences': :'scheduleRecurrences',
    'time_scheduled': :'timeScheduled',
    'query_properties': :'queryProperties',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
 
# File 'lib/oci/usage_api/models/create_schedule_details.rb', line 85

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'name': :'String',
    'compartment_id': :'String',
    'description': :'String',
    'output_file_format': :'String',
    'saved_report_id': :'String',
    'result_location': :'OCI::UsageApi::Models::ResultLocation',
    'schedule_recurrences': :'String',
    'time_scheduled': :'DateTime',
    'query_properties': :'OCI::UsageApi::Models::QueryProperties',
    '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



202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
 
# File 'lib/oci/usage_api/models/create_schedule_details.rb', line 202

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

  self.class == other.class &&
    name == other.name &&
    compartment_id == other.compartment_id &&
    description == other.description &&
    output_file_format == other.output_file_format &&
    saved_report_id == other.saved_report_id &&
    result_location == other.result_location &&
    schedule_recurrences == other.schedule_recurrences &&
    time_scheduled == other.time_scheduled &&
    query_properties == other.query_properties &&
    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



242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
 
# File 'lib/oci/usage_api/models/create_schedule_details.rb', line 242

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


222
223
224
 
# File 'lib/oci/usage_api/models/create_schedule_details.rb', line 222

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



231
232
233
 
# File 'lib/oci/usage_api/models/create_schedule_details.rb', line 231

def hash
  [name, compartment_id, description, output_file_format, saved_report_id, result_location, schedule_recurrences, time_scheduled, query_properties, 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



275
276
277
278
279
280
281
282
283
284
 
# File 'lib/oci/usage_api/models/create_schedule_details.rb', line 275

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



269
270
271
 
# File 'lib/oci/usage_api/models/create_schedule_details.rb', line 269

def to_s
  to_hash.to_s
end