Class BigQuerySource.Builder (0.37.0)

public static final class BigQuerySource.Builder extends GeneratedMessageV3.Builder<BigQuerySource.Builder> implements BigQuerySourceOrBuilder

BigQuery source import data from.

Protobuf type google.cloud.discoveryengine.v1.BigQuerySource

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public BigQuerySource.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
BigQuerySource.Builder
Overrides

build()

public BigQuerySource build()
Returns
TypeDescription
BigQuerySource

buildPartial()

public BigQuerySource buildPartial()
Returns
TypeDescription
BigQuerySource

clear()

public BigQuerySource.Builder clear()
Returns
TypeDescription
BigQuerySource.Builder
Overrides

clearDataSchema()

public BigQuerySource.Builder clearDataSchema()

The schema to use when parsing the data from the source.

Supported values for user event imports:

  • user_event (default): One UserEvent per row.

    Supported values for document imports:

  • document (default): One Document format per row. Each document must have a valid Document.id and one of Document.json_data or Document.struct_data.

  • custom: One custom data per row in arbitrary format that conforms to the defined Schema of the data store. This can only be used by Gen App Builder.

string data_schema = 6;

Returns
TypeDescription
BigQuerySource.Builder

This builder for chaining.

clearDatasetId()

public BigQuerySource.Builder clearDatasetId()

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

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

Returns
TypeDescription
BigQuerySource.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public BigQuerySource.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
NameDescription
fieldFieldDescriptor
Returns
TypeDescription
BigQuerySource.Builder
Overrides

clearGcsStagingDir()

public BigQuerySource.Builder clearGcsStagingDir()

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

Returns
TypeDescription
BigQuerySource.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public BigQuerySource.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
NameDescription
oneofOneofDescriptor
Returns
TypeDescription
BigQuerySource.Builder
Overrides

clearPartition()

public BigQuerySource.Builder clearPartition()
Returns
TypeDescription
BigQuerySource.Builder

clearPartitionDate()

public BigQuerySource.Builder clearPartitionDate()

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

.google.type.Date partition_date = 5;

Returns
TypeDescription
BigQuerySource.Builder

clearProjectId()

public BigQuerySource.Builder clearProjectId()

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

Returns
TypeDescription
BigQuerySource.Builder

This builder for chaining.

clearTableId()

public BigQuerySource.Builder clearTableId()

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

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

Returns
TypeDescription
BigQuerySource.Builder

This builder for chaining.

clone()

public BigQuerySource.Builder clone()
Returns
TypeDescription
BigQuerySource.Builder
Overrides

getDataSchema()

public String getDataSchema()

The schema to use when parsing the data from the source.

Supported values for user event imports:

  • user_event (default): One UserEvent per row.

    Supported values for document imports:

  • document (default): One Document format per row. Each document must have a valid Document.id and one of Document.json_data or Document.struct_data.

  • custom: One custom data per row in arbitrary format that conforms to the defined Schema of the data store. This can only be used by Gen App Builder.

string data_schema = 6;

Returns
TypeDescription
String

The dataSchema.

getDataSchemaBytes()

public ByteString getDataSchemaBytes()

The schema to use when parsing the data from the source.

Supported values for user event imports:

  • user_event (default): One UserEvent per row.

    Supported values for document imports:

  • document (default): One Document format per row. Each document must have a valid Document.id and one of Document.json_data or Document.struct_data.

  • custom: One custom data per row in arbitrary format that conforms to the defined Schema of the data store. This can only be used by Gen App Builder.

string data_schema = 6;

Returns
TypeDescription
ByteString

The bytes for dataSchema.

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 = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
String

The datasetId.

getDatasetIdBytes()

public ByteString getDatasetIdBytes()

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

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

Returns
TypeDescription
ByteString

The bytes for datasetId.

getDefaultInstanceForType()

public BigQuerySource getDefaultInstanceForType()
Returns
TypeDescription
BigQuerySource

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
TypeDescription
Descriptor
Overrides

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

Returns
TypeDescription
String

The gcsStagingDir.

getGcsStagingDirBytes()

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

Returns
TypeDescription
ByteString

The bytes for gcsStagingDir.

getPartitionCase()

public BigQuerySource.PartitionCase getPartitionCase()
Returns
TypeDescription
BigQuerySource.PartitionCase

getPartitionDate()

public Date getPartitionDate()

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

.google.type.Date partition_date = 5;

Returns
TypeDescription
com.google.type.Date

The partitionDate.

getPartitionDateBuilder()

public Date.Builder getPartitionDateBuilder()

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

.google.type.Date partition_date = 5;

Returns
TypeDescription
com.google.type.Date.Builder

getPartitionDateOrBuilder()

public DateOrBuilder getPartitionDateOrBuilder()

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

.google.type.Date partition_date = 5;

Returns
TypeDescription
com.google.type.DateOrBuilder

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

Returns
TypeDescription
String

The projectId.

getProjectIdBytes()

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

Returns
TypeDescription
ByteString

The bytes for projectId.

getTableId()

public String getTableId()

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

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

Returns
TypeDescription
String

The tableId.

getTableIdBytes()

public ByteString getTableIdBytes()

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

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

Returns
TypeDescription
ByteString

The bytes for tableId.

hasPartitionDate()

public boolean hasPartitionDate()

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

.google.type.Date partition_date = 5;

Returns
TypeDescription
boolean

Whether the partitionDate field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

mergeFrom(BigQuerySource other)

public BigQuerySource.Builder mergeFrom(BigQuerySource other)
Parameter
NameDescription
otherBigQuerySource
Returns
TypeDescription
BigQuerySource.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public BigQuerySource.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
BigQuerySource.Builder
Overrides
Exceptions
TypeDescription
IOException

mergeFrom(Message other)

public BigQuerySource.Builder mergeFrom(Message other)
Parameter
NameDescription
otherMessage
Returns
TypeDescription
BigQuerySource.Builder
Overrides

mergePartitionDate(Date value)

public BigQuerySource.Builder mergePartitionDate(Date value)

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

.google.type.Date partition_date = 5;

Parameter
NameDescription
valuecom.google.type.Date
Returns
TypeDescription
BigQuerySource.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final BigQuerySource.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
BigQuerySource.Builder
Overrides

setDataSchema(String value)

public BigQuerySource.Builder setDataSchema(String value)

The schema to use when parsing the data from the source.

Supported values for user event imports:

  • user_event (default): One UserEvent per row.

    Supported values for document imports:

  • document (default): One Document format per row. Each document must have a valid Document.id and one of Document.json_data or Document.struct_data.

  • custom: One custom data per row in arbitrary format that conforms to the defined Schema of the data store. This can only be used by Gen App Builder.

string data_schema = 6;

Parameter
NameDescription
valueString

The dataSchema to set.

Returns
TypeDescription
BigQuerySource.Builder

This builder for chaining.

setDataSchemaBytes(ByteString value)

public BigQuerySource.Builder setDataSchemaBytes(ByteString value)

The schema to use when parsing the data from the source.

Supported values for user event imports:

  • user_event (default): One UserEvent per row.

    Supported values for document imports:

  • document (default): One Document format per row. Each document must have a valid Document.id and one of Document.json_data or Document.struct_data.

  • custom: One custom data per row in arbitrary format that conforms to the defined Schema of the data store. This can only be used by Gen App Builder.

string data_schema = 6;

Parameter
NameDescription
valueByteString

The bytes for dataSchema to set.

Returns
TypeDescription
BigQuerySource.Builder

This builder for chaining.

setDatasetId(String value)

public BigQuerySource.Builder setDatasetId(String value)

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

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

Parameter
NameDescription
valueString

The datasetId to set.

Returns
TypeDescription
BigQuerySource.Builder

This builder for chaining.

setDatasetIdBytes(ByteString value)

public BigQuerySource.Builder setDatasetIdBytes(ByteString value)

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

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

Parameter
NameDescription
valueByteString

The bytes for datasetId to set.

Returns
TypeDescription
BigQuerySource.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public BigQuerySource.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
BigQuerySource.Builder
Overrides

setGcsStagingDir(String value)

public BigQuerySource.Builder setGcsStagingDir(String value)

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

Parameter
NameDescription
valueString

The gcsStagingDir to set.

Returns
TypeDescription
BigQuerySource.Builder

This builder for chaining.

setGcsStagingDirBytes(ByteString value)

public BigQuerySource.Builder setGcsStagingDirBytes(ByteString value)

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

Parameter
NameDescription
valueByteString

The bytes for gcsStagingDir to set.

Returns
TypeDescription
BigQuerySource.Builder

This builder for chaining.

setPartitionDate(Date value)

public BigQuerySource.Builder setPartitionDate(Date value)

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

.google.type.Date partition_date = 5;

Parameter
NameDescription
valuecom.google.type.Date
Returns
TypeDescription
BigQuerySource.Builder

setPartitionDate(Date.Builder builderForValue)

public BigQuerySource.Builder setPartitionDate(Date.Builder builderForValue)

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

.google.type.Date partition_date = 5;

Parameter
NameDescription
builderForValuecom.google.type.Date.Builder
Returns
TypeDescription
BigQuerySource.Builder

setProjectId(String value)

public BigQuerySource.Builder setProjectId(String value)

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

Parameter
NameDescription
valueString

The projectId to set.

Returns
TypeDescription
BigQuerySource.Builder

This builder for chaining.

setProjectIdBytes(ByteString value)

public BigQuerySource.Builder setProjectIdBytes(ByteString value)

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

Parameter
NameDescription
valueByteString

The bytes for projectId to set.

Returns
TypeDescription
BigQuerySource.Builder

This builder for chaining.

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

public BigQuerySource.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
NameDescription
fieldFieldDescriptor
indexint
valueObject
Returns
TypeDescription
BigQuerySource.Builder
Overrides

setTableId(String value)

public BigQuerySource.Builder setTableId(String value)

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

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

Parameter
NameDescription
valueString

The tableId to set.

Returns
TypeDescription
BigQuerySource.Builder

This builder for chaining.

setTableIdBytes(ByteString value)

public BigQuerySource.Builder setTableIdBytes(ByteString value)

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

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

Parameter
NameDescription
valueByteString

The bytes for tableId to set.

Returns
TypeDescription
BigQuerySource.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final BigQuerySource.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
BigQuerySource.Builder
Overrides