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

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

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.



1056
1057
1058
# File 'lib/google/apis/searchconsole_v1/classes.rb', line 1056

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

Instance Attribute Details

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

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



1008
1009
1010
# File 'lib/google/apis/searchconsole_v1/classes.rb', line 1008

def contents
  @contents
end

#errorsFixnum

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)


1014
1015
1016
# File 'lib/google/apis/searchconsole_v1/classes.rb', line 1014

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)


1019
1020
1021
# File 'lib/google/apis/searchconsole_v1/classes.rb', line 1019

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)


1025
1026
1027
# File 'lib/google/apis/searchconsole_v1/classes.rb', line 1025

def is_sitemaps_index
  @is_sitemaps_index
end

#last_downloadedString

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)


1032
1033
1034
# File 'lib/google/apis/searchconsole_v1/classes.rb', line 1032

def last_downloaded
  @last_downloaded
end

#last_submittedString

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)


1038
1039
1040
# File 'lib/google/apis/searchconsole_v1/classes.rb', line 1038

def 
  @last_submitted
end

#pathString

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

Returns:

  • (String)


1043
1044
1045
# File 'lib/google/apis/searchconsole_v1/classes.rb', line 1043

def path
  @path
end

#typeString

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

Returns:

  • (String)


1048
1049
1050
# File 'lib/google/apis/searchconsole_v1/classes.rb', line 1048

def type
  @type
end

#warningsFixnum

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)


1054
1055
1056
# File 'lib/google/apis/searchconsole_v1/classes.rb', line 1054

def warnings
  @warnings
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
# File 'lib/google/apis/searchconsole_v1/classes.rb', line 1061

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