Package com.google.cloud.discoveryengine.v1beta

Interface GcsSourceOrBuilder

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

  • Method Summary

    Modifier and Type
    Method
    Description
    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.
    String
    getInputUris(int index)
    Required.
    com.google.protobuf.ByteString
    getInputUrisBytes(int index)
    Required.
    int
    getInputUrisCount()
    Required.
    List<String>
    getInputUrisList()
    Required.

    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

    • getInputUrisList

      List<String> 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];
      Returns:
      A list containing the inputUris.

    • getInputUrisCount

      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];
      Returns:
      The count of inputUris.

    • getInputUris

      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];
      Parameters:
      index - The index of the element to return.
      Returns:
      The inputUris at the given index.

    • getInputUrisBytes

      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];
      Parameters:
      index - The index of the value to return.
      Returns:
      The bytes of the inputUris at the given index.

    • getDataSchema

      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;
      Returns:
      The dataSchema.

    • getDataSchemaBytes

      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;
      Returns:
      The bytes for dataSchema.