Class: Google::Apis::SearchconsoleV1::WmxSitemap

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



550
551
552
 
# File 'generated/google/apis/searchconsole_v1/classes.rb', line 550

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

Instance Attribute Details

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

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

Returns:



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

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) 


508
509
510
 
# File 'generated/google/apis/searchconsole_v1/classes.rb', line 508

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) 


513
514
515
 
# File 'generated/google/apis/searchconsole_v1/classes.rb', line 513

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) 


519
520
521
 
# File 'generated/google/apis/searchconsole_v1/classes.rb', line 519

def is_sitemaps_index
  @is_sitemaps_index
end

#last_downloaded ⇒ String

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:

  • (String) 


526
527
528
 
# File 'generated/google/apis/searchconsole_v1/classes.rb', line 526

def last_downloaded
  @last_downloaded
end

#last_submitted ⇒ String

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:

  • (String) 


532
533
534
 
# File 'generated/google/apis/searchconsole_v1/classes.rb', line 532

def last_submitted
  @last_submitted
end

#path ⇒ String

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

Returns:

  • (String) 


537
538
539
 
# File 'generated/google/apis/searchconsole_v1/classes.rb', line 537

def path
  @path
end

#type ⇒ String

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

Returns:

  • (String) 


542
543
544
 
# File 'generated/google/apis/searchconsole_v1/classes.rb', line 542

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) 


548
549
550
 
# File 'generated/google/apis/searchconsole_v1/classes.rb', line 548

def warnings
  @warnings
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



555
556
557
558
559
560
561
562
563
564
565
 
# File 'generated/google/apis/searchconsole_v1/classes.rb', line 555

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