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

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/cloud/discoveryengine/v1/site_search_engine_service.rb

Overview

Response message for SiteSearchEngineService.RecrawlUris method.

Defined Under Namespace

Classes: FailureInfo

Instance Attribute Summary collapse

Instance Attribute Details

#failed_uris ⇒ ::Array<::String>

Returns URIs that were not crawled before the LRO terminated.

Returns:

  • (::Array<::String>) —

    URIs that were not crawled before the LRO terminated.



368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
 
# File 'proto_docs/google/cloud/discoveryengine/v1/site_search_engine_service.rb', line 368

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

  # Details about why a particular URI failed to be crawled. Each FailureInfo
  # contains one FailureReason per CorpusType.
  # @!attribute [rw] uri
  #   @return [::String]
  #     URI that failed to be crawled.
  # @!attribute [rw] failure_reasons
  #   @return [::Array<::Google::Cloud::DiscoveryEngine::V1::RecrawlUrisResponse::FailureInfo::FailureReason>]
  #     List of failure reasons by corpus type (e.g. desktop, mobile).
  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
end

#failure_samples ⇒ ::Array<::Google::Cloud::DiscoveryEngine::V1::RecrawlUrisResponse::FailureInfo>

Returns Details for a sample of up to 10 failed_uris.

Returns:



368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
 
# File 'proto_docs/google/cloud/discoveryengine/v1/site_search_engine_service.rb', line 368

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

  # Details about why a particular URI failed to be crawled. Each FailureInfo
  # contains one FailureReason per CorpusType.
  # @!attribute [rw] uri
  #   @return [::String]
  #     URI that failed to be crawled.
  # @!attribute [rw] failure_reasons
  #   @return [::Array<::Google::Cloud::DiscoveryEngine::V1::RecrawlUrisResponse::FailureInfo::FailureReason>]
  #     List of failure reasons by corpus type (e.g. desktop, mobile).
  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
end