Class StartCrawlSessionRequest.Builder

java.lang.Object
com.google.protobuf.AbstractMessageLite.Builder
com.google.protobuf.AbstractMessage.Builder<StartCrawlSessionRequest.Builder>
com.google.protobuf.GeneratedMessage.Builder<StartCrawlSessionRequest.Builder>
ai.pipestream.connector.intake.v1.StartCrawlSessionRequest.Builder
All Implemented Interfaces:
StartCrawlSessionRequestOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable
Enclosing class:
StartCrawlSessionRequest

public static final class StartCrawlSessionRequest.Builder extends com.google.protobuf.GeneratedMessage.Builder<StartCrawlSessionRequest.Builder> implements StartCrawlSessionRequestOrBuilder
 Request to start a new crawl session.
 
Protobuf type ai.pipestream.connector.intake.v1.StartCrawlSessionRequest
  • 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.Builder<StartCrawlSessionRequest.Builder>
    • clear

      Specified by:
      clear in interface com.google.protobuf.Message.Builder
      Specified by:
      clear in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      clear in class com.google.protobuf.GeneratedMessage.Builder<StartCrawlSessionRequest.Builder>
    • getDescriptorForType

      public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
      Specified by:
      getDescriptorForType in interface com.google.protobuf.Message.Builder
      Specified by:
      getDescriptorForType in interface com.google.protobuf.MessageOrBuilder
      Overrides:
      getDescriptorForType in class com.google.protobuf.GeneratedMessage.Builder<StartCrawlSessionRequest.Builder>
    • getDefaultInstanceForType

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

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

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

      public StartCrawlSessionRequest.Builder mergeFrom(com.google.protobuf.Message other)
      Specified by:
      mergeFrom in interface com.google.protobuf.Message.Builder
      Overrides:
      mergeFrom in class com.google.protobuf.AbstractMessage.Builder<StartCrawlSessionRequest.Builder>
    • mergeFrom

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessage.Builder<StartCrawlSessionRequest.Builder>
    • mergeFrom

      public StartCrawlSessionRequest.Builder mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Specified by:
      mergeFrom in interface com.google.protobuf.Message.Builder
      Specified by:
      mergeFrom in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      mergeFrom in class com.google.protobuf.AbstractMessage.Builder<StartCrawlSessionRequest.Builder>
      Throws:
      IOException
    • 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.
    • setConnectorId

      public StartCrawlSessionRequest.Builder setConnectorId(String value)
       Connector identifier.
       
      string connector_id = 1 [json_name = "connectorId"];
      Parameters:
      value - The connectorId to set.
      Returns:
      This builder for chaining.
    • clearConnectorId

      public StartCrawlSessionRequest.Builder clearConnectorId()
       Connector identifier.
       
      string connector_id = 1 [json_name = "connectorId"];
      Returns:
      This builder for chaining.
    • setConnectorIdBytes

      public StartCrawlSessionRequest.Builder setConnectorIdBytes(com.google.protobuf.ByteString value)
       Connector identifier.
       
      string connector_id = 1 [json_name = "connectorId"];
      Parameters:
      value - The bytes for connectorId to set.
      Returns:
      This builder for chaining.
    • 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.
    • setApiKey

      public StartCrawlSessionRequest.Builder setApiKey(String value)
       API key for authentication.
       
      string api_key = 2 [json_name = "apiKey"];
      Parameters:
      value - The apiKey to set.
      Returns:
      This builder for chaining.
    • clearApiKey

      public StartCrawlSessionRequest.Builder clearApiKey()
       API key for authentication.
       
      string api_key = 2 [json_name = "apiKey"];
      Returns:
      This builder for chaining.
    • setApiKeyBytes

      public StartCrawlSessionRequest.Builder setApiKeyBytes(com.google.protobuf.ByteString value)
       API key for authentication.
       
      string api_key = 2 [json_name = "apiKey"];
      Parameters:
      value - The bytes for apiKey to set.
      Returns:
      This builder for chaining.
    • 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.
    • setCrawlId

      public StartCrawlSessionRequest.Builder setCrawlId(String value)
       Client-provided crawl identifier.
       
      string crawl_id = 3 [json_name = "crawlId"];
      Parameters:
      value - The crawlId to set.
      Returns:
      This builder for chaining.
    • clearCrawlId

      public StartCrawlSessionRequest.Builder clearCrawlId()
       Client-provided crawl identifier.
       
      string crawl_id = 3 [json_name = "crawlId"];
      Returns:
      This builder for chaining.
    • setCrawlIdBytes

      public StartCrawlSessionRequest.Builder setCrawlIdBytes(com.google.protobuf.ByteString value)
       Client-provided crawl identifier.
       
      string crawl_id = 3 [json_name = "crawlId"];
      Parameters:
      value - The bytes for crawlId to set.
      Returns:
      This builder for chaining.
    • 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.
    • setMetadata

      public StartCrawlSessionRequest.Builder setMetadata(CrawlMetadata value)
       Crawl metadata and parameters.
       
      .ai.pipestream.connector.intake.v1.CrawlMetadata metadata = 4 [json_name = "metadata"];
    • setMetadata

      public StartCrawlSessionRequest.Builder setMetadata(CrawlMetadata.Builder builderForValue)
       Crawl metadata and parameters.
       
      .ai.pipestream.connector.intake.v1.CrawlMetadata metadata = 4 [json_name = "metadata"];
    • mergeMetadata

      public StartCrawlSessionRequest.Builder mergeMetadata(CrawlMetadata value)
       Crawl metadata and parameters.
       
      .ai.pipestream.connector.intake.v1.CrawlMetadata metadata = 4 [json_name = "metadata"];
    • clearMetadata

      public StartCrawlSessionRequest.Builder clearMetadata()
       Crawl metadata and parameters.
       
      .ai.pipestream.connector.intake.v1.CrawlMetadata metadata = 4 [json_name = "metadata"];
    • getMetadataBuilder

      public CrawlMetadata.Builder getMetadataBuilder()
       Crawl metadata and parameters.
       
      .ai.pipestream.connector.intake.v1.CrawlMetadata metadata = 4 [json_name = "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.
    • setTrackDocuments

      public StartCrawlSessionRequest.Builder setTrackDocuments(boolean value)
       Whether to track all documents in this crawl for orphan detection.
       
      bool track_documents = 5 [json_name = "trackDocuments"];
      Parameters:
      value - The trackDocuments to set.
      Returns:
      This builder for chaining.
    • clearTrackDocuments

      public StartCrawlSessionRequest.Builder clearTrackDocuments()
       Whether to track all documents in this crawl for orphan detection.
       
      bool track_documents = 5 [json_name = "trackDocuments"];
      Returns:
      This builder for chaining.
    • 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.
    • setDeleteOrphans

      public StartCrawlSessionRequest.Builder setDeleteOrphans(boolean value)
       Whether to delete documents not seen in this crawl.
       
      bool delete_orphans = 6 [json_name = "deleteOrphans"];
      Parameters:
      value - The deleteOrphans to set.
      Returns:
      This builder for chaining.
    • clearDeleteOrphans

      public StartCrawlSessionRequest.Builder clearDeleteOrphans()
       Whether to delete documents not seen in this crawl.
       
      bool delete_orphans = 6 [json_name = "deleteOrphans"];
      Returns:
      This builder for chaining.