Class: Google::Apis::SearchconsoleV1::Metadata

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

Overview

An object that may be returned with your query results, providing context about the state of the data. When you request recent data (using all or hourly_all for dataState), some of the rows returned may represent data that is incomplete, which means that the data is still being collected and processed. This metadata object helps you identify exactly when this starts and ends. All dates and times provided in this object are in the America/ Los_Angeles time zone. The specific field returned within this object depends on how you've grouped your data in the request. See details in inner fields.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ Metadata

Returns a new instance of Metadata.



496
497
498
 
# File 'lib/google/apis/searchconsole_v1/classes.rb', line 496

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

Instance Attribute Details

#first_incomplete_date ⇒ String

The first date for which the data is still being collected and processed, presented in YYYY-MM-DD format (ISO-8601 extended local date format). This field is populated only when the request's dataState is "all", data is grouped by "DATE", and the requested date range contains incomplete data points. All values after the first_incomplete_date may still change noticeably. Corresponds to the JSON property firstIncompleteDate

Returns:

  • (String) 


484
485
486
 
# File 'lib/google/apis/searchconsole_v1/classes.rb', line 484

def first_incomplete_date
  @first_incomplete_date
end

#first_incomplete_hour ⇒ String

The first hour for which the data is still being collected and processed, presented in YYYY-MM-DDThh:mm:ss[+|-]hh:mm format (ISO-8601 extended offset date-time format). This field is populated only when the request's dataState is "hourly_all", data is grouped by "HOUR" and the requested date range contains incomplete data points. All values after the first_incomplete_hour may still change noticeably. Corresponds to the JSON property firstIncompleteHour

Returns:

  • (String) 


494
495
496
 
# File 'lib/google/apis/searchconsole_v1/classes.rb', line 494

def first_incomplete_hour
  @first_incomplete_hour
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



501
502
503
504
 
# File 'lib/google/apis/searchconsole_v1/classes.rb', line 501

def update!(**args)
  @first_incomplete_date = args[:first_incomplete_date] if args.key?(:first_incomplete_date)
  @first_incomplete_hour = args[:first_incomplete_hour] if args.key?(:first_incomplete_hour)
end