com.google.cloud.retail.v2

Class BigQuerySource

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessageV3

com.google.cloud.retail.v2.BigQuerySource

All Implemented Interfaces:

BigQuerySourceOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable

public final class BigQuerySource
extends com.google.protobuf.GeneratedMessageV3
implements BigQuerySourceOrBuilder

 BigQuery source import data from.
 

Protobuf type google.cloud.retail.v2.BigQuerySource

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	BigQuerySource.Builder BigQuery source import data from.
static class	BigQuerySource.PartitionCase

Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

Field Summary

Fields

Modifier and Type	Field and Description
static int	DATA_SCHEMA_FIELD_NUMBER
static int	DATASET_ID_FIELD_NUMBER
static int	GCS_STAGING_DIR_FIELD_NUMBER
static int	PARTITION_DATE_FIELD_NUMBER
static int	PROJECT_ID_FIELD_NUMBER
static int	TABLE_ID_FIELD_NUMBER

Fields inherited from class com.google.protobuf.GeneratedMessageV3

alwaysUseFieldBuilders, unknownFields

Fields inherited from class com.google.protobuf.AbstractMessage

memoizedSize

Fields inherited from class com.google.protobuf.AbstractMessageLite

memoizedHashCode

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
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.
String	getDatasetId() Required.
com.google.protobuf.ByteString	getDatasetIdBytes() Required.
static BigQuerySource	getDefaultInstance()
BigQuerySource	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
String	getGcsStagingDir() Intermediate Cloud Storage directory used for the import with a length limit of 2,000 characters.
com.google.protobuf.ByteString	getGcsStagingDirBytes() Intermediate Cloud Storage directory used for the import with a length limit of 2,000 characters.
com.google.protobuf.Parser<BigQuerySource>	getParserForType()
BigQuerySource.PartitionCase	getPartitionCase()
com.google.type.Date	getPartitionDate() BigQuery time partitioned table's _PARTITIONDATE in YYYY-MM-DD format.
com.google.type.DateOrBuilder	getPartitionDateOrBuilder() BigQuery time partitioned table's _PARTITIONDATE in YYYY-MM-DD format.
String	getProjectId() The project ID (can be project # or ID) that the BigQuery source is in with a length limit of 128 characters.
com.google.protobuf.ByteString	getProjectIdBytes() The project ID (can be project # or ID) that the BigQuery source is in with a length limit of 128 characters.
int	getSerializedSize()
String	getTableId() Required.
com.google.protobuf.ByteString	getTableIdBytes() Required.
int	hashCode()
boolean	hasPartitionDate() BigQuery time partitioned table's _PARTITIONDATE in YYYY-MM-DD format.
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
static BigQuerySource.Builder	newBuilder()
static BigQuerySource.Builder	newBuilder(BigQuerySource prototype)
BigQuerySource.Builder	newBuilderForType()
protected BigQuerySource.Builder	newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
protected Object	newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
static BigQuerySource	parseDelimitedFrom(InputStream input)
static BigQuerySource	parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static BigQuerySource	parseFrom(byte[] data)
static BigQuerySource	parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static BigQuerySource	parseFrom(ByteBuffer data)
static BigQuerySource	parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static BigQuerySource	parseFrom(com.google.protobuf.ByteString data)
static BigQuerySource	parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static BigQuerySource	parseFrom(com.google.protobuf.CodedInputStream input)
static BigQuerySource	parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static BigQuerySource	parseFrom(InputStream input)
static BigQuerySource	parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<BigQuerySource>	parser()
BigQuerySource.Builder	toBuilder()
void	writeTo(com.google.protobuf.CodedOutputStream output)

Methods inherited from class com.google.protobuf.GeneratedMessageV3

canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

Methods inherited from class com.google.protobuf.AbstractMessage

findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite

addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

Methods inherited from interface com.google.protobuf.MessageLite

toByteArray, toByteString, writeDelimitedTo, writeTo

Field Detail

PARTITION_DATE_FIELD_NUMBER

public static final int PARTITION_DATE_FIELD_NUMBER

See Also:

Constant Field Values

PROJECT_ID_FIELD_NUMBER

public static final int PROJECT_ID_FIELD_NUMBER

See Also:

Constant Field Values

DATASET_ID_FIELD_NUMBER

public static final int DATASET_ID_FIELD_NUMBER

See Also:

Constant Field Values

TABLE_ID_FIELD_NUMBER

public static final int TABLE_ID_FIELD_NUMBER

See Also:

Constant Field Values

GCS_STAGING_DIR_FIELD_NUMBER

public static final int GCS_STAGING_DIR_FIELD_NUMBER

See Also:

Constant Field Values

DATA_SCHEMA_FIELD_NUMBER

public static final int DATA_SCHEMA_FIELD_NUMBER

See Also:

Constant Field Values

Method Detail

newInstance

protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)

Overrides:

newInstance in class com.google.protobuf.GeneratedMessageV3

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

getPartitionCase

public BigQuerySource.PartitionCase getPartitionCase()

Specified by:

getPartitionCase in interface BigQuerySourceOrBuilder

hasPartitionDate

public boolean hasPartitionDate()

 BigQuery time partitioned table's _PARTITIONDATE in YYYY-MM-DD format.

 Only supported in
 [ImportProductsRequest][google.cloud.retail.v2.ImportProductsRequest].
 

.google.type.Date partition_date = 6;

Specified by:

hasPartitionDate in interface BigQuerySourceOrBuilder

Returns:

Whether the partitionDate field is set.

getPartitionDate

public com.google.type.Date getPartitionDate()

 BigQuery time partitioned table's _PARTITIONDATE in YYYY-MM-DD format.

 Only supported in
 [ImportProductsRequest][google.cloud.retail.v2.ImportProductsRequest].
 

.google.type.Date partition_date = 6;

Specified by:

getPartitionDate in interface BigQuerySourceOrBuilder

Returns:

The partitionDate.

getPartitionDateOrBuilder

public com.google.type.DateOrBuilder getPartitionDateOrBuilder()

 BigQuery time partitioned table's _PARTITIONDATE in YYYY-MM-DD format.

 Only supported in
 [ImportProductsRequest][google.cloud.retail.v2.ImportProductsRequest].
 

.google.type.Date partition_date = 6;

Specified by:

getPartitionDateOrBuilder in interface BigQuerySourceOrBuilder

getProjectId

public String getProjectId()

 The project ID (can be project # or ID) that the BigQuery source is in with
 a length limit of 128 characters. If not specified, inherits the project
 ID from the parent request.
 

string project_id = 5;

Specified by:

getProjectId in interface BigQuerySourceOrBuilder

Returns:

The projectId.

getProjectIdBytes

public com.google.protobuf.ByteString getProjectIdBytes()

 The project ID (can be project # or ID) that the BigQuery source is in with
 a length limit of 128 characters. If not specified, inherits the project
 ID from the parent request.
 

string project_id = 5;

Specified by:

getProjectIdBytes in interface BigQuerySourceOrBuilder

Returns:

The bytes for projectId.

getDatasetId

public String getDatasetId()

 Required. The BigQuery data set to copy the data from with a length limit
 of 1,024 characters.
 

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

Specified by:

getDatasetId in interface BigQuerySourceOrBuilder

Returns:

The datasetId.

getDatasetIdBytes

public com.google.protobuf.ByteString getDatasetIdBytes()

 Required. The BigQuery data set to copy the data from with a length limit
 of 1,024 characters.
 

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

Specified by:

getDatasetIdBytes in interface BigQuerySourceOrBuilder

Returns:

The bytes for datasetId.

getTableId

public String getTableId()

 Required. The BigQuery table to copy the data from with a length limit of
 1,024 characters.
 

string table_id = 2 [(.google.api.field_behavior) = REQUIRED];

Specified by:

getTableId in interface BigQuerySourceOrBuilder

Returns:

The tableId.

getTableIdBytes

public com.google.protobuf.ByteString getTableIdBytes()

 Required. The BigQuery table to copy the data from with a length limit of
 1,024 characters.
 

string table_id = 2 [(.google.api.field_behavior) = REQUIRED];

Specified by:

getTableIdBytes in interface BigQuerySourceOrBuilder

Returns:

The bytes for tableId.

getGcsStagingDir

public String getGcsStagingDir()

 Intermediate Cloud Storage directory used for the import with a length
 limit of 2,000 characters. Can be specified if one wants to have the
 BigQuery export to a specific Cloud Storage directory.
 

string gcs_staging_dir = 3;

Specified by:

getGcsStagingDir in interface BigQuerySourceOrBuilder

Returns:

The gcsStagingDir.

getGcsStagingDirBytes

public com.google.protobuf.ByteString getGcsStagingDirBytes()

 Intermediate Cloud Storage directory used for the import with a length
 limit of 2,000 characters. Can be specified if one wants to have the
 BigQuery export to a specific Cloud Storage directory.
 

string gcs_staging_dir = 3;

Specified by:

getGcsStagingDirBytes in interface BigQuerySourceOrBuilder

Returns:

The bytes for gcsStagingDir.

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`:
   The schema is available here:
   https://support.google.com/analytics/answer/3437719.
 * `user_event_ga4`:
   The schema is available here:
   https://support.google.com/analytics/answer/7029846.

 Supported values for autocomplete imports:

 * `suggestions` (default): One JSON completion suggestion per line.
 * `denylist`:  One JSON deny suggestion per line.
 * `allowlist`:  One JSON allow suggestion per line.
 

string data_schema = 4;

Specified by:

getDataSchema in interface BigQuerySourceOrBuilder

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`:
   The schema is available here:
   https://support.google.com/analytics/answer/3437719.
 * `user_event_ga4`:
   The schema is available here:
   https://support.google.com/analytics/answer/7029846.

 Supported values for autocomplete imports:

 * `suggestions` (default): One JSON completion suggestion per line.
 * `denylist`:  One JSON deny suggestion per line.
 * `allowlist`:  One JSON allow suggestion per line.
 

string data_schema = 4;

Specified by:

getDataSchemaBytes in interface BigQuerySourceOrBuilder

Returns:

The bytes for dataSchema.

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessageV3

writeTo

public void writeTo(com.google.protobuf.CodedOutputStream output)
             throws IOException

Specified by:

writeTo in interface com.google.protobuf.MessageLite

Overrides:

writeTo in class com.google.protobuf.GeneratedMessageV3

Throws:

IOException

getSerializedSize

public int getSerializedSize()

Specified by:

getSerializedSize in interface com.google.protobuf.MessageLite

Overrides:

getSerializedSize in class com.google.protobuf.GeneratedMessageV3

equals

public boolean equals(Object obj)

Specified by:

equals in interface com.google.protobuf.Message

Overrides:

equals in class com.google.protobuf.AbstractMessage

hashCode

public int hashCode()

Specified by:

hashCode in interface com.google.protobuf.Message

Overrides:

hashCode in class com.google.protobuf.AbstractMessage

parseFrom

public static BigQuerySource parseFrom(ByteBuffer data)
                                throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static BigQuerySource parseFrom(ByteBuffer data,
                                       com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static BigQuerySource parseFrom(com.google.protobuf.ByteString data)
                                throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static BigQuerySource parseFrom(com.google.protobuf.ByteString data,
                                       com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static BigQuerySource parseFrom(byte[] data)
                                throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static BigQuerySource parseFrom(byte[] data,
                                       com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static BigQuerySource parseFrom(InputStream input)
                                throws IOException

Throws:

IOException

parseFrom

public static BigQuerySource parseFrom(InputStream input,
                                       com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                throws IOException

Throws:

IOException

parseDelimitedFrom

public static BigQuerySource parseDelimitedFrom(InputStream input)
                                         throws IOException

Throws:

IOException

parseDelimitedFrom

public static BigQuerySource parseDelimitedFrom(InputStream input,
                                                com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                         throws IOException

Throws:

IOException

parseFrom

public static BigQuerySource parseFrom(com.google.protobuf.CodedInputStream input)
                                throws IOException

Throws:

IOException

parseFrom

public static BigQuerySource parseFrom(com.google.protobuf.CodedInputStream input,
                                       com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                throws IOException

Throws:

IOException

newBuilderForType

public BigQuerySource.Builder newBuilderForType()

Specified by:

newBuilderForType in interface com.google.protobuf.Message

Specified by:

newBuilderForType in interface com.google.protobuf.MessageLite

newBuilder

public static BigQuerySource.Builder newBuilder()

newBuilder

public static BigQuerySource.Builder newBuilder(BigQuerySource prototype)

toBuilder

public BigQuerySource.Builder toBuilder()

Specified by:

toBuilder in interface com.google.protobuf.Message

Specified by:

toBuilder in interface com.google.protobuf.MessageLite

newBuilderForType

protected BigQuerySource.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)

Specified by:

newBuilderForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstance

public static BigQuerySource getDefaultInstance()

parser

public static com.google.protobuf.Parser<BigQuerySource> parser()

getParserForType

public com.google.protobuf.Parser<BigQuerySource> getParserForType()

Specified by:

getParserForType in interface com.google.protobuf.Message

Specified by:

getParserForType in interface com.google.protobuf.MessageLite

Overrides:

getParserForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstanceForType

public BigQuerySource getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder