Class: Google::Apis::WebmastersV3::WmxSitemap

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

Overview

Contains detailed information about a specific URL submitted as a sitemap.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ WmxSitemap

Returns a new instance of WmxSitemap.



362
363
364
 
# File 'generated/google/apis/webmasters_v3/classes.rb', line 362

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

Instance Attribute Details

#contents ⇒ Array<Google::Apis::WebmastersV3::WmxSitemapContent>

The various content types in the sitemap. Corresponds to the JSON property contents

Returns:



314
315
316
 
# File 'generated/google/apis/webmasters_v3/classes.rb', line 314

def contents
  @contents
end

#errors ⇒ Fixnum

Number of errors in the sitemap. These are issues with the sitemap itself that need to be fixed before it can be processed correctly. Corresponds to the JSON property errors

Returns:

  • (Fixnum) 


320
321
322
 
# File 'generated/google/apis/webmasters_v3/classes.rb', line 320

def errors
  @errors
end

#is_pending ⇒ Boolean Also known as: is_pending?

If true, the sitemap has not been processed. Corresponds to the JSON property isPending

Returns:

  • (Boolean) 


325
326
327
 
# File 'generated/google/apis/webmasters_v3/classes.rb', line 325

def is_pending
  @is_pending
end

#is_sitemaps_index ⇒ Boolean Also known as: is_sitemaps_index?

If true, the sitemap is a collection of sitemaps. Corresponds to the JSON property isSitemapsIndex

Returns:

  • (Boolean) 


331
332
333
 
# File 'generated/google/apis/webmasters_v3/classes.rb', line 331

def is_sitemaps_index
  @is_sitemaps_index
end

#last_downloaded ⇒ DateTime

Date & time in which this sitemap was last downloaded. Date format is in RFC 3339 format (yyyy-mm-dd). Corresponds to the JSON property lastDownloaded

Returns:

  • (DateTime) 


338
339
340
 
# File 'generated/google/apis/webmasters_v3/classes.rb', line 338

def last_downloaded
  @last_downloaded
end

#last_submitted ⇒ DateTime

Date & time in which this sitemap was submitted. Date format is in RFC 3339 format (yyyy-mm-dd). Corresponds to the JSON property lastSubmitted

Returns:

  • (DateTime) 


344
345
346
 
# File 'generated/google/apis/webmasters_v3/classes.rb', line 344

def last_submitted
  @last_submitted
end

#path ⇒ String

The url of the sitemap. Corresponds to the JSON property path

Returns:

  • (String) 


349
350
351
 
# File 'generated/google/apis/webmasters_v3/classes.rb', line 349

def path
  @path
end

#type ⇒ String

The type of the sitemap. For example: rssFeed. Corresponds to the JSON property type

Returns:

  • (String) 


354
355
356
 
# File 'generated/google/apis/webmasters_v3/classes.rb', line 354

def type
  @type
end

#warnings ⇒ Fixnum

Number of warnings for the sitemap. These are generally non-critical issues with URLs in the sitemaps. Corresponds to the JSON property warnings

Returns:

  • (Fixnum) 


360
361
362
 
# File 'generated/google/apis/webmasters_v3/classes.rb', line 360

def warnings
  @warnings
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



367
368
369
370
371
372
373
374
375
376
377
 
# File 'generated/google/apis/webmasters_v3/classes.rb', line 367

def update!(**args)
  @contents = args[:contents] if args.key?(:contents)
  @errors = args[:errors] if args.key?(:errors)
  @is_pending = args[:is_pending] if args.key?(:is_pending)
  @is_sitemaps_index = args[:is_sitemaps_index] if args.key?(:is_sitemaps_index)
  @last_downloaded = args[:last_downloaded] if args.key?(:last_downloaded)
  @last_submitted = args[:last_submitted] if args.key?(:last_submitted)
  @path = args[:path] if args.key?(:path)
  @type = args[:type] if args.key?(:type)
  @warnings = args[:warnings] if args.key?(:warnings)
end