Package com.google.cloud.discoveryengine.v1beta

Class GcsSource

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.google.cloud.discoveryengine.v1beta.GcsSource
All Implemented Interfaces:
GcsSourceOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
@Generated public final class GcsSource extends com.google.protobuf.GeneratedMessage implements GcsSourceOrBuilder
 Cloud Storage location for input content.
Protobuf type google.cloud.discoveryengine.v1beta.GcsSource
See Also:

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static final class 
    GcsSource.Builder
    Cloud Storage location for input content.

    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
    DATA_SCHEMA_FIELD_NUMBER
     
    static final int
    INPUT_URIS_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
    getDataSchema()
    The schema to use when parsing the data from the source.
    com.google.protobuf.ByteString
    getDataSchemaBytes()
    The schema to use when parsing the data from the source.
    static GcsSource
    getDefaultInstance()
     
    GcsSource
    getDefaultInstanceForType()
     
    static final com.google.protobuf.Descriptors.Descriptor
    getDescriptor()
     
    String
    getInputUris(int index)
    Required.
    com.google.protobuf.ByteString
    getInputUrisBytes(int index)
    Required.
    int
    getInputUrisCount()
    Required.
    com.google.protobuf.ProtocolStringList
    getInputUrisList()
    Required.
    com.google.protobuf.Parser<GcsSource>
    getParserForType()
     
    int
    getSerializedSize()
     
    int
    hashCode()
     
    protected com.google.protobuf.GeneratedMessage.FieldAccessorTable
    internalGetFieldAccessorTable()
     
    final boolean
    isInitialized()
     
    static GcsSource.Builder
    newBuilder()
     
    static GcsSource.Builder
    newBuilder(GcsSource prototype)
     
    GcsSource.Builder
    newBuilderForType()
     
    protected GcsSource.Builder
    newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
     
    static GcsSource
    parseDelimitedFrom(InputStream input)
     
    static GcsSource
    parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static GcsSource
    parseFrom(byte[] data)
     
    static GcsSource
    parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static GcsSource
    parseFrom(com.google.protobuf.ByteString data)
     
    static GcsSource
    parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static GcsSource
    parseFrom(com.google.protobuf.CodedInputStream input)
     
    static GcsSource
    parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static GcsSource
    parseFrom(InputStream input)
     
    static GcsSource
    parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static GcsSource
    parseFrom(ByteBuffer data)
     
    static GcsSource
    parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static com.google.protobuf.Parser<GcsSource>
    parser()
     
    GcsSource.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

    • INPUT_URIS_FIELD_NUMBER

      public static final int INPUT_URIS_FIELD_NUMBER
      See Also:

    • DATA_SCHEMA_FIELD_NUMBER

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

    • getInputUrisList

      public com.google.protobuf.ProtocolStringList getInputUrisList()
       Required. Cloud Storage URIs to input files. Each URI can be up to
 2000 characters long. URIs can match the full object path (for example,
 `gs://bucket/directory/object.json`) or a pattern matching one or more
 files, such as `gs://bucket/directory/*.json`.

 A request can contain at most 100 files (or 100,000 files if `data_schema`
 is `content`). Each file can be up to 2 GB (or 100 MB if `data_schema` is
 `content`).
      repeated string input_uris = 1 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      getInputUrisList in interface GcsSourceOrBuilder
      Returns:
      A list containing the inputUris.

    • getInputUrisCount

      public int getInputUrisCount()
       Required. Cloud Storage URIs to input files. Each URI can be up to
 2000 characters long. URIs can match the full object path (for example,
 `gs://bucket/directory/object.json`) or a pattern matching one or more
 files, such as `gs://bucket/directory/*.json`.

 A request can contain at most 100 files (or 100,000 files if `data_schema`
 is `content`). Each file can be up to 2 GB (or 100 MB if `data_schema` is
 `content`).
      repeated string input_uris = 1 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      getInputUrisCount in interface GcsSourceOrBuilder
      Returns:
      The count of inputUris.

    • getInputUris

      public String getInputUris(int index)
       Required. Cloud Storage URIs to input files. Each URI can be up to
 2000 characters long. URIs can match the full object path (for example,
 `gs://bucket/directory/object.json`) or a pattern matching one or more
 files, such as `gs://bucket/directory/*.json`.

 A request can contain at most 100 files (or 100,000 files if `data_schema`
 is `content`). Each file can be up to 2 GB (or 100 MB if `data_schema` is
 `content`).
      repeated string input_uris = 1 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      getInputUris in interface GcsSourceOrBuilder
      Parameters:
      index - The index of the element to return.
      Returns:
      The inputUris at the given index.

    • getInputUrisBytes

      public com.google.protobuf.ByteString getInputUrisBytes(int index)
       Required. Cloud Storage URIs to input files. Each URI can be up to
 2000 characters long. URIs can match the full object path (for example,
 `gs://bucket/directory/object.json`) or a pattern matching one or more
 files, such as `gs://bucket/directory/*.json`.

 A request can contain at most 100 files (or 100,000 files if `data_schema`
 is `content`). Each file can be up to 2 GB (or 100 MB if `data_schema` is
 `content`).
      repeated string input_uris = 1 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      getInputUrisBytes in interface GcsSourceOrBuilder
      Parameters:
      index - The index of the value to return.
      Returns:
      The bytes of the inputUris at the given index.

    • getDataSchema

      public String getDataSchema()
       The schema to use when parsing the data from the source.

 Supported values for document imports:

 * `document` (default): One JSON
 [Document][google.cloud.discoveryengine.v1beta.Document] per line. Each
 document must
 have a valid
 [Document.id][google.cloud.discoveryengine.v1beta.Document.id].
 * `content`: Unstructured data (e.g. PDF, HTML). Each file matched by
 `input_uris` becomes a document, with the ID set to the first 128
 bits of SHA256(URI) encoded as a hex string.
 * `custom`: One custom data JSON per row in arbitrary format that conforms
 to the defined [Schema][google.cloud.discoveryengine.v1beta.Schema] of
 the data store. This can only be used by the GENERIC Data Store vertical.
 * `csv`: A CSV file with header conforming to the defined
 [Schema][google.cloud.discoveryengine.v1beta.Schema] of the
 data store. Each entry after the header is imported as a Document.
 This can only be used by the GENERIC Data Store vertical.

 Supported values for user event imports:

 * `user_event` (default): One JSON
 [UserEvent][google.cloud.discoveryengine.v1beta.UserEvent] per line.
      string data_schema = 2;
      Specified by:
      getDataSchema in interface GcsSourceOrBuilder
      Returns:
      The dataSchema.

    • getDataSchemaBytes

      public com.google.protobuf.ByteString getDataSchemaBytes()
       The schema to use when parsing the data from the source.

 Supported values for document imports:

 * `document` (default): One JSON
 [Document][google.cloud.discoveryengine.v1beta.Document] per line. Each
 document must
 have a valid
 [Document.id][google.cloud.discoveryengine.v1beta.Document.id].
 * `content`: Unstructured data (e.g. PDF, HTML). Each file matched by
 `input_uris` becomes a document, with the ID set to the first 128
 bits of SHA256(URI) encoded as a hex string.
 * `custom`: One custom data JSON per row in arbitrary format that conforms
 to the defined [Schema][google.cloud.discoveryengine.v1beta.Schema] of
 the data store. This can only be used by the GENERIC Data Store vertical.
 * `csv`: A CSV file with header conforming to the defined
 [Schema][google.cloud.discoveryengine.v1beta.Schema] of the
 data store. Each entry after the header is imported as a Document.
 This can only be used by the GENERIC Data Store vertical.

 Supported values for user event imports:

 * `user_event` (default): One JSON
 [UserEvent][google.cloud.discoveryengine.v1beta.UserEvent] per line.
      string data_schema = 2;
      Specified by:
      getDataSchemaBytes in interface GcsSourceOrBuilder
      Returns:
      The bytes for dataSchema.

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseDelimitedFrom

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

    • parseDelimitedFrom

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

    • parseFrom

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

    • parseFrom

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

    • newBuilderForType

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

    • newBuilder

      public static GcsSource.Builder newBuilder()

    • newBuilder

      public static GcsSource.Builder newBuilder(GcsSource prototype)

    • toBuilder

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

    • newBuilderForType

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

    • getDefaultInstance

      public static GcsSource getDefaultInstance()

    • parser

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

    • getParserForType

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