Package ai.pipestream.connector.intake.v1

Interface StartCrawlSessionRequestOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
StartCrawlSessionRequest, StartCrawlSessionRequest.Builder
@Generated public interface StartCrawlSessionRequestOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getApiKey()
    API key for authentication.
    com.google.protobuf.ByteString
    getApiKeyBytes()
    API key for authentication.
    String
    getConnectorId()
    Connector identifier.
    com.google.protobuf.ByteString
    getConnectorIdBytes()
    Connector identifier.
    String
    getCrawlId()
    Client-provided crawl identifier.
    com.google.protobuf.ByteString
    getCrawlIdBytes()
    Client-provided crawl identifier.
    boolean
    getDeleteOrphans()
    Whether to delete documents not seen in this crawl.
    CrawlMetadata
    getMetadata()
    Crawl metadata and parameters.
    CrawlMetadataOrBuilder
    getMetadataOrBuilder()
    Crawl metadata and parameters.
    boolean
    getTrackDocuments()
    Whether to track all documents in this crawl for orphan detection.
    boolean
    hasMetadata()
    Crawl metadata and parameters.

    Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

    isInitialized

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

    findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

  • Method Details

    • getConnectorId

      String getConnectorId()
       Connector identifier.
      string connector_id = 1 [json_name = "connectorId"];
      Returns:
      The connectorId.

    • getConnectorIdBytes

      com.google.protobuf.ByteString getConnectorIdBytes()
       Connector identifier.
      string connector_id = 1 [json_name = "connectorId"];
      Returns:
      The bytes for connectorId.

    • getApiKey

      String getApiKey()
       API key for authentication.
      string api_key = 2 [json_name = "apiKey"];
      Returns:
      The apiKey.

    • getApiKeyBytes

      com.google.protobuf.ByteString getApiKeyBytes()
       API key for authentication.
      string api_key = 2 [json_name = "apiKey"];
      Returns:
      The bytes for apiKey.

    • getCrawlId

      String getCrawlId()
       Client-provided crawl identifier.
      string crawl_id = 3 [json_name = "crawlId"];
      Returns:
      The crawlId.

    • getCrawlIdBytes

      com.google.protobuf.ByteString getCrawlIdBytes()
       Client-provided crawl identifier.
      string crawl_id = 3 [json_name = "crawlId"];
      Returns:
      The bytes for crawlId.

    • hasMetadata

      boolean hasMetadata()
       Crawl metadata and parameters.
      .ai.pipestream.connector.intake.v1.CrawlMetadata metadata = 4 [json_name = "metadata"];
      Returns:
      Whether the metadata field is set.

    • getMetadata

      CrawlMetadata getMetadata()
       Crawl metadata and parameters.
      .ai.pipestream.connector.intake.v1.CrawlMetadata metadata = 4 [json_name = "metadata"];
      Returns:
      The metadata.

    • getMetadataOrBuilder

      CrawlMetadataOrBuilder getMetadataOrBuilder()
       Crawl metadata and parameters.
      .ai.pipestream.connector.intake.v1.CrawlMetadata metadata = 4 [json_name = "metadata"];

    • getTrackDocuments

      boolean getTrackDocuments()
       Whether to track all documents in this crawl for orphan detection.
      bool track_documents = 5 [json_name = "trackDocuments"];
      Returns:
      The trackDocuments.

    • getDeleteOrphans

      boolean getDeleteOrphans()
       Whether to delete documents not seen in this crawl.
      bool delete_orphans = 6 [json_name = "deleteOrphans"];
      Returns:
      The deleteOrphans.