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

Methods included from Core::JsonObjectSupport

#to_json

Methods included from Core::Hashable

process_value, #to_h

Constructor Details

#initialize(**args) ⇒ WmxSitemap

Returns a new instance of WmxSitemap.


520
521
522
# File 'generated/google/apis/webmasters_v3/classes.rb', line 520

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

Instance Attribute Details

#contentsArray<Google::Apis::WebmastersV3::WmxSitemapContent>

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


472
473
474
# File 'generated/google/apis/webmasters_v3/classes.rb', line 472

def contents
  @contents
end

#errorsString

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:

  • (String)

478
479
480
# File 'generated/google/apis/webmasters_v3/classes.rb', line 478

def errors
  @errors
end

#is_pendingBoolean Also known as: is_pending?

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

Returns:

  • (Boolean)

483
484
485
# File 'generated/google/apis/webmasters_v3/classes.rb', line 483

def is_pending
  @is_pending
end

#is_sitemaps_indexBoolean Also known as: is_sitemaps_index?

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

Returns:

  • (Boolean)

489
490
491
# File 'generated/google/apis/webmasters_v3/classes.rb', line 489

def is_sitemaps_index
  @is_sitemaps_index
end

#last_downloadedDateTime

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)

496
497
498
# File 'generated/google/apis/webmasters_v3/classes.rb', line 496

def last_downloaded
  @last_downloaded
end

#last_submittedDateTime

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)

502
503
504
# File 'generated/google/apis/webmasters_v3/classes.rb', line 502

def 
  @last_submitted
end

#pathString

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

Returns:

  • (String)

507
508
509
# File 'generated/google/apis/webmasters_v3/classes.rb', line 507

def path
  @path
end

#typeString

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

Returns:

  • (String)

512
513
514
# File 'generated/google/apis/webmasters_v3/classes.rb', line 512

def type
  @type
end

#warningsString

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

Returns:

  • (String)

518
519
520
# File 'generated/google/apis/webmasters_v3/classes.rb', line 518

def warnings
  @warnings
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object


525
526
527
528
529
530
531
532
533
534
535
# File 'generated/google/apis/webmasters_v3/classes.rb', line 525

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