public final class GcsSource extends GeneratedMessageV3 implements GcsSourceOrBuilder
Google Cloud Storage location for input content.
format.
Protobuf type google.cloud.retail.v2.GcsSource
Static Fields
DATA_SCHEMA_FIELD_NUMBER
public static final int DATA_SCHEMA_FIELD_NUMBER
Field Value
public static final int INPUT_URIS_FIELD_NUMBER
Field Value
Static Methods
getDefaultInstance()
public static GcsSource getDefaultInstance()
Returns
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Returns
newBuilder()
public static GcsSource.Builder newBuilder()
Returns
newBuilder(GcsSource prototype)
public static GcsSource.Builder newBuilder(GcsSource prototype)
Parameter
Returns
public static GcsSource parseDelimitedFrom(InputStream input)
Parameter
Returns
Exceptions
public static GcsSource parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(byte[] data)
public static GcsSource parseFrom(byte[] data)
Parameter
Name | Description |
data | byte[]
|
Returns
Exceptions
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static GcsSource parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteString data)
public static GcsSource parseFrom(ByteString data)
Parameter
Returns
Exceptions
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static GcsSource parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static GcsSource parseFrom(CodedInputStream input)
Parameter
Returns
Exceptions
public static GcsSource parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static GcsSource parseFrom(InputStream input)
Parameter
Returns
Exceptions
public static GcsSource parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteBuffer data)
public static GcsSource parseFrom(ByteBuffer data)
Parameter
Returns
Exceptions
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static GcsSource parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parser()
public static Parser<GcsSource> parser()
Returns
Methods
equals(Object obj)
public boolean equals(Object obj)
Parameter
Returns
Overrides
getDataSchema()
public String getDataSchema()
The schema to use when parsing the data from the source.
Supported values for product imports:
product
(default): One JSON Product
per line. Each product must
have a valid Product.id.
product_merchant_center
: See Importing catalog data from Merchant
Center.
Supported values for user events imports:
user_event
(default): One JSON
UserEvent per line.
user_event_ga360
: Using
https://support.google.com/analytics/answer/3437719.
Supported values for control imports:
- 'control' (default): One JSON [Control][] per line.
Supported values for catalog attribute imports:
- 'catalog_attribute' (default): One CSV [CatalogAttribute][] per line.
string data_schema = 2;
Returns
Type | Description |
String | The dataSchema.
|
getDataSchemaBytes()
public ByteString getDataSchemaBytes()
The schema to use when parsing the data from the source.
Supported values for product imports:
product
(default): One JSON Product
per line. Each product must
have a valid Product.id.
product_merchant_center
: See Importing catalog data from Merchant
Center.
Supported values for user events imports:
user_event
(default): One JSON
UserEvent per line.
user_event_ga360
: Using
https://support.google.com/analytics/answer/3437719.
Supported values for control imports:
- 'control' (default): One JSON [Control][] per line.
Supported values for catalog attribute imports:
- 'catalog_attribute' (default): One CSV [CatalogAttribute][] per line.
string data_schema = 2;
Returns
Type | Description |
ByteString | The bytes for dataSchema.
|
getDefaultInstanceForType()
public GcsSource getDefaultInstanceForType()
Returns
public 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
for the expected file format and setup instructions.
repeated string input_uris = 1 [(.google.api.field_behavior) = REQUIRED];
Parameter
Name | Description |
index | int
The index of the element to return.
|
Returns
Type | Description |
String | The inputUris at the given index.
|
public 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
for the expected file format and setup instructions.
repeated string input_uris = 1 [(.google.api.field_behavior) = REQUIRED];
Parameter
Name | Description |
index | int
The index of the value to return.
|
Returns
Type | Description |
ByteString | The bytes of the inputUris at the given index.
|
public 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
for the expected file format and setup instructions.
repeated string input_uris = 1 [(.google.api.field_behavior) = REQUIRED];
Returns
Type | Description |
int | The count of inputUris.
|
public ProtocolStringList 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
for the expected file format and setup instructions.
repeated string input_uris = 1 [(.google.api.field_behavior) = REQUIRED];
Returns
getParserForType()
public Parser<GcsSource> getParserForType()
Returns
Overrides
getSerializedSize()
public int getSerializedSize()
Returns
Overrides
getUnknownFields()
public final UnknownFieldSet getUnknownFields()
Returns
Overrides
hashCode()
Returns
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Overrides
isInitialized()
public final boolean isInitialized()
Returns
Overrides
newBuilderForType()
public GcsSource.Builder newBuilderForType()
Returns
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected GcsSource.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Returns
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Returns
Overrides
toBuilder()
public GcsSource.Builder toBuilder()
Returns
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Parameter
Overrides
Exceptions