• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1 /*
2  * Copyright 2020 Google LLC
3  *
4  * Licensed under the Apache License, Version 2.0 (the "License");
5  * you may not use this file except in compliance with the License.
6  * You may obtain a copy of the License at
7  *
8  *     https://www.apache.org/licenses/LICENSE-2.0
9  *
10  * Unless required by applicable law or agreed to in writing, software
11  * distributed under the License is distributed on an "AS IS" BASIS,
12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  * See the License for the specific language governing permissions and
14  * limitations under the License.
15  */
16 // Generated by the protocol buffer compiler.  DO NOT EDIT!
17 // source: google/cloud/retail/v2/import_config.proto
18 
19 package com.google.cloud.retail.v2;
20 
21 public interface GcsSourceOrBuilder
22     extends
23     // @@protoc_insertion_point(interface_extends:google.cloud.retail.v2.GcsSource)
24     com.google.protobuf.MessageOrBuilder {
25 
26   /**
27    *
28    *
29    * <pre>
30    * Required. Google Cloud Storage URIs to input files. URI can be up to
31    * 2000 characters long. URIs can match the full object path (for example,
32    * `gs://bucket/directory/object.json`) or a pattern matching one or more
33    * files, such as `gs://bucket/directory/&#42;.json`. A request can
34    * contain at most 100 files, and each file can be up to 2 GB. See
35    * [Importing product
36    * information](https://cloud.google.com/retail/recommendations-ai/docs/upload-catalog)
37    * for the expected file format and setup instructions.
38    * </pre>
39    *
40    * <code>repeated string input_uris = 1 [(.google.api.field_behavior) = REQUIRED];</code>
41    *
42    * @return A list containing the inputUris.
43    */
getInputUrisList()44   java.util.List<java.lang.String> getInputUrisList();
45   /**
46    *
47    *
48    * <pre>
49    * Required. Google Cloud Storage URIs to input files. URI can be up to
50    * 2000 characters long. URIs can match the full object path (for example,
51    * `gs://bucket/directory/object.json`) or a pattern matching one or more
52    * files, such as `gs://bucket/directory/&#42;.json`. A request can
53    * contain at most 100 files, and each file can be up to 2 GB. See
54    * [Importing product
55    * information](https://cloud.google.com/retail/recommendations-ai/docs/upload-catalog)
56    * for the expected file format and setup instructions.
57    * </pre>
58    *
59    * <code>repeated string input_uris = 1 [(.google.api.field_behavior) = REQUIRED];</code>
60    *
61    * @return The count of inputUris.
62    */
getInputUrisCount()63   int getInputUrisCount();
64   /**
65    *
66    *
67    * <pre>
68    * Required. Google Cloud Storage URIs to input files. URI can be up to
69    * 2000 characters long. URIs can match the full object path (for example,
70    * `gs://bucket/directory/object.json`) or a pattern matching one or more
71    * files, such as `gs://bucket/directory/&#42;.json`. A request can
72    * contain at most 100 files, and each file can be up to 2 GB. See
73    * [Importing product
74    * information](https://cloud.google.com/retail/recommendations-ai/docs/upload-catalog)
75    * for the expected file format and setup instructions.
76    * </pre>
77    *
78    * <code>repeated string input_uris = 1 [(.google.api.field_behavior) = REQUIRED];</code>
79    *
80    * @param index The index of the element to return.
81    * @return The inputUris at the given index.
82    */
getInputUris(int index)83   java.lang.String getInputUris(int index);
84   /**
85    *
86    *
87    * <pre>
88    * Required. Google Cloud Storage URIs to input files. URI can be up to
89    * 2000 characters long. URIs can match the full object path (for example,
90    * `gs://bucket/directory/object.json`) or a pattern matching one or more
91    * files, such as `gs://bucket/directory/&#42;.json`. A request can
92    * contain at most 100 files, and each file can be up to 2 GB. See
93    * [Importing product
94    * information](https://cloud.google.com/retail/recommendations-ai/docs/upload-catalog)
95    * for the expected file format and setup instructions.
96    * </pre>
97    *
98    * <code>repeated string input_uris = 1 [(.google.api.field_behavior) = REQUIRED];</code>
99    *
100    * @param index The index of the value to return.
101    * @return The bytes of the inputUris at the given index.
102    */
getInputUrisBytes(int index)103   com.google.protobuf.ByteString getInputUrisBytes(int index);
104 
105   /**
106    *
107    *
108    * <pre>
109    * The schema to use when parsing the data from the source.
110    * Supported values for product imports:
111    * * `product` (default): One JSON [Product][google.cloud.retail.v2.Product]
112    * per line. Each product must
113    *   have a valid [Product.id][google.cloud.retail.v2.Product.id].
114    * * `product_merchant_center`: See [Importing catalog data from Merchant
115    *   Center](https://cloud.google.com/retail/recommendations-ai/docs/upload-catalog#mc).
116    * Supported values for user events imports:
117    * * `user_event` (default): One JSON
118    * [UserEvent][google.cloud.retail.v2.UserEvent] per line.
119    * * `user_event_ga360`: Using
120    *   https://support.google.com/analytics/answer/3437719.
121    * Supported values for control imports:
122    * * `control` (default): One JSON [Control][google.cloud.retail.v2.Control]
123    * per line.
124    * Supported values for catalog attribute imports:
125    * * `catalog_attribute` (default): One CSV
126    * [CatalogAttribute][google.cloud.retail.v2.CatalogAttribute] per line.
127    * </pre>
128    *
129    * <code>string data_schema = 2;</code>
130    *
131    * @return The dataSchema.
132    */
getDataSchema()133   java.lang.String getDataSchema();
134   /**
135    *
136    *
137    * <pre>
138    * The schema to use when parsing the data from the source.
139    * Supported values for product imports:
140    * * `product` (default): One JSON [Product][google.cloud.retail.v2.Product]
141    * per line. Each product must
142    *   have a valid [Product.id][google.cloud.retail.v2.Product.id].
143    * * `product_merchant_center`: See [Importing catalog data from Merchant
144    *   Center](https://cloud.google.com/retail/recommendations-ai/docs/upload-catalog#mc).
145    * Supported values for user events imports:
146    * * `user_event` (default): One JSON
147    * [UserEvent][google.cloud.retail.v2.UserEvent] per line.
148    * * `user_event_ga360`: Using
149    *   https://support.google.com/analytics/answer/3437719.
150    * Supported values for control imports:
151    * * `control` (default): One JSON [Control][google.cloud.retail.v2.Control]
152    * per line.
153    * Supported values for catalog attribute imports:
154    * * `catalog_attribute` (default): One CSV
155    * [CatalogAttribute][google.cloud.retail.v2.CatalogAttribute] per line.
156    * </pre>
157    *
158    * <code>string data_schema = 2;</code>
159    *
160    * @return The bytes for dataSchema.
161    */
getDataSchemaBytes()162   com.google.protobuf.ByteString getDataSchemaBytes();
163 }
164