Interface BigQueryConfigOrBuilder (0.12.0)

public interface BigQueryConfigOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

containsCloudFunctionMapping(String key)

public abstract boolean containsCloudFunctionMapping(String key)

Data Schema By default, Vision AI Application will try to write annotations to the target BigQuery table using the following schema:

ingestion_time: TIMESTAMP, the ingestion time of the original data.

application: STRING, name of the application which produces the annotation.

instance: STRING, Id of the instance which produces the annotation.

node: STRING, name of the application graph node which produces the annotation.

annotation: STRING or JSON, the actual annotation protobuf will be converted to json string with bytes field as 64 encoded string. It can be written to both String or Json type column.

To forward annotation data to an existing BigQuery table, customer needs to make sure the compatibility of the schema. The map maps application node name to its corresponding cloud function endpoint to transform the annotations directly to the google.cloud.bigquery.storage.v1.AppendRowsRequest (only avro_rows or proto_rows should be set). If configured, annotations produced by corresponding application node will sent to the Cloud Function at first before be forwarded to BigQuery.

If the default table schema doesn't fit, customer is able to transform the annotation output from Vision AI Application to arbitrary BigQuery table schema with CloudFunction.

  • The cloud function will receive AppPlatformCloudFunctionRequest where the annotations field will be the json format of Vision AI annotation.
  • The cloud function should return AppPlatformCloudFunctionResponse with AppendRowsRequest stored in the annotations field.
  • To drop the annotation, simply clear the annotations field in the returned AppPlatformCloudFunctionResponse.

map<string, string> cloud_function_mapping = 2;

Parameter
Name Description
key String
Returns
Type Description
boolean

getCloudFunctionMapping() (deprecated)

public abstract Map<String,String> getCloudFunctionMapping()
Returns
Type Description
Map<String,String>

getCloudFunctionMappingCount()

public abstract int getCloudFunctionMappingCount()

Data Schema By default, Vision AI Application will try to write annotations to the target BigQuery table using the following schema:

ingestion_time: TIMESTAMP, the ingestion time of the original data.

application: STRING, name of the application which produces the annotation.

instance: STRING, Id of the instance which produces the annotation.

node: STRING, name of the application graph node which produces the annotation.

annotation: STRING or JSON, the actual annotation protobuf will be converted to json string with bytes field as 64 encoded string. It can be written to both String or Json type column.

To forward annotation data to an existing BigQuery table, customer needs to make sure the compatibility of the schema. The map maps application node name to its corresponding cloud function endpoint to transform the annotations directly to the google.cloud.bigquery.storage.v1.AppendRowsRequest (only avro_rows or proto_rows should be set). If configured, annotations produced by corresponding application node will sent to the Cloud Function at first before be forwarded to BigQuery.

If the default table schema doesn't fit, customer is able to transform the annotation output from Vision AI Application to arbitrary BigQuery table schema with CloudFunction.

  • The cloud function will receive AppPlatformCloudFunctionRequest where the annotations field will be the json format of Vision AI annotation.
  • The cloud function should return AppPlatformCloudFunctionResponse with AppendRowsRequest stored in the annotations field.
  • To drop the annotation, simply clear the annotations field in the returned AppPlatformCloudFunctionResponse.

map<string, string> cloud_function_mapping = 2;

Returns
Type Description
int

getCloudFunctionMappingMap()

public abstract Map<String,String> getCloudFunctionMappingMap()

Data Schema By default, Vision AI Application will try to write annotations to the target BigQuery table using the following schema:

ingestion_time: TIMESTAMP, the ingestion time of the original data.

application: STRING, name of the application which produces the annotation.

instance: STRING, Id of the instance which produces the annotation.

node: STRING, name of the application graph node which produces the annotation.

annotation: STRING or JSON, the actual annotation protobuf will be converted to json string with bytes field as 64 encoded string. It can be written to both String or Json type column.

To forward annotation data to an existing BigQuery table, customer needs to make sure the compatibility of the schema. The map maps application node name to its corresponding cloud function endpoint to transform the annotations directly to the google.cloud.bigquery.storage.v1.AppendRowsRequest (only avro_rows or proto_rows should be set). If configured, annotations produced by corresponding application node will sent to the Cloud Function at first before be forwarded to BigQuery.

If the default table schema doesn't fit, customer is able to transform the annotation output from Vision AI Application to arbitrary BigQuery table schema with CloudFunction.

  • The cloud function will receive AppPlatformCloudFunctionRequest where the annotations field will be the json format of Vision AI annotation.
  • The cloud function should return AppPlatformCloudFunctionResponse with AppendRowsRequest stored in the annotations field.
  • To drop the annotation, simply clear the annotations field in the returned AppPlatformCloudFunctionResponse.

map<string, string> cloud_function_mapping = 2;

Returns
Type Description
Map<String,String>

getCloudFunctionMappingOrDefault(String key, String defaultValue)

public abstract String getCloudFunctionMappingOrDefault(String key, String defaultValue)

Data Schema By default, Vision AI Application will try to write annotations to the target BigQuery table using the following schema:

ingestion_time: TIMESTAMP, the ingestion time of the original data.

application: STRING, name of the application which produces the annotation.

instance: STRING, Id of the instance which produces the annotation.

node: STRING, name of the application graph node which produces the annotation.

annotation: STRING or JSON, the actual annotation protobuf will be converted to json string with bytes field as 64 encoded string. It can be written to both String or Json type column.

To forward annotation data to an existing BigQuery table, customer needs to make sure the compatibility of the schema. The map maps application node name to its corresponding cloud function endpoint to transform the annotations directly to the google.cloud.bigquery.storage.v1.AppendRowsRequest (only avro_rows or proto_rows should be set). If configured, annotations produced by corresponding application node will sent to the Cloud Function at first before be forwarded to BigQuery.

If the default table schema doesn't fit, customer is able to transform the annotation output from Vision AI Application to arbitrary BigQuery table schema with CloudFunction.

  • The cloud function will receive AppPlatformCloudFunctionRequest where the annotations field will be the json format of Vision AI annotation.
  • The cloud function should return AppPlatformCloudFunctionResponse with AppendRowsRequest stored in the annotations field.
  • To drop the annotation, simply clear the annotations field in the returned AppPlatformCloudFunctionResponse.

map<string, string> cloud_function_mapping = 2;

Parameters
Name Description
key String
defaultValue String
Returns
Type Description
String

getCloudFunctionMappingOrThrow(String key)

public abstract String getCloudFunctionMappingOrThrow(String key)

Data Schema By default, Vision AI Application will try to write annotations to the target BigQuery table using the following schema:

ingestion_time: TIMESTAMP, the ingestion time of the original data.

application: STRING, name of the application which produces the annotation.

instance: STRING, Id of the instance which produces the annotation.

node: STRING, name of the application graph node which produces the annotation.

annotation: STRING or JSON, the actual annotation protobuf will be converted to json string with bytes field as 64 encoded string. It can be written to both String or Json type column.

To forward annotation data to an existing BigQuery table, customer needs to make sure the compatibility of the schema. The map maps application node name to its corresponding cloud function endpoint to transform the annotations directly to the google.cloud.bigquery.storage.v1.AppendRowsRequest (only avro_rows or proto_rows should be set). If configured, annotations produced by corresponding application node will sent to the Cloud Function at first before be forwarded to BigQuery.

If the default table schema doesn't fit, customer is able to transform the annotation output from Vision AI Application to arbitrary BigQuery table schema with CloudFunction.

  • The cloud function will receive AppPlatformCloudFunctionRequest where the annotations field will be the json format of Vision AI annotation.
  • The cloud function should return AppPlatformCloudFunctionResponse with AppendRowsRequest stored in the annotations field.
  • To drop the annotation, simply clear the annotations field in the returned AppPlatformCloudFunctionResponse.

map<string, string> cloud_function_mapping = 2;

Parameter
Name Description
key String
Returns
Type Description
String

getCreateDefaultTableIfNotExists()

public abstract boolean getCreateDefaultTableIfNotExists()

If true, App Platform will create the BigQuery DataSet and the BigQuery Table with default schema if the specified table doesn't exist. This doesn't work if any cloud function customized schema is specified since the system doesn't know your desired schema. JSON column will be used in the default table created by App Platform.

bool create_default_table_if_not_exists = 3;

Returns
Type Description
boolean

The createDefaultTableIfNotExists.

getTable()

public abstract String getTable()

BigQuery table resource for Vision AI Platform to ingest annotations to.

string table = 1;

Returns
Type Description
String

The table.

getTableBytes()

public abstract ByteString getTableBytes()

BigQuery table resource for Vision AI Platform to ingest annotations to.

string table = 1;

Returns
Type Description
ByteString

The bytes for table.