Class: Google::Cloud::DiscoveryEngine::V1::RecrawlUrisResponse::FailureInfo

Inherits:

Object

Object
Google::Cloud::DiscoveryEngine::V1::RecrawlUrisResponse::FailureInfo

show all

Extended by:: Protobuf::MessageExts::ClassMethods

Includes:: Protobuf::MessageExts

Defined in:: proto_docs/google/cloud/discoveryengine/v1/site_search_engine_service.rb

Overview

Details about why a particular URI failed to be crawled. Each FailureInfo contains one FailureReason per CorpusType.

Defined Under Namespace

Classes: FailureReason

Instance Attribute Summary collapse

#failure_reasons ⇒ ::Array<::Google::Cloud::DiscoveryEngine::V1::RecrawlUrisResponse::FailureInfo::FailureReason>
List of failure reasons by corpus type (e.g. desktop, mobile).
#uri ⇒ ::String
URI that failed to be crawled.

Instance Attribute Details

#failure_reasons ⇒ `::Array<::Google::Cloud::DiscoveryEngine::V1::RecrawlUrisResponse::FailureInfo::FailureReason>`

Returns List of failure reasons by corpus type (e.g. desktop, mobile).

Returns:

(::Array<::Google::Cloud::DiscoveryEngine::V1::RecrawlUrisResponse::FailureInfo::FailureReason>) —
List of failure reasons by corpus type (e.g. desktop, mobile).

# File 'proto_docs/google/cloud/discoveryengine/v1/site_search_engine_service.rb', line 375

class FailureInfo
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Details about why crawling failed for a particular CorpusType, e.g.,
  # DESKTOP and MOBILE crawling may fail for different reasons.
  # @!attribute [rw] corpus_type
  #   @return [::Google::Cloud::DiscoveryEngine::V1::RecrawlUrisResponse::FailureInfo::FailureReason::CorpusType]
  #     DESKTOP, MOBILE, or CORPUS_TYPE_UNSPECIFIED.
  # @!attribute [rw] error_message
  #   @return [::String]
  #     Reason why the URI was not crawled.
  class FailureReason
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # CorpusType for the failed crawling operation.
    module CorpusType
      # Default value.
      CORPUS_TYPE_UNSPECIFIED = 0

      # Denotes a crawling attempt for the desktop version of a page.
      DESKTOP = 1

      # Denotes a crawling attempt for the mobile version of a page.
      MOBILE = 2
    end
  end
end

#uri ⇒ `::String`

Returns URI that failed to be crawled.