Class: Google::Apis::DfareportingV2_5::File

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
generated/google/apis/dfareporting_v2_5/classes.rb,
generated/google/apis/dfareporting_v2_5/representations.rb,
generated/google/apis/dfareporting_v2_5/representations.rb

Overview

Represents a File resource. A file contains the metadata for a report run. It shows the status of the run and holds the URLs to the generated report data if the run is finished and the status is "REPORT_AVAILABLE".

Defined Under Namespace

Classes: Urls

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Core::JsonObjectSupport

#to_json

Methods included from Core::Hashable

process_value, #to_h

Constructor Details

#initialize(**args) ⇒ File

Returns a new instance of File



5355
5356
5357
 
# File 'generated/google/apis/dfareporting_v2_5/classes.rb', line 5355

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#date_range ⇒ Google::Apis::DfareportingV2_5::DateRange

Represents a date range. Corresponds to the JSON property dateRange

Returns:



5308
5309
5310
 
# File 'generated/google/apis/dfareporting_v2_5/classes.rb', line 5308

def date_range
  @date_range
end

#etag ⇒ String

The eTag of this response for caching purposes. Corresponds to the JSON property etag

Returns:

  • (String) 


5313
5314
5315
 
# File 'generated/google/apis/dfareporting_v2_5/classes.rb', line 5313

def etag
  @etag
end

#file_name ⇒ String

The filename of the file. Corresponds to the JSON property fileName

Returns:

  • (String) 


5318
5319
5320
 
# File 'generated/google/apis/dfareporting_v2_5/classes.rb', line 5318

def file_name
  @file_name
end

#format ⇒ String

The output format of the report. Only available once the file is available. Corresponds to the JSON property format

Returns:

  • (String) 


5323
5324
5325
 
# File 'generated/google/apis/dfareporting_v2_5/classes.rb', line 5323

def format
  @format
end

#id ⇒ String

The unique ID of this report file. Corresponds to the JSON property id

Returns:

  • (String) 


5328
5329
5330
 
# File 'generated/google/apis/dfareporting_v2_5/classes.rb', line 5328

def id
  @id
end

#kind ⇒ String

The kind of resource this is, in this case dfareporting#file. Corresponds to the JSON property kind

Returns:

  • (String) 


5333
5334
5335
 
# File 'generated/google/apis/dfareporting_v2_5/classes.rb', line 5333

def kind
  @kind
end

#last_modified_time ⇒ String

The timestamp in milliseconds since epoch when this file was last modified. Corresponds to the JSON property lastModifiedTime

Returns:

  • (String) 


5338
5339
5340
 
# File 'generated/google/apis/dfareporting_v2_5/classes.rb', line 5338

def last_modified_time
  @last_modified_time
end

#report_id ⇒ String

The ID of the report this file was generated from. Corresponds to the JSON property reportId

Returns:

  • (String) 


5343
5344
5345
 
# File 'generated/google/apis/dfareporting_v2_5/classes.rb', line 5343

def report_id
  @report_id
end

#status ⇒ String

The status of the report file. Corresponds to the JSON property status

Returns:

  • (String) 


5348
5349
5350
 
# File 'generated/google/apis/dfareporting_v2_5/classes.rb', line 5348

def status
  @status
end

#urls ⇒ Google::Apis::DfareportingV2_5::File::Urls

The URLs where the completed report file can be downloaded. Corresponds to the JSON property urls

Returns:



5353
5354
5355
 
# File 'generated/google/apis/dfareporting_v2_5/classes.rb', line 5353

def urls
  @urls
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



5360
5361
5362
5363
5364
5365
5366
5367
5368
5369
5370
5371
 
# File 'generated/google/apis/dfareporting_v2_5/classes.rb', line 5360

def update!(**args)
  @date_range = args[:date_range] if args.key?(:date_range)
  @etag = args[:etag] if args.key?(:etag)
  @file_name = args[:file_name] if args.key?(:file_name)
  @format = args[:format] if args.key?(:format)
  @id = args[:id] if args.key?(:id)
  @kind = args[:kind] if args.key?(:kind)
  @last_modified_time = args[:last_modified_time] if args.key?(:last_modified_time)
  @report_id = args[:report_id] if args.key?(:report_id)
  @status = args[:status] if args.key?(:status)
  @urls = args[:urls] if args.key?(:urls)
end