Package ai.pipestream.connector.intake.v1

Class StartCrawlSessionRequest

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
ai.pipestream.connector.intake.v1.StartCrawlSessionRequest
All Implemented Interfaces:
StartCrawlSessionRequestOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
@Generated public final class StartCrawlSessionRequest extends com.google.protobuf.GeneratedMessage implements StartCrawlSessionRequestOrBuilder
 Request to start a new crawl session.
Protobuf type ai.pipestream.connector.intake.v1.StartCrawlSessionRequest
See Also:

  • Field Details

    • CONNECTOR_ID_FIELD_NUMBER

      public static final int CONNECTOR_ID_FIELD_NUMBER
      See Also:

    • API_KEY_FIELD_NUMBER

      public static final int API_KEY_FIELD_NUMBER
      See Also:

    • CRAWL_ID_FIELD_NUMBER

      public static final int CRAWL_ID_FIELD_NUMBER
      See Also:

    • METADATA_FIELD_NUMBER

      public static final int METADATA_FIELD_NUMBER
      See Also:

    • TRACK_DOCUMENTS_FIELD_NUMBER

      public static final int TRACK_DOCUMENTS_FIELD_NUMBER
      See Also:

    • DELETE_ORPHANS_FIELD_NUMBER

      public static final int DELETE_ORPHANS_FIELD_NUMBER
      See Also:

  • Method Details

    • getDescriptor

      public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage

    • getConnectorId

      public String getConnectorId()
       Connector identifier.
      string connector_id = 1 [json_name = "connectorId"];
      Specified by:
      getConnectorId in interface StartCrawlSessionRequestOrBuilder
      Returns:
      The connectorId.

    • getConnectorIdBytes

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

    • getApiKey

      public String getApiKey()
       API key for authentication.
      string api_key = 2 [json_name = "apiKey"];
      Specified by:
      getApiKey in interface StartCrawlSessionRequestOrBuilder
      Returns:
      The apiKey.

    • getApiKeyBytes

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

    • getCrawlId

      public String getCrawlId()
       Client-provided crawl identifier.
      string crawl_id = 3 [json_name = "crawlId"];
      Specified by:
      getCrawlId in interface StartCrawlSessionRequestOrBuilder
      Returns:
      The crawlId.

    • getCrawlIdBytes

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

    • hasMetadata

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

    • getMetadata

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

    • getMetadataOrBuilder

      public CrawlMetadataOrBuilder getMetadataOrBuilder()
       Crawl metadata and parameters.
      .ai.pipestream.connector.intake.v1.CrawlMetadata metadata = 4 [json_name = "metadata"];
      Specified by:
      getMetadataOrBuilder in interface StartCrawlSessionRequestOrBuilder

    • getTrackDocuments

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

    • getDeleteOrphans

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

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessage

    • writeTo

      public void writeTo(com.google.protobuf.CodedOutputStream output) throws IOException
      Specified by:
      writeTo in interface com.google.protobuf.MessageLite
      Overrides:
      writeTo in class com.google.protobuf.GeneratedMessage
      Throws:
      IOException

    • getSerializedSize

      public int getSerializedSize()
      Specified by:
      getSerializedSize in interface com.google.protobuf.MessageLite
      Overrides:
      getSerializedSize in class com.google.protobuf.GeneratedMessage

    • equals

      public boolean equals(Object obj)
      Specified by:
      equals in interface com.google.protobuf.Message
      Overrides:
      equals in class com.google.protobuf.AbstractMessage

    • hashCode

      public int hashCode()
      Specified by:
      hashCode in interface com.google.protobuf.Message
      Overrides:
      hashCode in class com.google.protobuf.AbstractMessage

    • parseFrom

      public static StartCrawlSessionRequest parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static StartCrawlSessionRequest parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static StartCrawlSessionRequest parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static StartCrawlSessionRequest parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static StartCrawlSessionRequest parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static StartCrawlSessionRequest parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static StartCrawlSessionRequest parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static StartCrawlSessionRequest parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static StartCrawlSessionRequest parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static StartCrawlSessionRequest parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseFrom

      public static StartCrawlSessionRequest parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static StartCrawlSessionRequest parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • newBuilderForType

      public StartCrawlSessionRequest.Builder newBuilderForType()
      Specified by:
      newBuilderForType in interface com.google.protobuf.Message
      Specified by:
      newBuilderForType in interface com.google.protobuf.MessageLite

    • newBuilder

      public static StartCrawlSessionRequest.Builder newBuilder()

    • newBuilder

      public static StartCrawlSessionRequest.Builder newBuilder(StartCrawlSessionRequest prototype)

    • toBuilder

      public StartCrawlSessionRequest.Builder toBuilder()
      Specified by:
      toBuilder in interface com.google.protobuf.Message
      Specified by:
      toBuilder in interface com.google.protobuf.MessageLite

    • newBuilderForType

      protected StartCrawlSessionRequest.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
      Overrides:
      newBuilderForType in class com.google.protobuf.AbstractMessage

    • getDefaultInstance

      public static StartCrawlSessionRequest getDefaultInstance()

    • parser

      public static com.google.protobuf.Parser<StartCrawlSessionRequest> parser()

    • getParserForType

      public com.google.protobuf.Parser<StartCrawlSessionRequest> getParserForType()
      Specified by:
      getParserForType in interface com.google.protobuf.Message
      Specified by:
      getParserForType in interface com.google.protobuf.MessageLite
      Overrides:
      getParserForType in class com.google.protobuf.GeneratedMessage

    • getDefaultInstanceForType

      public StartCrawlSessionRequest getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder