adminpb

package
v1.15.0 Latest Latest
Warning

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

 Go to latest Published: Mar 5, 2024 License: Apache-2.0 Imports: 14 Imported by: 4

Documentation

Index

Constants

This section is empty.

Variables

View Source 
var (
	Database_DatabaseType_name = map[int32]string{
		0: "DATABASE_TYPE_UNSPECIFIED",
		1: "FIRESTORE_NATIVE",
		2: "DATASTORE_MODE",
	}
	Database_DatabaseType_value = map[string]int32{
		"DATABASE_TYPE_UNSPECIFIED": 0,
		"FIRESTORE_NATIVE":          1,
		"DATASTORE_MODE":            2,
	}
)

Enum value maps for Database_DatabaseType.

View Source 
var (
	Database_ConcurrencyMode_name = map[int32]string{
		0: "CONCURRENCY_MODE_UNSPECIFIED",
		1: "OPTIMISTIC",
		2: "PESSIMISTIC",
		3: "OPTIMISTIC_WITH_ENTITY_GROUPS",
	}
	Database_ConcurrencyMode_value = map[string]int32{
		"CONCURRENCY_MODE_UNSPECIFIED":  0,
		"OPTIMISTIC":                    1,
		"PESSIMISTIC":                   2,
		"OPTIMISTIC_WITH_ENTITY_GROUPS": 3,
	}
)

Enum value maps for Database_ConcurrencyMode.

View Source 
var (
	Database_PointInTimeRecoveryEnablement_name = map[int32]string{
		0: "POINT_IN_TIME_RECOVERY_ENABLEMENT_UNSPECIFIED",
		1: "POINT_IN_TIME_RECOVERY_ENABLED",
		2: "POINT_IN_TIME_RECOVERY_DISABLED",
	}
	Database_PointInTimeRecoveryEnablement_value = map[string]int32{
		"POINT_IN_TIME_RECOVERY_ENABLEMENT_UNSPECIFIED": 0,
		"POINT_IN_TIME_RECOVERY_ENABLED":                1,
		"POINT_IN_TIME_RECOVERY_DISABLED":               2,
	}
)

Enum value maps for Database_PointInTimeRecoveryEnablement.

View Source 
var (
	Database_AppEngineIntegrationMode_name = map[int32]string{
		0: "APP_ENGINE_INTEGRATION_MODE_UNSPECIFIED",
		1: "ENABLED",
		2: "DISABLED",
	}
	Database_AppEngineIntegrationMode_value = map[string]int32{
		"APP_ENGINE_INTEGRATION_MODE_UNSPECIFIED": 0,
		"ENABLED":  1,
		"DISABLED": 2,
	}
)

Enum value maps for Database_AppEngineIntegrationMode.

View Source 
var (
	Database_DeleteProtectionState_name = map[int32]string{
		0: "DELETE_PROTECTION_STATE_UNSPECIFIED",
		1: "DELETE_PROTECTION_DISABLED",
		2: "DELETE_PROTECTION_ENABLED",
	}
	Database_DeleteProtectionState_value = map[string]int32{
		"DELETE_PROTECTION_STATE_UNSPECIFIED": 0,
		"DELETE_PROTECTION_DISABLED":          1,
		"DELETE_PROTECTION_ENABLED":           2,
	}
)

Enum value maps for Database_DeleteProtectionState.

View Source 
var (
	Field_TtlConfig_State_name = map[int32]string{
		0: "STATE_UNSPECIFIED",
		1: "CREATING",
		2: "ACTIVE",
		3: "NEEDS_REPAIR",
	}
	Field_TtlConfig_State_value = map[string]int32{
		"STATE_UNSPECIFIED": 0,
		"CREATING":          1,
		"ACTIVE":            2,
		"NEEDS_REPAIR":      3,
	}
)

Enum value maps for Field_TtlConfig_State.

View Source 
var (
	Index_QueryScope_name = map[int32]string{
		0: "QUERY_SCOPE_UNSPECIFIED",
		1: "COLLECTION",
		2: "COLLECTION_GROUP",
		3: "COLLECTION_RECURSIVE",
	}
	Index_QueryScope_value = map[string]int32{
		"QUERY_SCOPE_UNSPECIFIED": 0,
		"COLLECTION":              1,
		"COLLECTION_GROUP":        2,
		"COLLECTION_RECURSIVE":    3,
	}
)

Enum value maps for Index_QueryScope.

View Source 
var (
	Index_ApiScope_name = map[int32]string{
		0: "ANY_API",
		1: "DATASTORE_MODE_API",
	}
	Index_ApiScope_value = map[string]int32{
		"ANY_API":            0,
		"DATASTORE_MODE_API": 1,
	}
)

Enum value maps for Index_ApiScope.

View Source 
var (
	Index_State_name = map[int32]string{
		0: "STATE_UNSPECIFIED",
		1: "CREATING",
		2: "READY",
		3: "NEEDS_REPAIR",
	}
	Index_State_value = map[string]int32{
		"STATE_UNSPECIFIED": 0,
		"CREATING":          1,
		"READY":             2,
		"NEEDS_REPAIR":      3,
	}
)

Enum value maps for Index_State.

View Source 
var (
	Index_IndexField_Order_name = map[int32]string{
		0: "ORDER_UNSPECIFIED",
		1: "ASCENDING",
		2: "DESCENDING",
	}
	Index_IndexField_Order_value = map[string]int32{
		"ORDER_UNSPECIFIED": 0,
		"ASCENDING":         1,
		"DESCENDING":        2,
	}
)

Enum value maps for Index_IndexField_Order.

View Source 
var (
	Index_IndexField_ArrayConfig_name = map[int32]string{
		0: "ARRAY_CONFIG_UNSPECIFIED",
		1: "CONTAINS",
	}
	Index_IndexField_ArrayConfig_value = map[string]int32{
		"ARRAY_CONFIG_UNSPECIFIED": 0,
		"CONTAINS":                 1,
	}
)

Enum value maps for Index_IndexField_ArrayConfig.

View Source 
var (
	OperationState_name = map[int32]string{
		0: "OPERATION_STATE_UNSPECIFIED",
		1: "INITIALIZING",
		2: "PROCESSING",
		3: "CANCELLING",
		4: "FINALIZING",
		5: "SUCCESSFUL",
		6: "FAILED",
		7: "CANCELLED",
	}
	OperationState_value = map[string]int32{
		"OPERATION_STATE_UNSPECIFIED": 0,
		"INITIALIZING":                1,
		"PROCESSING":                  2,
		"CANCELLING":                  3,
		"FINALIZING":                  4,
		"SUCCESSFUL":                  5,
		"FAILED":                      6,
		"CANCELLED":                   7,
	}
)

Enum value maps for OperationState.

View Source 
var (
	FieldOperationMetadata_IndexConfigDelta_ChangeType_name = map[int32]string{
		0: "CHANGE_TYPE_UNSPECIFIED",
		1: "ADD",
		2: "REMOVE",
	}
	FieldOperationMetadata_IndexConfigDelta_ChangeType_value = map[string]int32{
		"CHANGE_TYPE_UNSPECIFIED": 0,
		"ADD":                     1,
		"REMOVE":                  2,
	}
)

Enum value maps for FieldOperationMetadata_IndexConfigDelta_ChangeType.

View Source 
var (
	FieldOperationMetadata_TtlConfigDelta_ChangeType_name = map[int32]string{
		0: "CHANGE_TYPE_UNSPECIFIED",
		1: "ADD",
		2: "REMOVE",
	}
	FieldOperationMetadata_TtlConfigDelta_ChangeType_value = map[string]int32{
		"CHANGE_TYPE_UNSPECIFIED": 0,
		"ADD":                     1,
		"REMOVE":                  2,
	}
)

Enum value maps for FieldOperationMetadata_TtlConfigDelta_ChangeType.

View Source 
var File_google_firestore_admin_v1_database_proto protoreflect.FileDescriptor
View Source 
var File_google_firestore_admin_v1_field_proto protoreflect.FileDescriptor
View Source 
var File_google_firestore_admin_v1_firestore_admin_proto protoreflect.FileDescriptor
View Source 
var File_google_firestore_admin_v1_index_proto protoreflect.FileDescriptor
View Source 
var File_google_firestore_admin_v1_location_proto protoreflect.FileDescriptor
View Source 
var File_google_firestore_admin_v1_operation_proto protoreflect.FileDescriptor

Functions

func RegisterFirestoreAdminServer 

func RegisterFirestoreAdminServer(s *grpc.Server, srv FirestoreAdminServer)

Types

type CreateDatabaseMetadata added in v1.15.0 

type CreateDatabaseMetadata struct {
	// contains filtered or unexported fields
}

Metadata related to the create database operation.

func (*CreateDatabaseMetadata) Descriptor deprecated added in v1.15.0 

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

Deprecated: Use CreateDatabaseMetadata.ProtoReflect.Descriptor instead.

func (*CreateDatabaseMetadata) ProtoMessage added in v1.15.0 

func (*CreateDatabaseMetadata) ProtoMessage()

func (*CreateDatabaseMetadata) ProtoReflect added in v1.15.0 

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

func (*CreateDatabaseMetadata) Reset added in v1.15.0 

func (x *CreateDatabaseMetadata) Reset()

func (*CreateDatabaseMetadata) String added in v1.15.0 

func (x *CreateDatabaseMetadata) String() string

type CreateDatabaseRequest added in v1.15.0 

type CreateDatabaseRequest struct {

	// Required. A parent name of the form
	// `projects/{project_id}`
	Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
	// Required. The Database to create.
	Database *Database `protobuf:"bytes,2,opt,name=database,proto3" json:"database,omitempty"`
	// Required. The ID to use for the database, which will become the final
	// component of the database's resource name.
	//
	// This value should be 4-63 characters. Valid characters are /[a-z][0-9]-/
	// with first character a letter and the last a letter or a number. Must not
	// be UUID-like /[0-9a-f]{8}(-[0-9a-f]{4}){3}-[0-9a-f]{12}/.
	//
	// "(default)" database id is also valid.
	DatabaseId string `protobuf:"bytes,3,opt,name=database_id,json=databaseId,proto3" json:"database_id,omitempty"`
	// contains filtered or unexported fields
}

The request for [FirestoreAdmin.CreateDatabase][google.firestore.admin.v1.FirestoreAdmin.CreateDatabase].

func (*CreateDatabaseRequest) Descriptor deprecated added in v1.15.0 

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

Deprecated: Use CreateDatabaseRequest.ProtoReflect.Descriptor instead.

func (*CreateDatabaseRequest) GetDatabase added in v1.15.0 

func (x *CreateDatabaseRequest) GetDatabase() *Database

func (*CreateDatabaseRequest) GetDatabaseId added in v1.15.0 

func (x *CreateDatabaseRequest) GetDatabaseId() string

func (*CreateDatabaseRequest) GetParent added in v1.15.0 

func (x *CreateDatabaseRequest) GetParent() string

func (*CreateDatabaseRequest) ProtoMessage added in v1.15.0 

func (*CreateDatabaseRequest) ProtoMessage()

func (*CreateDatabaseRequest) ProtoReflect added in v1.15.0 

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

func (*CreateDatabaseRequest) Reset added in v1.15.0 

func (x *CreateDatabaseRequest) Reset()

func (*CreateDatabaseRequest) String added in v1.15.0 

func (x *CreateDatabaseRequest) String() string

type CreateIndexRequest 

type CreateIndexRequest struct {

	// Required. A parent name of the form
	// `projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}`
	Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
	// Required. The composite index to create.
	Index *Index `protobuf:"bytes,2,opt,name=index,proto3" json:"index,omitempty"`
	// contains filtered or unexported fields
}

The request for [FirestoreAdmin.CreateIndex][google.firestore.admin.v1.FirestoreAdmin.CreateIndex].

func (*CreateIndexRequest) Descriptor deprecated 

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

Deprecated: Use CreateIndexRequest.ProtoReflect.Descriptor instead.

func (*CreateIndexRequest) GetIndex 

func (x *CreateIndexRequest) GetIndex() *Index

func (*CreateIndexRequest) GetParent 

func (x *CreateIndexRequest) GetParent() string

func (*CreateIndexRequest) ProtoMessage 

func (*CreateIndexRequest) ProtoMessage()

func (*CreateIndexRequest) ProtoReflect 

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

func (*CreateIndexRequest) Reset 

func (x *CreateIndexRequest) Reset()

func (*CreateIndexRequest) String 

func (x *CreateIndexRequest) String() string

type Database 

type Database struct {

	// The resource name of the Database.
	// Format: `projects/{project}/databases/{database}`
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// Output only. The system-generated UUID4 for this Database.
	Uid string `protobuf:"bytes,3,opt,name=uid,proto3" json:"uid,omitempty"`
	// Output only. The timestamp at which this database was created. Databases
	// created before 2016 do not populate create_time.
	CreateTime *timestamppb.Timestamp `protobuf:"bytes,5,opt,name=create_time,json=createTime,proto3" json:"create_time,omitempty"`
	// Output only. The timestamp at which this database was most recently
	// updated. Note this only includes updates to the database resource and not
	// data contained by the database.
	UpdateTime *timestamppb.Timestamp `protobuf:"bytes,6,opt,name=update_time,json=updateTime,proto3" json:"update_time,omitempty"`
	// The location of the database. Available locations are listed at
	// https://cloud.google.com/firestore/docs/locations.
	LocationId string `protobuf:"bytes,9,opt,name=location_id,json=locationId,proto3" json:"location_id,omitempty"`
	// The type of the database.
	// See https://cloud.google.com/datastore/docs/firestore-or-datastore for
	// information about how to choose.
	Type Database_DatabaseType `protobuf:"varint,10,opt,name=type,proto3,enum=google.firestore.admin.v1.Database_DatabaseType" json:"type,omitempty"`
	// The concurrency control mode to use for this database.
	ConcurrencyMode Database_ConcurrencyMode `` /* 164-byte string literal not displayed */
	// Output only. The period during which past versions of data are retained in
	// the database.
	//
	// Any [read][google.firestore.v1.GetDocumentRequest.read_time]
	// or [query][google.firestore.v1.ListDocumentsRequest.read_time] can specify
	// a `read_time` within this window, and will read the state of the database
	// at that time.
	//
	// If the PITR feature is enabled, the retention period is 7 days. Otherwise,
	// the retention period is 1 hour.
	VersionRetentionPeriod *durationpb.Duration `` /* 130-byte string literal not displayed */
	// Output only. The earliest timestamp at which older versions of the data can
	// be read from the database. See [version_retention_period] above; this field
	// is populated with `now - version_retention_period`.
	//
	// This value is continuously updated, and becomes stale the moment it is
	// queried. If you are using this value to recover data, make sure to account
	// for the time from the moment when the value is queried to the moment when
	// you initiate the recovery.
	EarliestVersionTime *timestamppb.Timestamp `protobuf:"bytes,18,opt,name=earliest_version_time,json=earliestVersionTime,proto3" json:"earliest_version_time,omitempty"`
	// Whether to enable the PITR feature on this database.
	PointInTimeRecoveryEnablement Database_PointInTimeRecoveryEnablement `` /* 226-byte string literal not displayed */
	// The App Engine integration mode to use for this database.
	AppEngineIntegrationMode Database_AppEngineIntegrationMode `` /* 204-byte string literal not displayed */
	// Output only. The key_prefix for this database. This key_prefix is used, in
	// combination with the project id ("<key prefix>~<project id>") to construct
	// the application id that is returned from the Cloud Datastore APIs in Google
	// App Engine first generation runtimes.
	//
	// This value may be empty in which case the appid to use for URL-encoded keys
	// is the project_id (eg: foo instead of v~foo).
	KeyPrefix string `protobuf:"bytes,20,opt,name=key_prefix,json=keyPrefix,proto3" json:"key_prefix,omitempty"`
	// State of delete protection for the database.
	DeleteProtectionState Database_DeleteProtectionState `` /* 190-byte string literal not displayed */
	// This checksum is computed by the server based on the value of other
	// fields, and may be sent on update and delete requests to ensure the
	// client has an up-to-date value before proceeding.
	Etag string `protobuf:"bytes,99,opt,name=etag,proto3" json:"etag,omitempty"`
	// contains filtered or unexported fields
}

A Cloud Firestore Database.

func (*Database) Descriptor deprecated 

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

Deprecated: Use Database.ProtoReflect.Descriptor instead.

func (*Database) GetAppEngineIntegrationMode 

func (x *Database) GetAppEngineIntegrationMode() Database_AppEngineIntegrationMode

func (*Database) GetConcurrencyMode 

func (x *Database) GetConcurrencyMode() Database_ConcurrencyMode

func (*Database) GetCreateTime added in v1.15.0 

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

func (*Database) GetDeleteProtectionState added in v1.15.0 

func (x *Database) GetDeleteProtectionState() Database_DeleteProtectionState

func (*Database) GetEarliestVersionTime added in v1.15.0 

func (x *Database) GetEarliestVersionTime() *timestamppb.Timestamp

func (*Database) GetEtag 

func (x *Database) GetEtag() string

func (*Database) GetKeyPrefix 

func (x *Database) GetKeyPrefix() string

func (*Database) GetLocationId 

func (x *Database) GetLocationId() string

func (*Database) GetName 

func (x *Database) GetName() string

func (*Database) GetPointInTimeRecoveryEnablement added in v1.15.0 

func (x *Database) GetPointInTimeRecoveryEnablement() Database_PointInTimeRecoveryEnablement

func (*Database) GetType 

func (x *Database) GetType() Database_DatabaseType

func (*Database) GetUid added in v1.15.0 

func (x *Database) GetUid() string

func (*Database) GetUpdateTime added in v1.15.0 

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

func (*Database) GetVersionRetentionPeriod added in v1.15.0 

func (x *Database) GetVersionRetentionPeriod() *durationpb.Duration

func (*Database) ProtoMessage 

func (*Database) ProtoMessage()

func (*Database) ProtoReflect 

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

func (*Database) Reset 

func (x *Database) Reset()

func (*Database) String 

func (x *Database) String() string

type Database_AppEngineIntegrationMode 

type Database_AppEngineIntegrationMode int32

The type of App Engine integration mode. 

const (
	// Not used.
	Database_APP_ENGINE_INTEGRATION_MODE_UNSPECIFIED Database_AppEngineIntegrationMode = 0
	// If an App Engine application exists in the same region as this database,
	// App Engine configuration will impact this database. This includes
	// disabling of the application & database, as well as disabling writes to
	// the database.
	Database_ENABLED Database_AppEngineIntegrationMode = 1
	// App Engine has no effect on the ability of this database to serve
	// requests.
	//
	// This is the default setting for databases created with the Firestore API.
	Database_DISABLED Database_AppEngineIntegrationMode = 2
)

func (Database_AppEngineIntegrationMode) Descriptor 

func (Database_AppEngineIntegrationMode) Descriptor() protoreflect.EnumDescriptor

func (Database_AppEngineIntegrationMode) Enum 

func (x Database_AppEngineIntegrationMode) Enum() *Database_AppEngineIntegrationMode

func (Database_AppEngineIntegrationMode) EnumDescriptor deprecated 

func (Database_AppEngineIntegrationMode) EnumDescriptor() ([]byte, []int)

Deprecated: Use Database_AppEngineIntegrationMode.Descriptor instead.

func (Database_AppEngineIntegrationMode) Number 

func (x Database_AppEngineIntegrationMode) Number() protoreflect.EnumNumber

func (Database_AppEngineIntegrationMode) String 

func (x Database_AppEngineIntegrationMode) String() string

func (Database_AppEngineIntegrationMode) Type 

func (Database_AppEngineIntegrationMode) Type() protoreflect.EnumType

type Database_ConcurrencyMode 

type Database_ConcurrencyMode int32

The type of concurrency control mode for transactions. 

const (
	// Not used.
	Database_CONCURRENCY_MODE_UNSPECIFIED Database_ConcurrencyMode = 0
	// Use optimistic concurrency control by default. This mode is available
	// for Cloud Firestore databases.
	Database_OPTIMISTIC Database_ConcurrencyMode = 1
	// Use pessimistic concurrency control by default. This mode is available
	// for Cloud Firestore databases.
	//
	// This is the default setting for Cloud Firestore.
	Database_PESSIMISTIC Database_ConcurrencyMode = 2
	// Use optimistic concurrency control with entity groups by default.
	//
	// This is the only available mode for Cloud Datastore.
	//
	// This mode is also available for Cloud Firestore with Datastore Mode but
	// is not recommended.
	Database_OPTIMISTIC_WITH_ENTITY_GROUPS Database_ConcurrencyMode = 3
)

func (Database_ConcurrencyMode) Descriptor 

func (Database_ConcurrencyMode) Descriptor() protoreflect.EnumDescriptor

func (Database_ConcurrencyMode) Enum 

func (x Database_ConcurrencyMode) Enum() *Database_ConcurrencyMode

func (Database_ConcurrencyMode) EnumDescriptor deprecated 

func (Database_ConcurrencyMode) EnumDescriptor() ([]byte, []int)

Deprecated: Use Database_ConcurrencyMode.Descriptor instead.

func (Database_ConcurrencyMode) Number 

func (x Database_ConcurrencyMode) Number() protoreflect.EnumNumber

func (Database_ConcurrencyMode) String 

func (x Database_ConcurrencyMode) String() string

func (Database_ConcurrencyMode) Type 

func (Database_ConcurrencyMode) Type() protoreflect.EnumType

type Database_DatabaseType 

type Database_DatabaseType int32

The type of the database. See https://cloud.google.com/datastore/docs/firestore-or-datastore for information about how to choose.

Mode changes are only allowed if the database is empty. 

const (
	// The default value. This value is used if the database type is omitted.
	Database_DATABASE_TYPE_UNSPECIFIED Database_DatabaseType = 0
	// Firestore Native Mode
	Database_FIRESTORE_NATIVE Database_DatabaseType = 1
	// Firestore in Datastore Mode.
	Database_DATASTORE_MODE Database_DatabaseType = 2
)

func (Database_DatabaseType) Descriptor 

func (Database_DatabaseType) Descriptor() protoreflect.EnumDescriptor

func (Database_DatabaseType) Enum 

func (x Database_DatabaseType) Enum() *Database_DatabaseType

func (Database_DatabaseType) EnumDescriptor deprecated 

func (Database_DatabaseType) EnumDescriptor() ([]byte, []int)

Deprecated: Use Database_DatabaseType.Descriptor instead.

func (Database_DatabaseType) Number 

func (x Database_DatabaseType) Number() protoreflect.EnumNumber

func (Database_DatabaseType) String 

func (x Database_DatabaseType) String() string

func (Database_DatabaseType) Type 

func (Database_DatabaseType) Type() protoreflect.EnumType

type Database_DeleteProtectionState added in v1.15.0 

type Database_DeleteProtectionState int32

The delete protection state of the database. 

const (
	// The default value. Delete protection type is not specified
	Database_DELETE_PROTECTION_STATE_UNSPECIFIED Database_DeleteProtectionState = 0
	// Delete protection is disabled
	Database_DELETE_PROTECTION_DISABLED Database_DeleteProtectionState = 1
	// Delete protection is enabled
	Database_DELETE_PROTECTION_ENABLED Database_DeleteProtectionState = 2
)

func (Database_DeleteProtectionState) Descriptor added in v1.15.0 

func (Database_DeleteProtectionState) Descriptor() protoreflect.EnumDescriptor

func (Database_DeleteProtectionState) Enum added in v1.15.0 

func (x Database_DeleteProtectionState) Enum() *Database_DeleteProtectionState

func (Database_DeleteProtectionState) EnumDescriptor deprecated added in v1.15.0 

func (Database_DeleteProtectionState) EnumDescriptor() ([]byte, []int)

Deprecated: Use Database_DeleteProtectionState.Descriptor instead.

func (Database_DeleteProtectionState) Number added in v1.15.0 

func (x Database_DeleteProtectionState) Number() protoreflect.EnumNumber

func (Database_DeleteProtectionState) String added in v1.15.0 

func (x Database_DeleteProtectionState) String() string

func (Database_DeleteProtectionState) Type added in v1.15.0 

func (Database_DeleteProtectionState) Type() protoreflect.EnumType

type Database_PointInTimeRecoveryEnablement added in v1.15.0 

type Database_PointInTimeRecoveryEnablement int32

Point In Time Recovery feature enablement. 

const (
	// Not used.
	Database_POINT_IN_TIME_RECOVERY_ENABLEMENT_UNSPECIFIED Database_PointInTimeRecoveryEnablement = 0
	// Reads are supported on selected versions of the data from within the past
	// 7 days:
	//
	// * Reads against any timestamp within the past hour
	// * Reads against 1-minute snapshots beyond 1 hour and within 7 days
	//
	// `version_retention_period` and `earliest_version_time` can be
	// used to determine the supported versions.
	Database_POINT_IN_TIME_RECOVERY_ENABLED Database_PointInTimeRecoveryEnablement = 1
	// Reads are supported on any version of the data from within the past 1
	// hour.
	Database_POINT_IN_TIME_RECOVERY_DISABLED Database_PointInTimeRecoveryEnablement = 2
)

func (Database_PointInTimeRecoveryEnablement) Descriptor added in v1.15.0 

func (Database_PointInTimeRecoveryEnablement) Descriptor() protoreflect.EnumDescriptor

func (Database_PointInTimeRecoveryEnablement) Enum added in v1.15.0 

func (x Database_PointInTimeRecoveryEnablement) Enum() *Database_PointInTimeRecoveryEnablement

func (Database_PointInTimeRecoveryEnablement) EnumDescriptor deprecated added in v1.15.0 

func (Database_PointInTimeRecoveryEnablement) EnumDescriptor() ([]byte, []int)

Deprecated: Use Database_PointInTimeRecoveryEnablement.Descriptor instead.

func (Database_PointInTimeRecoveryEnablement) Number added in v1.15.0 

func (x Database_PointInTimeRecoveryEnablement) Number() protoreflect.EnumNumber

func (Database_PointInTimeRecoveryEnablement) String added in v1.15.0 

func (x Database_PointInTimeRecoveryEnablement) String() string

func (Database_PointInTimeRecoveryEnablement) Type added in v1.15.0 

func (Database_PointInTimeRecoveryEnablement) Type() protoreflect.EnumType

type DeleteDatabaseMetadata added in v1.15.0 

type DeleteDatabaseMetadata struct {
	// contains filtered or unexported fields
}

Metadata related to the delete database operation.

func (*DeleteDatabaseMetadata) Descriptor deprecated added in v1.15.0 

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

Deprecated: Use DeleteDatabaseMetadata.ProtoReflect.Descriptor instead.

func (*DeleteDatabaseMetadata) ProtoMessage added in v1.15.0 

func (*DeleteDatabaseMetadata) ProtoMessage()

func (*DeleteDatabaseMetadata) ProtoReflect added in v1.15.0 

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

func (*DeleteDatabaseMetadata) Reset added in v1.15.0 

func (x *DeleteDatabaseMetadata) Reset()

func (*DeleteDatabaseMetadata) String added in v1.15.0 

func (x *DeleteDatabaseMetadata) String() string

type DeleteDatabaseRequest added in v1.15.0 

type DeleteDatabaseRequest struct {

	// Required. A name of the form
	// `projects/{project_id}/databases/{database_id}`
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// The current etag of the Database.
	// If an etag is provided and does not match the current etag of the database,
	// deletion will be blocked and a FAILED_PRECONDITION error will be returned.
	Etag string `protobuf:"bytes,3,opt,name=etag,proto3" json:"etag,omitempty"`
	// contains filtered or unexported fields
}

The request for [FirestoreAdmin.DeleteDatabase][google.firestore.admin.v1.FirestoreAdmin.DeleteDatabase].

func (*DeleteDatabaseRequest) Descriptor deprecated added in v1.15.0 

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

Deprecated: Use DeleteDatabaseRequest.ProtoReflect.Descriptor instead.

func (*DeleteDatabaseRequest) GetEtag added in v1.15.0 

func (x *DeleteDatabaseRequest) GetEtag() string

func (*DeleteDatabaseRequest) GetName added in v1.15.0 

func (x *DeleteDatabaseRequest) GetName() string

func (*DeleteDatabaseRequest) ProtoMessage added in v1.15.0 

func (*DeleteDatabaseRequest) ProtoMessage()

func (*DeleteDatabaseRequest) ProtoReflect added in v1.15.0 

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

func (*DeleteDatabaseRequest) Reset added in v1.15.0 

func (x *DeleteDatabaseRequest) Reset()

func (*DeleteDatabaseRequest) String added in v1.15.0 

func (x *DeleteDatabaseRequest) String() string

type DeleteIndexRequest 

type DeleteIndexRequest struct {

	// Required. A name of the form
	// `projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/indexes/{index_id}`
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// contains filtered or unexported fields
}

The request for [FirestoreAdmin.DeleteIndex][google.firestore.admin.v1.FirestoreAdmin.DeleteIndex].

func (*DeleteIndexRequest) Descriptor deprecated 

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

Deprecated: Use DeleteIndexRequest.ProtoReflect.Descriptor instead.

func (*DeleteIndexRequest) GetName 

func (x *DeleteIndexRequest) GetName() string

func (*DeleteIndexRequest) ProtoMessage 

func (*DeleteIndexRequest) ProtoMessage()

func (*DeleteIndexRequest) ProtoReflect 

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

func (*DeleteIndexRequest) Reset 

func (x *DeleteIndexRequest) Reset()

func (*DeleteIndexRequest) String 

func (x *DeleteIndexRequest) String() string

type ExportDocumentsMetadata 

type ExportDocumentsMetadata struct {

	// The time this operation started.
	StartTime *timestamppb.Timestamp `protobuf:"bytes,1,opt,name=start_time,json=startTime,proto3" json:"start_time,omitempty"`
	// The time this operation completed. Will be unset if operation still in
	// progress.
	EndTime *timestamppb.Timestamp `protobuf:"bytes,2,opt,name=end_time,json=endTime,proto3" json:"end_time,omitempty"`
	// The state of the export operation.
	OperationState OperationState `` /* 150-byte string literal not displayed */
	// The progress, in documents, of this operation.
	ProgressDocuments *Progress `protobuf:"bytes,4,opt,name=progress_documents,json=progressDocuments,proto3" json:"progress_documents,omitempty"`
	// The progress, in bytes, of this operation.
	ProgressBytes *Progress `protobuf:"bytes,5,opt,name=progress_bytes,json=progressBytes,proto3" json:"progress_bytes,omitempty"`
	// Which collection ids are being exported.
	CollectionIds []string `protobuf:"bytes,6,rep,name=collection_ids,json=collectionIds,proto3" json:"collection_ids,omitempty"`
	// Where the documents are being exported to.
	OutputUriPrefix string `protobuf:"bytes,7,opt,name=output_uri_prefix,json=outputUriPrefix,proto3" json:"output_uri_prefix,omitempty"`
	// Which namespace ids are being exported.
	NamespaceIds []string `protobuf:"bytes,8,rep,name=namespace_ids,json=namespaceIds,proto3" json:"namespace_ids,omitempty"`
	// The timestamp that corresponds to the version of the database that is being
	// exported. If unspecified, there are no guarantees about the consistency of
	// the documents being exported.
	SnapshotTime *timestamppb.Timestamp `protobuf:"bytes,9,opt,name=snapshot_time,json=snapshotTime,proto3" json:"snapshot_time,omitempty"`
	// contains filtered or unexported fields
}

Metadata for [google.longrunning.Operation][google.longrunning.Operation] results from [FirestoreAdmin.ExportDocuments][google.firestore.admin.v1.FirestoreAdmin.ExportDocuments].

func (*ExportDocumentsMetadata) Descriptor deprecated 

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

Deprecated: Use ExportDocumentsMetadata.ProtoReflect.Descriptor instead.

func (*ExportDocumentsMetadata) GetCollectionIds 

func (x *ExportDocumentsMetadata) GetCollectionIds() []string

func (*ExportDocumentsMetadata) GetEndTime 

func (x *ExportDocumentsMetadata) GetEndTime() *timestamppb.Timestamp

func (*ExportDocumentsMetadata) GetNamespaceIds added in v1.15.0 

func (x *ExportDocumentsMetadata) GetNamespaceIds() []string

func (*ExportDocumentsMetadata) GetOperationState 

func (x *ExportDocumentsMetadata) GetOperationState() OperationState

func (*ExportDocumentsMetadata) GetOutputUriPrefix 

func (x *ExportDocumentsMetadata) GetOutputUriPrefix() string

func (*ExportDocumentsMetadata) GetProgressBytes 

func (x *ExportDocumentsMetadata) GetProgressBytes() *Progress

func (*ExportDocumentsMetadata) GetProgressDocuments 

func (x *ExportDocumentsMetadata) GetProgressDocuments() *Progress

func (*ExportDocumentsMetadata) GetSnapshotTime added in v1.15.0 

func (x *ExportDocumentsMetadata) GetSnapshotTime() *timestamppb.Timestamp

func (*ExportDocumentsMetadata) GetStartTime 

func (x *ExportDocumentsMetadata) GetStartTime() *timestamppb.Timestamp

func (*ExportDocumentsMetadata) ProtoMessage 

func (*ExportDocumentsMetadata) ProtoMessage()

func (*ExportDocumentsMetadata) ProtoReflect 

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

func (*ExportDocumentsMetadata) Reset 

func (x *ExportDocumentsMetadata) Reset()

func (*ExportDocumentsMetadata) String 

func (x *ExportDocumentsMetadata) String() string

type ExportDocumentsRequest 

type ExportDocumentsRequest struct {

	// Required. Database to export. Should be of the form:
	// `projects/{project_id}/databases/{database_id}`.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// Which collection ids to export. Unspecified means all collections.
	CollectionIds []string `protobuf:"bytes,2,rep,name=collection_ids,json=collectionIds,proto3" json:"collection_ids,omitempty"`
	// The output URI. Currently only supports Google Cloud Storage URIs of the
	// form: `gs://BUCKET_NAME[/NAMESPACE_PATH]`, where `BUCKET_NAME` is the name
	// of the Google Cloud Storage bucket and `NAMESPACE_PATH` is an optional
	// Google Cloud Storage namespace path. When
	// choosing a name, be sure to consider Google Cloud Storage naming
	// guidelines: https://cloud.google.com/storage/docs/naming.
	// If the URI is a bucket (without a namespace path), a prefix will be
	// generated based on the start time.
	OutputUriPrefix string `protobuf:"bytes,3,opt,name=output_uri_prefix,json=outputUriPrefix,proto3" json:"output_uri_prefix,omitempty"`
	// An empty list represents all namespaces. This is the preferred
	// usage for databases that don't use namespaces.
	//
	// An empty string element represents the default namespace. This should be
	// used if the database has data in non-default namespaces, but doesn't want
	// to include them. Each namespace in this list must be unique.
	NamespaceIds []string `protobuf:"bytes,4,rep,name=namespace_ids,json=namespaceIds,proto3" json:"namespace_ids,omitempty"`
	// The timestamp that corresponds to the version of the database to be
	// exported. The timestamp must be in the past, rounded to the minute and not
	// older than
	// [earliestVersionTime][google.firestore.admin.v1.Database.earliest_version_time].
	// If specified, then the exported documents will represent a consistent view
	// of the database at the provided time. Otherwise, there are no guarantees
	// about the consistency of the exported documents.
	SnapshotTime *timestamppb.Timestamp `protobuf:"bytes,5,opt,name=snapshot_time,json=snapshotTime,proto3" json:"snapshot_time,omitempty"`
	// contains filtered or unexported fields
}

The request for [FirestoreAdmin.ExportDocuments][google.firestore.admin.v1.FirestoreAdmin.ExportDocuments].

func (*ExportDocumentsRequest) Descriptor deprecated 

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

Deprecated: Use ExportDocumentsRequest.ProtoReflect.Descriptor instead.

func (*ExportDocumentsRequest) GetCollectionIds 

func (x *ExportDocumentsRequest) GetCollectionIds() []string

func (*ExportDocumentsRequest) GetName 

func (x *ExportDocumentsRequest) GetName() string

func (*ExportDocumentsRequest) GetNamespaceIds added in v1.15.0 

func (x *ExportDocumentsRequest) GetNamespaceIds() []string

func (*ExportDocumentsRequest) GetOutputUriPrefix 

func (x *ExportDocumentsRequest) GetOutputUriPrefix() string

func (*ExportDocumentsRequest) GetSnapshotTime added in v1.15.0 

func (x *ExportDocumentsRequest) GetSnapshotTime() *timestamppb.Timestamp

func (*ExportDocumentsRequest) ProtoMessage 

func (*ExportDocumentsRequest) ProtoMessage()

func (*ExportDocumentsRequest) ProtoReflect 

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

func (*ExportDocumentsRequest) Reset 

func (x *ExportDocumentsRequest) Reset()

func (*ExportDocumentsRequest) String 

func (x *ExportDocumentsRequest) String() string

type ExportDocumentsResponse 

type ExportDocumentsResponse struct {

	// Location of the output files. This can be used to begin an import
	// into Cloud Firestore (this project or another project) after the operation
	// completes successfully.
	OutputUriPrefix string `protobuf:"bytes,1,opt,name=output_uri_prefix,json=outputUriPrefix,proto3" json:"output_uri_prefix,omitempty"`
	// contains filtered or unexported fields
}

Returned in the [google.longrunning.Operation][google.longrunning.Operation] response field.

func (*ExportDocumentsResponse) Descriptor deprecated 

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

Deprecated: Use ExportDocumentsResponse.ProtoReflect.Descriptor instead.

func (*ExportDocumentsResponse) GetOutputUriPrefix 

func (x *ExportDocumentsResponse) GetOutputUriPrefix() string

func (*ExportDocumentsResponse) ProtoMessage 

func (*ExportDocumentsResponse) ProtoMessage()

func (*ExportDocumentsResponse) ProtoReflect 

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

func (*ExportDocumentsResponse) Reset 

func (x *ExportDocumentsResponse) Reset()

func (*ExportDocumentsResponse) String 

func (x *ExportDocumentsResponse) String() string

type Field 

type Field struct {

	// Required. A field name of the form
	// `projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/fields/{field_path}`
	//
	// A field path may be a simple field name, e.g. `address` or a path to fields
	// within map_value , e.g. `address.city`,
	// or a special field path. The only valid special field is `*`, which
	// represents any field.
	//
	// Field paths may be quoted using ` (backtick). The only character that needs
	// to be escaped within a quoted field path is the backtick character itself,
	// escaped using a backslash. Special characters in field paths that
	// must be quoted include: `*`, `.`,
	// “` (backtick), `[`, `]`, as well as any ascii symbolic characters.
	//
	// Examples:
	// (Note: Comments here are written in markdown syntax, so there is an
	//
	//	additional layer of backticks to represent a code block)
	//
	// `\`address.city\“ represents a field named `address.city`, not the map key
	// `city` in the field `address`.
	// `\`*\“ represents a field named `*`, not any field.
	//
	// A special `Field` contains the default indexing settings for all fields.
	// This field's resource name is:
	// `projects/{project_id}/databases/{database_id}/collectionGroups/__default__/fields/*`
	// Indexes defined on this `Field` will be applied to all fields which do not
	// have their own `Field` index configuration.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// The index configuration for this field. If unset, field indexing will
	// revert to the configuration defined by the `ancestor_field`. To
	// explicitly remove all indexes for this field, specify an index config
	// with an empty list of indexes.
	IndexConfig *Field_IndexConfig `protobuf:"bytes,2,opt,name=index_config,json=indexConfig,proto3" json:"index_config,omitempty"`
	// The TTL configuration for this `Field`.
	// Setting or unsetting this will enable or disable the TTL for
	// documents that have this `Field`.
	TtlConfig *Field_TtlConfig `protobuf:"bytes,3,opt,name=ttl_config,json=ttlConfig,proto3" json:"ttl_config,omitempty"`
	// contains filtered or unexported fields
}

Represents a single field in the database.

Fields are grouped by their "Collection Group", which represent all collections in the database with the same id.

func (*Field) Descriptor deprecated 

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

Deprecated: Use Field.ProtoReflect.Descriptor instead.

func (*Field) GetIndexConfig 

func (x *Field) GetIndexConfig() *Field_IndexConfig

func (*Field) GetName 

func (x *Field) GetName() string

func (*Field) GetTtlConfig 

func (x *Field) GetTtlConfig() *Field_TtlConfig

func (*Field) ProtoMessage 

func (*Field) ProtoMessage()

func (*Field) ProtoReflect 

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

func (*Field) Reset 

func (x *Field) Reset()

func (*Field) String 

func (x *Field) String() string

type FieldOperationMetadata 

type FieldOperationMetadata struct {

	// The time this operation started.
	StartTime *timestamppb.Timestamp `protobuf:"bytes,1,opt,name=start_time,json=startTime,proto3" json:"start_time,omitempty"`
	// The time this operation completed. Will be unset if operation still in
	// progress.
	EndTime *timestamppb.Timestamp `protobuf:"bytes,2,opt,name=end_time,json=endTime,proto3" json:"end_time,omitempty"`
	// The field resource that this operation is acting on. For example:
	// `projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/fields/{field_path}`
	Field string `protobuf:"bytes,3,opt,name=field,proto3" json:"field,omitempty"`
	// A list of
	// [IndexConfigDelta][google.firestore.admin.v1.FieldOperationMetadata.IndexConfigDelta],
	// which describe the intent of this operation.
	IndexConfigDeltas []*FieldOperationMetadata_IndexConfigDelta `protobuf:"bytes,4,rep,name=index_config_deltas,json=indexConfigDeltas,proto3" json:"index_config_deltas,omitempty"`
	// The state of the operation.
	State OperationState `protobuf:"varint,5,opt,name=state,proto3,enum=google.firestore.admin.v1.OperationState" json:"state,omitempty"`
	// The progress, in documents, of this operation.
	ProgressDocuments *Progress `protobuf:"bytes,6,opt,name=progress_documents,json=progressDocuments,proto3" json:"progress_documents,omitempty"`
	// The progress, in bytes, of this operation.
	ProgressBytes *Progress `protobuf:"bytes,7,opt,name=progress_bytes,json=progressBytes,proto3" json:"progress_bytes,omitempty"`
	// Describes the deltas of TTL configuration.
	TtlConfigDelta *FieldOperationMetadata_TtlConfigDelta `protobuf:"bytes,8,opt,name=ttl_config_delta,json=ttlConfigDelta,proto3" json:"ttl_config_delta,omitempty"`
	// contains filtered or unexported fields
}

Metadata for [google.longrunning.Operation][google.longrunning.Operation] results from [FirestoreAdmin.UpdateField][google.firestore.admin.v1.FirestoreAdmin.UpdateField].

func (*FieldOperationMetadata) Descriptor deprecated 

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

Deprecated: Use FieldOperationMetadata.ProtoReflect.Descriptor instead.

func (*FieldOperationMetadata) GetEndTime 

func (x *FieldOperationMetadata) GetEndTime() *timestamppb.Timestamp

func (*FieldOperationMetadata) GetField 

func (x *FieldOperationMetadata) GetField() string

func (*FieldOperationMetadata) GetIndexConfigDeltas 

func (x *FieldOperationMetadata) GetIndexConfigDeltas() []*FieldOperationMetadata_IndexConfigDelta

func (*FieldOperationMetadata) GetProgressBytes 

func (x *FieldOperationMetadata) GetProgressBytes() *Progress

func (*FieldOperationMetadata) GetProgressDocuments 

func (x *FieldOperationMetadata) GetProgressDocuments() *Progress

func (*FieldOperationMetadata) GetStartTime 

func (x *FieldOperationMetadata) GetStartTime() *timestamppb.Timestamp

func (*FieldOperationMetadata) GetState 

func (x *FieldOperationMetadata) GetState() OperationState

func (*FieldOperationMetadata) GetTtlConfigDelta 

func (x *FieldOperationMetadata) GetTtlConfigDelta() *FieldOperationMetadata_TtlConfigDelta

func (*FieldOperationMetadata) ProtoMessage 

func (*FieldOperationMetadata) ProtoMessage()

func (*FieldOperationMetadata) ProtoReflect 

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

func (*FieldOperationMetadata) Reset 

func (x *FieldOperationMetadata) Reset()

func (*FieldOperationMetadata) String 

func (x *FieldOperationMetadata) String() string

type FieldOperationMetadata_IndexConfigDelta 

type FieldOperationMetadata_IndexConfigDelta struct {

	// Specifies how the index is changing.
	ChangeType FieldOperationMetadata_IndexConfigDelta_ChangeType `` /* 174-byte string literal not displayed */
	// The index being changed.
	Index *Index `protobuf:"bytes,2,opt,name=index,proto3" json:"index,omitempty"`
	// contains filtered or unexported fields
}

Information about an index configuration change.

func (*FieldOperationMetadata_IndexConfigDelta) Descriptor deprecated 

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

Deprecated: Use FieldOperationMetadata_IndexConfigDelta.ProtoReflect.Descriptor instead.

func (*FieldOperationMetadata_IndexConfigDelta) GetChangeType 

func (x *FieldOperationMetadata_IndexConfigDelta) GetChangeType() FieldOperationMetadata_IndexConfigDelta_ChangeType

func (*FieldOperationMetadata_IndexConfigDelta) GetIndex 

func (x *FieldOperationMetadata_IndexConfigDelta) GetIndex() *Index

func (*FieldOperationMetadata_IndexConfigDelta) ProtoMessage 

func (*FieldOperationMetadata_IndexConfigDelta) ProtoMessage()

func (*FieldOperationMetadata_IndexConfigDelta) ProtoReflect 

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

func (*FieldOperationMetadata_IndexConfigDelta) Reset 

func (x *FieldOperationMetadata_IndexConfigDelta) Reset()

func (*FieldOperationMetadata_IndexConfigDelta) String 

func (x *FieldOperationMetadata_IndexConfigDelta) String() string

type FieldOperationMetadata_IndexConfigDelta_ChangeType 

type FieldOperationMetadata_IndexConfigDelta_ChangeType int32

Specifies how the index is changing. 

const (
	// The type of change is not specified or known.
	FieldOperationMetadata_IndexConfigDelta_CHANGE_TYPE_UNSPECIFIED FieldOperationMetadata_IndexConfigDelta_ChangeType = 0
	// The single field index is being added.
	FieldOperationMetadata_IndexConfigDelta_ADD FieldOperationMetadata_IndexConfigDelta_ChangeType = 1
	// The single field index is being removed.
	FieldOperationMetadata_IndexConfigDelta_REMOVE FieldOperationMetadata_IndexConfigDelta_ChangeType = 2
)

func (FieldOperationMetadata_IndexConfigDelta_ChangeType) Descriptor 

func (FieldOperationMetadata_IndexConfigDelta_ChangeType) Descriptor() protoreflect.EnumDescriptor

func (FieldOperationMetadata_IndexConfigDelta_ChangeType) Enum 

func (x FieldOperationMetadata_IndexConfigDelta_ChangeType) Enum() *FieldOperationMetadata_IndexConfigDelta_ChangeType

func (FieldOperationMetadata_IndexConfigDelta_ChangeType) EnumDescriptor deprecated 

func (FieldOperationMetadata_IndexConfigDelta_ChangeType) EnumDescriptor() ([]byte, []int)

Deprecated: Use FieldOperationMetadata_IndexConfigDelta_ChangeType.Descriptor instead.

func (FieldOperationMetadata_IndexConfigDelta_ChangeType) Number 

func (x FieldOperationMetadata_IndexConfigDelta_ChangeType) Number() protoreflect.EnumNumber

func (FieldOperationMetadata_IndexConfigDelta_ChangeType) String 

func (x FieldOperationMetadata_IndexConfigDelta_ChangeType) String() string

func (FieldOperationMetadata_IndexConfigDelta_ChangeType) Type 

func (FieldOperationMetadata_IndexConfigDelta_ChangeType) Type() protoreflect.EnumType

type FieldOperationMetadata_TtlConfigDelta 

type FieldOperationMetadata_TtlConfigDelta struct {

	// Specifies how the TTL configuration is changing.
	ChangeType FieldOperationMetadata_TtlConfigDelta_ChangeType `` /* 172-byte string literal not displayed */
	// contains filtered or unexported fields
}

Information about a TTL configuration change.

func (*FieldOperationMetadata_TtlConfigDelta) Descriptor deprecated 

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

Deprecated: Use FieldOperationMetadata_TtlConfigDelta.ProtoReflect.Descriptor instead.

func (*FieldOperationMetadata_TtlConfigDelta) GetChangeType 

func (x *FieldOperationMetadata_TtlConfigDelta) GetChangeType() FieldOperationMetadata_TtlConfigDelta_ChangeType

func (*FieldOperationMetadata_TtlConfigDelta) ProtoMessage 

func (*FieldOperationMetadata_TtlConfigDelta) ProtoMessage()

func (*FieldOperationMetadata_TtlConfigDelta) ProtoReflect 

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

func (*FieldOperationMetadata_TtlConfigDelta) Reset 

func (x *FieldOperationMetadata_TtlConfigDelta) Reset()

func (*FieldOperationMetadata_TtlConfigDelta) String 

func (x *FieldOperationMetadata_TtlConfigDelta) String() string

type FieldOperationMetadata_TtlConfigDelta_ChangeType 

type FieldOperationMetadata_TtlConfigDelta_ChangeType int32

Specifies how the TTL config is changing. 

const (
	// The type of change is not specified or known.
	FieldOperationMetadata_TtlConfigDelta_CHANGE_TYPE_UNSPECIFIED FieldOperationMetadata_TtlConfigDelta_ChangeType = 0
	// The TTL config is being added.
	FieldOperationMetadata_TtlConfigDelta_ADD FieldOperationMetadata_TtlConfigDelta_ChangeType = 1
	// The TTL config is being removed.
	FieldOperationMetadata_TtlConfigDelta_REMOVE FieldOperationMetadata_TtlConfigDelta_ChangeType = 2
)

func (FieldOperationMetadata_TtlConfigDelta_ChangeType) Descriptor 

func (FieldOperationMetadata_TtlConfigDelta_ChangeType) Descriptor() protoreflect.EnumDescriptor

func (FieldOperationMetadata_TtlConfigDelta_ChangeType) Enum 

func (x FieldOperationMetadata_TtlConfigDelta_ChangeType) Enum() *FieldOperationMetadata_TtlConfigDelta_ChangeType

func (FieldOperationMetadata_TtlConfigDelta_ChangeType) EnumDescriptor deprecated 

func (FieldOperationMetadata_TtlConfigDelta_ChangeType) EnumDescriptor() ([]byte, []int)

Deprecated: Use FieldOperationMetadata_TtlConfigDelta_ChangeType.Descriptor instead.

func (FieldOperationMetadata_TtlConfigDelta_ChangeType) Number 

func (x FieldOperationMetadata_TtlConfigDelta_ChangeType) Number() protoreflect.EnumNumber

func (FieldOperationMetadata_TtlConfigDelta_ChangeType) String 

func (x FieldOperationMetadata_TtlConfigDelta_ChangeType) String() string

func (FieldOperationMetadata_TtlConfigDelta_ChangeType) Type 

func (FieldOperationMetadata_TtlConfigDelta_ChangeType) Type() protoreflect.EnumType

type Field_IndexConfig 

type Field_IndexConfig struct {

	// The indexes supported for this field.
	Indexes []*Index `protobuf:"bytes,1,rep,name=indexes,proto3" json:"indexes,omitempty"`
	// Output only. When true, the `Field`'s index configuration is set from the
	// configuration specified by the `ancestor_field`.
	// When false, the `Field`'s index configuration is defined explicitly.
	UsesAncestorConfig bool `protobuf:"varint,2,opt,name=uses_ancestor_config,json=usesAncestorConfig,proto3" json:"uses_ancestor_config,omitempty"`
	// Output only. Specifies the resource name of the `Field` from which this field's
	// index configuration is set (when `uses_ancestor_config` is true),
	// or from which it *would* be set if this field had no index configuration
	// (when `uses_ancestor_config` is false).
	AncestorField string `protobuf:"bytes,3,opt,name=ancestor_field,json=ancestorField,proto3" json:"ancestor_field,omitempty"`
	// Output only
	// When true, the `Field`'s index configuration is in the process of being
	// reverted. Once complete, the index config will transition to the same
	// state as the field specified by `ancestor_field`, at which point
	// `uses_ancestor_config` will be `true` and `reverting` will be `false`.
	Reverting bool `protobuf:"varint,4,opt,name=reverting,proto3" json:"reverting,omitempty"`
	// contains filtered or unexported fields
}

The index configuration for this field.

func (*Field_IndexConfig) Descriptor deprecated 

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

Deprecated: Use Field_IndexConfig.ProtoReflect.Descriptor instead.

func (*Field_IndexConfig) GetAncestorField 

func (x *Field_IndexConfig) GetAncestorField() string

func (*Field_IndexConfig) GetIndexes 

func (x *Field_IndexConfig) GetIndexes() []*Index

func (*Field_IndexConfig) GetReverting 

func (x *Field_IndexConfig) GetReverting() bool

func (*Field_IndexConfig) GetUsesAncestorConfig 

func (x *Field_IndexConfig) GetUsesAncestorConfig() bool

func (*Field_IndexConfig) ProtoMessage 

func (*Field_IndexConfig) ProtoMessage()

func (*Field_IndexConfig) ProtoReflect 

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

func (*Field_IndexConfig) Reset 

func (x *Field_IndexConfig) Reset()

func (*Field_IndexConfig) String 

func (x *Field_IndexConfig) String() string

type Field_TtlConfig 

type Field_TtlConfig struct {

	// Output only. The state of the TTL configuration.
	State Field_TtlConfig_State `protobuf:"varint,1,opt,name=state,proto3,enum=google.firestore.admin.v1.Field_TtlConfig_State" json:"state,omitempty"`
	// contains filtered or unexported fields
}

The TTL (time-to-live) configuration for documents that have this `Field` set. Storing a timestamp value into a TTL-enabled field will be treated as the document's absolute expiration time. Using any other data type or leaving the field absent will disable the TTL for the individual document.

func (*Field_TtlConfig) Descriptor deprecated 

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

Deprecated: Use Field_TtlConfig.ProtoReflect.Descriptor instead.

func (*Field_TtlConfig) GetState 

func (x *Field_TtlConfig) GetState() Field_TtlConfig_State

func (*Field_TtlConfig) ProtoMessage 

func (*Field_TtlConfig) ProtoMessage()

func (*Field_TtlConfig) ProtoReflect 

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

func (*Field_TtlConfig) Reset 

func (x *Field_TtlConfig) Reset()

func (*Field_TtlConfig) String 

func (x *Field_TtlConfig) String() string

type Field_TtlConfig_State 

type Field_TtlConfig_State int32

The state of applying the TTL configuration to all documents. 

const (
	// The state is unspecified or unknown.
	Field_TtlConfig_STATE_UNSPECIFIED Field_TtlConfig_State = 0
	// The TTL is being applied. There is an active long-running operation to
	// track the change. Newly written documents will have TTLs applied as
	// requested. Requested TTLs on existing documents are still being
	// processed. When TTLs on all existing documents have been processed, the
	// state will move to 'ACTIVE'.
	Field_TtlConfig_CREATING Field_TtlConfig_State = 1
	// The TTL is active for all documents.
	Field_TtlConfig_ACTIVE Field_TtlConfig_State = 2
	// The TTL configuration could not be enabled for all existing documents.
	// Newly written documents will continue to have their TTL applied.
	// The LRO returned when last attempting to enable TTL for this `Field`
	// has failed, and may have more details.
	Field_TtlConfig_NEEDS_REPAIR Field_TtlConfig_State = 3
)

func (Field_TtlConfig_State) Descriptor 

func (Field_TtlConfig_State) Descriptor() protoreflect.EnumDescriptor

func (Field_TtlConfig_State) Enum 

func (x Field_TtlConfig_State) Enum() *Field_TtlConfig_State

func (Field_TtlConfig_State) EnumDescriptor deprecated 

func (Field_TtlConfig_State) EnumDescriptor() ([]byte, []int)

Deprecated: Use Field_TtlConfig_State.Descriptor instead.

func (Field_TtlConfig_State) Number 

func (x Field_TtlConfig_State) Number() protoreflect.EnumNumber

func (Field_TtlConfig_State) String 

func (x Field_TtlConfig_State) String() string

func (Field_TtlConfig_State) Type 

func (Field_TtlConfig_State) Type() protoreflect.EnumType

type FirestoreAdminClient 

type FirestoreAdminClient interface {
	// Creates a composite index. This returns a
	// [google.longrunning.Operation][google.longrunning.Operation] which may be
	// used to track the status of the creation. The metadata for the operation
	// will be the type
	// [IndexOperationMetadata][google.firestore.admin.v1.IndexOperationMetadata].
	CreateIndex(ctx context.Context, in *CreateIndexRequest, opts ...grpc.CallOption) (*longrunningpb.Operation, error)
	// Lists composite indexes.
	ListIndexes(ctx context.Context, in *ListIndexesRequest, opts ...grpc.CallOption) (*ListIndexesResponse, error)
	// Gets a composite index.
	GetIndex(ctx context.Context, in *GetIndexRequest, opts ...grpc.CallOption) (*Index, error)
	// Deletes a composite index.
	DeleteIndex(ctx context.Context, in *DeleteIndexRequest, opts ...grpc.CallOption) (*emptypb.Empty, error)
	// Gets the metadata and configuration for a Field.
	GetField(ctx context.Context, in *GetFieldRequest, opts ...grpc.CallOption) (*Field, error)
	// Updates a field configuration. Currently, field updates apply only to
	// single field index configuration. However, calls to
	// [FirestoreAdmin.UpdateField][google.firestore.admin.v1.FirestoreAdmin.UpdateField]
	// should provide a field mask to avoid changing any configuration that the
	// caller isn't aware of. The field mask should be specified as: `{ paths:
	// "index_config" }`.
	//
	// This call returns a
	// [google.longrunning.Operation][google.longrunning.Operation] which may be
	// used to track the status of the field update. The metadata for the
	// operation will be the type
	// [FieldOperationMetadata][google.firestore.admin.v1.FieldOperationMetadata].
	//
	// To configure the default field settings for the database, use
	// the special `Field` with resource name:
	// `projects/{project_id}/databases/{database_id}/collectionGroups/__default__/fields/*`.
	UpdateField(ctx context.Context, in *UpdateFieldRequest, opts ...grpc.CallOption) (*longrunningpb.Operation, error)
	// Lists the field configuration and metadata for this database.
	//
	// Currently,
	// [FirestoreAdmin.ListFields][google.firestore.admin.v1.FirestoreAdmin.ListFields]
	// only supports listing fields that have been explicitly overridden. To issue
	// this query, call
	// [FirestoreAdmin.ListFields][google.firestore.admin.v1.FirestoreAdmin.ListFields]
	// with the filter set to `indexConfig.usesAncestorConfig:false` or
	// `ttlConfig:*`.
	ListFields(ctx context.Context, in *ListFieldsRequest, opts ...grpc.CallOption) (*ListFieldsResponse, error)
	// Exports a copy of all or a subset of documents from Google Cloud Firestore
	// to another storage system, such as Google Cloud Storage. Recent updates to
	// documents may not be reflected in the export. The export occurs in the
	// background and its progress can be monitored and managed via the
	// Operation resource that is created. The output of an export may only be
	// used once the associated operation is done. If an export operation is
	// cancelled before completion it may leave partial data behind in Google
	// Cloud Storage.
	//
	// For more details on export behavior and output format, refer to:
	// https://cloud.google.com/firestore/docs/manage-data/export-import
	ExportDocuments(ctx context.Context, in *ExportDocumentsRequest, opts ...grpc.CallOption) (*longrunningpb.Operation, error)
	// Imports documents into Google Cloud Firestore. Existing documents with the
	// same name are overwritten. The import occurs in the background and its
	// progress can be monitored and managed via the Operation resource that is
	// created. If an ImportDocuments operation is cancelled, it is possible
	// that a subset of the data has already been imported to Cloud Firestore.
	ImportDocuments(ctx context.Context, in *ImportDocumentsRequest, opts ...grpc.CallOption) (*longrunningpb.Operation, error)
	// Create a database.
	CreateDatabase(ctx context.Context, in *CreateDatabaseRequest, opts ...grpc.CallOption) (*longrunningpb.Operation, error)
	// Gets information about a database.
	GetDatabase(ctx context.Context, in *GetDatabaseRequest, opts ...grpc.CallOption) (*Database, error)
	// List all the databases in the project.
	ListDatabases(ctx context.Context, in *ListDatabasesRequest, opts ...grpc.CallOption) (*ListDatabasesResponse, error)
	// Updates a database.
	UpdateDatabase(ctx context.Context, in *UpdateDatabaseRequest, opts ...grpc.CallOption) (*longrunningpb.Operation, error)
	// Deletes a database.
	DeleteDatabase(ctx context.Context, in *DeleteDatabaseRequest, opts ...grpc.CallOption) (*longrunningpb.Operation, error)
}

FirestoreAdminClient is the client API for FirestoreAdmin service.

For semantics around ctx use and closing/ending streaming RPCs, please refer to https://godoc.org/google.golang.org/grpc#ClientConn.NewStream.

func NewFirestoreAdminClient 

func NewFirestoreAdminClient(cc grpc.ClientConnInterface) FirestoreAdminClient

type FirestoreAdminServer 

type FirestoreAdminServer interface {
	// Creates a composite index. This returns a
	// [google.longrunning.Operation][google.longrunning.Operation] which may be
	// used to track the status of the creation. The metadata for the operation
	// will be the type
	// [IndexOperationMetadata][google.firestore.admin.v1.IndexOperationMetadata].
	CreateIndex(context.Context, *CreateIndexRequest) (*longrunningpb.Operation, error)
	// Lists composite indexes.
	ListIndexes(context.Context, *ListIndexesRequest) (*ListIndexesResponse, error)
	// Gets a composite index.
	GetIndex(context.Context, *GetIndexRequest) (*Index, error)
	// Deletes a composite index.
	DeleteIndex(context.Context, *DeleteIndexRequest) (*emptypb.Empty, error)
	// Gets the metadata and configuration for a Field.
	GetField(context.Context, *GetFieldRequest) (*Field, error)
	// Updates a field configuration. Currently, field updates apply only to
	// single field index configuration. However, calls to
	// [FirestoreAdmin.UpdateField][google.firestore.admin.v1.FirestoreAdmin.UpdateField]
	// should provide a field mask to avoid changing any configuration that the
	// caller isn't aware of. The field mask should be specified as: `{ paths:
	// "index_config" }`.
	//
	// This call returns a
	// [google.longrunning.Operation][google.longrunning.Operation] which may be
	// used to track the status of the field update. The metadata for the
	// operation will be the type
	// [FieldOperationMetadata][google.firestore.admin.v1.FieldOperationMetadata].
	//
	// To configure the default field settings for the database, use
	// the special `Field` with resource name:
	// `projects/{project_id}/databases/{database_id}/collectionGroups/__default__/fields/*`.
	UpdateField(context.Context, *UpdateFieldRequest) (*longrunningpb.Operation, error)
	// Lists the field configuration and metadata for this database.
	//
	// Currently,
	// [FirestoreAdmin.ListFields][google.firestore.admin.v1.FirestoreAdmin.ListFields]
	// only supports listing fields that have been explicitly overridden. To issue
	// this query, call
	// [FirestoreAdmin.ListFields][google.firestore.admin.v1.FirestoreAdmin.ListFields]
	// with the filter set to `indexConfig.usesAncestorConfig:false` or
	// `ttlConfig:*`.
	ListFields(context.Context, *ListFieldsRequest) (*ListFieldsResponse, error)
	// Exports a copy of all or a subset of documents from Google Cloud Firestore
	// to another storage system, such as Google Cloud Storage. Recent updates to
	// documents may not be reflected in the export. The export occurs in the
	// background and its progress can be monitored and managed via the
	// Operation resource that is created. The output of an export may only be
	// used once the associated operation is done. If an export operation is
	// cancelled before completion it may leave partial data behind in Google
	// Cloud Storage.
	//
	// For more details on export behavior and output format, refer to:
	// https://cloud.google.com/firestore/docs/manage-data/export-import
	ExportDocuments(context.Context, *ExportDocumentsRequest) (*longrunningpb.Operation, error)
	// Imports documents into Google Cloud Firestore. Existing documents with the
	// same name are overwritten. The import occurs in the background and its
	// progress can be monitored and managed via the Operation resource that is
	// created. If an ImportDocuments operation is cancelled, it is possible
	// that a subset of the data has already been imported to Cloud Firestore.
	ImportDocuments(context.Context, *ImportDocumentsRequest) (*longrunningpb.Operation, error)
	// Create a database.
	CreateDatabase(context.Context, *CreateDatabaseRequest) (*longrunningpb.Operation, error)
	// Gets information about a database.
	GetDatabase(context.Context, *GetDatabaseRequest) (*Database, error)
	// List all the databases in the project.
	ListDatabases(context.Context, *ListDatabasesRequest) (*ListDatabasesResponse, error)
	// Updates a database.
	UpdateDatabase(context.Context, *UpdateDatabaseRequest) (*longrunningpb.Operation, error)
	// Deletes a database.
	DeleteDatabase(context.Context, *DeleteDatabaseRequest) (*longrunningpb.Operation, error)
}

FirestoreAdminServer is the server API for FirestoreAdmin service.

type GetDatabaseRequest 

type GetDatabaseRequest struct {

	// Required. A name of the form
	// `projects/{project_id}/databases/{database_id}`
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// contains filtered or unexported fields
}

The request for [FirestoreAdmin.GetDatabase][google.firestore.admin.v1.FirestoreAdmin.GetDatabase].

func (*GetDatabaseRequest) Descriptor deprecated 

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

Deprecated: Use GetDatabaseRequest.ProtoReflect.Descriptor instead.

func (*GetDatabaseRequest) GetName 

func (x *GetDatabaseRequest) GetName() string

func (*GetDatabaseRequest) ProtoMessage 

func (*GetDatabaseRequest) ProtoMessage()

func (*GetDatabaseRequest) ProtoReflect 

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

func (*GetDatabaseRequest) Reset 

func (x *GetDatabaseRequest) Reset()

func (*GetDatabaseRequest) String 

func (x *GetDatabaseRequest) String() string

type GetFieldRequest 

type GetFieldRequest struct {

	// Required. A name of the form
	// `projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/fields/{field_id}`
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// contains filtered or unexported fields
}

The request for [FirestoreAdmin.GetField][google.firestore.admin.v1.FirestoreAdmin.GetField].

func (*GetFieldRequest) Descriptor deprecated 

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

Deprecated: Use GetFieldRequest.ProtoReflect.Descriptor instead.

func (*GetFieldRequest) GetName 

func (x *GetFieldRequest) GetName() string

func (*GetFieldRequest) ProtoMessage 

func (*GetFieldRequest) ProtoMessage()

func (*GetFieldRequest) ProtoReflect 

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

func (*GetFieldRequest) Reset 

func (x *GetFieldRequest) Reset()

func (*GetFieldRequest) String 

func (x *GetFieldRequest) String() string

type GetIndexRequest 

type GetIndexRequest struct {

	// Required. A name of the form
	// `projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/indexes/{index_id}`
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// contains filtered or unexported fields
}

The request for [FirestoreAdmin.GetIndex][google.firestore.admin.v1.FirestoreAdmin.GetIndex].

func (*GetIndexRequest) Descriptor deprecated 

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

Deprecated: Use GetIndexRequest.ProtoReflect.Descriptor instead.

func (*GetIndexRequest) GetName 

func (x *GetIndexRequest) GetName() string

func (*GetIndexRequest) ProtoMessage 

func (*GetIndexRequest) ProtoMessage()

func (*GetIndexRequest) ProtoReflect 

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

func (*GetIndexRequest) Reset 

func (x *GetIndexRequest) Reset()

func (*GetIndexRequest) String 

func (x *GetIndexRequest) String() string

type ImportDocumentsMetadata 

type ImportDocumentsMetadata struct {

	// The time this operation started.
	StartTime *timestamppb.Timestamp `protobuf:"bytes,1,opt,name=start_time,json=startTime,proto3" json:"start_time,omitempty"`
	// The time this operation completed. Will be unset if operation still in
	// progress.
	EndTime *timestamppb.Timestamp `protobuf:"bytes,2,opt,name=end_time,json=endTime,proto3" json:"end_time,omitempty"`
	// The state of the import operation.
	OperationState OperationState `` /* 150-byte string literal not displayed */
	// The progress, in documents, of this operation.
	ProgressDocuments *Progress `protobuf:"bytes,4,opt,name=progress_documents,json=progressDocuments,proto3" json:"progress_documents,omitempty"`
	// The progress, in bytes, of this operation.
	ProgressBytes *Progress `protobuf:"bytes,5,opt,name=progress_bytes,json=progressBytes,proto3" json:"progress_bytes,omitempty"`
	// Which collection ids are being imported.
	CollectionIds []string `protobuf:"bytes,6,rep,name=collection_ids,json=collectionIds,proto3" json:"collection_ids,omitempty"`
	// The location of the documents being imported.
	InputUriPrefix string `protobuf:"bytes,7,opt,name=input_uri_prefix,json=inputUriPrefix,proto3" json:"input_uri_prefix,omitempty"`
	// Which namespace ids are being imported.
	NamespaceIds []string `protobuf:"bytes,8,rep,name=namespace_ids,json=namespaceIds,proto3" json:"namespace_ids,omitempty"`
	// contains filtered or unexported fields
}

Metadata for [google.longrunning.Operation][google.longrunning.Operation] results from [FirestoreAdmin.ImportDocuments][google.firestore.admin.v1.FirestoreAdmin.ImportDocuments].

func (*ImportDocumentsMetadata) Descriptor deprecated 

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

Deprecated: Use ImportDocumentsMetadata.ProtoReflect.Descriptor instead.

func (*ImportDocumentsMetadata) GetCollectionIds 

func (x *ImportDocumentsMetadata) GetCollectionIds() []string

func (*ImportDocumentsMetadata) GetEndTime 

func (x *ImportDocumentsMetadata) GetEndTime() *timestamppb.Timestamp

func (*ImportDocumentsMetadata) GetInputUriPrefix 

func (x *ImportDocumentsMetadata) GetInputUriPrefix() string

func (*ImportDocumentsMetadata) GetNamespaceIds added in v1.15.0 

func (x *ImportDocumentsMetadata) GetNamespaceIds() []string

func (*ImportDocumentsMetadata) GetOperationState 

func (x *ImportDocumentsMetadata) GetOperationState() OperationState

func (*ImportDocumentsMetadata) GetProgressBytes 

func (x *ImportDocumentsMetadata) GetProgressBytes() *Progress

func (*ImportDocumentsMetadata) GetProgressDocuments 

func (x *ImportDocumentsMetadata) GetProgressDocuments() *Progress

func (*ImportDocumentsMetadata) GetStartTime 

func (x *ImportDocumentsMetadata) GetStartTime() *timestamppb.Timestamp

func (*ImportDocumentsMetadata) ProtoMessage 

func (*ImportDocumentsMetadata) ProtoMessage()

func (*ImportDocumentsMetadata) ProtoReflect 

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

func (*ImportDocumentsMetadata) Reset 

func (x *ImportDocumentsMetadata) Reset()

func (*ImportDocumentsMetadata) String 

func (x *ImportDocumentsMetadata) String() string

type ImportDocumentsRequest 

type ImportDocumentsRequest struct {

	// Required. Database to import into. Should be of the form:
	// `projects/{project_id}/databases/{database_id}`.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// Which collection ids to import. Unspecified means all collections included
	// in the import.
	CollectionIds []string `protobuf:"bytes,2,rep,name=collection_ids,json=collectionIds,proto3" json:"collection_ids,omitempty"`
	// Location of the exported files.
	// This must match the output_uri_prefix of an ExportDocumentsResponse from
	// an export that has completed successfully.
	// See:
	// [google.firestore.admin.v1.ExportDocumentsResponse.output_uri_prefix][google.firestore.admin.v1.ExportDocumentsResponse.output_uri_prefix].
	InputUriPrefix string `protobuf:"bytes,3,opt,name=input_uri_prefix,json=inputUriPrefix,proto3" json:"input_uri_prefix,omitempty"`
	// An empty list represents all namespaces. This is the preferred
	// usage for databases that don't use namespaces.
	//
	// An empty string element represents the default namespace. This should be
	// used if the database has data in non-default namespaces, but doesn't want
	// to include them. Each namespace in this list must be unique.
	NamespaceIds []string `protobuf:"bytes,4,rep,name=namespace_ids,json=namespaceIds,proto3" json:"namespace_ids,omitempty"`
	// contains filtered or unexported fields
}

The request for [FirestoreAdmin.ImportDocuments][google.firestore.admin.v1.FirestoreAdmin.ImportDocuments].

func (*ImportDocumentsRequest) Descriptor deprecated 

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

Deprecated: Use ImportDocumentsRequest.ProtoReflect.Descriptor instead.

func (*ImportDocumentsRequest) GetCollectionIds 

func (x *ImportDocumentsRequest) GetCollectionIds() []string

func (*ImportDocumentsRequest) GetInputUriPrefix 

func (x *ImportDocumentsRequest) GetInputUriPrefix() string

func (*ImportDocumentsRequest) GetName 

func (x *ImportDocumentsRequest) GetName() string

func (*ImportDocumentsRequest) GetNamespaceIds added in v1.15.0 

func (x *ImportDocumentsRequest) GetNamespaceIds() []string

func (*ImportDocumentsRequest) ProtoMessage 

func (*ImportDocumentsRequest) ProtoMessage()

func (*ImportDocumentsRequest) ProtoReflect 

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

func (*ImportDocumentsRequest) Reset 

func (x *ImportDocumentsRequest) Reset()

func (*ImportDocumentsRequest) String 

func (x *ImportDocumentsRequest) String() string

type Index 

type Index struct {

	// Output only. A server defined name for this index.
	// The form of this name for composite indexes will be:
	// `projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/indexes/{composite_index_id}`
	// For single field indexes, this field will be empty.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// Indexes with a collection query scope specified allow queries
	// against a collection that is the child of a specific document, specified at
	// query time, and that has the same collection id.
	//
	// Indexes with a collection group query scope specified allow queries against
	// all collections descended from a specific document, specified at query
	// time, and that have the same collection id as this index.
	QueryScope Index_QueryScope `` /* 140-byte string literal not displayed */
	// The API scope supported by this index.
	ApiScope Index_ApiScope `` /* 132-byte string literal not displayed */
	// The fields supported by this index.
	//
	// For composite indexes, this requires a minimum of 2 and a maximum of 100
	// fields. The last field entry is always for the field path `__name__`. If,
	// on creation, `__name__` was not specified as the last field, it will be
	// added automatically with the same direction as that of the last field
	// defined. If the final field in a composite index is not directional, the
	// `__name__` will be ordered ASCENDING (unless explicitly specified).
	//
	// For single field indexes, this will always be exactly one entry with a
	// field path equal to the field path of the associated field.
	Fields []*Index_IndexField `protobuf:"bytes,3,rep,name=fields,proto3" json:"fields,omitempty"`
	// Output only. The serving state of the index.
	State Index_State `protobuf:"varint,4,opt,name=state,proto3,enum=google.firestore.admin.v1.Index_State" json:"state,omitempty"`
	// contains filtered or unexported fields
}

Cloud Firestore indexes enable simple and complex queries against documents in a database.

func (*Index) Descriptor deprecated 

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

Deprecated: Use Index.ProtoReflect.Descriptor instead.

func (*Index) GetApiScope added in v1.15.0 

func (x *Index) GetApiScope() Index_ApiScope

func (*Index) GetFields 

func (x *Index) GetFields() []*Index_IndexField

func (*Index) GetName 

func (x *Index) GetName() string

func (*Index) GetQueryScope 

func (x *Index) GetQueryScope() Index_QueryScope

func (*Index) GetState 

func (x *Index) GetState() Index_State

func (*Index) ProtoMessage 

func (*Index) ProtoMessage()

func (*Index) ProtoReflect 

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

func (*Index) Reset 

func (x *Index) Reset()

func (*Index) String 

func (x *Index) String() string

type IndexOperationMetadata 

type IndexOperationMetadata struct {

	// The time this operation started.
	StartTime *timestamppb.Timestamp `protobuf:"bytes,1,opt,name=start_time,json=startTime,proto3" json:"start_time,omitempty"`
	// The time this operation completed. Will be unset if operation still in
	// progress.
	EndTime *timestamppb.Timestamp `protobuf:"bytes,2,opt,name=end_time,json=endTime,proto3" json:"end_time,omitempty"`
	// The index resource that this operation is acting on. For example:
	// `projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/indexes/{index_id}`
	Index string `protobuf:"bytes,3,opt,name=index,proto3" json:"index,omitempty"`
	// The state of the operation.
	State OperationState `protobuf:"varint,4,opt,name=state,proto3,enum=google.firestore.admin.v1.OperationState" json:"state,omitempty"`
	// The progress, in documents, of this operation.
	ProgressDocuments *Progress `protobuf:"bytes,5,opt,name=progress_documents,json=progressDocuments,proto3" json:"progress_documents,omitempty"`
	// The progress, in bytes, of this operation.
	ProgressBytes *Progress `protobuf:"bytes,6,opt,name=progress_bytes,json=progressBytes,proto3" json:"progress_bytes,omitempty"`
	// contains filtered or unexported fields
}

Metadata for [google.longrunning.Operation][google.longrunning.Operation] results from [FirestoreAdmin.CreateIndex][google.firestore.admin.v1.FirestoreAdmin.CreateIndex].

func (*IndexOperationMetadata) Descriptor deprecated 

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

Deprecated: Use IndexOperationMetadata.ProtoReflect.Descriptor instead.

func (*IndexOperationMetadata) GetEndTime 

func (x *IndexOperationMetadata) GetEndTime() *timestamppb.Timestamp

func (*IndexOperationMetadata) GetIndex 

func (x *IndexOperationMetadata) GetIndex() string

func (*IndexOperationMetadata) GetProgressBytes 

func (x *IndexOperationMetadata) GetProgressBytes() *Progress

func (*IndexOperationMetadata) GetProgressDocuments 

func (x *IndexOperationMetadata) GetProgressDocuments() *Progress

func (*IndexOperationMetadata) GetStartTime 

func (x *IndexOperationMetadata) GetStartTime() *timestamppb.Timestamp

func (*IndexOperationMetadata) GetState 

func (x *IndexOperationMetadata) GetState() OperationState

func (*IndexOperationMetadata) ProtoMessage 

func (*IndexOperationMetadata) ProtoMessage()

func (*IndexOperationMetadata) ProtoReflect 

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

func (*IndexOperationMetadata) Reset 

func (x *IndexOperationMetadata) Reset()

func (*IndexOperationMetadata) String 

func (x *IndexOperationMetadata) String() string

type Index_ApiScope added in v1.15.0 

type Index_ApiScope int32

API Scope defines the APIs (Firestore Native, or Firestore in Datastore Mode) that are supported for queries. 

const (
	// The index can only be used by the Firestore Native query API.
	// This is the default.
	Index_ANY_API Index_ApiScope = 0
	// The index can only be used by the Firestore in Datastore Mode query API.
	Index_DATASTORE_MODE_API Index_ApiScope = 1
)

func (Index_ApiScope) Descriptor added in v1.15.0 

func (Index_ApiScope) Descriptor() protoreflect.EnumDescriptor

func (Index_ApiScope) Enum added in v1.15.0 

func (x Index_ApiScope) Enum() *Index_ApiScope

func (Index_ApiScope) EnumDescriptor deprecated added in v1.15.0 

func (Index_ApiScope) EnumDescriptor() ([]byte, []int)

Deprecated: Use Index_ApiScope.Descriptor instead.

func (Index_ApiScope) Number added in v1.15.0 

func (x Index_ApiScope) Number() protoreflect.EnumNumber

func (Index_ApiScope) String added in v1.15.0 

func (x Index_ApiScope) String() string

func (Index_ApiScope) Type added in v1.15.0 

func (Index_ApiScope) Type() protoreflect.EnumType

type Index_IndexField 

type Index_IndexField struct {

	// Can be __name__.
	// For single field indexes, this must match the name of the field or may
	// be omitted.
	FieldPath string `protobuf:"bytes,1,opt,name=field_path,json=fieldPath,proto3" json:"field_path,omitempty"`
	// How the field value is indexed.
	//
	// Types that are assignable to ValueMode:
	//
	//	*Index_IndexField_Order_
	//	*Index_IndexField_ArrayConfig_
	ValueMode isIndex_IndexField_ValueMode `protobuf_oneof:"value_mode"`
	// contains filtered or unexported fields
}

A field in an index. The field_path describes which field is indexed, the value_mode describes how the field value is indexed.

func (*Index_IndexField) Descriptor deprecated 

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

Deprecated: Use Index_IndexField.ProtoReflect.Descriptor instead.

func (*Index_IndexField) GetArrayConfig 

func (x *Index_IndexField) GetArrayConfig() Index_IndexField_ArrayConfig

func (*Index_IndexField) GetFieldPath 

func (x *Index_IndexField) GetFieldPath() string

func (*Index_IndexField) GetOrder 

func (x *Index_IndexField) GetOrder() Index_IndexField_Order

func (*Index_IndexField) GetValueMode 

func (m *Index_IndexField) GetValueMode() isIndex_IndexField_ValueMode

func (*Index_IndexField) ProtoMessage 

func (*Index_IndexField) ProtoMessage()

func (*Index_IndexField) ProtoReflect 

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

func (*Index_IndexField) Reset 

func (x *Index_IndexField) Reset()

func (*Index_IndexField) String 

func (x *Index_IndexField) String() string

type Index_IndexField_ArrayConfig 

type Index_IndexField_ArrayConfig int32

The supported array value configurations. 

const (
	// The index does not support additional array queries.
	Index_IndexField_ARRAY_CONFIG_UNSPECIFIED Index_IndexField_ArrayConfig = 0
	// The index supports array containment queries.
	Index_IndexField_CONTAINS Index_IndexField_ArrayConfig = 1
)

func (Index_IndexField_ArrayConfig) Descriptor 

func (Index_IndexField_ArrayConfig) Descriptor() protoreflect.EnumDescriptor

func (Index_IndexField_ArrayConfig) Enum 

func (x Index_IndexField_ArrayConfig) Enum() *Index_IndexField_ArrayConfig

func (Index_IndexField_ArrayConfig) EnumDescriptor deprecated 

func (Index_IndexField_ArrayConfig) EnumDescriptor() ([]byte, []int)

Deprecated: Use Index_IndexField_ArrayConfig.Descriptor instead.

func (Index_IndexField_ArrayConfig) Number 

func (x Index_IndexField_ArrayConfig) Number() protoreflect.EnumNumber

func (Index_IndexField_ArrayConfig) String 

func (x Index_IndexField_ArrayConfig) String() string

func (Index_IndexField_ArrayConfig) Type 

func (Index_IndexField_ArrayConfig) Type() protoreflect.EnumType

type Index_IndexField_ArrayConfig_ 

type Index_IndexField_ArrayConfig_ struct {
	// Indicates that this field supports operations on `array_value`s.
	ArrayConfig Index_IndexField_ArrayConfig `` /* 131-byte string literal not displayed */
}

type Index_IndexField_Order 

type Index_IndexField_Order int32

The supported orderings. 

const (
	// The ordering is unspecified. Not a valid option.
	Index_IndexField_ORDER_UNSPECIFIED Index_IndexField_Order = 0
	// The field is ordered by ascending field value.
	Index_IndexField_ASCENDING Index_IndexField_Order = 1
	// The field is ordered by descending field value.
	Index_IndexField_DESCENDING Index_IndexField_Order = 2
)

func (Index_IndexField_Order) Descriptor 

func (Index_IndexField_Order) Descriptor() protoreflect.EnumDescriptor

func (Index_IndexField_Order) Enum 

func (x Index_IndexField_Order) Enum() *Index_IndexField_Order

func (Index_IndexField_Order) EnumDescriptor deprecated 

func (Index_IndexField_Order) EnumDescriptor() ([]byte, []int)

Deprecated: Use Index_IndexField_Order.Descriptor instead.

func (Index_IndexField_Order) Number 

func (x Index_IndexField_Order) Number() protoreflect.EnumNumber

func (Index_IndexField_Order) String 

func (x Index_IndexField_Order) String() string

func (Index_IndexField_Order) Type 

func (Index_IndexField_Order) Type() protoreflect.EnumType

type Index_IndexField_Order_ 

type Index_IndexField_Order_ struct {
	// Indicates that this field supports ordering by the specified order or
	// comparing using =, !=, <, <=, >, >=.
	Order Index_IndexField_Order `protobuf:"varint,2,opt,name=order,proto3,enum=google.firestore.admin.v1.Index_IndexField_Order,oneof"`
}

type Index_QueryScope 

type Index_QueryScope int32

Query Scope defines the scope at which a query is run. This is specified on a StructuredQuery's `from` field. 

const (
	// The query scope is unspecified. Not a valid option.
	Index_QUERY_SCOPE_UNSPECIFIED Index_QueryScope = 0
	// Indexes with a collection query scope specified allow queries
	// against a collection that is the child of a specific document, specified
	// at query time, and that has the collection id specified by the index.
	Index_COLLECTION Index_QueryScope = 1
	// Indexes with a collection group query scope specified allow queries
	// against all collections that has the collection id specified by the
	// index.
	Index_COLLECTION_GROUP Index_QueryScope = 2
	// Include all the collections's ancestor in the index. Only available for
	// Datastore Mode databases.
	Index_COLLECTION_RECURSIVE Index_QueryScope = 3
)

func (Index_QueryScope) Descriptor 

func (Index_QueryScope) Descriptor() protoreflect.EnumDescriptor

func (Index_QueryScope) Enum 

func (x Index_QueryScope) Enum() *Index_QueryScope

func (Index_QueryScope) EnumDescriptor deprecated 

func (Index_QueryScope) EnumDescriptor() ([]byte, []int)

Deprecated: Use Index_QueryScope.Descriptor instead.

func (Index_QueryScope) Number 

func (x Index_QueryScope) Number() protoreflect.EnumNumber

func (Index_QueryScope) String 

func (x Index_QueryScope) String() string

func (Index_QueryScope) Type 

func (Index_QueryScope) Type() protoreflect.EnumType

type Index_State 

type Index_State int32

The state of an index. During index creation, an index will be in the `CREATING` state. If the index is created successfully, it will transition to the `READY` state. If the index creation encounters a problem, the index will transition to the `NEEDS_REPAIR` state. 

const (
	// The state is unspecified.
	Index_STATE_UNSPECIFIED Index_State = 0
	// The index is being created.
	// There is an active long-running operation for the index.
	// The index is updated when writing a document.
	// Some index data may exist.
	Index_CREATING Index_State = 1
	// The index is ready to be used.
	// The index is updated when writing a document.
	// The index is fully populated from all stored documents it applies to.
	Index_READY Index_State = 2
	// The index was being created, but something went wrong.
	// There is no active long-running operation for the index,
	// and the most recently finished long-running operation failed.
	// The index is not updated when writing a document.
	// Some index data may exist.
	// Use the google.longrunning.Operations API to determine why the operation
	// that last attempted to create this index failed, then re-create the
	// index.
	Index_NEEDS_REPAIR Index_State = 3
)

func (Index_State) Descriptor 

func (Index_State) Descriptor() protoreflect.EnumDescriptor

func (Index_State) Enum 

func (x Index_State) Enum() *Index_State

func (Index_State) EnumDescriptor deprecated 

func (Index_State) EnumDescriptor() ([]byte, []int)

Deprecated: Use Index_State.Descriptor instead.

func (Index_State) Number 

func (x Index_State) Number() protoreflect.EnumNumber

func (Index_State) String 

func (x Index_State) String() string

func (Index_State) Type 

func (Index_State) Type() protoreflect.EnumType

type ListDatabasesRequest 

type ListDatabasesRequest struct {

	// Required. A parent name of the form
	// `projects/{project_id}`
	Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
	// contains filtered or unexported fields
}

A request to list the Firestore Databases in all locations for a project.

func (*ListDatabasesRequest) Descriptor deprecated 

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

Deprecated: Use ListDatabasesRequest.ProtoReflect.Descriptor instead.

func (*ListDatabasesRequest) GetParent 

func (x *ListDatabasesRequest) GetParent() string

func (*ListDatabasesRequest) ProtoMessage 

func (*ListDatabasesRequest) ProtoMessage()

func (*ListDatabasesRequest) ProtoReflect 

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

func (*ListDatabasesRequest) Reset 

func (x *ListDatabasesRequest) Reset()

func (*ListDatabasesRequest) String 

func (x *ListDatabasesRequest) String() string

type ListDatabasesResponse 

type ListDatabasesResponse struct {

	// The databases in the project.
	Databases []*Database `protobuf:"bytes,1,rep,name=databases,proto3" json:"databases,omitempty"`
	// In the event that data about individual databases cannot be listed they
	// will be recorded here.
	//
	// An example entry might be: projects/some_project/locations/some_location
	// This can happen if the Cloud Region that the Database resides in is
	// currently unavailable.  In this case we can't fetch all the details about
	// the database. You may be able to get a more detailed error message
	// (or possibly fetch the resource) by sending a 'Get' request for the
	// resource or a 'List' request for the specific location.
	Unreachable []string `protobuf:"bytes,3,rep,name=unreachable,proto3" json:"unreachable,omitempty"`
	// contains filtered or unexported fields
}

The list of databases for a project.

func (*ListDatabasesResponse) Descriptor deprecated 

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

Deprecated: Use ListDatabasesResponse.ProtoReflect.Descriptor instead.

func (*ListDatabasesResponse) GetDatabases 

func (x *ListDatabasesResponse) GetDatabases() []*Database

func (*ListDatabasesResponse) GetUnreachable added in v1.15.0 

func (x *ListDatabasesResponse) GetUnreachable() []string

func (*ListDatabasesResponse) ProtoMessage 

func (*ListDatabasesResponse) ProtoMessage()

func (*ListDatabasesResponse) ProtoReflect 

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

func (*ListDatabasesResponse) Reset 

func (x *ListDatabasesResponse) Reset()

func (*ListDatabasesResponse) String 

func (x *ListDatabasesResponse) String() string

type ListFieldsRequest 

type ListFieldsRequest struct {

	// Required. A parent name of the form
	// `projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}`
	Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
	// The filter to apply to list results. Currently,
	// [FirestoreAdmin.ListFields][google.firestore.admin.v1.FirestoreAdmin.ListFields]
	// only supports listing fields that have been explicitly overridden. To issue
	// this query, call
	// [FirestoreAdmin.ListFields][google.firestore.admin.v1.FirestoreAdmin.ListFields]
	// with a filter that includes `indexConfig.usesAncestorConfig:false` .
	Filter string `protobuf:"bytes,2,opt,name=filter,proto3" json:"filter,omitempty"`
	// The number of results to return.
	PageSize int32 `protobuf:"varint,3,opt,name=page_size,json=pageSize,proto3" json:"page_size,omitempty"`
	// A page token, returned from a previous call to
	// [FirestoreAdmin.ListFields][google.firestore.admin.v1.FirestoreAdmin.ListFields],
	// that may be used to get the next page of results.
	PageToken string `protobuf:"bytes,4,opt,name=page_token,json=pageToken,proto3" json:"page_token,omitempty"`
	// contains filtered or unexported fields
}

The request for [FirestoreAdmin.ListFields][google.firestore.admin.v1.FirestoreAdmin.ListFields].

func (*ListFieldsRequest) Descriptor deprecated 

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

Deprecated: Use ListFieldsRequest.ProtoReflect.Descriptor instead.

func (*ListFieldsRequest) GetFilter 

func (x *ListFieldsRequest) GetFilter() string

func (*ListFieldsRequest) GetPageSize 

func (x *ListFieldsRequest) GetPageSize() int32

func (*ListFieldsRequest) GetPageToken 

func (x *ListFieldsRequest) GetPageToken() string

func (*ListFieldsRequest) GetParent 

func (x *ListFieldsRequest) GetParent() string

func (*ListFieldsRequest) ProtoMessage 

func (*ListFieldsRequest) ProtoMessage()

func (*ListFieldsRequest) ProtoReflect 

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

func (*ListFieldsRequest) Reset 

func (x *ListFieldsRequest) Reset()

func (*ListFieldsRequest) String 

func (x *ListFieldsRequest) String() string

type ListFieldsResponse 

type ListFieldsResponse struct {

	// The requested fields.
	Fields []*Field `protobuf:"bytes,1,rep,name=fields,proto3" json:"fields,omitempty"`
	// A page token that may be used to request another page of results. If blank,
	// this is the last page.
	NextPageToken string `protobuf:"bytes,2,opt,name=next_page_token,json=nextPageToken,proto3" json:"next_page_token,omitempty"`
	// contains filtered or unexported fields
}

The response for [FirestoreAdmin.ListFields][google.firestore.admin.v1.FirestoreAdmin.ListFields].

func (*ListFieldsResponse) Descriptor deprecated 

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

Deprecated: Use ListFieldsResponse.ProtoReflect.Descriptor instead.

func (*ListFieldsResponse) GetFields 

func (x *ListFieldsResponse) GetFields() []*Field

func (*ListFieldsResponse) GetNextPageToken 

func (x *ListFieldsResponse) GetNextPageToken() string

func (*ListFieldsResponse) ProtoMessage 

func (*ListFieldsResponse) ProtoMessage()

func (*ListFieldsResponse) ProtoReflect 

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

func (*ListFieldsResponse) Reset 

func (x *ListFieldsResponse) Reset()

func (*ListFieldsResponse) String 

func (x *ListFieldsResponse) String() string

type ListIndexesRequest 

type ListIndexesRequest struct {

	// Required. A parent name of the form
	// `projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}`
	Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
	// The filter to apply to list results.
	Filter string `protobuf:"bytes,2,opt,name=filter,proto3" json:"filter,omitempty"`
	// The number of results to return.
	PageSize int32 `protobuf:"varint,3,opt,name=page_size,json=pageSize,proto3" json:"page_size,omitempty"`
	// A page token, returned from a previous call to
	// [FirestoreAdmin.ListIndexes][google.firestore.admin.v1.FirestoreAdmin.ListIndexes],
	// that may be used to get the next page of results.
	PageToken string `protobuf:"bytes,4,opt,name=page_token,json=pageToken,proto3" json:"page_token,omitempty"`
	// contains filtered or unexported fields
}

The request for [FirestoreAdmin.ListIndexes][google.firestore.admin.v1.FirestoreAdmin.ListIndexes].

func (*ListIndexesRequest) Descriptor deprecated 

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

Deprecated: Use ListIndexesRequest.ProtoReflect.Descriptor instead.

func (*ListIndexesRequest) GetFilter 

func (x *ListIndexesRequest) GetFilter() string

func (*ListIndexesRequest) GetPageSize 

func (x *ListIndexesRequest) GetPageSize() int32

func (*ListIndexesRequest) GetPageToken 

func (x *ListIndexesRequest) GetPageToken() string

func (*ListIndexesRequest) GetParent 

func (x *ListIndexesRequest) GetParent() string

func (*ListIndexesRequest) ProtoMessage 

func (*ListIndexesRequest) ProtoMessage()

func (*ListIndexesRequest) ProtoReflect 

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

func (*ListIndexesRequest) Reset 

func (x *ListIndexesRequest) Reset()

func (*ListIndexesRequest) String 

func (x *ListIndexesRequest) String() string

type ListIndexesResponse 

type ListIndexesResponse struct {

	// The requested indexes.
	Indexes []*Index `protobuf:"bytes,1,rep,name=indexes,proto3" json:"indexes,omitempty"`
	// A page token that may be used to request another page of results. If blank,
	// this is the last page.
	NextPageToken string `protobuf:"bytes,2,opt,name=next_page_token,json=nextPageToken,proto3" json:"next_page_token,omitempty"`
	// contains filtered or unexported fields
}

The response for [FirestoreAdmin.ListIndexes][google.firestore.admin.v1.FirestoreAdmin.ListIndexes].

func (*ListIndexesResponse) Descriptor deprecated 

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

Deprecated: Use ListIndexesResponse.ProtoReflect.Descriptor instead.

func (*ListIndexesResponse) GetIndexes 

func (x *ListIndexesResponse) GetIndexes() []*Index

func (*ListIndexesResponse) GetNextPageToken 

func (x *ListIndexesResponse) GetNextPageToken() string

func (*ListIndexesResponse) ProtoMessage 

func (*ListIndexesResponse) ProtoMessage()

func (*ListIndexesResponse) ProtoReflect 

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

func (*ListIndexesResponse) Reset 

func (x *ListIndexesResponse) Reset()

func (*ListIndexesResponse) String 

func (x *ListIndexesResponse) String() string

type LocationMetadata 

type LocationMetadata struct {
	// contains filtered or unexported fields
}

The metadata message for [google.cloud.location.Location.metadata][google.cloud.location.Location.metadata].

func (*LocationMetadata) Descriptor deprecated 

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

Deprecated: Use LocationMetadata.ProtoReflect.Descriptor instead.

func (*LocationMetadata) ProtoMessage 

func (*LocationMetadata) ProtoMessage()

func (*LocationMetadata) ProtoReflect 

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

func (*LocationMetadata) Reset 

func (x *LocationMetadata) Reset()

func (*LocationMetadata) String 

func (x *LocationMetadata) String() string

type OperationState 

type OperationState int32

Describes the state of the operation. 

const (
	// Unspecified.
	OperationState_OPERATION_STATE_UNSPECIFIED OperationState = 0
	// Request is being prepared for processing.
	OperationState_INITIALIZING OperationState = 1
	// Request is actively being processed.
	OperationState_PROCESSING OperationState = 2
	// Request is in the process of being cancelled after user called
	// google.longrunning.Operations.CancelOperation on the operation.
	OperationState_CANCELLING OperationState = 3
	// Request has been processed and is in its finalization stage.
	OperationState_FINALIZING OperationState = 4
	// Request has completed successfully.
	OperationState_SUCCESSFUL OperationState = 5
	// Request has finished being processed, but encountered an error.
	OperationState_FAILED OperationState = 6
	// Request has finished being cancelled after user called
	// google.longrunning.Operations.CancelOperation.
	OperationState_CANCELLED OperationState = 7
)

func (OperationState) Descriptor 

func (OperationState) Descriptor() protoreflect.EnumDescriptor

func (OperationState) Enum 

func (x OperationState) Enum() *OperationState

func (OperationState) EnumDescriptor deprecated 

func (OperationState) EnumDescriptor() ([]byte, []int)

Deprecated: Use OperationState.Descriptor instead.

func (OperationState) Number 

func (x OperationState) Number() protoreflect.EnumNumber

func (OperationState) String 

func (x OperationState) String() string

func (OperationState) Type 

func (OperationState) Type() protoreflect.EnumType

type Progress 

type Progress struct {

	// The amount of work estimated.
	EstimatedWork int64 `protobuf:"varint,1,opt,name=estimated_work,json=estimatedWork,proto3" json:"estimated_work,omitempty"`
	// The amount of work completed.
	CompletedWork int64 `protobuf:"varint,2,opt,name=completed_work,json=completedWork,proto3" json:"completed_work,omitempty"`
	// contains filtered or unexported fields
}

Describes the progress of the operation. Unit of work is generic and must be interpreted based on where Progress[google.firestore.admin.v1.Progress] is used.

func (*Progress) Descriptor deprecated 

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

Deprecated: Use Progress.ProtoReflect.Descriptor instead.

func (*Progress) GetCompletedWork 

func (x *Progress) GetCompletedWork() int64

func (*Progress) GetEstimatedWork 

func (x *Progress) GetEstimatedWork() int64

func (*Progress) ProtoMessage 

func (*Progress) ProtoMessage()

func (*Progress) ProtoReflect 

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

func (*Progress) Reset 

func (x *Progress) Reset()

func (*Progress) String 

func (x *Progress) String() string

type UnimplementedFirestoreAdminServer 

type UnimplementedFirestoreAdminServer struct {
}

UnimplementedFirestoreAdminServer can be embedded to have forward compatible implementations.

func (*UnimplementedFirestoreAdminServer) CreateDatabase added in v1.15.0 

func (*UnimplementedFirestoreAdminServer) CreateDatabase(context.Context, *CreateDatabaseRequest) (*longrunningpb.Operation, error)

func (*UnimplementedFirestoreAdminServer) CreateIndex 

func (*UnimplementedFirestoreAdminServer) CreateIndex(context.Context, *CreateIndexRequest) (*longrunningpb.Operation, error)

func (*UnimplementedFirestoreAdminServer) DeleteDatabase added in v1.15.0 

func (*UnimplementedFirestoreAdminServer) DeleteDatabase(context.Context, *DeleteDatabaseRequest) (*longrunningpb.Operation, error)

func (*UnimplementedFirestoreAdminServer) DeleteIndex 

func (*UnimplementedFirestoreAdminServer) DeleteIndex(context.Context, *DeleteIndexRequest) (*emptypb.Empty, error)

func (*UnimplementedFirestoreAdminServer) ExportDocuments 

func (*UnimplementedFirestoreAdminServer) ExportDocuments(context.Context, *ExportDocumentsRequest) (*longrunningpb.Operation, error)

func (*UnimplementedFirestoreAdminServer) GetDatabase 

func (*UnimplementedFirestoreAdminServer) GetDatabase(context.Context, *GetDatabaseRequest) (*Database, error)

func (*UnimplementedFirestoreAdminServer) GetField 

func (*UnimplementedFirestoreAdminServer) GetField(context.Context, *GetFieldRequest) (*Field, error)

func (*UnimplementedFirestoreAdminServer) GetIndex 

func (*UnimplementedFirestoreAdminServer) GetIndex(context.Context, *GetIndexRequest) (*Index, error)

func (*UnimplementedFirestoreAdminServer) ImportDocuments 

func (*UnimplementedFirestoreAdminServer) ImportDocuments(context.Context, *ImportDocumentsRequest) (*longrunningpb.Operation, error)

func (*UnimplementedFirestoreAdminServer) ListDatabases 

func (*UnimplementedFirestoreAdminServer) ListDatabases(context.Context, *ListDatabasesRequest) (*ListDatabasesResponse, error)

func (*UnimplementedFirestoreAdminServer) ListFields 

func (*UnimplementedFirestoreAdminServer) ListFields(context.Context, *ListFieldsRequest) (*ListFieldsResponse, error)

func (*UnimplementedFirestoreAdminServer) ListIndexes 

func (*UnimplementedFirestoreAdminServer) ListIndexes(context.Context, *ListIndexesRequest) (*ListIndexesResponse, error)

func (*UnimplementedFirestoreAdminServer) UpdateDatabase 

func (*UnimplementedFirestoreAdminServer) UpdateDatabase(context.Context, *UpdateDatabaseRequest) (*longrunningpb.Operation, error)

func (*UnimplementedFirestoreAdminServer) UpdateField 

func (*UnimplementedFirestoreAdminServer) UpdateField(context.Context, *UpdateFieldRequest) (*longrunningpb.Operation, error)

type UpdateDatabaseMetadata 

type UpdateDatabaseMetadata struct {
	// contains filtered or unexported fields
}

Metadata related to the update database operation.

func (*UpdateDatabaseMetadata) Descriptor deprecated 

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

Deprecated: Use UpdateDatabaseMetadata.ProtoReflect.Descriptor instead.

func (*UpdateDatabaseMetadata) ProtoMessage 

func (*UpdateDatabaseMetadata) ProtoMessage()

func (*UpdateDatabaseMetadata) ProtoReflect 

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

func (*UpdateDatabaseMetadata) Reset 

func (x *UpdateDatabaseMetadata) Reset()

func (*UpdateDatabaseMetadata) String 

func (x *UpdateDatabaseMetadata) String() string

type UpdateDatabaseRequest 

type UpdateDatabaseRequest struct {

	// Required. The database to update.
	Database *Database `protobuf:"bytes,1,opt,name=database,proto3" json:"database,omitempty"`
	// The list of fields to be updated.
	UpdateMask *fieldmaskpb.FieldMask `protobuf:"bytes,2,opt,name=update_mask,json=updateMask,proto3" json:"update_mask,omitempty"`
	// contains filtered or unexported fields
}

The request for [FirestoreAdmin.UpdateDatabase][google.firestore.admin.v1.FirestoreAdmin.UpdateDatabase].

func (*UpdateDatabaseRequest) Descriptor deprecated 

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

Deprecated: Use UpdateDatabaseRequest.ProtoReflect.Descriptor instead.

func (*UpdateDatabaseRequest) GetDatabase 

func (x *UpdateDatabaseRequest) GetDatabase() *Database

func (*UpdateDatabaseRequest) GetUpdateMask 

func (x *UpdateDatabaseRequest) GetUpdateMask() *fieldmaskpb.FieldMask

func (*UpdateDatabaseRequest) ProtoMessage 

func (*UpdateDatabaseRequest) ProtoMessage()

func (*UpdateDatabaseRequest) ProtoReflect 

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

func (*UpdateDatabaseRequest) Reset 

func (x *UpdateDatabaseRequest) Reset()

func (*UpdateDatabaseRequest) String 

func (x *UpdateDatabaseRequest) String() string

type UpdateFieldRequest 

type UpdateFieldRequest struct {

	// Required. The field to be updated.
	Field *Field `protobuf:"bytes,1,opt,name=field,proto3" json:"field,omitempty"`
	// A mask, relative to the field. If specified, only configuration specified
	// by this field_mask will be updated in the field.
	UpdateMask *fieldmaskpb.FieldMask `protobuf:"bytes,2,opt,name=update_mask,json=updateMask,proto3" json:"update_mask,omitempty"`
	// contains filtered or unexported fields
}

The request for [FirestoreAdmin.UpdateField][google.firestore.admin.v1.FirestoreAdmin.UpdateField].

func (*UpdateFieldRequest) Descriptor deprecated 

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

Deprecated: Use UpdateFieldRequest.ProtoReflect.Descriptor instead.

func (*UpdateFieldRequest) GetField 

func (x *UpdateFieldRequest) GetField() *Field

func (*UpdateFieldRequest) GetUpdateMask 

func (x *UpdateFieldRequest) GetUpdateMask() *fieldmaskpb.FieldMask

func (*UpdateFieldRequest) ProtoMessage 

func (*UpdateFieldRequest) ProtoMessage()

func (*UpdateFieldRequest) ProtoReflect 

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

func (*UpdateFieldRequest) Reset 

func (x *UpdateFieldRequest) Reset()

func (*UpdateFieldRequest) String 

func (x *UpdateFieldRequest) String() string

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.