Package com.google.cloud.discoveryengine.v1beta

Class FirestoreSource

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.google.cloud.discoveryengine.v1beta.FirestoreSource
All Implemented Interfaces:
FirestoreSourceOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
@Generated public final class FirestoreSource extends com.google.protobuf.GeneratedMessage implements FirestoreSourceOrBuilder
 Firestore source import data from.
Protobuf type google.cloud.discoveryengine.v1beta.FirestoreSource
See Also:

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static final class 
    FirestoreSource.Builder
    Firestore source import data from.

    Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessage

    com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.FieldAccessorTable, com.google.protobuf.GeneratedMessage.GeneratedExtension<ContainingT extends com.google.protobuf.Message,T extends Object>, com.google.protobuf.GeneratedMessage.UnusedPrivateParameter

    Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessage

    com.google.protobuf.AbstractMessage.BuilderParent

    Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

    com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final int
    COLLECTION_ID_FIELD_NUMBER
     
    static final int
    DATABASE_ID_FIELD_NUMBER
     
    static final int
    GCS_STAGING_DIR_FIELD_NUMBER
     
    static final int
    PROJECT_ID_FIELD_NUMBER
     

    Fields inherited from class com.google.protobuf.GeneratedMessage

    alwaysUseFieldBuilders, loggedPre22TypeNames, unknownFields

    Fields inherited from class com.google.protobuf.AbstractMessage

    memoizedSize

    Fields inherited from class com.google.protobuf.AbstractMessageLite

    memoizedHashCode

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    equals(Object obj)
     
    String
    getCollectionId()
    Required.
    com.google.protobuf.ByteString
    getCollectionIdBytes()
    Required.
    String
    getDatabaseId()
    Required.
    com.google.protobuf.ByteString
    getDatabaseIdBytes()
    Required.
    static FirestoreSource
    getDefaultInstance()
     
    FirestoreSource
    getDefaultInstanceForType()
     
    static final com.google.protobuf.Descriptors.Descriptor
    getDescriptor()
     
    String
    getGcsStagingDir()
    Intermediate Cloud Storage directory used for the import with a length limit of 2,000 characters.
    com.google.protobuf.ByteString
    getGcsStagingDirBytes()
    Intermediate Cloud Storage directory used for the import with a length limit of 2,000 characters.
    com.google.protobuf.Parser<FirestoreSource>
    getParserForType()
     
    String
    getProjectId()
    The project ID that the Cloud SQL source is in with a length limit of 128 characters.
    com.google.protobuf.ByteString
    getProjectIdBytes()
    The project ID that the Cloud SQL source is in with a length limit of 128 characters.
    int
    getSerializedSize()
     
    int
    hashCode()
     
    protected com.google.protobuf.GeneratedMessage.FieldAccessorTable
    internalGetFieldAccessorTable()
     
    final boolean
    isInitialized()
     
    static FirestoreSource.Builder
    newBuilder()
     
    static FirestoreSource.Builder
    newBuilder(FirestoreSource prototype)
     
    FirestoreSource.Builder
    newBuilderForType()
     
    protected FirestoreSource.Builder
    newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
     
    static FirestoreSource
    parseDelimitedFrom(InputStream input)
     
    static FirestoreSource
    parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static FirestoreSource
    parseFrom(byte[] data)
     
    static FirestoreSource
    parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static FirestoreSource
    parseFrom(com.google.protobuf.ByteString data)
     
    static FirestoreSource
    parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static FirestoreSource
    parseFrom(com.google.protobuf.CodedInputStream input)
     
    static FirestoreSource
    parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static FirestoreSource
    parseFrom(InputStream input)
     
    static FirestoreSource
    parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static FirestoreSource
    parseFrom(ByteBuffer data)
     
    static FirestoreSource
    parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static com.google.protobuf.Parser<FirestoreSource>
    parser()
     
    FirestoreSource.Builder
    toBuilder()
     
    void
    writeTo(com.google.protobuf.CodedOutputStream output)
     

    Methods inherited from class com.google.protobuf.GeneratedMessage

    canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, newFileScopedGeneratedExtension, newInstance, newMessageScopedGeneratedExtension, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

    Methods inherited from class com.google.protobuf.AbstractMessage

    findInitializationErrors, getInitializationErrorString, hashFields, toString

    Methods inherited from class com.google.protobuf.AbstractMessageLite

    addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

    Methods inherited from interface com.google.protobuf.MessageLite

    toByteArray, toByteString, writeDelimitedTo, writeTo

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

  • Field Details

    • PROJECT_ID_FIELD_NUMBER

      public static final int PROJECT_ID_FIELD_NUMBER
      See Also:

    • DATABASE_ID_FIELD_NUMBER

      public static final int DATABASE_ID_FIELD_NUMBER
      See Also:

    • COLLECTION_ID_FIELD_NUMBER

      public static final int COLLECTION_ID_FIELD_NUMBER
      See Also:

    • GCS_STAGING_DIR_FIELD_NUMBER

      public static final int GCS_STAGING_DIR_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

    • getProjectId

      public String getProjectId()
       The project ID that the Cloud SQL source is in with a length limit of 128
 characters. If not specified, inherits the project ID from the parent
 request.
      string project_id = 1;
      Specified by:
      getProjectId in interface FirestoreSourceOrBuilder
      Returns:
      The projectId.

    • getProjectIdBytes

      public com.google.protobuf.ByteString getProjectIdBytes()
       The project ID that the Cloud SQL source is in with a length limit of 128
 characters. If not specified, inherits the project ID from the parent
 request.
      string project_id = 1;
      Specified by:
      getProjectIdBytes in interface FirestoreSourceOrBuilder
      Returns:
      The bytes for projectId.

    • getDatabaseId

      public String getDatabaseId()
       Required. The Firestore database to copy the data from with a length limit
 of 256 characters.
      string database_id = 2 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      getDatabaseId in interface FirestoreSourceOrBuilder
      Returns:
      The databaseId.

    • getDatabaseIdBytes

      public com.google.protobuf.ByteString getDatabaseIdBytes()
       Required. The Firestore database to copy the data from with a length limit
 of 256 characters.
      string database_id = 2 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      getDatabaseIdBytes in interface FirestoreSourceOrBuilder
      Returns:
      The bytes for databaseId.

    • getCollectionId

      public String getCollectionId()
       Required. The Firestore collection (or entity) to copy the data from with a
 length limit of 1,500 characters.
      string collection_id = 3 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      getCollectionId in interface FirestoreSourceOrBuilder
      Returns:
      The collectionId.

    • getCollectionIdBytes

      public com.google.protobuf.ByteString getCollectionIdBytes()
       Required. The Firestore collection (or entity) to copy the data from with a
 length limit of 1,500 characters.
      string collection_id = 3 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      getCollectionIdBytes in interface FirestoreSourceOrBuilder
      Returns:
      The bytes for collectionId.

    • getGcsStagingDir

      public String getGcsStagingDir()
       Intermediate Cloud Storage directory used for the import with a length
 limit of 2,000 characters. Can be specified if one wants to have the
 Firestore export to a specific Cloud Storage directory.

 Ensure that the Firestore service account has the necessary Cloud
 Storage Admin permissions to access the specified Cloud Storage directory.
      string gcs_staging_dir = 4;
      Specified by:
      getGcsStagingDir in interface FirestoreSourceOrBuilder
      Returns:
      The gcsStagingDir.

    • getGcsStagingDirBytes

      public com.google.protobuf.ByteString getGcsStagingDirBytes()
       Intermediate Cloud Storage directory used for the import with a length
 limit of 2,000 characters. Can be specified if one wants to have the
 Firestore export to a specific Cloud Storage directory.

 Ensure that the Firestore service account has the necessary Cloud
 Storage Admin permissions to access the specified Cloud Storage directory.
      string gcs_staging_dir = 4;
      Specified by:
      getGcsStagingDirBytes in interface FirestoreSourceOrBuilder
      Returns:
      The bytes for gcsStagingDir.

    • 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 FirestoreSource parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseDelimitedFrom

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

    • parseDelimitedFrom

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

    • parseFrom

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

    • parseFrom

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

    • newBuilderForType

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

    • newBuilder

      public static FirestoreSource.Builder newBuilder()

    • newBuilder

      public static FirestoreSource.Builder newBuilder(FirestoreSource prototype)

    • toBuilder

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

    • newBuilderForType

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

    • getDefaultInstance

      public static FirestoreSource getDefaultInstance()

    • parser

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

    • getParserForType

      public com.google.protobuf.Parser<FirestoreSource> 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 FirestoreSource getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder