Class: Google::Apis::DfareportingV4::File
- Inherits:
-
Object
- Object
- Google::Apis::DfareportingV4::File
- Includes:
- Core::Hashable, Core::JsonObjectSupport
- Defined in:
- lib/google/apis/dfareporting_v4/classes.rb,
lib/google/apis/dfareporting_v4/representations.rb,
lib/google/apis/dfareporting_v4/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
-
#date_range ⇒ Google::Apis::DfareportingV4::DateRange
Represents a date range.
-
#etag ⇒ String
Etag of this resource.
-
#file_name ⇒ String
The filename of the file.
-
#format ⇒ String
The output format of the report.
-
#id ⇒ Fixnum
The unique ID of this report file.
-
#kind ⇒ String
Identifies what kind of resource this is.
-
#last_modified_time ⇒ Fixnum
The timestamp in milliseconds since epoch when this file was last modified.
-
#report_id ⇒ Fixnum
The ID of the report this file was generated from.
-
#status ⇒ String
The status of the report file.
-
#urls ⇒ Google::Apis::DfareportingV4::File::Urls
The URLs where the completed report file can be downloaded.
Instance Method Summary collapse
-
#initialize(**args) ⇒ File
constructor
A new instance of File.
-
#update!(**args) ⇒ Object
Update properties of this object.
Constructor Details
#initialize(**args) ⇒ File
Returns a new instance of File.
5997 5998 5999 |
# File 'lib/google/apis/dfareporting_v4/classes.rb', line 5997 def initialize(**args) update!(**args) end |
Instance Attribute Details
#date_range ⇒ Google::Apis::DfareportingV4::DateRange
Represents a date range.
Corresponds to the JSON property dateRange
5949 5950 5951 |
# File 'lib/google/apis/dfareporting_v4/classes.rb', line 5949 def date_range @date_range end |
#etag ⇒ String
Etag of this resource.
Corresponds to the JSON property etag
5954 5955 5956 |
# File 'lib/google/apis/dfareporting_v4/classes.rb', line 5954 def etag @etag end |
#file_name ⇒ String
The filename of the file.
Corresponds to the JSON property fileName
5959 5960 5961 |
# File 'lib/google/apis/dfareporting_v4/classes.rb', line 5959 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
5964 5965 5966 |
# File 'lib/google/apis/dfareporting_v4/classes.rb', line 5964 def format @format end |
#id ⇒ Fixnum
The unique ID of this report file.
Corresponds to the JSON property id
5969 5970 5971 |
# File 'lib/google/apis/dfareporting_v4/classes.rb', line 5969 def id @id end |
#kind ⇒ String
Identifies what kind of resource this is. Value: the fixed string "
dfareporting#file".
Corresponds to the JSON property kind
5975 5976 5977 |
# File 'lib/google/apis/dfareporting_v4/classes.rb', line 5975 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
5980 5981 5982 |
# File 'lib/google/apis/dfareporting_v4/classes.rb', line 5980 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
5985 5986 5987 |
# File 'lib/google/apis/dfareporting_v4/classes.rb', line 5985 def report_id @report_id end |
#status ⇒ String
The status of the report file.
Corresponds to the JSON property status
5990 5991 5992 |
# File 'lib/google/apis/dfareporting_v4/classes.rb', line 5990 def status @status end |
#urls ⇒ Google::Apis::DfareportingV4::File::Urls
The URLs where the completed report file can be downloaded.
Corresponds to the JSON property urls
5995 5996 5997 |
# File 'lib/google/apis/dfareporting_v4/classes.rb', line 5995 def urls @urls end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
6002 6003 6004 6005 6006 6007 6008 6009 6010 6011 6012 6013 |
# File 'lib/google/apis/dfareporting_v4/classes.rb', line 6002 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 |