Interface BigQuerySourceOrBuilder (0.31.0)

public interface BigQuerySourceOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getDataSchema()

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

getGcsStagingDir()

public abstract 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 abstract 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 abstract BigQuerySource.PartitionCase getPartitionCase()
Returns
TypeDescription
BigQuerySource.PartitionCase

getPartitionDate()

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

getPartitionDateOrBuilder()

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