Class: Google::Apis::DfareportingV3_1::File

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
generated/google/apis/dfareporting_v3_1/classes.rb,
generated/google/apis/dfareporting_v3_1/representations.rb,
generated/google/apis/dfareporting_v3_1/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



5795
5796
5797
 
# File 'generated/google/apis/dfareporting_v3_1/classes.rb', line 5795

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

Instance Attribute Details

#date_range ⇒ Google::Apis::DfareportingV3_1::DateRange

Represents a date range. Corresponds to the JSON property dateRange

Returns:



5748
5749
5750
 
# File 'generated/google/apis/dfareporting_v3_1/classes.rb', line 5748

def date_range
  @date_range
end

#etag ⇒ String

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

Returns:

  • (String) 


5753
5754
5755
 
# File 'generated/google/apis/dfareporting_v3_1/classes.rb', line 5753

def etag
  @etag
end

#file_name ⇒ String

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

Returns:

  • (String) 


5758
5759
5760
 
# File 'generated/google/apis/dfareporting_v3_1/classes.rb', line 5758

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) 


5763
5764
5765
 
# File 'generated/google/apis/dfareporting_v3_1/classes.rb', line 5763

def format
  @format
end

#id ⇒ Fixnum

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

Returns:

  • (Fixnum) 


5768
5769
5770
 
# File 'generated/google/apis/dfareporting_v3_1/classes.rb', line 5768

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) 


5773
5774
5775
 
# File 'generated/google/apis/dfareporting_v3_1/classes.rb', line 5773

def kind
  @kind
end

#last_modified_time ⇒ Fixnum

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

Returns:

  • (Fixnum) 


5778
5779
5780
 
# File 'generated/google/apis/dfareporting_v3_1/classes.rb', line 5778

def last_modified_time
  @last_modified_time
end

#report_id ⇒ Fixnum

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

Returns:

  • (Fixnum) 


5783
5784
5785
 
# File 'generated/google/apis/dfareporting_v3_1/classes.rb', line 5783

def report_id
  @report_id
end

#status ⇒ String

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

Returns:

  • (String) 


5788
5789
5790
 
# File 'generated/google/apis/dfareporting_v3_1/classes.rb', line 5788

def status
  @status
end

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

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

Returns:



5793
5794
5795
 
# File 'generated/google/apis/dfareporting_v3_1/classes.rb', line 5793

def urls
  @urls
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



5800
5801
5802
5803
5804
5805
5806
5807
5808
5809
5810
5811
 
# File 'generated/google/apis/dfareporting_v3_1/classes.rb', line 5800

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