Class GcsSource.Builder (2.48.0)

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

Google Cloud Storage location for input content.

Protobuf type google.cloud.retail.v2.GcsSource

Implements

GcsSourceOrBuilder

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

Methods

addAllInputUris(Iterable<String> values)

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 for the expected file format and setup instructions.

repeated string input_uris = 1 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
values Iterable<String>

The inputUris to add.

Returns
Type Description
GcsSource.Builder

This builder for chaining.

addInputUris(String value)

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 for the expected file format and setup instructions.

repeated string input_uris = 1 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
value String

The inputUris to add.

Returns
Type Description
GcsSource.Builder

This builder for chaining.

addInputUrisBytes(ByteString value)

public GcsSource.Builder addInputUrisBytes(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 for the expected file format and setup instructions.

repeated string input_uris = 1 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
value ByteString

The bytes of the inputUris to add.

Returns
Type Description
GcsSource.Builder

This builder for chaining.

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public GcsSource.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
GcsSource.Builder
Overrides

build()

public GcsSource build()
Returns
Type Description
GcsSource

buildPartial()

public GcsSource buildPartial()
Returns
Type Description
GcsSource

clear()

public GcsSource.Builder clear()
Returns
Type Description
GcsSource.Builder
Overrides

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 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
GcsSource.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public GcsSource.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
GcsSource.Builder
Overrides

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 for the expected file format and setup instructions.

repeated string input_uris = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
GcsSource.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public GcsSource.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
GcsSource.Builder
Overrides

clone()

public GcsSource.Builder clone()
Returns
Type Description
GcsSource.Builder
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
Type Description
GcsSource

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

getInputUris(int index)

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.

getInputUrisBytes(int 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.

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 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.

getInputUrisList()

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
Type Description
ProtocolStringList

A list containing the inputUris.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(GcsSource other)

public GcsSource.Builder mergeFrom(GcsSource other)
Parameter
Name Description
other GcsSource
Returns
Type Description
GcsSource.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public GcsSource.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
GcsSource.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public GcsSource.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
GcsSource.Builder
Overrides

mergeUnknownFields(UnknownFieldSet unknownFields)

public final GcsSource.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
GcsSource.Builder
Overrides

setDataSchema(String value)

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

Parameter
Name Description
value String

The dataSchema to set.

Returns
Type Description
GcsSource.Builder

This builder for chaining.

setDataSchemaBytes(ByteString value)

public GcsSource.Builder setDataSchemaBytes(ByteString value)

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;

Parameter
Name Description
value ByteString

The bytes for dataSchema to set.

Returns
Type Description
GcsSource.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public GcsSource.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
GcsSource.Builder
Overrides

setInputUris(int index, String value)

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 for the expected file format and setup instructions.

repeated string input_uris = 1 [(.google.api.field_behavior) = REQUIRED];

Parameters
Name Description
index int

The index to set the value at.

value String

The inputUris to set.

Returns
Type Description
GcsSource.Builder

This builder for chaining.

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public GcsSource.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
GcsSource.Builder
Overrides

setUnknownFields(UnknownFieldSet unknownFields)

public final GcsSource.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
GcsSource.Builder
Overrides