Package com.google.cloud.retail.v2

Interface GcsSourceOrBuilder

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

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      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 Detail

      • getInputUrisList

        List<String> getInputUrisList()
         Required. Google Cloud Storage URIs to input files. 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, and each file can be up to 2 GB. See
 [Importing product
 information](https://cloud.google.com/retail/recommendations-ai/docs/upload-catalog)
 for the expected file format and setup instructions.
        repeated string input_uris = 1 [(.google.api.field_behavior) = REQUIRED];
        Returns:
        A list containing the inputUris.

      • getInputUrisCount

        int getInputUrisCount()
         Required. Google Cloud Storage URIs to input files. 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, and each file can be up to 2 GB. See
 [Importing product
 information](https://cloud.google.com/retail/recommendations-ai/docs/upload-catalog)
 for the expected file format and setup instructions.
        repeated string input_uris = 1 [(.google.api.field_behavior) = REQUIRED];
        Returns:
        The count of inputUris.

      • getInputUris

        String getInputUris​(int index)
         Required. Google Cloud Storage URIs to input files. 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, and each file can be up to 2 GB. See
 [Importing product
 information](https://cloud.google.com/retail/recommendations-ai/docs/upload-catalog)
 for the expected file format and setup instructions.
        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. Google Cloud Storage URIs to input files. 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, and each file can be up to 2 GB. See
 [Importing product
 information](https://cloud.google.com/retail/recommendations-ai/docs/upload-catalog)
 for the expected file format and setup instructions.
        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 product imports:

 * `product` (default): One JSON [Product][google.cloud.retail.v2.Product]
 per line. Each product must
   have a valid [Product.id][google.cloud.retail.v2.Product.id].
 * `product_merchant_center`: See [Importing catalog data from Merchant
   Center](https://cloud.google.com/retail/recommendations-ai/docs/upload-catalog#mc).

 Supported values for user events imports:

 * `user_event` (default): One JSON
 [UserEvent][google.cloud.retail.v2.UserEvent] per line.
 * `user_event_ga360`: Using
   https://support.google.com/analytics/answer/3437719.

 Supported values for control imports:

 * `control` (default): One JSON [Control][google.cloud.retail.v2.Control]
 per line.

 Supported values for catalog attribute imports:

 * `catalog_attribute` (default): One CSV
 [CatalogAttribute][google.cloud.retail.v2.CatalogAttribute] 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 product imports:

 * `product` (default): One JSON [Product][google.cloud.retail.v2.Product]
 per line. Each product must
   have a valid [Product.id][google.cloud.retail.v2.Product.id].
 * `product_merchant_center`: See [Importing catalog data from Merchant
   Center](https://cloud.google.com/retail/recommendations-ai/docs/upload-catalog#mc).

 Supported values for user events imports:

 * `user_event` (default): One JSON
 [UserEvent][google.cloud.retail.v2.UserEvent] per line.
 * `user_event_ga360`: Using
   https://support.google.com/analytics/answer/3437719.

 Supported values for control imports:

 * `control` (default): One JSON [Control][google.cloud.retail.v2.Control]
 per line.

 Supported values for catalog attribute imports:

 * `catalog_attribute` (default): One CSV
 [CatalogAttribute][google.cloud.retail.v2.CatalogAttribute] per line.
        string data_schema = 2;
        Returns:
        The bytes for dataSchema.