Class: Google::Apis::DfareportingV2_1::File

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

process_value, #to_h

Constructor Details

#initialize(**args) ⇒ File

Returns a new instance of File.



4906
4907
4908
 
# File 'generated/google/apis/dfareporting_v2_1/classes.rb', line 4906

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

Instance Attribute Details

#date_range ⇒ Google::Apis::DfareportingV2_1::DateRange

Represents a date range. Corresponds to the JSON property dateRange

Returns:



4859
4860
4861
 
# File 'generated/google/apis/dfareporting_v2_1/classes.rb', line 4859

def date_range
  @date_range
end

#etag ⇒ String

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

Returns:

  • (String) 


4864
4865
4866
 
# File 'generated/google/apis/dfareporting_v2_1/classes.rb', line 4864

def etag
  @etag
end

#file_name ⇒ String

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

Returns:

  • (String) 


4869
4870
4871
 
# File 'generated/google/apis/dfareporting_v2_1/classes.rb', line 4869

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) 


4874
4875
4876
 
# File 'generated/google/apis/dfareporting_v2_1/classes.rb', line 4874

def format
  @format
end

#id ⇒ String

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

Returns:

  • (String) 


4879
4880
4881
 
# File 'generated/google/apis/dfareporting_v2_1/classes.rb', line 4879

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) 


4884
4885
4886
 
# File 'generated/google/apis/dfareporting_v2_1/classes.rb', line 4884

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) 


4889
4890
4891
 
# File 'generated/google/apis/dfareporting_v2_1/classes.rb', line 4889

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) 


4894
4895
4896
 
# File 'generated/google/apis/dfareporting_v2_1/classes.rb', line 4894

def report_id
  @report_id
end

#status ⇒ String

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

Returns:

  • (String) 


4899
4900
4901
 
# File 'generated/google/apis/dfareporting_v2_1/classes.rb', line 4899

def status
  @status
end

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

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

Returns:



4904
4905
4906
 
# File 'generated/google/apis/dfareporting_v2_1/classes.rb', line 4904

def urls
  @urls
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



4911
4912
4913
4914
4915
4916
4917
4918
4919
4920
4921
4922
 
# File 'generated/google/apis/dfareporting_v2_1/classes.rb', line 4911

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