protos

package
v0.0.4 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Feb 2, 2023 License: Apache-2.0 Imports: 5 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

View Source
var (
	// BigQuery field schema generation options.
	//
	// optional gen_bq_schema.BigQueryFieldOptions bigquery = 1021;
	E_Bigquery = &file_bq_field_proto_extTypes[0]
)

Extension fields to descriptorpb.FieldOptions.

View Source
var (
	// BigQuery message schema generation options.
	//
	// The field number is a globally unique id for this option, assigned by
	// protobuf-global-extension-registry@google.com
	//
	// optional gen_bq_schema.BigQueryMessageOptions bigquery_opts = 1021;
	E_BigqueryOpts = &file_bq_table_proto_extTypes[0]
)

Extension fields to descriptorpb.MessageOptions.

View Source
var File_bq_field_proto protoreflect.FileDescriptor
View Source
var File_bq_table_proto protoreflect.FileDescriptor

Functions

This section is empty.

Types

type BigQueryFieldOptions

type BigQueryFieldOptions struct {

	// Flag to specify that a field should be marked as 'REQUIRED' when
	// used to generate schema for BigQuery.
	Require bool `protobuf:"varint,1,opt,name=require,proto3" json:"require,omitempty"`
	// Optionally override whatever type is resolved by the schema
	// generator. This is useful, for example, to store epoch timestamps
	// with the underlying 'TIMESTAMP' type, when normally, they would
	// be structured as 'INTEGER' fields.
	TypeOverride string `protobuf:"bytes,2,opt,name=type_override,json=typeOverride,proto3" json:"type_override,omitempty"`
	// Optionally omit a field from BigQuery schema.
	Ignore bool `protobuf:"varint,3,opt,name=ignore,proto3" json:"ignore,omitempty"`
	// Set the description for a field in BigQuery schema.
	Description string `protobuf:"bytes,4,opt,name=description,proto3" json:"description,omitempty"`
	// Customize the name of the field in the BigQuery schema.
	Name string `protobuf:"bytes,5,opt,name=name,proto3" json:"name,omitempty"`
	// Optionally add PolicyTag for a field in BigQuery schema.
	PolicyTags string `protobuf:"bytes,6,opt,name=policy_tags,json=policyTags,proto3" json:"policy_tags,omitempty"`
	// Whether is primary key, doesn't impact table schema but can be looked up later (for example for generating materialized views).
	IsPrimary bool `protobuf:"varint,20,opt,name=is_primary,json=isPrimary,proto3" json:"is_primary,omitempty"`
	// Whether to create first_seen in materialized view for a timestamp type field
	MaterializeFirstSeen bool `protobuf:"varint,21,opt,name=materialize_first_seen,json=materializeFirstSeen,proto3" json:"materialize_first_seen,omitempty"`
	// Whether to ignore nulls for a field when generating the materialized view (ignore null values, provide latest non null value)
	MaterializeIgnoreNulls bool `` /* 131-byte string literal not displayed */
	// Create additional tables materializing this field as GROUP BY and exposing latest record for that group
	Materialize bool `protobuf:"varint,23,opt,name=materialize,proto3" json:"materialize,omitempty"`
	// What time period to partition this table by (can only be used on one field, options are "HOUR", "DAY", "MONTH", "YEAR")
	TimePartitionType string `protobuf:"bytes,24,opt,name=time_partition_type,json=timePartitionType,proto3" json:"time_partition_type,omitempty"`
	// contains filtered or unexported fields
}

Message containing options related to BigQuery schema generation and management via Protobuf.

func (*BigQueryFieldOptions) Descriptor deprecated

func (*BigQueryFieldOptions) Descriptor() ([]byte, []int)

Deprecated: Use BigQueryFieldOptions.ProtoReflect.Descriptor instead.

func (*BigQueryFieldOptions) GetDescription

func (x *BigQueryFieldOptions) GetDescription() string

func (*BigQueryFieldOptions) GetIgnore

func (x *BigQueryFieldOptions) GetIgnore() bool

func (*BigQueryFieldOptions) GetIsPrimary

func (x *BigQueryFieldOptions) GetIsPrimary() bool

func (*BigQueryFieldOptions) GetMaterialize

func (x *BigQueryFieldOptions) GetMaterialize() bool

func (*BigQueryFieldOptions) GetMaterializeFirstSeen

func (x *BigQueryFieldOptions) GetMaterializeFirstSeen() bool

func (*BigQueryFieldOptions) GetMaterializeIgnoreNulls

func (x *BigQueryFieldOptions) GetMaterializeIgnoreNulls() bool

func (*BigQueryFieldOptions) GetName

func (x *BigQueryFieldOptions) GetName() string

func (*BigQueryFieldOptions) GetPolicyTags

func (x *BigQueryFieldOptions) GetPolicyTags() string

func (*BigQueryFieldOptions) GetRequire

func (x *BigQueryFieldOptions) GetRequire() bool

func (*BigQueryFieldOptions) GetTimePartitionType

func (x *BigQueryFieldOptions) GetTimePartitionType() string

func (*BigQueryFieldOptions) GetTypeOverride

func (x *BigQueryFieldOptions) GetTypeOverride() string

func (*BigQueryFieldOptions) ProtoMessage

func (*BigQueryFieldOptions) ProtoMessage()

func (*BigQueryFieldOptions) ProtoReflect

func (x *BigQueryFieldOptions) ProtoReflect() protoreflect.Message

func (*BigQueryFieldOptions) Reset

func (x *BigQueryFieldOptions) Reset()

func (*BigQueryFieldOptions) String

func (x *BigQueryFieldOptions) String() string

type BigQueryMessageOptions

type BigQueryMessageOptions struct {

	// Specifies a name of table in BigQuery for the message.
	//
	// If not blank, indicates the message is a type of record to be stored into BigQuery.
	TableName string `protobuf:"bytes,1,opt,name=table_name,json=tableName,proto3" json:"table_name,omitempty"`
	// If true, BigQuery field names will default to a field's JSON name,
	// not its original/proto field name.
	UseJsonNames bool `protobuf:"varint,2,opt,name=use_json_names,json=useJsonNames,proto3" json:"use_json_names,omitempty"`
	// If set, adds defined extra fields to a JSON representation of the message.
	// Value format: "<field name>:<BigQuery field type>" for basic types
	// or "<field name>:RECORD:<protobuf type>" for message types.
	// "NULLABLE" by default, different mode may be set via optional suffix ":<mode>"
	ExtraFields []string `protobuf:"bytes,3,rep,name=extra_fields,json=extraFields,proto3" json:"extra_fields,omitempty"`
	// If set, execute specified sql file to create schema, use for extra views or materialized tables
	Sql []string `protobuf:"bytes,10,rep,name=sql,proto3" json:"sql,omitempty"`
	// If set, skip using the schema to create this table (use with sql option)
	SkipSchema bool `protobuf:"varint,11,opt,name=skip_schema,json=skipSchema,proto3" json:"skip_schema,omitempty"`
	// contains filtered or unexported fields
}

func (*BigQueryMessageOptions) Descriptor deprecated

func (*BigQueryMessageOptions) Descriptor() ([]byte, []int)

Deprecated: Use BigQueryMessageOptions.ProtoReflect.Descriptor instead.

func (*BigQueryMessageOptions) GetExtraFields

func (x *BigQueryMessageOptions) GetExtraFields() []string

func (*BigQueryMessageOptions) GetSkipSchema added in v0.0.4

func (x *BigQueryMessageOptions) GetSkipSchema() bool

func (*BigQueryMessageOptions) GetSql added in v0.0.4

func (x *BigQueryMessageOptions) GetSql() []string

func (*BigQueryMessageOptions) GetTableName

func (x *BigQueryMessageOptions) GetTableName() string

func (*BigQueryMessageOptions) GetUseJsonNames

func (x *BigQueryMessageOptions) GetUseJsonNames() bool

func (*BigQueryMessageOptions) ProtoMessage

func (*BigQueryMessageOptions) ProtoMessage()

func (*BigQueryMessageOptions) ProtoReflect

func (x *BigQueryMessageOptions) ProtoReflect() protoreflect.Message

func (*BigQueryMessageOptions) Reset

func (x *BigQueryMessageOptions) Reset()

func (*BigQueryMessageOptions) String

func (x *BigQueryMessageOptions) String() string

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL