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.



1001
1002
1003
# File 'lib/google/apis/searchconsole_v1/classes.rb', line 1001

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



953
954
955
# File 'lib/google/apis/searchconsole_v1/classes.rb', line 953

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)


959
960
961
# File 'lib/google/apis/searchconsole_v1/classes.rb', line 959

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)


964
965
966
# File 'lib/google/apis/searchconsole_v1/classes.rb', line 964

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)


970
971
972
# File 'lib/google/apis/searchconsole_v1/classes.rb', line 970

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)


977
978
979
# File 'lib/google/apis/searchconsole_v1/classes.rb', line 977

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)


983
984
985
# File 'lib/google/apis/searchconsole_v1/classes.rb', line 983

def 
  @last_submitted
end

#pathString

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

Returns:

  • (String)


988
989
990
# File 'lib/google/apis/searchconsole_v1/classes.rb', line 988

def path
  @path
end

#typeString

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

Returns:

  • (String)


993
994
995
# File 'lib/google/apis/searchconsole_v1/classes.rb', line 993

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)


999
1000
1001
# File 'lib/google/apis/searchconsole_v1/classes.rb', line 999

def warnings
  @warnings
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
# File 'lib/google/apis/searchconsole_v1/classes.rb', line 1006

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