firestoredata

package
v0.8.0 Latest Latest
Warning

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

Go to latest
Published: Mar 29, 2024 License: Apache-2.0 Imports: 7 Imported by: 7

Documentation

Overview

Package firestoredata provides Cloud Firestore type definitions for CloudEvent data payloads.

Supported CloudEvent Types

  • google.cloud.firestore.document.v1.created
  • google.cloud.firestore.document.v1.updated
  • google.cloud.firestore.document.v1.deleted
  • google.cloud.firestore.document.v1.written
  • google.cloud.firestore.document.v1.created.withAuthContext
  • google.cloud.firestore.document.v1.updated.withAuthContext
  • google.cloud.firestore.document.v1.deleted.withAuthContext
  • google.cloud.firestore.document.v1.written.withAuthContext

Index

Constants

This section is empty.

Variables

View Source
var File_cloud_firestore_v1_data_proto protoreflect.FileDescriptor

Functions

This section is empty.

Types

type ArrayValue

type ArrayValue struct {

	// Values in the array.
	Values []*Value `protobuf:"bytes,1,rep,name=values,proto3" json:"values,omitempty"`
	// contains filtered or unexported fields
}

An array value.

func (*ArrayValue) Descriptor deprecated

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

Deprecated: Use ArrayValue.ProtoReflect.Descriptor instead.

func (*ArrayValue) GetValues

func (x *ArrayValue) GetValues() []*Value

func (*ArrayValue) ProtoMessage

func (*ArrayValue) ProtoMessage()

func (*ArrayValue) ProtoReflect

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

func (*ArrayValue) Reset

func (x *ArrayValue) Reset()

func (*ArrayValue) String

func (x *ArrayValue) String() string

type Document

type Document struct {

	// The resource name of the document. For example:
	// `projects/{project_id}/databases/{database_id}/documents/{document_path}`
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// The document's fields.
	//
	// The map keys represent field names.
	//
	// A simple field name contains only characters `a` to `z`, `A` to `Z`,
	// `0` to `9`, or `_`, and must not start with `0` to `9`. For example,
	// `foo_bar_17`.
	//
	// Field names matching the regular expression `__.*__` are reserved. Reserved
	// field names are forbidden except in certain documented contexts. The map
	// keys, represented as UTF-8, must not exceed 1,500 bytes and cannot be
	// empty.
	//
	// Field paths may be used in other contexts to refer to structured fields
	// defined here. For `map_value`, the field path is represented by the simple
	// or quoted field names of the containing fields, delimited by `.`. For
	// example, the structured field
	// `"foo" : { map_value: { "x&y" : { string_value: "hello" }}}` would be
	// represented by the field path `foo.x&y`.
	//
	// Within a field path, a quoted field name starts and ends with “ ` “ and
	// may contain any character. Some characters, including “ ` “, must be
	// escaped using a `\`. For example, “ `x&y` “ represents `x&y` and
	// “ `bak\`tik` “ represents “ bak`tik “.
	Fields map[string]*Value `` /* 153-byte string literal not displayed */
	// The time at which the document was created.
	//
	// This value increases monotonically when a document is deleted then
	// recreated. It can also be compared to values from other documents and
	// the `read_time` of a query.
	CreateTime *timestamppb.Timestamp `protobuf:"bytes,3,opt,name=create_time,json=createTime,proto3" json:"create_time,omitempty"`
	// The time at which the document was last changed.
	//
	// This value is initially set to the `create_time` then increases
	// monotonically with each change to the document. It can also be
	// compared to values from other documents and the `read_time` of a query.
	UpdateTime *timestamppb.Timestamp `protobuf:"bytes,4,opt,name=update_time,json=updateTime,proto3" json:"update_time,omitempty"`
	// contains filtered or unexported fields
}

A Firestore document.

func (*Document) Descriptor deprecated

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

Deprecated: Use Document.ProtoReflect.Descriptor instead.

func (*Document) GetCreateTime

func (x *Document) GetCreateTime() *timestamppb.Timestamp

func (*Document) GetFields

func (x *Document) GetFields() map[string]*Value

func (*Document) GetName

func (x *Document) GetName() string

func (*Document) GetUpdateTime

func (x *Document) GetUpdateTime() *timestamppb.Timestamp

func (*Document) ProtoMessage

func (*Document) ProtoMessage()

func (*Document) ProtoReflect

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

func (*Document) Reset

func (x *Document) Reset()

func (*Document) String

func (x *Document) String() string

type DocumentEventData

type DocumentEventData struct {

	// A Document object containing a post-operation document snapshot.
	// This is not populated for delete events.
	Value *Document `protobuf:"bytes,1,opt,name=value,proto3" json:"value,omitempty"`
	// A Document object containing a pre-operation document snapshot.
	// This is only populated for update and delete events.
	OldValue *Document `protobuf:"bytes,2,opt,name=old_value,json=oldValue,proto3" json:"old_value,omitempty"`
	// A DocumentMask object that lists changed fields.
	// This is only populated for update events.
	UpdateMask *DocumentMask `protobuf:"bytes,3,opt,name=update_mask,json=updateMask,proto3" json:"update_mask,omitempty"`
	// contains filtered or unexported fields
}

The data within all Firestore document events.

func (*DocumentEventData) Descriptor deprecated

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

Deprecated: Use DocumentEventData.ProtoReflect.Descriptor instead.

func (*DocumentEventData) GetOldValue

func (x *DocumentEventData) GetOldValue() *Document

func (*DocumentEventData) GetUpdateMask

func (x *DocumentEventData) GetUpdateMask() *DocumentMask

func (*DocumentEventData) GetValue

func (x *DocumentEventData) GetValue() *Document

func (*DocumentEventData) ProtoMessage

func (*DocumentEventData) ProtoMessage()

func (*DocumentEventData) ProtoReflect

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

func (*DocumentEventData) Reset

func (x *DocumentEventData) Reset()

func (*DocumentEventData) String

func (x *DocumentEventData) String() string

type DocumentMask

type DocumentMask struct {

	// The list of field paths in the mask.
	// See [Document.fields][google.cloud.firestore.v1.events.Document.fields]
	// for a field path syntax reference.
	FieldPaths []string `protobuf:"bytes,1,rep,name=field_paths,json=fieldPaths,proto3" json:"field_paths,omitempty"`
	// contains filtered or unexported fields
}

A set of field paths on a document.

func (*DocumentMask) Descriptor deprecated

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

Deprecated: Use DocumentMask.ProtoReflect.Descriptor instead.

func (*DocumentMask) GetFieldPaths

func (x *DocumentMask) GetFieldPaths() []string

func (*DocumentMask) ProtoMessage

func (*DocumentMask) ProtoMessage()

func (*DocumentMask) ProtoReflect

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

func (*DocumentMask) Reset

func (x *DocumentMask) Reset()

func (*DocumentMask) String

func (x *DocumentMask) String() string

type MapValue

type MapValue struct {

	// The map's fields.
	//
	// The map keys represent field names. Field names matching the regular
	// expression `__.*__` are reserved. Reserved field names are forbidden except
	// in certain documented contexts. The map keys, represented as UTF-8, must
	// not exceed 1,500 bytes and cannot be empty.
	Fields map[string]*Value `` /* 153-byte string literal not displayed */
	// contains filtered or unexported fields
}

A map value.

func (*MapValue) Descriptor deprecated

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

Deprecated: Use MapValue.ProtoReflect.Descriptor instead.

func (*MapValue) GetFields

func (x *MapValue) GetFields() map[string]*Value

func (*MapValue) ProtoMessage

func (*MapValue) ProtoMessage()

func (*MapValue) ProtoReflect

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

func (*MapValue) Reset

func (x *MapValue) Reset()

func (*MapValue) String

func (x *MapValue) String() string

type Value

type Value struct {

	// Must have a value set.
	//
	// Types that are assignable to ValueType:
	//
	//	*Value_NullValue
	//	*Value_BooleanValue
	//	*Value_IntegerValue
	//	*Value_DoubleValue
	//	*Value_TimestampValue
	//	*Value_StringValue
	//	*Value_BytesValue
	//	*Value_ReferenceValue
	//	*Value_GeoPointValue
	//	*Value_ArrayValue
	//	*Value_MapValue
	ValueType isValue_ValueType `protobuf_oneof:"value_type"`
	// contains filtered or unexported fields
}

A message that can hold any of the supported value types.

func (*Value) Descriptor deprecated

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

Deprecated: Use Value.ProtoReflect.Descriptor instead.

func (*Value) GetArrayValue

func (x *Value) GetArrayValue() *ArrayValue

func (*Value) GetBooleanValue

func (x *Value) GetBooleanValue() bool

func (*Value) GetBytesValue

func (x *Value) GetBytesValue() []byte

func (*Value) GetDoubleValue

func (x *Value) GetDoubleValue() float64

func (*Value) GetGeoPointValue

func (x *Value) GetGeoPointValue() *latlng.LatLng

func (*Value) GetIntegerValue

func (x *Value) GetIntegerValue() int64

func (*Value) GetMapValue

func (x *Value) GetMapValue() *MapValue

func (*Value) GetNullValue

func (x *Value) GetNullValue() structpb.NullValue

func (*Value) GetReferenceValue

func (x *Value) GetReferenceValue() string

func (*Value) GetStringValue

func (x *Value) GetStringValue() string

func (*Value) GetTimestampValue

func (x *Value) GetTimestampValue() *timestamppb.Timestamp

func (*Value) GetValueType

func (m *Value) GetValueType() isValue_ValueType

func (*Value) ProtoMessage

func (*Value) ProtoMessage()

func (*Value) ProtoReflect

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

func (*Value) Reset

func (x *Value) Reset()

func (*Value) String

func (x *Value) String() string

type Value_ArrayValue

type Value_ArrayValue struct {
	// An array value.
	//
	// Cannot directly contain another array value, though can contain an
	// map which contains another array.
	ArrayValue *ArrayValue `protobuf:"bytes,9,opt,name=array_value,json=arrayValue,proto3,oneof"`
}

type Value_BooleanValue

type Value_BooleanValue struct {
	// A boolean value.
	BooleanValue bool `protobuf:"varint,1,opt,name=boolean_value,json=booleanValue,proto3,oneof"`
}

type Value_BytesValue

type Value_BytesValue struct {
	// A bytes value.
	//
	// Must not exceed 1 MiB - 89 bytes.
	// Only the first 1,500 bytes are considered by queries.
	BytesValue []byte `protobuf:"bytes,18,opt,name=bytes_value,json=bytesValue,proto3,oneof"`
}

type Value_DoubleValue

type Value_DoubleValue struct {
	// A double value.
	DoubleValue float64 `protobuf:"fixed64,3,opt,name=double_value,json=doubleValue,proto3,oneof"`
}

type Value_GeoPointValue

type Value_GeoPointValue struct {
	// A geo point value representing a point on the surface of Earth.
	GeoPointValue *latlng.LatLng `protobuf:"bytes,8,opt,name=geo_point_value,json=geoPointValue,proto3,oneof"`
}

type Value_IntegerValue

type Value_IntegerValue struct {
	// An integer value.
	IntegerValue int64 `protobuf:"varint,2,opt,name=integer_value,json=integerValue,proto3,oneof"`
}

type Value_MapValue

type Value_MapValue struct {
	// A map value.
	MapValue *MapValue `protobuf:"bytes,6,opt,name=map_value,json=mapValue,proto3,oneof"`
}

type Value_NullValue

type Value_NullValue struct {
	// A null value.
	NullValue structpb.NullValue `protobuf:"varint,11,opt,name=null_value,json=nullValue,proto3,enum=google.protobuf.NullValue,oneof"`
}

type Value_ReferenceValue

type Value_ReferenceValue struct {
	// A reference to a document. For example:
	// `projects/{project_id}/databases/{database_id}/documents/{document_path}`.
	ReferenceValue string `protobuf:"bytes,5,opt,name=reference_value,json=referenceValue,proto3,oneof"`
}

type Value_StringValue

type Value_StringValue struct {
	// A string value.
	//
	// The string, represented as UTF-8, must not exceed 1 MiB - 89 bytes.
	// Only the first 1,500 bytes of the UTF-8 representation are considered by
	// queries.
	StringValue string `protobuf:"bytes,17,opt,name=string_value,json=stringValue,proto3,oneof"`
}

type Value_TimestampValue

type Value_TimestampValue struct {
	// A timestamp value.
	//
	// Precise only to microseconds. When stored, any additional precision is
	// rounded down.
	TimestampValue *timestamppb.Timestamp `protobuf:"bytes,10,opt,name=timestamp_value,json=timestampValue,proto3,oneof"`
}

Jump to

Keyboard shortcuts

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