Class BigQuerySource (0.44.0)

public final class BigQuerySource extends GeneratedMessageV3 implements BigQuerySourceOrBuilder

BigQuery source import data from.

Protobuf type google.cloud.discoveryengine.v1beta.BigQuerySource

Static Fields

DATASET_ID_FIELD_NUMBER

public static final int DATASET_ID_FIELD_NUMBER
Field Value
Type Description
int

DATA_SCHEMA_FIELD_NUMBER

public static final int DATA_SCHEMA_FIELD_NUMBER
Field Value
Type Description
int

GCS_STAGING_DIR_FIELD_NUMBER

public static final int GCS_STAGING_DIR_FIELD_NUMBER
Field Value
Type Description
int

PARTITION_DATE_FIELD_NUMBER

public static final int PARTITION_DATE_FIELD_NUMBER
Field Value
Type Description
int

PROJECT_ID_FIELD_NUMBER

public static final int PROJECT_ID_FIELD_NUMBER
Field Value
Type Description
int

TABLE_ID_FIELD_NUMBER

public static final int TABLE_ID_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static BigQuerySource getDefaultInstance()
Returns
Type Description
BigQuerySource

getDescriptor()

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

newBuilder()

public static BigQuerySource.Builder newBuilder()
Returns
Type Description
BigQuerySource.Builder

newBuilder(BigQuerySource prototype)

public static BigQuerySource.Builder newBuilder(BigQuerySource prototype)
Parameter
Name Description
prototype BigQuerySource
Returns
Type Description
BigQuerySource.Builder

parseDelimitedFrom(InputStream input)

public static BigQuerySource parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
BigQuerySource
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static BigQuerySource parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
BigQuerySource
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static BigQuerySource parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
BigQuerySource
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static BigQuerySource parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
BigQuerySource
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static BigQuerySource parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
BigQuerySource
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static BigQuerySource parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
BigQuerySource
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static BigQuerySource parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
BigQuerySource
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static BigQuerySource parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
BigQuerySource
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static BigQuerySource parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
BigQuerySource
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static BigQuerySource parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
BigQuerySource
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static BigQuerySource parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
BigQuerySource
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static BigQuerySource parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
BigQuerySource
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<BigQuerySource> parser()
Returns
Type Description
Parser<BigQuerySource>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
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 the GENERIC Data Store vertical.

string data_schema = 6;

Returns
Type Description
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 the GENERIC Data Store vertical.

string data_schema = 6;

Returns
Type Description
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
Type Description
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
Type Description
ByteString

The bytes for datasetId.

getDefaultInstanceForType()

public BigQuerySource getDefaultInstanceForType()
Returns
Type Description
BigQuerySource

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

The bytes for gcsStagingDir.

getParserForType()

public Parser<BigQuerySource> getParserForType()
Returns
Type Description
Parser<BigQuerySource>
Overrides

getPartitionCase()

public BigQuerySource.PartitionCase getPartitionCase()
Returns
Type Description
BigQuerySource.PartitionCase

getPartitionDate()

public Date getPartitionDate()

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

.google.type.Date partition_date = 5;

Returns
Type Description
com.google.type.Date

The partitionDate.

getPartitionDateOrBuilder()

public DateOrBuilder getPartitionDateOrBuilder()

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

.google.type.Date partition_date = 5;

Returns
Type Description
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
Type Description
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
Type Description
ByteString

The bytes for projectId.

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

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

Whether the partitionDate field is set.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public BigQuerySource.Builder newBuilderForType()
Returns
Type Description
BigQuerySource.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected BigQuerySource.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
BigQuerySource.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public BigQuerySource.Builder toBuilder()
Returns
Type Description
BigQuerySource.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException