com.google.cloud.retail.v2.GcsSourceOrBuilder Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of proto-google-cloud-retail-v2 Show documentation
Proto library for google-cloud-retail
The newest version!
/*
 * Copyright 2024 Google LLC
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     https://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
// Generated by the protocol buffer compiler.  DO NOT EDIT!
// source: google/cloud/retail/v2/import_config.proto

// Protobuf Java Version: 3.25.5
package com.google.cloud.retail.v2;

public interface GcsSourceOrBuilder
    extends
    // @@protoc_insertion_point(interface_extends:google.cloud.retail.v2.GcsSource)
    com.google.protobuf.MessageOrBuilder {

  /**
   *
   *
   *    * 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];
   *
   * @return A list containing the inputUris.
   */
  java.util.List 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];
   *
   * @return The count of inputUris.
   */
  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];
   *
   * @param index The index of the element to return.
   * @return The inputUris at the given index.
   */
  java.lang.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];
   *
   * @param index The index of the value to return.
   * @return The bytes of the inputUris at the given index.
   */
  com.google.protobuf.ByteString getInputUrisBytes(int index);

  /**
   *
   *
   *    * 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;
   *
   * @return The dataSchema.
   */
  java.lang.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;
   *
   * @return The bytes for dataSchema.
   */
  com.google.protobuf.ByteString getDataSchemaBytes();
}