Package com.google.cloud.retail.v2

Class GcsSource.Builder

java.lang.Object

com.google.protobuf.AbstractMessageLite.Builder

com.google.protobuf.AbstractMessage.Builder<BuilderT>

com.google.protobuf.GeneratedMessageV3.Builder<GcsSource.Builder>

com.google.cloud.retail.v2.GcsSource.Builder

All Implemented Interfaces:

GcsSourceOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable

Enclosing class:

GcsSource

public static final class GcsSource.Builder
extends com.google.protobuf.GeneratedMessageV3.Builder<GcsSource.Builder>
implements GcsSourceOrBuilder

 Google Cloud Storage location for input content.
 

Protobuf type google.cloud.retail.v2.GcsSource

Method Summary

Modifier and Type	Method	Description
GcsSource.Builder	addAllInputUris(Iterable<String> values)	Required.
GcsSource.Builder	addInputUris(String value)	Required.
GcsSource.Builder	addInputUrisBytes(com.google.protobuf.ByteString value)	Required.
GcsSource.Builder	addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
GcsSource	build()
GcsSource	buildPartial()
GcsSource.Builder	clear()
GcsSource.Builder	clearDataSchema()	The schema to use when parsing the data from the source.
GcsSource.Builder	clearField(com.google.protobuf.Descriptors.FieldDescriptor field)
GcsSource.Builder	clearInputUris()	Required.
GcsSource.Builder	clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)
GcsSource.Builder	clone()
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.
GcsSource	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
com.google.protobuf.Descriptors.Descriptor	getDescriptorForType()
String	getInputUris(int index)	Required.
com.google.protobuf.ByteString	getInputUrisBytes(int index)	Required.
int	getInputUrisCount()	Required.
com.google.protobuf.ProtocolStringList	getInputUrisList()	Required.
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
GcsSource.Builder	mergeFrom(GcsSource other)
GcsSource.Builder	mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
GcsSource.Builder	mergeFrom(com.google.protobuf.Message other)
GcsSource.Builder	mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
GcsSource.Builder	setDataSchema(String value)	The schema to use when parsing the data from the source.
GcsSource.Builder	setDataSchemaBytes(com.google.protobuf.ByteString value)	The schema to use when parsing the data from the source.
GcsSource.Builder	setField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
GcsSource.Builder	setInputUris(int index, String value)	Required.
GcsSource.Builder	setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value)
GcsSource.Builder	setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)

Methods inherited from class com.google.protobuf.GeneratedMessageV3.Builder

getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, getUnknownFieldSetBuilder, hasField, hasOneof, internalGetMapField, internalGetMutableMapField, isClean, markClean, mergeUnknownLengthDelimitedField, mergeUnknownVarintField, newBuilderForField, onBuilt, onChanged, parseUnknownField, setUnknownFieldSetBuilder, setUnknownFieldsProto3

Methods inherited from class com.google.protobuf.AbstractMessage.Builder

findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite.Builder

addAll, addAll, mergeDelimitedFrom, mergeDelimitedFrom, mergeFrom, newUninitializedMessageException

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.Message.Builder

mergeDelimitedFrom, mergeDelimitedFrom

Methods inherited from interface com.google.protobuf.MessageLite.Builder

mergeFrom

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Method Detail

getDescriptor

public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

internalGetFieldAccessorTable

protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Specified by:

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3.Builder<GcsSource.Builder>

clear

public GcsSource.Builder clear()

Specified by:

clear in interface com.google.protobuf.Message.Builder

Specified by:

clear in interface com.google.protobuf.MessageLite.Builder

Overrides:

clear in class com.google.protobuf.GeneratedMessageV3.Builder<GcsSource.Builder>

getDescriptorForType

public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()

Specified by:

getDescriptorForType in interface com.google.protobuf.Message.Builder

Specified by:

getDescriptorForType in interface com.google.protobuf.MessageOrBuilder

Overrides:

getDescriptorForType in class com.google.protobuf.GeneratedMessageV3.Builder<GcsSource.Builder>

getDefaultInstanceForType

public GcsSource getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder

build

public GcsSource build()

Specified by:

build in interface com.google.protobuf.Message.Builder

Specified by:

build in interface com.google.protobuf.MessageLite.Builder

buildPartial

public GcsSource buildPartial()

Specified by:

buildPartial in interface com.google.protobuf.Message.Builder

Specified by:

buildPartial in interface com.google.protobuf.MessageLite.Builder

clone

public GcsSource.Builder clone()

Specified by:

clone in interface com.google.protobuf.Message.Builder

Specified by:

clone in interface com.google.protobuf.MessageLite.Builder

Overrides:

clone in class com.google.protobuf.GeneratedMessageV3.Builder<GcsSource.Builder>

setField

public GcsSource.Builder setField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                  Object value)

Specified by:

setField in interface com.google.protobuf.Message.Builder

Overrides:

setField in class com.google.protobuf.GeneratedMessageV3.Builder<GcsSource.Builder>

clearField

public GcsSource.Builder clearField(com.google.protobuf.Descriptors.FieldDescriptor field)

Specified by:

clearField in interface com.google.protobuf.Message.Builder

Overrides:

clearField in class com.google.protobuf.GeneratedMessageV3.Builder<GcsSource.Builder>

clearOneof

public GcsSource.Builder clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)

Specified by:

clearOneof in interface com.google.protobuf.Message.Builder

Overrides:

clearOneof in class com.google.protobuf.GeneratedMessageV3.Builder<GcsSource.Builder>

setRepeatedField

public GcsSource.Builder setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                          int index,
                                          Object value)

Specified by:

setRepeatedField in interface com.google.protobuf.Message.Builder

Overrides:

setRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<GcsSource.Builder>

addRepeatedField

public GcsSource.Builder addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                          Object value)

Specified by:

addRepeatedField in interface com.google.protobuf.Message.Builder

Overrides:

addRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<GcsSource.Builder>

mergeFrom

public GcsSource.Builder mergeFrom(com.google.protobuf.Message other)

Specified by:

mergeFrom in interface com.google.protobuf.Message.Builder

Overrides:

mergeFrom in class com.google.protobuf.AbstractMessage.Builder<GcsSource.Builder>

mergeFrom

public GcsSource.Builder mergeFrom(GcsSource other)

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessageV3.Builder<GcsSource.Builder>

mergeFrom

public GcsSource.Builder mergeFrom(com.google.protobuf.CodedInputStream input,
                                   com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                            throws IOException

Specified by:

mergeFrom in interface com.google.protobuf.Message.Builder

Specified by:

mergeFrom in interface com.google.protobuf.MessageLite.Builder

Overrides:

mergeFrom in class com.google.protobuf.AbstractMessage.Builder<GcsSource.Builder>

Throws:

IOException

getInputUrisList

public com.google.protobuf.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](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];

Specified by:

getInputUrisList in interface GcsSourceOrBuilder

Returns:

A list containing the inputUris.

getInputUrisCount

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](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];

Specified by:

getInputUrisCount in interface GcsSourceOrBuilder

Returns:

The count of inputUris.

getInputUris

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](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];

Specified by:

getInputUris in interface GcsSourceOrBuilder

Parameters:

index - The index of the element to return.

Returns:

The inputUris at the given index.

getInputUrisBytes

public 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];

Specified by:

getInputUrisBytes in interface GcsSourceOrBuilder

Parameters:

index - The index of the value to return.

Returns:

The bytes of the inputUris at the given index.

setInputUris

public GcsSource.Builder setInputUris(int index,
                                      String value)

 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 to set the value at.

value - The inputUris to set.

Returns:

This builder for chaining.

addInputUris

public GcsSource.Builder addInputUris(String value)

 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:

value - The inputUris to add.

Returns:

This builder for chaining.

addAllInputUris

public GcsSource.Builder addAllInputUris(Iterable<String> values)

 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:

values - The inputUris to add.

Returns:

This builder for chaining.

clearInputUris

public GcsSource.Builder clearInputUris()

 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:

This builder for chaining.

addInputUrisBytes

public GcsSource.Builder addInputUrisBytes(com.google.protobuf.ByteString value)

 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:

value - The bytes of the inputUris to add.

Returns:

This builder for chaining.

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][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;

Specified by:

getDataSchema in interface GcsSourceOrBuilder

Returns:

The dataSchema.

getDataSchemaBytes

public 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;

Specified by:

getDataSchemaBytes in interface GcsSourceOrBuilder

Returns:

The bytes for dataSchema.

setDataSchema

public GcsSource.Builder setDataSchema(String value)

 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;

Parameters:

value - The dataSchema to set.

Returns:

This builder for chaining.

clearDataSchema

public GcsSource.Builder clearDataSchema()

 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:

This builder for chaining.

setDataSchemaBytes

public GcsSource.Builder setDataSchemaBytes(com.google.protobuf.ByteString value)

 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;

Parameters:

value - The bytes for dataSchema to set.

Returns:

This builder for chaining.

setUnknownFields

public final GcsSource.Builder setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)

Specified by:

setUnknownFields in interface com.google.protobuf.Message.Builder

Overrides:

setUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<GcsSource.Builder>

mergeUnknownFields

public final GcsSource.Builder mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)

Specified by:

mergeUnknownFields in interface com.google.protobuf.Message.Builder

Overrides:

mergeUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<GcsSource.Builder>