Cloud Firestore API v1 - Package cloud.google.com/go/firestore/apiv1/admin/adminpb (v1.22.0)

1.22.0 (latest) 1.21.0 1.20.0 1.19.0 1.18.0 1.17.0 1.16.0 1.15.0 1.12.0 1.11.0 1.10.0 1.9.0 1.8.0 1.7.0 1.6.1 1.5.0 1.4.0

Note: To get more information about this package, such as access to older versions, view this package on pkg.go.dev.

Constants

FirestoreAdmin_CreateIndex_FullMethodName, FirestoreAdmin_ListIndexes_FullMethodName, FirestoreAdmin_GetIndex_FullMethodName, FirestoreAdmin_DeleteIndex_FullMethodName, FirestoreAdmin_GetField_FullMethodName, FirestoreAdmin_UpdateField_FullMethodName, FirestoreAdmin_ListFields_FullMethodName, FirestoreAdmin_ExportDocuments_FullMethodName, FirestoreAdmin_ImportDocuments_FullMethodName, FirestoreAdmin_BulkDeleteDocuments_FullMethodName, FirestoreAdmin_CreateDatabase_FullMethodName, FirestoreAdmin_GetDatabase_FullMethodName, FirestoreAdmin_ListDatabases_FullMethodName, FirestoreAdmin_UpdateDatabase_FullMethodName, FirestoreAdmin_DeleteDatabase_FullMethodName, FirestoreAdmin_CreateUserCreds_FullMethodName, FirestoreAdmin_GetUserCreds_FullMethodName, FirestoreAdmin_ListUserCreds_FullMethodName, FirestoreAdmin_EnableUserCreds_FullMethodName, FirestoreAdmin_DisableUserCreds_FullMethodName, FirestoreAdmin_ResetUserPassword_FullMethodName, FirestoreAdmin_DeleteUserCreds_FullMethodName, FirestoreAdmin_GetBackup_FullMethodName, FirestoreAdmin_ListBackups_FullMethodName, FirestoreAdmin_DeleteBackup_FullMethodName, FirestoreAdmin_RestoreDatabase_FullMethodName, FirestoreAdmin_CreateBackupSchedule_FullMethodName, FirestoreAdmin_GetBackupSchedule_FullMethodName, FirestoreAdmin_ListBackupSchedules_FullMethodName, FirestoreAdmin_UpdateBackupSchedule_FullMethodName, FirestoreAdmin_DeleteBackupSchedule_FullMethodName, FirestoreAdmin_CloneDatabase_FullMethodName

const (
	FirestoreAdmin_CreateIndex_FullMethodName          = "/google.firestore.admin.v1.FirestoreAdmin/CreateIndex"
	FirestoreAdmin_ListIndexes_FullMethodName          = "/google.firestore.admin.v1.FirestoreAdmin/ListIndexes"
	FirestoreAdmin_GetIndex_FullMethodName             = "/google.firestore.admin.v1.FirestoreAdmin/GetIndex"
	FirestoreAdmin_DeleteIndex_FullMethodName          = "/google.firestore.admin.v1.FirestoreAdmin/DeleteIndex"
	FirestoreAdmin_GetField_FullMethodName             = "/google.firestore.admin.v1.FirestoreAdmin/GetField"
	FirestoreAdmin_UpdateField_FullMethodName          = "/google.firestore.admin.v1.FirestoreAdmin/UpdateField"
	FirestoreAdmin_ListFields_FullMethodName           = "/google.firestore.admin.v1.FirestoreAdmin/ListFields"
	FirestoreAdmin_ExportDocuments_FullMethodName      = "/google.firestore.admin.v1.FirestoreAdmin/ExportDocuments"
	FirestoreAdmin_ImportDocuments_FullMethodName      = "/google.firestore.admin.v1.FirestoreAdmin/ImportDocuments"
	FirestoreAdmin_BulkDeleteDocuments_FullMethodName  = "/google.firestore.admin.v1.FirestoreAdmin/BulkDeleteDocuments"
	FirestoreAdmin_CreateDatabase_FullMethodName       = "/google.firestore.admin.v1.FirestoreAdmin/CreateDatabase"
	FirestoreAdmin_GetDatabase_FullMethodName          = "/google.firestore.admin.v1.FirestoreAdmin/GetDatabase"
	FirestoreAdmin_ListDatabases_FullMethodName        = "/google.firestore.admin.v1.FirestoreAdmin/ListDatabases"
	FirestoreAdmin_UpdateDatabase_FullMethodName       = "/google.firestore.admin.v1.FirestoreAdmin/UpdateDatabase"
	FirestoreAdmin_DeleteDatabase_FullMethodName       = "/google.firestore.admin.v1.FirestoreAdmin/DeleteDatabase"
	FirestoreAdmin_CreateUserCreds_FullMethodName      = "/google.firestore.admin.v1.FirestoreAdmin/CreateUserCreds"
	FirestoreAdmin_GetUserCreds_FullMethodName         = "/google.firestore.admin.v1.FirestoreAdmin/GetUserCreds"
	FirestoreAdmin_ListUserCreds_FullMethodName        = "/google.firestore.admin.v1.FirestoreAdmin/ListUserCreds"
	FirestoreAdmin_EnableUserCreds_FullMethodName      = "/google.firestore.admin.v1.FirestoreAdmin/EnableUserCreds"
	FirestoreAdmin_DisableUserCreds_FullMethodName     = "/google.firestore.admin.v1.FirestoreAdmin/DisableUserCreds"
	FirestoreAdmin_ResetUserPassword_FullMethodName    = "/google.firestore.admin.v1.FirestoreAdmin/ResetUserPassword"
	FirestoreAdmin_DeleteUserCreds_FullMethodName      = "/google.firestore.admin.v1.FirestoreAdmin/DeleteUserCreds"
	FirestoreAdmin_GetBackup_FullMethodName            = "/google.firestore.admin.v1.FirestoreAdmin/GetBackup"
	FirestoreAdmin_ListBackups_FullMethodName          = "/google.firestore.admin.v1.FirestoreAdmin/ListBackups"
	FirestoreAdmin_DeleteBackup_FullMethodName         = "/google.firestore.admin.v1.FirestoreAdmin/DeleteBackup"
	FirestoreAdmin_RestoreDatabase_FullMethodName      = "/google.firestore.admin.v1.FirestoreAdmin/RestoreDatabase"
	FirestoreAdmin_CreateBackupSchedule_FullMethodName = "/google.firestore.admin.v1.FirestoreAdmin/CreateBackupSchedule"
	FirestoreAdmin_GetBackupSchedule_FullMethodName    = "/google.firestore.admin.v1.FirestoreAdmin/GetBackupSchedule"
	FirestoreAdmin_ListBackupSchedules_FullMethodName  = "/google.firestore.admin.v1.FirestoreAdmin/ListBackupSchedules"
	FirestoreAdmin_UpdateBackupSchedule_FullMethodName = "/google.firestore.admin.v1.FirestoreAdmin/UpdateBackupSchedule"
	FirestoreAdmin_DeleteBackupSchedule_FullMethodName = "/google.firestore.admin.v1.FirestoreAdmin/DeleteBackupSchedule"
	FirestoreAdmin_CloneDatabase_FullMethodName        = "/google.firestore.admin.v1.FirestoreAdmin/CloneDatabase"
)

Variables

Backup_State_name, Backup_State_value

var (
	Backup_State_name = map[int32]string{
		0: "STATE_UNSPECIFIED",
		1: "CREATING",
		2: "READY",
		3: "NOT_AVAILABLE",
	}
	Backup_State_value = map[string]int32{
		"STATE_UNSPECIFIED": 0,
		"CREATING":          1,
		"READY":             2,
		"NOT_AVAILABLE":     3,
	}
)

Enum value maps for Backup_State.

Database_DatabaseType_name, Database_DatabaseType_value

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.

Database_ConcurrencyMode_name, Database_ConcurrencyMode_value

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.

Database_PointInTimeRecoveryEnablement_name, Database_PointInTimeRecoveryEnablement_value

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.

Database_AppEngineIntegrationMode_name, Database_AppEngineIntegrationMode_value

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.

Database_DeleteProtectionState_name, Database_DeleteProtectionState_value

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.

Database_DatabaseEdition_name, Database_DatabaseEdition_value

var (
	Database_DatabaseEdition_name = map[int32]string{
		0: "DATABASE_EDITION_UNSPECIFIED",
		1: "STANDARD",
		2: "ENTERPRISE",
	}
	Database_DatabaseEdition_value = map[string]int32{
		"DATABASE_EDITION_UNSPECIFIED": 0,
		"STANDARD":                     1,
		"ENTERPRISE":                   2,
	}
)

Enum value maps for Database_DatabaseEdition.

Database_DataAccessMode_name, Database_DataAccessMode_value

var (
	Database_DataAccessMode_name = map[int32]string{
		0: "DATA_ACCESS_MODE_UNSPECIFIED",
		1: "DATA_ACCESS_MODE_ENABLED",
		2: "DATA_ACCESS_MODE_DISABLED",
	}
	Database_DataAccessMode_value = map[string]int32{
		"DATA_ACCESS_MODE_UNSPECIFIED": 0,
		"DATA_ACCESS_MODE_ENABLED":     1,
		"DATA_ACCESS_MODE_DISABLED":    2,
	}
)

Enum value maps for Database_DataAccessMode.

Field_TtlConfig_State_name, Field_TtlConfig_State_value

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.

Index_QueryScope_name, Index_QueryScope_value

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.

Index_ApiScope_name, Index_ApiScope_value

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

Enum value maps for Index_ApiScope.

Index_State_name, Index_State_value

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.

Index_Density_name, Index_Density_value

var (
	Index_Density_name = map[int32]string{
		0: "DENSITY_UNSPECIFIED",
		1: "SPARSE_ALL",
		2: "SPARSE_ANY",
		3: "DENSE",
	}
	Index_Density_value = map[string]int32{
		"DENSITY_UNSPECIFIED": 0,
		"SPARSE_ALL":          1,
		"SPARSE_ANY":          2,
		"DENSE":               3,
	}
)

Enum value maps for Index_Density.

Index_IndexField_Order_name, Index_IndexField_Order_value

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.

Index_IndexField_ArrayConfig_name, Index_IndexField_ArrayConfig_value

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.

OperationState_name, OperationState_value

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.

FieldOperationMetadata_IndexConfigDelta_ChangeType_name, FieldOperationMetadata_IndexConfigDelta_ChangeType_value

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.

FieldOperationMetadata_TtlConfigDelta_ChangeType_name, FieldOperationMetadata_TtlConfigDelta_ChangeType_value

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.

RealtimeUpdatesMode_name, RealtimeUpdatesMode_value

var (
	RealtimeUpdatesMode_name = map[int32]string{
		0: "REALTIME_UPDATES_MODE_UNSPECIFIED",
		1: "REALTIME_UPDATES_MODE_ENABLED",
		2: "REALTIME_UPDATES_MODE_DISABLED",
	}
	RealtimeUpdatesMode_value = map[string]int32{
		"REALTIME_UPDATES_MODE_UNSPECIFIED": 0,
		"REALTIME_UPDATES_MODE_ENABLED":     1,
		"REALTIME_UPDATES_MODE_DISABLED":    2,
	}
)

Enum value maps for RealtimeUpdatesMode.

UserCreds_State_name, UserCreds_State_value

var (
	UserCreds_State_name = map[int32]string{
		0: "STATE_UNSPECIFIED",
		1: "ENABLED",
		2: "DISABLED",
	}
	UserCreds_State_value = map[string]int32{
		"STATE_UNSPECIFIED": 0,
		"ENABLED":           1,
		"DISABLED":          2,
	}
)

Enum value maps for UserCreds_State.

File_google_firestore_admin_v1_backup_proto

var File_google_firestore_admin_v1_backup_proto protoreflect.FileDescriptor

File_google_firestore_admin_v1_database_proto

var File_google_firestore_admin_v1_database_proto protoreflect.FileDescriptor

File_google_firestore_admin_v1_field_proto

var File_google_firestore_admin_v1_field_proto protoreflect.FileDescriptor

File_google_firestore_admin_v1_firestore_admin_proto

var File_google_firestore_admin_v1_firestore_admin_proto protoreflect.FileDescriptor

File_google_firestore_admin_v1_index_proto

var File_google_firestore_admin_v1_index_proto protoreflect.FileDescriptor

File_google_firestore_admin_v1_location_proto

var File_google_firestore_admin_v1_location_proto protoreflect.FileDescriptor

File_google_firestore_admin_v1_operation_proto

var File_google_firestore_admin_v1_operation_proto protoreflect.FileDescriptor

File_google_firestore_admin_v1_realtime_updates_proto

var File_google_firestore_admin_v1_realtime_updates_proto protoreflect.FileDescriptor

File_google_firestore_admin_v1_schedule_proto

var File_google_firestore_admin_v1_schedule_proto protoreflect.FileDescriptor

File_google_firestore_admin_v1_snapshot_proto

var File_google_firestore_admin_v1_snapshot_proto protoreflect.FileDescriptor

File_google_firestore_admin_v1_user_creds_proto

var File_google_firestore_admin_v1_user_creds_proto protoreflect.FileDescriptor

FirestoreAdmin_ServiceDesc

var FirestoreAdmin_ServiceDesc = grpc.ServiceDesc{
	ServiceName: "google.firestore.admin.v1.FirestoreAdmin",
	HandlerType: (*FirestoreAdminServer)(nil),
	Methods: []grpc.MethodDesc{
		{
			MethodName: "CreateIndex",
			Handler:    _FirestoreAdmin_CreateIndex_Handler,
		},
		{
			MethodName: "ListIndexes",
			Handler:    _FirestoreAdmin_ListIndexes_Handler,
		},
		{
			MethodName: "GetIndex",
			Handler:    _FirestoreAdmin_GetIndex_Handler,
		},
		{
			MethodName: "DeleteIndex",
			Handler:    _FirestoreAdmin_DeleteIndex_Handler,
		},
		{
			MethodName: "GetField",
			Handler:    _FirestoreAdmin_GetField_Handler,
		},
		{
			MethodName: "UpdateField",
			Handler:    _FirestoreAdmin_UpdateField_Handler,
		},
		{
			MethodName: "ListFields",
			Handler:    _FirestoreAdmin_ListFields_Handler,
		},
		{
			MethodName: "ExportDocuments",
			Handler:    _FirestoreAdmin_ExportDocuments_Handler,
		},
		{
			MethodName: "ImportDocuments",
			Handler:    _FirestoreAdmin_ImportDocuments_Handler,
		},
		{
			MethodName: "BulkDeleteDocuments",
			Handler:    _FirestoreAdmin_BulkDeleteDocuments_Handler,
		},
		{
			MethodName: "CreateDatabase",
			Handler:    _FirestoreAdmin_CreateDatabase_Handler,
		},
		{
			MethodName: "GetDatabase",
			Handler:    _FirestoreAdmin_GetDatabase_Handler,
		},
		{
			MethodName: "ListDatabases",
			Handler:    _FirestoreAdmin_ListDatabases_Handler,
		},
		{
			MethodName: "UpdateDatabase",
			Handler:    _FirestoreAdmin_UpdateDatabase_Handler,
		},
		{
			MethodName: "DeleteDatabase",
			Handler:    _FirestoreAdmin_DeleteDatabase_Handler,
		},
		{
			MethodName: "CreateUserCreds",
			Handler:    _FirestoreAdmin_CreateUserCreds_Handler,
		},
		{
			MethodName: "GetUserCreds",
			Handler:    _FirestoreAdmin_GetUserCreds_Handler,
		},
		{
			MethodName: "ListUserCreds",
			Handler:    _FirestoreAdmin_ListUserCreds_Handler,
		},
		{
			MethodName: "EnableUserCreds",
			Handler:    _FirestoreAdmin_EnableUserCreds_Handler,
		},
		{
			MethodName: "DisableUserCreds",
			Handler:    _FirestoreAdmin_DisableUserCreds_Handler,
		},
		{
			MethodName: "ResetUserPassword",
			Handler:    _FirestoreAdmin_ResetUserPassword_Handler,
		},
		{
			MethodName: "DeleteUserCreds",
			Handler:    _FirestoreAdmin_DeleteUserCreds_Handler,
		},
		{
			MethodName: "GetBackup",
			Handler:    _FirestoreAdmin_GetBackup_Handler,
		},
		{
			MethodName: "ListBackups",
			Handler:    _FirestoreAdmin_ListBackups_Handler,
		},
		{
			MethodName: "DeleteBackup",
			Handler:    _FirestoreAdmin_DeleteBackup_Handler,
		},
		{
			MethodName: "RestoreDatabase",
			Handler:    _FirestoreAdmin_RestoreDatabase_Handler,
		},
		{
			MethodName: "CreateBackupSchedule",
			Handler:    _FirestoreAdmin_CreateBackupSchedule_Handler,
		},
		{
			MethodName: "GetBackupSchedule",
			Handler:    _FirestoreAdmin_GetBackupSchedule_Handler,
		},
		{
			MethodName: "ListBackupSchedules",
			Handler:    _FirestoreAdmin_ListBackupSchedules_Handler,
		},
		{
			MethodName: "UpdateBackupSchedule",
			Handler:    _FirestoreAdmin_UpdateBackupSchedule_Handler,
		},
		{
			MethodName: "DeleteBackupSchedule",
			Handler:    _FirestoreAdmin_DeleteBackupSchedule_Handler,
		},
		{
			MethodName: "CloneDatabase",
			Handler:    _FirestoreAdmin_CloneDatabase_Handler,
		},
	},
	Streams:  []grpc.StreamDesc{},
	Metadata: "google/firestore/admin/v1/firestore_admin.proto",
}

FirestoreAdmin_ServiceDesc is the grpc.ServiceDesc for FirestoreAdmin service. It's only intended for direct use with grpc.RegisterService, and not to be introspected or modified (even as a copy)

Functions

func RegisterFirestoreAdminServer

func RegisterFirestoreAdminServer(s grpc.ServiceRegistrar, srv FirestoreAdminServer)

Backup

type Backup struct {

	// Output only. The unique resource name of the Backup.
	//
	// Format is `projects/{project}/locations/{location}/backups/{backup}`.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// Output only. Name of the Firestore database that the backup is from.
	//
	// Format is `projects/{project}/databases/{database}`.
	Database string `protobuf:"bytes,2,opt,name=database,proto3" json:"database,omitempty"`
	// Output only. The system-generated UUID4 for the Firestore database that the
	// backup is from.
	DatabaseUid string `protobuf:"bytes,7,opt,name=database_uid,json=databaseUid,proto3" json:"database_uid,omitempty"`
	// Output only. The backup contains an externally consistent copy of the
	// database at this time.
	SnapshotTime *timestamppb.Timestamp `protobuf:"bytes,3,opt,name=snapshot_time,json=snapshotTime,proto3" json:"snapshot_time,omitempty"`
	// Output only. The timestamp at which this backup expires.
	ExpireTime *timestamppb.Timestamp `protobuf:"bytes,4,opt,name=expire_time,json=expireTime,proto3" json:"expire_time,omitempty"`
	// Output only. Statistics about the backup.
	//
	// This data only becomes available after the backup is fully materialized to
	// secondary storage. This field will be empty till then.
	Stats *Backup_Stats `protobuf:"bytes,6,opt,name=stats,proto3" json:"stats,omitempty"`
	// Output only. The current state of the backup.
	State Backup_State `protobuf:"varint,8,opt,name=state,proto3,enum=google.firestore.admin.v1.Backup_State" json:"state,omitempty"`
	// contains filtered or unexported fields
}

A Backup of a Cloud Firestore Database.

The backup contains all documents and index configurations for the given database at a specific point in time.

func (*Backup) Descriptor

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

Deprecated: Use Backup.ProtoReflect.Descriptor instead.

func (*Backup) GetDatabase

func (x *Backup) GetDatabase() string

func (*Backup) GetDatabaseUid

func (x *Backup) GetDatabaseUid() string

func (*Backup) GetExpireTime

func (x *Backup) GetExpireTime() *timestamppb.Timestamp

func (*Backup) GetName

func (x *Backup) GetName() string

func (*Backup) GetSnapshotTime

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

func (*Backup) GetState

func (x *Backup) GetState() Backup_State

func (*Backup) GetStats

func (x *Backup) GetStats() *Backup_Stats

func (*Backup) ProtoMessage

func (*Backup) ProtoMessage()

func (*Backup) ProtoReflect

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

func (*Backup) Reset

func (x *Backup) Reset()

func (*Backup) String

func (x *Backup) String() string

BackupSchedule

type BackupSchedule struct {

	// Output only. The unique backup schedule identifier across all locations and
	// databases for the given project.
	//
	// This will be auto-assigned.
	//
	// Format is
	// `projects/{project}/databases/{database}/backupSchedules/{backup_schedule}`
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// Output only. The timestamp at which this backup schedule was created and
	// effective since.
	//
	// No backups will be created for this schedule before this time.
	CreateTime *timestamppb.Timestamp `protobuf:"bytes,3,opt,name=create_time,json=createTime,proto3" json:"create_time,omitempty"`
	// Output only. The timestamp at which this backup schedule was most recently
	// updated. When a backup schedule is first created, this is the same as
	// create_time.
	UpdateTime *timestamppb.Timestamp `protobuf:"bytes,10,opt,name=update_time,json=updateTime,proto3" json:"update_time,omitempty"`
	// At what relative time in the future, compared to its creation time,
	// the backup should be deleted, e.g. keep backups for 7 days.
	//
	// The maximum supported retention period is 14 weeks.
	Retention *durationpb.Duration `protobuf:"bytes,6,opt,name=retention,proto3" json:"retention,omitempty"`
	// A oneof field to represent when backups will be taken.
	//
	// Types that are valid to be assigned to Recurrence:
	//
	//	*BackupSchedule_DailyRecurrence
	//	*BackupSchedule_WeeklyRecurrence
	Recurrence isBackupSchedule_Recurrence `protobuf_oneof:"recurrence"`
	// contains filtered or unexported fields
}

A backup schedule for a Cloud Firestore Database.

This resource is owned by the database it is backing up, and is deleted along with the database. The actual backups are not though.

func (*BackupSchedule) Descriptor

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

Deprecated: Use BackupSchedule.ProtoReflect.Descriptor instead.

func (*BackupSchedule) GetCreateTime

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

func (*BackupSchedule) GetDailyRecurrence

func (x *BackupSchedule) GetDailyRecurrence() *DailyRecurrence

func (*BackupSchedule) GetName

func (x *BackupSchedule) GetName() string

func (*BackupSchedule) GetRecurrence

func (x *BackupSchedule) GetRecurrence() isBackupSchedule_Recurrence

func (*BackupSchedule) GetRetention

func (x *BackupSchedule) GetRetention() *durationpb.Duration

func (*BackupSchedule) GetUpdateTime

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

func (*BackupSchedule) GetWeeklyRecurrence

func (x *BackupSchedule) GetWeeklyRecurrence() *WeeklyRecurrence

func (*BackupSchedule) ProtoMessage

func (*BackupSchedule) ProtoMessage()

func (*BackupSchedule) ProtoReflect

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

func (*BackupSchedule) Reset

func (x *BackupSchedule) Reset()

func (*BackupSchedule) String

func (x *BackupSchedule) String() string

BackupSchedule_DailyRecurrence

type BackupSchedule_DailyRecurrence struct {
	// For a schedule that runs daily.
	DailyRecurrence *DailyRecurrence `protobuf:"bytes,7,opt,name=daily_recurrence,json=dailyRecurrence,proto3,oneof"`
}

BackupSchedule_WeeklyRecurrence

type BackupSchedule_WeeklyRecurrence struct {
	// For a schedule that runs weekly on a specific day.
	WeeklyRecurrence *WeeklyRecurrence `protobuf:"bytes,8,opt,name=weekly_recurrence,json=weeklyRecurrence,proto3,oneof"`
}

Backup_State

type Backup_State int32

Indicate the current state of the backup.

Backup_STATE_UNSPECIFIED, Backup_CREATING, Backup_READY, Backup_NOT_AVAILABLE

const (
	// The state is unspecified.
	Backup_STATE_UNSPECIFIED Backup_State = 0
	// The pending backup is still being created. Operations on the
	// backup will be rejected in this state.
	Backup_CREATING Backup_State = 1
	// The backup is complete and ready to use.
	Backup_READY Backup_State = 2
	// The backup is not available at this moment.
	Backup_NOT_AVAILABLE Backup_State = 3
)

func (Backup_State) Descriptor

func (Backup_State) Descriptor() protoreflect.EnumDescriptor

func (Backup_State) Enum

func (x Backup_State) Enum() *Backup_State

func (Backup_State) EnumDescriptor

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

Deprecated: Use Backup_State.Descriptor instead.

func (Backup_State) Number

func (x Backup_State) Number() protoreflect.EnumNumber

func (Backup_State) String

func (x Backup_State) String() string

func (Backup_State) Type

func (Backup_State) Type() protoreflect.EnumType

Backup_Stats

type Backup_Stats struct {

	// Output only. Summation of the size of all documents and index entries in
	// the backup, measured in bytes.
	SizeBytes int64 `protobuf:"varint,1,opt,name=size_bytes,json=sizeBytes,proto3" json:"size_bytes,omitempty"`
	// Output only. The total number of documents contained in the backup.
	DocumentCount int64 `protobuf:"varint,2,opt,name=document_count,json=documentCount,proto3" json:"document_count,omitempty"`
	// Output only. The total number of index entries contained in the backup.
	IndexCount int64 `protobuf:"varint,3,opt,name=index_count,json=indexCount,proto3" json:"index_count,omitempty"`
	// contains filtered or unexported fields
}

Backup specific statistics.

func (*Backup_Stats) Descriptor

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

Deprecated: Use Backup_Stats.ProtoReflect.Descriptor instead.

func (*Backup_Stats) GetDocumentCount

func (x *Backup_Stats) GetDocumentCount() int64

func (*Backup_Stats) GetIndexCount

func (x *Backup_Stats) GetIndexCount() int64

func (*Backup_Stats) GetSizeBytes

func (x *Backup_Stats) GetSizeBytes() int64

func (*Backup_Stats) ProtoMessage

func (*Backup_Stats) ProtoMessage()

func (*Backup_Stats) ProtoReflect

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

func (*Backup_Stats) Reset

func (x *Backup_Stats) Reset()

func (*Backup_Stats) String

func (x *Backup_Stats) String() string

BulkDeleteDocumentsMetadata

type BulkDeleteDocumentsMetadata 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 operation.
	OperationState OperationState `protobuf:"varint,3,opt,name=operation_state,json=operationState,proto3,enum=google.firestore.admin.v1.OperationState" json:"operation_state,omitempty"`
	// 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"`
	// The IDs of the collection groups that are being deleted.
	CollectionIds []string `protobuf:"bytes,6,rep,name=collection_ids,json=collectionIds,proto3" json:"collection_ids,omitempty"`
	// Which namespace IDs are being deleted.
	NamespaceIds []string `protobuf:"bytes,7,rep,name=namespace_ids,json=namespaceIds,proto3" json:"namespace_ids,omitempty"`
	// The timestamp that corresponds to the version of the database that is being
	// read to get the list of documents to delete. This time can also be used as
	// the timestamp of PITR in case of disaster recovery (subject to PITR window
	// limit).
	SnapshotTime *timestamppb.Timestamp `protobuf:"bytes,8,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.BulkDeleteDocuments][google.firestore.admin.v1.FirestoreAdmin.BulkDeleteDocuments].

func (*BulkDeleteDocumentsMetadata) Descriptor

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

Deprecated: Use BulkDeleteDocumentsMetadata.ProtoReflect.Descriptor instead.

func (*BulkDeleteDocumentsMetadata) GetCollectionIds

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

func (*BulkDeleteDocumentsMetadata) GetEndTime

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

func (*BulkDeleteDocumentsMetadata) GetNamespaceIds

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

func (*BulkDeleteDocumentsMetadata) GetOperationState

func (x *BulkDeleteDocumentsMetadata) GetOperationState() OperationState

func (*BulkDeleteDocumentsMetadata) GetProgressBytes

func (x *BulkDeleteDocumentsMetadata) GetProgressBytes() *Progress

func (*BulkDeleteDocumentsMetadata) GetProgressDocuments

func (x *BulkDeleteDocumentsMetadata) GetProgressDocuments() *Progress

func (*BulkDeleteDocumentsMetadata) GetSnapshotTime

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

func (*BulkDeleteDocumentsMetadata) GetStartTime

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

func (*BulkDeleteDocumentsMetadata) ProtoMessage

func (*BulkDeleteDocumentsMetadata) ProtoMessage()

func (*BulkDeleteDocumentsMetadata) ProtoReflect

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

func (*BulkDeleteDocumentsMetadata) Reset

func (x *BulkDeleteDocumentsMetadata) Reset()

func (*BulkDeleteDocumentsMetadata) String

func (x *BulkDeleteDocumentsMetadata) String() string

BulkDeleteDocumentsRequest

type BulkDeleteDocumentsRequest struct {

	// Required. Database to operate. Should be of the form:
	// `projects/{project_id}/databases/{database_id}`.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// Optional. IDs of the collection groups to delete. Unspecified means all
	// collection groups.
	//
	// Each collection group in this list must be unique.
	CollectionIds []string `protobuf:"bytes,2,rep,name=collection_ids,json=collectionIds,proto3" json:"collection_ids,omitempty"`
	// Optional. Namespaces to delete.
	//
	// An empty list means all namespaces. This is the recommended
	// 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 delete from them.
	//
	// Each namespace in this list must be unique.
	NamespaceIds []string `protobuf:"bytes,3,rep,name=namespace_ids,json=namespaceIds,proto3" json:"namespace_ids,omitempty"`
	// contains filtered or unexported fields
}

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

When both collection_ids and namespace_ids are set, only documents satisfying both conditions will be deleted.

Requests with namespace_ids and collection_ids both empty will be rejected. Please use [FirestoreAdmin.DeleteDatabase][google.firestore.admin.v1.FirestoreAdmin.DeleteDatabase] instead.

func (*BulkDeleteDocumentsRequest) Descriptor

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

Deprecated: Use BulkDeleteDocumentsRequest.ProtoReflect.Descriptor instead.

func (*BulkDeleteDocumentsRequest) GetCollectionIds

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

func (*BulkDeleteDocumentsRequest) GetName

func (x *BulkDeleteDocumentsRequest) GetName() string

func (*BulkDeleteDocumentsRequest) GetNamespaceIds

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

func (*BulkDeleteDocumentsRequest) ProtoMessage

func (*BulkDeleteDocumentsRequest) ProtoMessage()

func (*BulkDeleteDocumentsRequest) ProtoReflect

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

func (*BulkDeleteDocumentsRequest) Reset

func (x *BulkDeleteDocumentsRequest) Reset()

func (*BulkDeleteDocumentsRequest) String

func (x *BulkDeleteDocumentsRequest) String() string

BulkDeleteDocumentsResponse

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

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

func (*BulkDeleteDocumentsResponse) Descriptor

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

Deprecated: Use BulkDeleteDocumentsResponse.ProtoReflect.Descriptor instead.

func (*BulkDeleteDocumentsResponse) ProtoMessage

func (*BulkDeleteDocumentsResponse) ProtoMessage()

func (*BulkDeleteDocumentsResponse) ProtoReflect

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

func (*BulkDeleteDocumentsResponse) Reset

func (x *BulkDeleteDocumentsResponse) Reset()

func (*BulkDeleteDocumentsResponse) String

func (x *BulkDeleteDocumentsResponse) String() string

CloneDatabaseMetadata

type CloneDatabaseMetadata struct {

	// The time the clone was started.
	StartTime *timestamppb.Timestamp `protobuf:"bytes,1,opt,name=start_time,json=startTime,proto3" json:"start_time,omitempty"`
	// The time the clone finished, unset for ongoing clones.
	EndTime *timestamppb.Timestamp `protobuf:"bytes,2,opt,name=end_time,json=endTime,proto3" json:"end_time,omitempty"`
	// The operation state of the clone.
	OperationState OperationState `protobuf:"varint,3,opt,name=operation_state,json=operationState,proto3,enum=google.firestore.admin.v1.OperationState" json:"operation_state,omitempty"`
	// The name of the database being cloned to.
	Database string `protobuf:"bytes,4,opt,name=database,proto3" json:"database,omitempty"`
	// The snapshot from which this database was cloned.
	PitrSnapshot *PitrSnapshot `protobuf:"bytes,7,opt,name=pitr_snapshot,json=pitrSnapshot,proto3" json:"pitr_snapshot,omitempty"`
	// How far along the clone is as an estimated percentage of remaining time.
	ProgressPercentage *Progress `protobuf:"bytes,6,opt,name=progress_percentage,json=progressPercentage,proto3" json:"progress_percentage,omitempty"`
	// contains filtered or unexported fields
}

Metadata for the [long-running operation][google.longrunning.Operation] from the [CloneDatabase][google.firestore.admin.v1.CloneDatabase] request.

func (*CloneDatabaseMetadata) Descriptor

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

Deprecated: Use CloneDatabaseMetadata.ProtoReflect.Descriptor instead.

func (*CloneDatabaseMetadata) GetDatabase

func (x *CloneDatabaseMetadata) GetDatabase() string

func (*CloneDatabaseMetadata) GetEndTime

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

func (*CloneDatabaseMetadata) GetOperationState

func (x *CloneDatabaseMetadata) GetOperationState() OperationState

func (*CloneDatabaseMetadata) GetPitrSnapshot

func (x *CloneDatabaseMetadata) GetPitrSnapshot() *PitrSnapshot

func (*CloneDatabaseMetadata) GetProgressPercentage

func (x *CloneDatabaseMetadata) GetProgressPercentage() *Progress

func (*CloneDatabaseMetadata) GetStartTime

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

func (*CloneDatabaseMetadata) ProtoMessage

func (*CloneDatabaseMetadata) ProtoMessage()

func (*CloneDatabaseMetadata) ProtoReflect

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

func (*CloneDatabaseMetadata) Reset

func (x *CloneDatabaseMetadata) Reset()

func (*CloneDatabaseMetadata) String

func (x *CloneDatabaseMetadata) String() string

CloneDatabaseRequest

type CloneDatabaseRequest struct {

	// Required. The project to clone the database in. Format is
	// `projects/{project_id}`.
	Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
	// Required. The ID to use for the database, which will become the final
	// component of the database's resource name. This database ID must not be
	// associated with an existing database.
	//
	// 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 if the database is Standard edition.
	DatabaseId string `protobuf:"bytes,2,opt,name=database_id,json=databaseId,proto3" json:"database_id,omitempty"`
	// Required. Specification of the PITR data to clone from. The source database
	// must exist.
	//
	// The cloned database will be created in the same location as the source
	// database.
	PitrSnapshot *PitrSnapshot `protobuf:"bytes,6,opt,name=pitr_snapshot,json=pitrSnapshot,proto3" json:"pitr_snapshot,omitempty"`
	// Optional. Encryption configuration for the cloned database.
	//
	// If this field is not specified, the cloned database will use
	// the same encryption configuration as the source database, namely
	// [use_source_encryption][google.firestore.admin.v1.Database.EncryptionConfig.use_source_encryption].
	EncryptionConfig *Database_EncryptionConfig `protobuf:"bytes,4,opt,name=encryption_config,json=encryptionConfig,proto3" json:"encryption_config,omitempty"`
	// Optional. Immutable. Tags to be bound to the cloned database.
	//
	// The tags should be provided in the format of
	// `tagKeys/{tag_key_id} -> tagValues/{tag_value_id}`.
	Tags map[string]string `protobuf:"bytes,5,rep,name=tags,proto3" json:"tags,omitempty" protobuf_key:"bytes,1,opt,name=key" protobuf_val:"bytes,2,opt,name=value"`
	// contains filtered or unexported fields
}

The request message for [FirestoreAdmin.CloneDatabase][google.firestore.admin.v1.FirestoreAdmin.CloneDatabase].

func (*CloneDatabaseRequest) Descriptor

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

Deprecated: Use CloneDatabaseRequest.ProtoReflect.Descriptor instead.

func (*CloneDatabaseRequest) GetDatabaseId

func (x *CloneDatabaseRequest) GetDatabaseId() string

func (*CloneDatabaseRequest) GetEncryptionConfig

func (x *CloneDatabaseRequest) GetEncryptionConfig() *Database_EncryptionConfig

func (*CloneDatabaseRequest) GetParent

func (x *CloneDatabaseRequest) GetParent() string

func (*CloneDatabaseRequest) GetPitrSnapshot

func (x *CloneDatabaseRequest) GetPitrSnapshot() *PitrSnapshot

func (*CloneDatabaseRequest) GetTags

func (x *CloneDatabaseRequest) GetTags() map[string]string

func (*CloneDatabaseRequest) ProtoMessage

func (*CloneDatabaseRequest) ProtoMessage()

func (*CloneDatabaseRequest) ProtoReflect

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

func (*CloneDatabaseRequest) Reset

func (x *CloneDatabaseRequest) Reset()

func (*CloneDatabaseRequest) String

func (x *CloneDatabaseRequest) String() string

CreateBackupScheduleRequest

type CreateBackupScheduleRequest struct {

	// Required. The parent database.
	//
	//	Format `projects/{project}/databases/{database}`
	Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
	// Required. The backup schedule to create.
	BackupSchedule *BackupSchedule `protobuf:"bytes,2,opt,name=backup_schedule,json=backupSchedule,proto3" json:"backup_schedule,omitempty"`
	// contains filtered or unexported fields
}

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

func (*CreateBackupScheduleRequest) Descriptor

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

Deprecated: Use CreateBackupScheduleRequest.ProtoReflect.Descriptor instead.

func (*CreateBackupScheduleRequest) GetBackupSchedule

func (x *CreateBackupScheduleRequest) GetBackupSchedule() *BackupSchedule

func (*CreateBackupScheduleRequest) GetParent

func (x *CreateBackupScheduleRequest) GetParent() string

func (*CreateBackupScheduleRequest) ProtoMessage

func (*CreateBackupScheduleRequest) ProtoMessage()

func (*CreateBackupScheduleRequest) ProtoReflect

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

func (*CreateBackupScheduleRequest) Reset

func (x *CreateBackupScheduleRequest) Reset()

func (*CreateBackupScheduleRequest) String

func (x *CreateBackupScheduleRequest) String() string

CreateDatabaseMetadata

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

Metadata related to the create database operation.

func (*CreateDatabaseMetadata) Descriptor

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

Deprecated: Use CreateDatabaseMetadata.ProtoReflect.Descriptor instead.

func (*CreateDatabaseMetadata) ProtoMessage

func (*CreateDatabaseMetadata) ProtoMessage()

func (*CreateDatabaseMetadata) ProtoReflect

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

func (*CreateDatabaseMetadata) Reset

func (x *CreateDatabaseMetadata) Reset()

func (*CreateDatabaseMetadata) String

func (x *CreateDatabaseMetadata) String() string

CreateDatabaseRequest

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 if the database is Standard edition.
	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

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

Deprecated: Use CreateDatabaseRequest.ProtoReflect.Descriptor instead.

func (*CreateDatabaseRequest) GetDatabase

func (x *CreateDatabaseRequest) GetDatabase() *Database

func (*CreateDatabaseRequest) GetDatabaseId

func (x *CreateDatabaseRequest) GetDatabaseId() string

func (*CreateDatabaseRequest) GetParent

func (x *CreateDatabaseRequest) GetParent() string

func (*CreateDatabaseRequest) ProtoMessage

func (*CreateDatabaseRequest) ProtoMessage()

func (*CreateDatabaseRequest) ProtoReflect

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

func (*CreateDatabaseRequest) Reset

func (x *CreateDatabaseRequest) Reset()

func (*CreateDatabaseRequest) String

func (x *CreateDatabaseRequest) String() string

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

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

CreateUserCredsRequest

type CreateUserCredsRequest struct {

	// Required. A parent name of the form
	// `projects/{project_id}/databases/{database_id}`
	Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
	// Required. The user creds to create.
	UserCreds *UserCreds `protobuf:"bytes,2,opt,name=user_creds,json=userCreds,proto3" json:"user_creds,omitempty"`
	// Required. The ID to use for the user creds, which will become the final
	// component of the user creds'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}/.
	UserCredsId string `protobuf:"bytes,3,opt,name=user_creds_id,json=userCredsId,proto3" json:"user_creds_id,omitempty"`
	// contains filtered or unexported fields
}

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

func (*CreateUserCredsRequest) Descriptor

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

Deprecated: Use CreateUserCredsRequest.ProtoReflect.Descriptor instead.

func (*CreateUserCredsRequest) GetParent

func (x *CreateUserCredsRequest) GetParent() string

func (*CreateUserCredsRequest) GetUserCreds

func (x *CreateUserCredsRequest) GetUserCreds() *UserCreds

func (*CreateUserCredsRequest) GetUserCredsId

func (x *CreateUserCredsRequest) GetUserCredsId() string

func (*CreateUserCredsRequest) ProtoMessage

func (*CreateUserCredsRequest) ProtoMessage()

func (*CreateUserCredsRequest) ProtoReflect

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

func (*CreateUserCredsRequest) Reset

func (x *CreateUserCredsRequest) Reset()

func (*CreateUserCredsRequest) String

func (x *CreateUserCredsRequest) String() string

DailyRecurrence

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

Represents a recurring schedule that runs every day.

The time zone is UTC.

func (*DailyRecurrence) Descriptor

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

Deprecated: Use DailyRecurrence.ProtoReflect.Descriptor instead.

func (*DailyRecurrence) ProtoMessage

func (*DailyRecurrence) ProtoMessage()

func (*DailyRecurrence) ProtoReflect

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

func (*DailyRecurrence) Reset

func (x *DailyRecurrence) Reset()

func (*DailyRecurrence) String

func (x *DailyRecurrence) String() string

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"`
	// Output only. The timestamp at which this database was deleted. Only set if
	// the database has been deleted.
	DeleteTime *timestamppb.Timestamp `protobuf:"bytes,7,opt,name=delete_time,json=deleteTime,proto3" json:"delete_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.
	//
	// If unspecified in a CreateDatabase request, this will default based on the
	// database edition: Optimistic for Enterprise and Pessimistic for all other
	// databases.
	ConcurrencyMode Database_ConcurrencyMode `protobuf:"varint,15,opt,name=concurrency_mode,json=concurrencyMode,proto3,enum=google.firestore.admin.v1.Database_ConcurrencyMode" json:"concurrency_mode,omitempty"`
	// 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 `protobuf:"bytes,17,opt,name=version_retention_period,json=versionRetentionPeriod,proto3" json:"version_retention_period,omitempty"`
	// 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 `protobuf:"varint,21,opt,name=point_in_time_recovery_enablement,json=pointInTimeRecoveryEnablement,proto3,enum=google.firestore.admin.v1.Database_PointInTimeRecoveryEnablement" json:"point_in_time_recovery_enablement,omitempty"`
	// The App Engine integration mode to use for this database.
	AppEngineIntegrationMode Database_AppEngineIntegrationMode `protobuf:"varint,19,opt,name=app_engine_integration_mode,json=appEngineIntegrationMode,proto3,enum=google.firestore.admin.v1.Database_AppEngineIntegrationMode" json:"app_engine_integration_mode,omitempty"`
	// Output only. The key_prefix for this database. This key_prefix is used, in
	// combination with the project ID ("

A Cloud Firestore Database.

func (*Database) Descriptor

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

Deprecated: Use Database.ProtoReflect.Descriptor instead.

func (*Database) GetAppEngineIntegrationMode

func (x *Database) GetAppEngineIntegrationMode() Database_AppEngineIntegrationMode

func (*Database) GetCmekConfig

func (x *Database) GetCmekConfig() *Database_CmekConfig

func (*Database) GetConcurrencyMode

func (x *Database) GetConcurrencyMode() Database_ConcurrencyMode

func (*Database) GetCreateTime

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

func (*Database) GetDatabaseEdition

func (x *Database) GetDatabaseEdition() Database_DatabaseEdition

func (*Database) GetDeleteProtectionState

func (x *Database) GetDeleteProtectionState() Database_DeleteProtectionState

func (*Database) GetDeleteTime

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

func (*Database) GetEarliestVersionTime

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

func (*Database) GetEtag

func (x *Database) GetEtag() string

func (*Database) GetFirestoreDataAccessMode

func (x *Database) GetFirestoreDataAccessMode() Database_DataAccessMode

func (*Database) GetFreeTier

func (x *Database) GetFreeTier() bool

func (*Database) GetKeyPrefix

func (x *Database) GetKeyPrefix() string

func (*Database) GetLocationId

func (x *Database) GetLocationId() string

func (*Database) GetMongodbCompatibleDataAccessMode

func (x *Database) GetMongodbCompatibleDataAccessMode() Database_DataAccessMode

func (*Database) GetName

func (x *Database) GetName() string

func (*Database) GetPointInTimeRecoveryEnablement

func (x *Database) GetPointInTimeRecoveryEnablement() Database_PointInTimeRecoveryEnablement

func (*Database) GetPreviousId

func (x *Database) GetPreviousId() string

func (*Database) GetRealtimeUpdatesMode

func (x *Database) GetRealtimeUpdatesMode() RealtimeUpdatesMode

func (*Database) GetSourceInfo

func (x *Database) GetSourceInfo() *Database_SourceInfo

func (*Database) GetTags

func (x *Database) GetTags() map[string]string

func (*Database) GetType

func (x *Database) GetType() Database_DatabaseType

func (*Database) GetUid

func (x *Database) GetUid() string

func (*Database) GetUpdateTime

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

func (*Database) GetVersionRetentionPeriod

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

Database_AppEngineIntegrationMode

type Database_AppEngineIntegrationMode int32

The type of App Engine integration mode.

Database_APP_ENGINE_INTEGRATION_MODE_UNSPECIFIED, Database_ENABLED, Database_DISABLED

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

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

Database_CmekConfig

type Database_CmekConfig struct {

	// Required. Only keys in the same location as this database are allowed to
	// be used for encryption.
	//
	// For Firestore's nam5 multi-region, this corresponds to Cloud KMS
	// multi-region us. For Firestore's eur3 multi-region, this corresponds to
	// Cloud KMS multi-region europe. See
	// https://cloud.google.com/kms/docs/locations.
	//
	// The expected format is
	// `projects/{project_id}/locations/{kms_location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}`.
	KmsKeyName string `protobuf:"bytes,1,opt,name=kms_key_name,json=kmsKeyName,proto3" json:"kms_key_name,omitempty"`
	// Output only. Currently in-use [KMS key
	// versions](https://cloud.google.com/kms/docs/resource-hierarchy#key_versions).
	// During [key rotation](https://cloud.google.com/kms/docs/key-rotation),
	// there can be multiple in-use key versions.
	//
	// The expected format is
	// `projects/{project_id}/locations/{kms_location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}/cryptoKeyVersions/{key_version}`.
	ActiveKeyVersion []string `protobuf:"bytes,2,rep,name=active_key_version,json=activeKeyVersion,proto3" json:"active_key_version,omitempty"`
	// contains filtered or unexported fields
}

The CMEK (Customer Managed Encryption Key) configuration for a Firestore database. If not present, the database is secured by the default Google encryption key.

func (*Database_CmekConfig) Descriptor

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

Deprecated: Use Database_CmekConfig.ProtoReflect.Descriptor instead.

func (*Database_CmekConfig) GetActiveKeyVersion

func (x *Database_CmekConfig) GetActiveKeyVersion() []string

func (*Database_CmekConfig) GetKmsKeyName

func (x *Database_CmekConfig) GetKmsKeyName() string

func (*Database_CmekConfig) ProtoMessage

func (*Database_CmekConfig) ProtoMessage()

func (*Database_CmekConfig) ProtoReflect

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

func (*Database_CmekConfig) Reset

func (x *Database_CmekConfig) Reset()

func (*Database_CmekConfig) String

func (x *Database_CmekConfig) String() string

Database_ConcurrencyMode

type Database_ConcurrencyMode int32

The type of concurrency control mode for transactions.

Database_CONCURRENCY_MODE_UNSPECIFIED, Database_OPTIMISTIC, Database_PESSIMISTIC, Database_OPTIMISTIC_WITH_ENTITY_GROUPS

const (
	// Not used.
	Database_CONCURRENCY_MODE_UNSPECIFIED Database_ConcurrencyMode = 0
	// Use optimistic concurrency control by default. This mode is available
	// for Cloud Firestore databases.
	//
	// This is the default setting for Cloud Firestore Enterprise Edition
	// 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 Standard Edition
	// databases.
	Database_PESSIMISTIC Database_ConcurrencyMode = 2
	// Use optimistic concurrency control with entity groups by default.
	//
	// This mode is enabled for some databases that were automatically upgraded
	// from Cloud Datastore to Cloud Firestore with Datastore Mode.
	//
	// It is not recommended for any new databases, and not supported for
	// Firestore Native databases.
	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

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

Database_DataAccessMode

type Database_DataAccessMode int32

The data access mode.

Database_DATA_ACCESS_MODE_UNSPECIFIED, Database_DATA_ACCESS_MODE_ENABLED, Database_DATA_ACCESS_MODE_DISABLED

const (
	// Not Used.
	Database_DATA_ACCESS_MODE_UNSPECIFIED Database_DataAccessMode = 0
	// Accessing the database through the API is allowed.
	Database_DATA_ACCESS_MODE_ENABLED Database_DataAccessMode = 1
	// Accessing the database through the API is disallowed.
	Database_DATA_ACCESS_MODE_DISABLED Database_DataAccessMode = 2
)

func (Database_DataAccessMode) Descriptor

func (Database_DataAccessMode) Descriptor() protoreflect.EnumDescriptor

func (Database_DataAccessMode) Enum

func (x Database_DataAccessMode) Enum() *Database_DataAccessMode

func (Database_DataAccessMode) EnumDescriptor

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

Deprecated: Use Database_DataAccessMode.Descriptor instead.

func (Database_DataAccessMode) Number

func (x Database_DataAccessMode) Number() protoreflect.EnumNumber

func (Database_DataAccessMode) String

func (x Database_DataAccessMode) String() string

func (Database_DataAccessMode) Type

func (Database_DataAccessMode) Type() protoreflect.EnumType

Database_DatabaseEdition

type Database_DatabaseEdition int32

The edition of the database.

Database_DATABASE_EDITION_UNSPECIFIED, Database_STANDARD, Database_ENTERPRISE

const (
	// Not used.
	Database_DATABASE_EDITION_UNSPECIFIED Database_DatabaseEdition = 0
	// Standard edition.
	//
	// This is the default setting if not specified.
	Database_STANDARD Database_DatabaseEdition = 1
	// Enterprise edition.
	Database_ENTERPRISE Database_DatabaseEdition = 2
)

func (Database_DatabaseEdition) Descriptor

func (Database_DatabaseEdition) Descriptor() protoreflect.EnumDescriptor

func (Database_DatabaseEdition) Enum

func (x Database_DatabaseEdition) Enum() *Database_DatabaseEdition

func (Database_DatabaseEdition) EnumDescriptor

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

Deprecated: Use Database_DatabaseEdition.Descriptor instead.

func (Database_DatabaseEdition) Number

func (x Database_DatabaseEdition) Number() protoreflect.EnumNumber

func (Database_DatabaseEdition) String

func (x Database_DatabaseEdition) String() string

func (Database_DatabaseEdition) Type

func (Database_DatabaseEdition) Type() protoreflect.EnumType

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.

Database_DATABASE_TYPE_UNSPECIFIED, Database_FIRESTORE_NATIVE, Database_DATASTORE_MODE

const (
	// Not used.
	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

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

Database_DeleteProtectionState

type Database_DeleteProtectionState int32

The delete protection state of the database.

Database_DELETE_PROTECTION_STATE_UNSPECIFIED, Database_DELETE_PROTECTION_DISABLED, Database_DELETE_PROTECTION_ENABLED

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

func (Database_DeleteProtectionState) Descriptor() protoreflect.EnumDescriptor

func (Database_DeleteProtectionState) Enum

func (x Database_DeleteProtectionState) Enum() *Database_DeleteProtectionState

func (Database_DeleteProtectionState) EnumDescriptor

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

Deprecated: Use Database_DeleteProtectionState.Descriptor instead.

func (Database_DeleteProtectionState) Number

func (x Database_DeleteProtectionState) Number() protoreflect.EnumNumber

func (Database_DeleteProtectionState) String

func (x Database_DeleteProtectionState) String() string

func (Database_DeleteProtectionState) Type

func (Database_DeleteProtectionState) Type() protoreflect.EnumType

Database_EncryptionConfig

type Database_EncryptionConfig struct {

	// The method for encrypting the database.
	//
	// Types that are valid to be assigned to EncryptionType:
	//
	//	*Database_EncryptionConfig_GoogleDefaultEncryption
	//	*Database_EncryptionConfig_UseSourceEncryption
	//	*Database_EncryptionConfig_CustomerManagedEncryption
	EncryptionType isDatabase_EncryptionConfig_EncryptionType `protobuf_oneof:"encryption_type"`
	// contains filtered or unexported fields
}

Encryption configuration for a new database being created from another source.

The source could be a [Backup][google.firestore.admin.v1.Backup] or a [PitrSnapshot][google.firestore.admin.v1.PitrSnapshot].

func (*Database_EncryptionConfig) Descriptor

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

Deprecated: Use Database_EncryptionConfig.ProtoReflect.Descriptor instead.

func (*Database_EncryptionConfig) GetCustomerManagedEncryption

func (x *Database_EncryptionConfig) GetCustomerManagedEncryption() *Database_EncryptionConfig_CustomerManagedEncryptionOptions

func (*Database_EncryptionConfig) GetEncryptionType

func (x *Database_EncryptionConfig) GetEncryptionType() isDatabase_EncryptionConfig_EncryptionType

func (*Database_EncryptionConfig) GetGoogleDefaultEncryption

func (x *Database_EncryptionConfig) GetGoogleDefaultEncryption() *Database_EncryptionConfig_GoogleDefaultEncryptionOptions

func (*Database_EncryptionConfig) GetUseSourceEncryption

func (x *Database_EncryptionConfig) GetUseSourceEncryption() *Database_EncryptionConfig_SourceEncryptionOptions

func (*Database_EncryptionConfig) ProtoMessage

func (*Database_EncryptionConfig) ProtoMessage()

func (*Database_EncryptionConfig) ProtoReflect

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

func (*Database_EncryptionConfig) Reset

func (x *Database_EncryptionConfig) Reset()

func (*Database_EncryptionConfig) String

func (x *Database_EncryptionConfig) String() string

Database_EncryptionConfig_CustomerManagedEncryption

type Database_EncryptionConfig_CustomerManagedEncryption struct {
	// Use Customer Managed Encryption Keys (CMEK) for encryption.
	CustomerManagedEncryption *Database_EncryptionConfig_CustomerManagedEncryptionOptions `protobuf:"bytes,3,opt,name=customer_managed_encryption,json=customerManagedEncryption,proto3,oneof"`
}

Database_EncryptionConfig_CustomerManagedEncryptionOptions

type Database_EncryptionConfig_CustomerManagedEncryptionOptions struct {

	// Required. Only keys in the same location as the database are allowed to
	// be used for encryption.
	//
	// For Firestore's nam5 multi-region, this corresponds to Cloud KMS
	// multi-region us. For Firestore's eur3 multi-region, this corresponds to
	// Cloud KMS multi-region europe. See
	// https://cloud.google.com/kms/docs/locations.
	//
	// The expected format is
	// `projects/{project_id}/locations/{kms_location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}`.
	KmsKeyName string `protobuf:"bytes,1,opt,name=kms_key_name,json=kmsKeyName,proto3" json:"kms_key_name,omitempty"`
	// contains filtered or unexported fields
}

The configuration options for using CMEK (Customer Managed Encryption Key) encryption.

func (*Database_EncryptionConfig_CustomerManagedEncryptionOptions) Descriptor

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

Deprecated: Use Database_EncryptionConfig_CustomerManagedEncryptionOptions.ProtoReflect.Descriptor instead.

func (*Database_EncryptionConfig_CustomerManagedEncryptionOptions) GetKmsKeyName

func (x *Database_EncryptionConfig_CustomerManagedEncryptionOptions) GetKmsKeyName() string

func (*Database_EncryptionConfig_CustomerManagedEncryptionOptions) ProtoMessage

func (*Database_EncryptionConfig_CustomerManagedEncryptionOptions) ProtoMessage()

func (*Database_EncryptionConfig_CustomerManagedEncryptionOptions) ProtoReflect

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

func (*Database_EncryptionConfig_CustomerManagedEncryptionOptions) Reset

func (x *Database_EncryptionConfig_CustomerManagedEncryptionOptions) Reset()

func (*Database_EncryptionConfig_CustomerManagedEncryptionOptions) String

func (x *Database_EncryptionConfig_CustomerManagedEncryptionOptions) String() string

Database_EncryptionConfig_GoogleDefaultEncryption

type Database_EncryptionConfig_GoogleDefaultEncryption struct {
	// Use Google default encryption.
	GoogleDefaultEncryption *Database_EncryptionConfig_GoogleDefaultEncryptionOptions `protobuf:"bytes,1,opt,name=google_default_encryption,json=googleDefaultEncryption,proto3,oneof"`
}

Database_EncryptionConfig_GoogleDefaultEncryptionOptions

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

The configuration options for using Google default encryption.

func (*Database_EncryptionConfig_GoogleDefaultEncryptionOptions) Descriptor

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

Deprecated: Use Database_EncryptionConfig_GoogleDefaultEncryptionOptions.ProtoReflect.Descriptor instead.

func (*Database_EncryptionConfig_GoogleDefaultEncryptionOptions) ProtoMessage

func (*Database_EncryptionConfig_GoogleDefaultEncryptionOptions) ProtoMessage()

func (*Database_EncryptionConfig_GoogleDefaultEncryptionOptions) ProtoReflect

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

func (*Database_EncryptionConfig_GoogleDefaultEncryptionOptions) Reset

func (x *Database_EncryptionConfig_GoogleDefaultEncryptionOptions) Reset()

func (*Database_EncryptionConfig_GoogleDefaultEncryptionOptions) String

func (x *Database_EncryptionConfig_GoogleDefaultEncryptionOptions) String() string

Database_EncryptionConfig_SourceEncryptionOptions

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

The configuration options for using the same encryption method as the source.

func (*Database_EncryptionConfig_SourceEncryptionOptions) Descriptor

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

Deprecated: Use Database_EncryptionConfig_SourceEncryptionOptions.ProtoReflect.Descriptor instead.

func (*Database_EncryptionConfig_SourceEncryptionOptions) ProtoMessage

func (*Database_EncryptionConfig_SourceEncryptionOptions) ProtoMessage()

func (*Database_EncryptionConfig_SourceEncryptionOptions) ProtoReflect

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

func (*Database_EncryptionConfig_SourceEncryptionOptions) Reset

func (x *Database_EncryptionConfig_SourceEncryptionOptions) Reset()

func (*Database_EncryptionConfig_SourceEncryptionOptions) String

func (x *Database_EncryptionConfig_SourceEncryptionOptions) String() string

Database_EncryptionConfig_UseSourceEncryption

type Database_EncryptionConfig_UseSourceEncryption struct {
	// The database will use the same encryption configuration as the source.
	UseSourceEncryption *Database_EncryptionConfig_SourceEncryptionOptions `protobuf:"bytes,2,opt,name=use_source_encryption,json=useSourceEncryption,proto3,oneof"`
}

Database_PointInTimeRecoveryEnablement

type Database_PointInTimeRecoveryEnablement int32

Point In Time Recovery feature enablement.

Database_POINT_IN_TIME_RECOVERY_ENABLEMENT_UNSPECIFIED, Database_POINT_IN_TIME_RECOVERY_ENABLED, Database_POINT_IN_TIME_RECOVERY_DISABLED

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

func (Database_PointInTimeRecoveryEnablement) Descriptor() protoreflect.EnumDescriptor

func (Database_PointInTimeRecoveryEnablement) Enum

func (x Database_PointInTimeRecoveryEnablement) Enum() *Database_PointInTimeRecoveryEnablement

func (Database_PointInTimeRecoveryEnablement) EnumDescriptor

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

Deprecated: Use Database_PointInTimeRecoveryEnablement.Descriptor instead.

func (Database_PointInTimeRecoveryEnablement) Number

func (x Database_PointInTimeRecoveryEnablement) Number() protoreflect.EnumNumber

func (Database_PointInTimeRecoveryEnablement) String

func (x Database_PointInTimeRecoveryEnablement) String() string

func (Database_PointInTimeRecoveryEnablement) Type

func (Database_PointInTimeRecoveryEnablement) Type() protoreflect.EnumType

Database_SourceInfo

type Database_SourceInfo struct {

	// The source from which this database is derived.
	//
	// Types that are valid to be assigned to Source:
	//
	//	*Database_SourceInfo_Backup
	Source isDatabase_SourceInfo_Source `protobuf_oneof:"source"`
	// The associated long-running operation. This field may not be set after
	// the operation has completed. Format:
	// `projects/{project}/databases/{database}/operations/{operation}`.
	Operation string `protobuf:"bytes,3,opt,name=operation,proto3" json:"operation,omitempty"`
	// contains filtered or unexported fields
}

Information about the provenance of this database.

func (*Database_SourceInfo) Descriptor

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

Deprecated: Use Database_SourceInfo.ProtoReflect.Descriptor instead.

func (*Database_SourceInfo) GetBackup

func (x *Database_SourceInfo) GetBackup() *Database_SourceInfo_BackupSource

func (*Database_SourceInfo) GetOperation

func (x *Database_SourceInfo) GetOperation() string

func (*Database_SourceInfo) GetSource

func (x *Database_SourceInfo) GetSource() isDatabase_SourceInfo_Source

func (*Database_SourceInfo) ProtoMessage

func (*Database_SourceInfo) ProtoMessage()

func (*Database_SourceInfo) ProtoReflect

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

func (*Database_SourceInfo) Reset

func (x *Database_SourceInfo) Reset()

func (*Database_SourceInfo) String

func (x *Database_SourceInfo) String() string

Database_SourceInfo_Backup

type Database_SourceInfo_Backup struct {
	// If set, this database was restored from the specified backup (or a
	// snapshot thereof).
	Backup *Database_SourceInfo_BackupSource `protobuf:"bytes,1,opt,name=backup,proto3,oneof"`
}

Database_SourceInfo_BackupSource

type Database_SourceInfo_BackupSource struct {

	// The resource name of the backup that was used to restore this
	// database. Format:
	// `projects/{project}/locations/{location}/backups/{backup}`.
	Backup string `protobuf:"bytes,1,opt,name=backup,proto3" json:"backup,omitempty"`
	// contains filtered or unexported fields
}

Information about a backup that was used to restore a database.

func (*Database_SourceInfo_BackupSource) Descriptor

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

Deprecated: Use Database_SourceInfo_BackupSource.ProtoReflect.Descriptor instead.

func (*Database_SourceInfo_BackupSource) GetBackup

func (x *Database_SourceInfo_BackupSource) GetBackup() string

func (*Database_SourceInfo_BackupSource) ProtoMessage

func (*Database_SourceInfo_BackupSource) ProtoMessage()

func (*Database_SourceInfo_BackupSource) ProtoReflect

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

func (*Database_SourceInfo_BackupSource) Reset

func (x *Database_SourceInfo_BackupSource) Reset()

func (*Database_SourceInfo_BackupSource) String

func (x *Database_SourceInfo_BackupSource) String() string

DeleteBackupRequest

type DeleteBackupRequest struct {

	// Required. Name of the backup to delete.
	//
	// format is `projects/{project}/locations/{location}/backups/{backup}`.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// contains filtered or unexported fields
}

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

func (*DeleteBackupRequest) Descriptor

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

Deprecated: Use DeleteBackupRequest.ProtoReflect.Descriptor instead.

func (*DeleteBackupRequest) GetName

func (x *DeleteBackupRequest) GetName() string

func (*DeleteBackupRequest) ProtoMessage

func (*DeleteBackupRequest) ProtoMessage()

func (*DeleteBackupRequest) ProtoReflect

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

func (*DeleteBackupRequest) Reset

func (x *DeleteBackupRequest) Reset()

func (*DeleteBackupRequest) String

func (x *DeleteBackupRequest) String() string

DeleteBackupScheduleRequest

type DeleteBackupScheduleRequest struct {

	// Required. The name of the backup schedule.
	//
	// Format
	// `projects/{project}/databases/{database}/backupSchedules/{backup_schedule}`
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// contains filtered or unexported fields
}

The request for [FirestoreAdmin.DeleteBackupSchedules][].

func (*DeleteBackupScheduleRequest) Descriptor

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

Deprecated: Use DeleteBackupScheduleRequest.ProtoReflect.Descriptor instead.

func (*DeleteBackupScheduleRequest) GetName

func (x *DeleteBackupScheduleRequest) GetName() string

func (*DeleteBackupScheduleRequest) ProtoMessage

func (*DeleteBackupScheduleRequest) ProtoMessage()

func (*DeleteBackupScheduleRequest) ProtoReflect

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

func (*DeleteBackupScheduleRequest) Reset

func (x *DeleteBackupScheduleRequest) Reset()

func (*DeleteBackupScheduleRequest) String

func (x *DeleteBackupScheduleRequest) String() string

DeleteDatabaseMetadata

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

Metadata related to the delete database operation.

func (*DeleteDatabaseMetadata) Descriptor

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

Deprecated: Use DeleteDatabaseMetadata.ProtoReflect.Descriptor instead.

func (*DeleteDatabaseMetadata) ProtoMessage

func (*DeleteDatabaseMetadata) ProtoMessage()

func (*DeleteDatabaseMetadata) ProtoReflect

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

func (*DeleteDatabaseMetadata) Reset

func (x *DeleteDatabaseMetadata) Reset()

func (*DeleteDatabaseMetadata) String

func (x *DeleteDatabaseMetadata) String() string

DeleteDatabaseRequest

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

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

Deprecated: Use DeleteDatabaseRequest.ProtoReflect.Descriptor instead.

func (*DeleteDatabaseRequest) GetEtag

func (x *DeleteDatabaseRequest) GetEtag() string

func (*DeleteDatabaseRequest) GetName

func (x *DeleteDatabaseRequest) GetName() string

func (*DeleteDatabaseRequest) ProtoMessage

func (*DeleteDatabaseRequest) ProtoMessage()

func (*DeleteDatabaseRequest) ProtoReflect

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

func (*DeleteDatabaseRequest) Reset

func (x *DeleteDatabaseRequest) Reset()

func (*DeleteDatabaseRequest) String

func (x *DeleteDatabaseRequest) String() string

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

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

DeleteUserCredsRequest

type DeleteUserCredsRequest struct {

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

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

func (*DeleteUserCredsRequest) Descriptor

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

Deprecated: Use DeleteUserCredsRequest.ProtoReflect.Descriptor instead.

func (*DeleteUserCredsRequest) GetName

func (x *DeleteUserCredsRequest) GetName() string

func (*DeleteUserCredsRequest) ProtoMessage

func (*DeleteUserCredsRequest) ProtoMessage()

func (*DeleteUserCredsRequest) ProtoReflect

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

func (*DeleteUserCredsRequest) Reset

func (x *DeleteUserCredsRequest) Reset()

func (*DeleteUserCredsRequest) String

func (x *DeleteUserCredsRequest) String() string

DisableUserCredsRequest

type DisableUserCredsRequest struct {

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

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

func (*DisableUserCredsRequest) Descriptor

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

Deprecated: Use DisableUserCredsRequest.ProtoReflect.Descriptor instead.

func (*DisableUserCredsRequest) GetName

func (x *DisableUserCredsRequest) GetName() string

func (*DisableUserCredsRequest) ProtoMessage

func (*DisableUserCredsRequest) ProtoMessage()

func (*DisableUserCredsRequest) ProtoReflect

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

func (*DisableUserCredsRequest) Reset

func (x *DisableUserCredsRequest) Reset()

func (*DisableUserCredsRequest) String

func (x *DisableUserCredsRequest) String() string

EnableUserCredsRequest

type EnableUserCredsRequest struct {

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

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

func (*EnableUserCredsRequest) Descriptor

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

Deprecated: Use EnableUserCredsRequest.ProtoReflect.Descriptor instead.

func (*EnableUserCredsRequest) GetName

func (x *EnableUserCredsRequest) GetName() string

func (*EnableUserCredsRequest) ProtoMessage

func (*EnableUserCredsRequest) ProtoMessage()

func (*EnableUserCredsRequest) ProtoReflect

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

func (*EnableUserCredsRequest) Reset

func (x *EnableUserCredsRequest) Reset()

func (*EnableUserCredsRequest) String

func (x *EnableUserCredsRequest) String() string

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 `protobuf:"varint,3,opt,name=operation_state,json=operationState,proto3,enum=google.firestore.admin.v1.OperationState" json:"operation_state,omitempty"`
	// 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

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

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

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

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"`
	// IDs of the collection groups to export. Unspecified means all
	// collection groups. Each collection group in this list must be unique.
	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

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

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

func (*ExportDocumentsRequest) GetOutputUriPrefix

func (x *ExportDocumentsRequest) GetOutputUriPrefix() string

func (*ExportDocumentsRequest) GetSnapshotTime

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

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

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

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 can 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 can be quoted using “ ` “ (backtick). The only character that
	// must 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:
	// “ `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

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

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

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

FieldOperationMetadata_IndexConfigDelta

type FieldOperationMetadata_IndexConfigDelta struct {

	// Specifies how the index is changing.
	ChangeType FieldOperationMetadata_IndexConfigDelta_ChangeType `protobuf:"varint,1,opt,name=change_type,json=changeType,proto3,enum=google.firestore.admin.v1.FieldOperationMetadata_IndexConfigDelta_ChangeType" json:"change_type,omitempty"`
	// 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

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

FieldOperationMetadata_IndexConfigDelta_ChangeType

type FieldOperationMetadata_IndexConfigDelta_ChangeType int32

Specifies how the index is changing.

FieldOperationMetadata_IndexConfigDelta_CHANGE_TYPE_UNSPECIFIED, FieldOperationMetadata_IndexConfigDelta_ADD, FieldOperationMetadata_IndexConfigDelta_REMOVE

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

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

FieldOperationMetadata_TtlConfigDelta

type FieldOperationMetadata_TtlConfigDelta struct {

	// Specifies how the TTL configuration is changing.
	ChangeType FieldOperationMetadata_TtlConfigDelta_ChangeType `protobuf:"varint,1,opt,name=change_type,json=changeType,proto3,enum=google.firestore.admin.v1.FieldOperationMetadata_TtlConfigDelta_ChangeType" json:"change_type,omitempty"`
	// The offset, relative to the timestamp value in the TTL-enabled field,
	// used determine the document's expiration time.
	ExpirationOffset *durationpb.Duration `protobuf:"bytes,3,opt,name=expiration_offset,json=expirationOffset,proto3" json:"expiration_offset,omitempty"`
	// contains filtered or unexported fields
}

Information about a TTL configuration change.

func (*FieldOperationMetadata_TtlConfigDelta) Descriptor

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) GetExpirationOffset

func (x *FieldOperationMetadata_TtlConfigDelta) GetExpirationOffset() *durationpb.Duration

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

FieldOperationMetadata_TtlConfigDelta_ChangeType

type FieldOperationMetadata_TtlConfigDelta_ChangeType int32

Specifies how the TTL config is changing.

FieldOperationMetadata_TtlConfigDelta_CHANGE_TYPE_UNSPECIFIED, FieldOperationMetadata_TtlConfigDelta_ADD, FieldOperationMetadata_TtlConfigDelta_REMOVE

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

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

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

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

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"`
	// Optional. The offset, relative to the timestamp value from the
	// TTL-enabled field, used to determine the document's expiration time.
	//
	// `expiration_offset.seconds` must be between 0 and 2,147,483,647
	// inclusive. Values more precise than seconds are rejected.
	//
	// If unset, defaults to 0, in which case the expiration time is the same
	// as the timestamp value from the TTL-enabled field.
	ExpirationOffset *durationpb.Duration `protobuf:"bytes,3,opt,name=expiration_offset,json=expirationOffset,proto3" json:"expiration_offset,omitempty"`
	// contains filtered or unexported fields
}

The TTL (time-to-live) configuration for documents that have this Field set.

A timestamp stored in a TTL-enabled field will be used to determine the expiration time of the document. The expiration time is the sum of the timestamp value and the expiration_offset.

For Enterprise edition databases, the timestamp value may alternatively be stored in an array value in the TTL-enabled field.

An expiration time in the past indicates that the document is eligible for immediate expiration. Using any other data type or leaving the field absent will disable expiration for the individual document.

func (*Field_TtlConfig) Descriptor

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

Deprecated: Use Field_TtlConfig.ProtoReflect.Descriptor instead.

func (*Field_TtlConfig) GetExpirationOffset

func (x *Field_TtlConfig) GetExpirationOffset() *durationpb.Duration

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

Field_TtlConfig_State

type Field_TtlConfig_State int32

The state of applying the TTL configuration to all documents.

Field_TtlConfig_STATE_UNSPECIFIED, Field_TtlConfig_CREATING, Field_TtlConfig_ACTIVE, Field_TtlConfig_NEEDS_REPAIR

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

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

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)
	// Bulk deletes a subset of documents from Google Cloud Firestore.
	// Documents created or updated after the underlying system starts to process
	// the request will not be deleted. The bulk delete occurs in the background
	// and its progress can be monitored and managed via the Operation resource
	// that is created.
	//
	// For more details on bulk delete behavior, refer to:
	// https://cloud.google.com/firestore/docs/manage-data/bulk-delete
	BulkDeleteDocuments(ctx context.Context, in *BulkDeleteDocumentsRequest, 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)
	// Create a user creds.
	CreateUserCreds(ctx context.Context, in *CreateUserCredsRequest, opts ...grpc.CallOption) (*UserCreds, error)
	// Gets a user creds resource. Note that the returned resource does not
	// contain the secret value itself.
	GetUserCreds(ctx context.Context, in *GetUserCredsRequest, opts ...grpc.CallOption) (*UserCreds, error)
	// List all user creds in the database. Note that the returned resource
	// does not contain the secret value itself.
	ListUserCreds(ctx context.Context, in *ListUserCredsRequest, opts ...grpc.CallOption) (*ListUserCredsResponse, error)
	// Enables a user creds. No-op if the user creds are already enabled.
	EnableUserCreds(ctx context.Context, in *EnableUserCredsRequest, opts ...grpc.CallOption) (*UserCreds, error)
	// Disables a user creds. No-op if the user creds are already disabled.
	DisableUserCreds(ctx context.Context, in *DisableUserCredsRequest, opts ...grpc.CallOption) (*UserCreds, error)
	// Resets the password of a user creds.
	ResetUserPassword(ctx context.Context, in *ResetUserPasswordRequest, opts ...grpc.CallOption) (*UserCreds, error)
	// Deletes a user creds.
	DeleteUserCreds(ctx context.Context, in *DeleteUserCredsRequest, opts ...grpc.CallOption) (*emptypb.Empty, error)
	// Gets information about a backup.
	GetBackup(ctx context.Context, in *GetBackupRequest, opts ...grpc.CallOption) (*Backup, error)
	// Lists all the backups.
	ListBackups(ctx context.Context, in *ListBackupsRequest, opts ...grpc.CallOption) (*ListBackupsResponse, error)
	// Deletes a backup.
	DeleteBackup(ctx context.Context, in *DeleteBackupRequest, opts ...grpc.CallOption) (*emptypb.Empty, error)
	// Creates a new database by restoring from an existing backup.
	//
	// The new database must be in the same cloud region or multi-region location
	// as the existing backup. This behaves similar to
	// [FirestoreAdmin.CreateDatabase][google.firestore.admin.v1.FirestoreAdmin.CreateDatabase]
	// except instead of creating a new empty database, a new database is created
	// with the database type, index configuration, and documents from an existing
	// backup.
	//
	// The [long-running operation][google.longrunning.Operation] can be used to
	// track the progress of the restore, with the Operation's
	// [metadata][google.longrunning.Operation.metadata] field type being the
	// [RestoreDatabaseMetadata][google.firestore.admin.v1.RestoreDatabaseMetadata].
	// The [response][google.longrunning.Operation.response] type is the
	// [Database][google.firestore.admin.v1.Database] if the restore was
	// successful. The new database is not readable or writeable until the LRO has
	// completed.
	RestoreDatabase(ctx context.Context, in *RestoreDatabaseRequest, opts ...grpc.CallOption) (*longrunningpb.Operation, error)
	// Creates a backup schedule on a database.
	// At most two backup schedules can be configured on a database, one daily
	// backup schedule and one weekly backup schedule.
	CreateBackupSchedule(ctx context.Context, in *CreateBackupScheduleRequest, opts ...grpc.CallOption) (*BackupSchedule, error)
	// Gets information about a backup schedule.
	GetBackupSchedule(ctx context.Context, in *GetBackupScheduleRequest, opts ...grpc.CallOption) (*BackupSchedule, error)
	// List backup schedules.
	ListBackupSchedules(ctx context.Context, in *ListBackupSchedulesRequest, opts ...grpc.CallOption) (*ListBackupSchedulesResponse, error)
	// Updates a backup schedule.
	UpdateBackupSchedule(ctx context.Context, in *UpdateBackupScheduleRequest, opts ...grpc.CallOption) (*BackupSchedule, error)
	// Deletes a backup schedule.
	DeleteBackupSchedule(ctx context.Context, in *DeleteBackupScheduleRequest, opts ...grpc.CallOption) (*emptypb.Empty, error)
	// Creates a new database by cloning an existing one.
	//
	// The new database must be in the same cloud region or multi-region location
	// as the existing database. This behaves similar to
	// [FirestoreAdmin.CreateDatabase][google.firestore.admin.v1.FirestoreAdmin.CreateDatabase]
	// except instead of creating a new empty database, a new database is created
	// with the database type, index configuration, and documents from an existing
	// database.
	//
	// The [long-running operation][google.longrunning.Operation] can be used to
	// track the progress of the clone, with the Operation's
	// [metadata][google.longrunning.Operation.metadata] field type being the
	// [CloneDatabaseMetadata][google.firestore.admin.v1.CloneDatabaseMetadata].
	// The [response][google.longrunning.Operation.response] type is the
	// [Database][google.firestore.admin.v1.Database] if the clone was
	// successful. The new database is not readable or writeable until the LRO has
	// completed.
	CloneDatabase(ctx context.Context, in *CloneDatabaseRequest, 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://pkg.go.dev/google.golang.org/grpc/?tab=doc#ClientConn.NewStream.

func NewFirestoreAdminClient

func NewFirestoreAdminClient(cc grpc.ClientConnInterface) FirestoreAdminClient

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)
	// Bulk deletes a subset of documents from Google Cloud Firestore.
	// Documents created or updated after the underlying system starts to process
	// the request will not be deleted. The bulk delete occurs in the background
	// and its progress can be monitored and managed via the Operation resource
	// that is created.
	//
	// For more details on bulk delete behavior, refer to:
	// https://cloud.google.com/firestore/docs/manage-data/bulk-delete
	BulkDeleteDocuments(context.Context, *BulkDeleteDocumentsRequest) (*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)
	// Create a user creds.
	CreateUserCreds(context.Context, *CreateUserCredsRequest) (*UserCreds, error)
	// Gets a user creds resource. Note that the returned resource does not
	// contain the secret value itself.
	GetUserCreds(context.Context, *GetUserCredsRequest) (*UserCreds, error)
	// List all user creds in the database. Note that the returned resource
	// does not contain the secret value itself.
	ListUserCreds(context.Context, *ListUserCredsRequest) (*ListUserCredsResponse, error)
	// Enables a user creds. No-op if the user creds are already enabled.
	EnableUserCreds(context.Context, *EnableUserCredsRequest) (*UserCreds, error)
	// Disables a user creds. No-op if the user creds are already disabled.
	DisableUserCreds(context.Context, *DisableUserCredsRequest) (*UserCreds, error)
	// Resets the password of a user creds.
	ResetUserPassword(context.Context, *ResetUserPasswordRequest) (*UserCreds, error)
	// Deletes a user creds.
	DeleteUserCreds(context.Context, *DeleteUserCredsRequest) (*emptypb.Empty, error)
	// Gets information about a backup.
	GetBackup(context.Context, *GetBackupRequest) (*Backup, error)
	// Lists all the backups.
	ListBackups(context.Context, *ListBackupsRequest) (*ListBackupsResponse, error)
	// Deletes a backup.
	DeleteBackup(context.Context, *DeleteBackupRequest) (*emptypb.Empty, error)
	// Creates a new database by restoring from an existing backup.
	//
	// The new database must be in the same cloud region or multi-region location
	// as the existing backup. This behaves similar to
	// [FirestoreAdmin.CreateDatabase][google.firestore.admin.v1.FirestoreAdmin.CreateDatabase]
	// except instead of creating a new empty database, a new database is created
	// with the database type, index configuration, and documents from an existing
	// backup.
	//
	// The [long-running operation][google.longrunning.Operation] can be used to
	// track the progress of the restore, with the Operation's
	// [metadata][google.longrunning.Operation.metadata] field type being the
	// [RestoreDatabaseMetadata][google.firestore.admin.v1.RestoreDatabaseMetadata].
	// The [response][google.longrunning.Operation.response] type is the
	// [Database][google.firestore.admin.v1.Database] if the restore was
	// successful. The new database is not readable or writeable until the LRO has
	// completed.
	RestoreDatabase(context.Context, *RestoreDatabaseRequest) (*longrunningpb.Operation, error)
	// Creates a backup schedule on a database.
	// At most two backup schedules can be configured on a database, one daily
	// backup schedule and one weekly backup schedule.
	CreateBackupSchedule(context.Context, *CreateBackupScheduleRequest) (*BackupSchedule, error)
	// Gets information about a backup schedule.
	GetBackupSchedule(context.Context, *GetBackupScheduleRequest) (*BackupSchedule, error)
	// List backup schedules.
	ListBackupSchedules(context.Context, *ListBackupSchedulesRequest) (*ListBackupSchedulesResponse, error)
	// Updates a backup schedule.
	UpdateBackupSchedule(context.Context, *UpdateBackupScheduleRequest) (*BackupSchedule, error)
	// Deletes a backup schedule.
	DeleteBackupSchedule(context.Context, *DeleteBackupScheduleRequest) (*emptypb.Empty, error)
	// Creates a new database by cloning an existing one.
	//
	// The new database must be in the same cloud region or multi-region location
	// as the existing database. This behaves similar to
	// [FirestoreAdmin.CreateDatabase][google.firestore.admin.v1.FirestoreAdmin.CreateDatabase]
	// except instead of creating a new empty database, a new database is created
	// with the database type, index configuration, and documents from an existing
	// database.
	//
	// The [long-running operation][google.longrunning.Operation] can be used to
	// track the progress of the clone, with the Operation's
	// [metadata][google.longrunning.Operation.metadata] field type being the
	// [CloneDatabaseMetadata][google.firestore.admin.v1.CloneDatabaseMetadata].
	// The [response][google.longrunning.Operation.response] type is the
	// [Database][google.firestore.admin.v1.Database] if the clone was
	// successful. The new database is not readable or writeable until the LRO has
	// completed.
	CloneDatabase(context.Context, *CloneDatabaseRequest) (*longrunningpb.Operation, error)
}

FirestoreAdminServer is the server API for FirestoreAdmin service. All implementations should embed UnimplementedFirestoreAdminServer for forward compatibility

GetBackupRequest

type GetBackupRequest struct {

	// Required. Name of the backup to fetch.
	//
	// Format is `projects/{project}/locations/{location}/backups/{backup}`.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// contains filtered or unexported fields
}

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

func (*GetBackupRequest) Descriptor

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

Deprecated: Use GetBackupRequest.ProtoReflect.Descriptor instead.

func (*GetBackupRequest) GetName

func (x *GetBackupRequest) GetName() string

func (*GetBackupRequest) ProtoMessage

func (*GetBackupRequest) ProtoMessage()

func (*GetBackupRequest) ProtoReflect

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

func (*GetBackupRequest) Reset

func (x *GetBackupRequest) Reset()

func (*GetBackupRequest) String

func (x *GetBackupRequest) String() string

GetBackupScheduleRequest

type GetBackupScheduleRequest struct {

	// Required. The name of the backup schedule.
	//
	// Format
	// `projects/{project}/databases/{database}/backupSchedules/{backup_schedule}`
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// contains filtered or unexported fields
}

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

func (*GetBackupScheduleRequest) Descriptor

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

Deprecated: Use GetBackupScheduleRequest.ProtoReflect.Descriptor instead.

func (*GetBackupScheduleRequest) GetName

func (x *GetBackupScheduleRequest) GetName() string

func (*GetBackupScheduleRequest) ProtoMessage

func (*GetBackupScheduleRequest) ProtoMessage()

func (*GetBackupScheduleRequest) ProtoReflect

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

func (*GetBackupScheduleRequest) Reset

func (x *GetBackupScheduleRequest) Reset()

func (*GetBackupScheduleRequest) String

func (x *GetBackupScheduleRequest) String() string

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

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

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

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

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

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

GetUserCredsRequest

type GetUserCredsRequest struct {

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

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

func (*GetUserCredsRequest) Descriptor

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

Deprecated: Use GetUserCredsRequest.ProtoReflect.Descriptor instead.

func (*GetUserCredsRequest) GetName

func (x *GetUserCredsRequest) GetName() string

func (*GetUserCredsRequest) ProtoMessage

func (*GetUserCredsRequest) ProtoMessage()

func (*GetUserCredsRequest) ProtoReflect

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

func (*GetUserCredsRequest) Reset

func (x *GetUserCredsRequest) Reset()

func (*GetUserCredsRequest) String

func (x *GetUserCredsRequest) String() string

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 `protobuf:"varint,3,opt,name=operation_state,json=operationState,proto3,enum=google.firestore.admin.v1.OperationState" json:"operation_state,omitempty"`
	// 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

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

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

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"`
	// IDs of the collection groups to import. Unspecified means all collection
	// groups that were included in the export. Each collection group in this list
	// must be unique.
	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

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

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

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 `protobuf:"varint,2,opt,name=query_scope,json=queryScope,proto3,enum=google.firestore.admin.v1.Index_QueryScope" json:"query_scope,omitempty"`
	// The API scope supported by this index.
	ApiScope Index_ApiScope `protobuf:"varint,5,opt,name=api_scope,json=apiScope,proto3,enum=google.firestore.admin.v1.Index_ApiScope" json:"api_scope,omitempty"`
	// 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"`
	// Immutable. The density configuration of the index.
	Density Index_Density `protobuf:"varint,6,opt,name=density,proto3,enum=google.firestore.admin.v1.Index_Density" json:"density,omitempty"`
	// Optional. Whether the index is multikey. By default, the index is not
	// multikey. For non-multikey indexes, none of the paths in the index
	// definition reach or traverse an array, except via an explicit array index.
	// For multikey indexes, at most one of the paths in the index definition
	// reach or traverse an array, except via an explicit array index. Violations
	// will result in errors.
	//
	// Note this field only applies to index with MONGODB_COMPATIBLE_API ApiScope.
	Multikey bool `protobuf:"varint,7,opt,name=multikey,proto3" json:"multikey,omitempty"`
	// Optional. The number of shards for the index.
	ShardCount int32 `protobuf:"varint,8,opt,name=shard_count,json=shardCount,proto3" json:"shard_count,omitempty"`
	// Optional. Whether it is an unique index. Unique index ensures all values
	// for the indexed field(s) are unique across documents.
	Unique bool `protobuf:"varint,10,opt,name=unique,proto3" json:"unique,omitempty"`
	// contains filtered or unexported fields
}

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

func (*Index) Descriptor

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

Deprecated: Use Index.ProtoReflect.Descriptor instead.

func (*Index) GetApiScope

func (x *Index) GetApiScope() Index_ApiScope

func (*Index) GetDensity

func (x *Index) GetDensity() Index_Density

func (*Index) GetFields

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

func (*Index) GetMultikey

func (x *Index) GetMultikey() bool

func (*Index) GetName

func (x *Index) GetName() string

func (*Index) GetQueryScope

func (x *Index) GetQueryScope() Index_QueryScope

func (*Index) GetShardCount

func (x *Index) GetShardCount() int32

func (*Index) GetState

func (x *Index) GetState() Index_State

func (*Index) GetUnique

func (x *Index) GetUnique() bool

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

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

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

Index_ApiScope

type Index_ApiScope int32

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

Index_ANY_API, Index_DATASTORE_MODE_API, Index_MONGODB_COMPATIBLE_API

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
	// The index can only be used by the MONGODB_COMPATIBLE_API.
	Index_MONGODB_COMPATIBLE_API Index_ApiScope = 2
)

func (Index_ApiScope) Descriptor

func (Index_ApiScope) Descriptor() protoreflect.EnumDescriptor

func (Index_ApiScope) Enum

func (x Index_ApiScope) Enum() *Index_ApiScope

func (Index_ApiScope) EnumDescriptor

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

Deprecated: Use Index_ApiScope.Descriptor instead.

func (Index_ApiScope) Number

func (x Index_ApiScope) Number() protoreflect.EnumNumber

func (Index_ApiScope) String

func (x Index_ApiScope) String() string

func (Index_ApiScope) Type

func (Index_ApiScope) Type() protoreflect.EnumType

Index_Density

type Index_Density int32

The density configuration for the index.

Index_DENSITY_UNSPECIFIED, Index_SPARSE_ALL, Index_SPARSE_ANY, Index_DENSE

const (
	// Unspecified. It will use database default setting. This value is input
	// only.
	Index_DENSITY_UNSPECIFIED Index_Density = 0
	// An index entry will only exist if ALL fields are present in the document.
	//
	// This is both the default and only allowed value for Standard Edition
	// databases (for both Cloud Firestore `ANY_API` and Cloud Datastore
	// `DATASTORE_MODE_API`).
	//
	// Take for example the following document:
	//
	// ```
	//
	//	{
	//	  "__name__": "...",
	//	  "a": 1,
	//	  "b": 2,
	//	  "c": 3
	//	}
	//
	// ```
	//
	// an index on `(a ASC, b ASC, c ASC, __name__ ASC)` will generate an index
	// entry for this document since `a`, 'b', `c`, and `__name__` are all
	// present but an index of `(a ASC, d ASC, __name__ ASC)` will not generate
	// an index entry for this document since `d` is missing.
	//
	// This means that such indexes can only be used to serve a query when the
	// query has either implicit or explicit requirements that all fields from
	// the index are present.
	Index_SPARSE_ALL Index_Density = 1
	// An index entry will exist if ANY field are present in the document.
	//
	// This is used as the definition of a sparse index for Enterprise Edition
	// databases.
	//
	// Take for example the following document:
	//
	// ```
	//
	//	{
	//	  "__name__": "...",
	//	  "a": 1,
	//	  "b": 2,
	//	  "c": 3
	//	}
	//
	// ```
	//
	// an index on `(a ASC, d ASC)` will generate an index entry for this
	// document since `a` is present, and will fill in an `unset` value for `d`.
	// An index on `(d ASC, e ASC)` will not generate any index entry as neither
	// `d` nor `e` are present.
	//
	// An index that contains `__name__` will generate an index entry for all
	// documents since Firestore guarantees that all documents have a `__name__`
	// field.
	Index_SPARSE_ANY Index_Density = 2
	// An index entry will exist regardless of if the fields are present or not.
	//
	// This is the default density for an Enterprise Edition database.
	//
	// The index will store `unset` values for fields that are not present in
	// the document.
	Index_DENSE Index_Density = 3
)

func (Index_Density) Descriptor

func (Index_Density) Descriptor() protoreflect.EnumDescriptor

func (Index_Density) Enum

func (x Index_Density) Enum() *Index_Density

func (Index_Density) EnumDescriptor

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

Deprecated: Use Index_Density.Descriptor instead.

func (Index_Density) Number

func (x Index_Density) Number() protoreflect.EnumNumber

func (Index_Density) String

func (x Index_Density) String() string

func (Index_Density) Type

func (Index_Density) Type() protoreflect.EnumType

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 valid to be assigned to ValueMode:
	//
	//	*Index_IndexField_Order_
	//	*Index_IndexField_ArrayConfig_
	//	*Index_IndexField_VectorConfig_
	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

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 (x *Index_IndexField) GetValueMode() isIndex_IndexField_ValueMode

func (*Index_IndexField) GetVectorConfig

func (x *Index_IndexField) GetVectorConfig() *Index_IndexField_VectorConfig

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

Index_IndexField_ArrayConfig

type Index_IndexField_ArrayConfig int32

The supported array value configurations.

Index_IndexField_ARRAY_CONFIG_UNSPECIFIED, Index_IndexField_CONTAINS

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

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

Index_IndexField_ArrayConfig_

type Index_IndexField_ArrayConfig_ struct {
	// Indicates that this field supports operations on `array_value`s.
	ArrayConfig Index_IndexField_ArrayConfig `protobuf:"varint,3,opt,name=array_config,json=arrayConfig,proto3,enum=google.firestore.admin.v1.Index_IndexField_ArrayConfig,oneof"`
}

Index_IndexField_Order

type Index_IndexField_Order int32

The supported orderings.

Index_IndexField_ORDER_UNSPECIFIED, Index_IndexField_ASCENDING, Index_IndexField_DESCENDING

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

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

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"`
}

Index_IndexField_VectorConfig

type Index_IndexField_VectorConfig struct {

	// Required. The vector dimension this configuration applies to.
	//
	// The resulting index will only include vectors of this dimension, and
	// can be used for vector search with the same dimension.
	Dimension int32 `protobuf:"varint,1,opt,name=dimension,proto3" json:"dimension,omitempty"`
	// The type of index used.
	//
	// Types that are valid to be assigned to Type:
	//
	//	*Index_IndexField_VectorConfig_Flat
	Type isIndex_IndexField_VectorConfig_Type `protobuf_oneof:"type"`
	// contains filtered or unexported fields
}

The index configuration to support vector search operations

func (*Index_IndexField_VectorConfig) Descriptor

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

Deprecated: Use Index_IndexField_VectorConfig.ProtoReflect.Descriptor instead.

func (*Index_IndexField_VectorConfig) GetDimension

func (x *Index_IndexField_VectorConfig) GetDimension() int32

func (*Index_IndexField_VectorConfig) GetFlat

func (x *Index_IndexField_VectorConfig) GetFlat() *Index_IndexField_VectorConfig_FlatIndex

func (*Index_IndexField_VectorConfig) GetType

func (x *Index_IndexField_VectorConfig) GetType() isIndex_IndexField_VectorConfig_Type

func (*Index_IndexField_VectorConfig) ProtoMessage

func (*Index_IndexField_VectorConfig) ProtoMessage()

func (*Index_IndexField_VectorConfig) ProtoReflect

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

func (*Index_IndexField_VectorConfig) Reset

func (x *Index_IndexField_VectorConfig) Reset()

func (*Index_IndexField_VectorConfig) String

func (x *Index_IndexField_VectorConfig) String() string

Index_IndexField_VectorConfig_

type Index_IndexField_VectorConfig_ struct {
	// Indicates that this field supports nearest neighbor and distance
	// operations on vector.
	VectorConfig *Index_IndexField_VectorConfig `protobuf:"bytes,4,opt,name=vector_config,json=vectorConfig,proto3,oneof"`
}

Index_IndexField_VectorConfig_Flat

type Index_IndexField_VectorConfig_Flat struct {
	// Indicates the vector index is a flat index.
	Flat *Index_IndexField_VectorConfig_FlatIndex `protobuf:"bytes,2,opt,name=flat,proto3,oneof"`
}

Index_IndexField_VectorConfig_FlatIndex

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

An index that stores vectors in a flat data structure, and supports exhaustive search.

func (*Index_IndexField_VectorConfig_FlatIndex) Descriptor

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

Deprecated: Use Index_IndexField_VectorConfig_FlatIndex.ProtoReflect.Descriptor instead.

func (*Index_IndexField_VectorConfig_FlatIndex) ProtoMessage

func (*Index_IndexField_VectorConfig_FlatIndex) ProtoMessage()

func (*Index_IndexField_VectorConfig_FlatIndex) ProtoReflect

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

func (*Index_IndexField_VectorConfig_FlatIndex) Reset

func (x *Index_IndexField_VectorConfig_FlatIndex) Reset()

func (*Index_IndexField_VectorConfig_FlatIndex) String

func (x *Index_IndexField_VectorConfig_FlatIndex) String() string

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.

Index_QUERY_SCOPE_UNSPECIFIED, Index_COLLECTION, Index_COLLECTION_GROUP, Index_COLLECTION_RECURSIVE

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

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

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.

Index_STATE_UNSPECIFIED, Index_CREATING, Index_READY, Index_NEEDS_REPAIR

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

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

ListBackupSchedulesRequest

type ListBackupSchedulesRequest struct {

	// Required. The parent database.
	//
	// Format is `projects/{project}/databases/{database}`.
	Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
	// contains filtered or unexported fields
}

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

func (*ListBackupSchedulesRequest) Descriptor

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

Deprecated: Use ListBackupSchedulesRequest.ProtoReflect.Descriptor instead.

func (*ListBackupSchedulesRequest) GetParent

func (x *ListBackupSchedulesRequest) GetParent() string

func (*ListBackupSchedulesRequest) ProtoMessage

func (*ListBackupSchedulesRequest) ProtoMessage()

func (*ListBackupSchedulesRequest) ProtoReflect

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

func (*ListBackupSchedulesRequest) Reset

func (x *ListBackupSchedulesRequest) Reset()

func (*ListBackupSchedulesRequest) String

func (x *ListBackupSchedulesRequest) String() string

ListBackupSchedulesResponse

type ListBackupSchedulesResponse struct {

	// List of all backup schedules.
	BackupSchedules []*BackupSchedule `protobuf:"bytes,1,rep,name=backup_schedules,json=backupSchedules,proto3" json:"backup_schedules,omitempty"`
	// contains filtered or unexported fields
}

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

func (*ListBackupSchedulesResponse) Descriptor

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

Deprecated: Use ListBackupSchedulesResponse.ProtoReflect.Descriptor instead.

func (*ListBackupSchedulesResponse) GetBackupSchedules

func (x *ListBackupSchedulesResponse) GetBackupSchedules() []*BackupSchedule

func (*ListBackupSchedulesResponse) ProtoMessage

func (*ListBackupSchedulesResponse) ProtoMessage()

func (*ListBackupSchedulesResponse) ProtoReflect

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

func (*ListBackupSchedulesResponse) Reset

func (x *ListBackupSchedulesResponse) Reset()

func (*ListBackupSchedulesResponse) String

func (x *ListBackupSchedulesResponse) String() string

ListBackupsRequest

type ListBackupsRequest struct {

	// Required. The location to list backups from.
	//
	// Format is `projects/{project}/locations/{location}`.
	// Use `{location} = '-'` to list backups from all locations for the given
	// project. This allows listing backups from a single location or from all
	// locations.
	Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
	// An expression that filters the list of returned backups.
	//
	// A filter expression consists of a field name, a comparison operator, and a
	// value for filtering.
	// The value must be a string, a number, or a boolean. The comparison operator
	// must be one of: `<`, `="">`, `<=`, `="">=`, `!=`, `=`, or `:`.
	// Colon `:` is the contains operator. Filter rules are not case sensitive.
	//
	// The following fields in the [Backup][google.firestore.admin.v1.Backup] are
	// eligible for filtering:
	//
	//   - `database_uid` (supports `=` only)
	Filter string `protobuf:"bytes,2,opt,name=filter,proto3" json:"filter,omitempty"`
	// contains filtered or unexported fields
}

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

func (*ListBackupsRequest) Descriptor

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

Deprecated: Use ListBackupsRequest.ProtoReflect.Descriptor instead.

func (*ListBackupsRequest) GetFilter

func (x *ListBackupsRequest) GetFilter() string

func (*ListBackupsRequest) GetParent

func (x *ListBackupsRequest) GetParent() string

func (*ListBackupsRequest) ProtoMessage

func (*ListBackupsRequest) ProtoMessage()

func (*ListBackupsRequest) ProtoReflect

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

func (*ListBackupsRequest) Reset

func (x *ListBackupsRequest) Reset()

func (*ListBackupsRequest) String

func (x *ListBackupsRequest) String() string

ListBackupsResponse

type ListBackupsResponse struct {

	// List of all backups for the project.
	Backups []*Backup `protobuf:"bytes,1,rep,name=backups,proto3" json:"backups,omitempty"`
	// List of locations that existing backups were not able to be fetched from.
	//
	// Instead of failing the entire requests when a single location is
	// unreachable, this response returns a partial result set and list of
	// locations unable to be reached here. The request can be retried against a
	// single location to get a concrete error.
	Unreachable []string `protobuf:"bytes,3,rep,name=unreachable,proto3" json:"unreachable,omitempty"`
	// contains filtered or unexported fields
}

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

func (*ListBackupsResponse) Descriptor

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

Deprecated: Use ListBackupsResponse.ProtoReflect.Descriptor instead.

func (*ListBackupsResponse) GetBackups

func (x *ListBackupsResponse) GetBackups() []*Backup

func (*ListBackupsResponse) GetUnreachable

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

func (*ListBackupsResponse) ProtoMessage

func (*ListBackupsResponse) ProtoMessage()

func (*ListBackupsResponse) ProtoReflect

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

func (*ListBackupsResponse) Reset

func (x *ListBackupsResponse) Reset()

func (*ListBackupsResponse) String

func (x *ListBackupsResponse) String() string

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"`
	// If true, also returns deleted resources.
	ShowDeleted bool `protobuf:"varint,4,opt,name=show_deleted,json=showDeleted,proto3" json:"show_deleted,omitempty"`
	// contains filtered or unexported fields
}

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

func (*ListDatabasesRequest) Descriptor

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

Deprecated: Use ListDatabasesRequest.ProtoReflect.Descriptor instead.

func (*ListDatabasesRequest) GetParent

func (x *ListDatabasesRequest) GetParent() string

func (*ListDatabasesRequest) GetShowDeleted

func (x *ListDatabasesRequest) GetShowDeleted() bool

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

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

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

Deprecated: Use ListDatabasesResponse.ProtoReflect.Descriptor instead.

func (*ListDatabasesResponse) GetDatabases

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

func (*ListDatabasesResponse) GetUnreachable

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

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` or
	// `ttlConfig:*`.
	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

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

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

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

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

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

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

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

ListUserCredsRequest

type ListUserCredsRequest struct {

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

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

func (*ListUserCredsRequest) Descriptor

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

Deprecated: Use ListUserCredsRequest.ProtoReflect.Descriptor instead.

func (*ListUserCredsRequest) GetParent

func (x *ListUserCredsRequest) GetParent() string

func (*ListUserCredsRequest) ProtoMessage

func (*ListUserCredsRequest) ProtoMessage()

func (*ListUserCredsRequest) ProtoReflect

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

func (*ListUserCredsRequest) Reset

func (x *ListUserCredsRequest) Reset()

func (*ListUserCredsRequest) String

func (x *ListUserCredsRequest) String() string

ListUserCredsResponse

type ListUserCredsResponse struct {

	// The user creds for the database.
	UserCreds []*UserCreds `protobuf:"bytes,1,rep,name=user_creds,json=userCreds,proto3" json:"user_creds,omitempty"`
	// contains filtered or unexported fields
}

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

func (*ListUserCredsResponse) Descriptor

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

Deprecated: Use ListUserCredsResponse.ProtoReflect.Descriptor instead.

func (*ListUserCredsResponse) GetUserCreds

func (x *ListUserCredsResponse) GetUserCreds() []*UserCreds

func (*ListUserCredsResponse) ProtoMessage

func (*ListUserCredsResponse) ProtoMessage()

func (*ListUserCredsResponse) ProtoReflect

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

func (*ListUserCredsResponse) Reset

func (x *ListUserCredsResponse) Reset()

func (*ListUserCredsResponse) String

func (x *ListUserCredsResponse) String() string

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

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

OperationState

type OperationState int32

Describes the state of the operation.

OperationState_OPERATION_STATE_UNSPECIFIED, OperationState_INITIALIZING, OperationState_PROCESSING, OperationState_CANCELLING, OperationState_FINALIZING, OperationState_SUCCESSFUL, OperationState_FAILED, OperationState_CANCELLED

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

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

PitrSnapshot

type PitrSnapshot struct {

	// Required. The name of the database that this was a snapshot of. Format:
	// `projects/{project}/databases/{database}`.
	Database string `protobuf:"bytes,1,opt,name=database,proto3" json:"database,omitempty"`
	// Output only. Public UUID of the database the snapshot was associated with.
	DatabaseUid []byte `protobuf:"bytes,2,opt,name=database_uid,json=databaseUid,proto3" json:"database_uid,omitempty"`
	// Required. Snapshot time of the database.
	SnapshotTime *timestamppb.Timestamp `protobuf:"bytes,3,opt,name=snapshot_time,json=snapshotTime,proto3" json:"snapshot_time,omitempty"`
	// contains filtered or unexported fields
}

A consistent snapshot of a database at a specific point in time. A PITR (Point-in-time recovery) snapshot with previous versions of a database's data is available for every minute up to the associated database's data retention period. If the PITR feature is enabled, the retention period is 7 days; otherwise, it is one hour.

func (*PitrSnapshot) Descriptor

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

Deprecated: Use PitrSnapshot.ProtoReflect.Descriptor instead.

func (*PitrSnapshot) GetDatabase

func (x *PitrSnapshot) GetDatabase() string

func (*PitrSnapshot) GetDatabaseUid

func (x *PitrSnapshot) GetDatabaseUid() []byte

func (*PitrSnapshot) GetSnapshotTime

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

func (*PitrSnapshot) ProtoMessage

func (*PitrSnapshot) ProtoMessage()

func (*PitrSnapshot) ProtoReflect

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

func (*PitrSnapshot) Reset

func (x *PitrSnapshot) Reset()

func (*PitrSnapshot) String

func (x *PitrSnapshot) String() string

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

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

RealtimeUpdatesMode

type RealtimeUpdatesMode int32

The Realtime Updates mode.

RealtimeUpdatesMode_REALTIME_UPDATES_MODE_UNSPECIFIED, RealtimeUpdatesMode_REALTIME_UPDATES_MODE_ENABLED, RealtimeUpdatesMode_REALTIME_UPDATES_MODE_DISABLED

const (
	// The Realtime Updates feature is not specified.
	RealtimeUpdatesMode_REALTIME_UPDATES_MODE_UNSPECIFIED RealtimeUpdatesMode = 0
	// The Realtime Updates feature is enabled by default.
	//
	// This could potentially degrade write performance for the database.
	RealtimeUpdatesMode_REALTIME_UPDATES_MODE_ENABLED RealtimeUpdatesMode = 1
	// The Realtime Updates feature is disabled by default.
	RealtimeUpdatesMode_REALTIME_UPDATES_MODE_DISABLED RealtimeUpdatesMode = 2
)

func (RealtimeUpdatesMode) Descriptor

func (RealtimeUpdatesMode) Descriptor() protoreflect.EnumDescriptor

func (RealtimeUpdatesMode) Enum

func (x RealtimeUpdatesMode) Enum() *RealtimeUpdatesMode

func (RealtimeUpdatesMode) EnumDescriptor

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

Deprecated: Use RealtimeUpdatesMode.Descriptor instead.

func (RealtimeUpdatesMode) Number

func (x RealtimeUpdatesMode) Number() protoreflect.EnumNumber

func (RealtimeUpdatesMode) String

func (x RealtimeUpdatesMode) String() string

func (RealtimeUpdatesMode) Type

func (RealtimeUpdatesMode) Type() protoreflect.EnumType

ResetUserPasswordRequest

type ResetUserPasswordRequest struct {

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

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

func (*ResetUserPasswordRequest) Descriptor

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

Deprecated: Use ResetUserPasswordRequest.ProtoReflect.Descriptor instead.

func (*ResetUserPasswordRequest) GetName

func (x *ResetUserPasswordRequest) GetName() string

func (*ResetUserPasswordRequest) ProtoMessage

func (*ResetUserPasswordRequest) ProtoMessage()

func (*ResetUserPasswordRequest) ProtoReflect

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

func (*ResetUserPasswordRequest) Reset

func (x *ResetUserPasswordRequest) Reset()

func (*ResetUserPasswordRequest) String

func (x *ResetUserPasswordRequest) String() string

RestoreDatabaseMetadata

type RestoreDatabaseMetadata struct {

	// The time the restore was started.
	StartTime *timestamppb.Timestamp `protobuf:"bytes,1,opt,name=start_time,json=startTime,proto3" json:"start_time,omitempty"`
	// The time the restore finished, unset for ongoing restores.
	EndTime *timestamppb.Timestamp `protobuf:"bytes,2,opt,name=end_time,json=endTime,proto3" json:"end_time,omitempty"`
	// The operation state of the restore.
	OperationState OperationState `protobuf:"varint,3,opt,name=operation_state,json=operationState,proto3,enum=google.firestore.admin.v1.OperationState" json:"operation_state,omitempty"`
	// The name of the database being restored to.
	Database string `protobuf:"bytes,4,opt,name=database,proto3" json:"database,omitempty"`
	// The name of the backup restoring from.
	Backup string `protobuf:"bytes,5,opt,name=backup,proto3" json:"backup,omitempty"`
	// How far along the restore is as an estimated percentage of remaining time.
	ProgressPercentage *Progress `protobuf:"bytes,8,opt,name=progress_percentage,json=progressPercentage,proto3" json:"progress_percentage,omitempty"`
	// contains filtered or unexported fields
}

Metadata for the [long-running operation][google.longrunning.Operation] from the [RestoreDatabase][google.firestore.admin.v1.RestoreDatabase] request.

func (*RestoreDatabaseMetadata) Descriptor

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

Deprecated: Use RestoreDatabaseMetadata.ProtoReflect.Descriptor instead.

func (*RestoreDatabaseMetadata) GetBackup

func (x *RestoreDatabaseMetadata) GetBackup() string

func (*RestoreDatabaseMetadata) GetDatabase

func (x *RestoreDatabaseMetadata) GetDatabase() string

func (*RestoreDatabaseMetadata) GetEndTime

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

func (*RestoreDatabaseMetadata) GetOperationState

func (x *RestoreDatabaseMetadata) GetOperationState() OperationState

func (*RestoreDatabaseMetadata) GetProgressPercentage

func (x *RestoreDatabaseMetadata) GetProgressPercentage() *Progress

func (*RestoreDatabaseMetadata) GetStartTime

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

func (*RestoreDatabaseMetadata) ProtoMessage

func (*RestoreDatabaseMetadata) ProtoMessage()

func (*RestoreDatabaseMetadata) ProtoReflect

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

func (*RestoreDatabaseMetadata) Reset

func (x *RestoreDatabaseMetadata) Reset()

func (*RestoreDatabaseMetadata) String

func (x *RestoreDatabaseMetadata) String() string

RestoreDatabaseRequest

type RestoreDatabaseRequest struct {

	// Required. The project to restore the database in. Format is
	// `projects/{project_id}`.
	Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
	// Required. The ID to use for the database, which will become the final
	// component of the database's resource name. This database ID must not be
	// associated with an existing database.
	//
	// 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 if the database is Standard edition.
	DatabaseId string `protobuf:"bytes,2,opt,name=database_id,json=databaseId,proto3" json:"database_id,omitempty"`
	// Required. Backup to restore from. Must be from the same project as the
	// parent.
	//
	// The restored database will be created in the same location as the source
	// backup.
	//
	// Format is: `projects/{project_id}/locations/{location}/backups/{backup}`
	Backup string `protobuf:"bytes,3,opt,name=backup,proto3" json:"backup,omitempty"`
	// Optional. Encryption configuration for the restored database.
	//
	// If this field is not specified, the restored database will use
	// the same encryption configuration as the backup, namely
	// [use_source_encryption][google.firestore.admin.v1.Database.EncryptionConfig.use_source_encryption].
	EncryptionConfig *Database_EncryptionConfig `protobuf:"bytes,9,opt,name=encryption_config,json=encryptionConfig,proto3" json:"encryption_config,omitempty"`
	// Optional. Immutable. Tags to be bound to the restored database.
	//
	// The tags should be provided in the format of
	// `tagKeys/{tag_key_id} -> tagValues/{tag_value_id}`.
	Tags map[string]string `protobuf:"bytes,10,rep,name=tags,proto3" json:"tags,omitempty" protobuf_key:"bytes,1,opt,name=key" protobuf_val:"bytes,2,opt,name=value"`
	// contains filtered or unexported fields
}

The request message for [FirestoreAdmin.RestoreDatabase][google.firestore.admin.v1.FirestoreAdmin.RestoreDatabase].

func (*RestoreDatabaseRequest) Descriptor

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

Deprecated: Use RestoreDatabaseRequest.ProtoReflect.Descriptor instead.

func (*RestoreDatabaseRequest) GetBackup

func (x *RestoreDatabaseRequest) GetBackup() string

func (*RestoreDatabaseRequest) GetDatabaseId

func (x *RestoreDatabaseRequest) GetDatabaseId() string

func (*RestoreDatabaseRequest) GetEncryptionConfig

func (x *RestoreDatabaseRequest) GetEncryptionConfig() *Database_EncryptionConfig

func (*RestoreDatabaseRequest) GetParent

func (x *RestoreDatabaseRequest) GetParent() string

func (*RestoreDatabaseRequest) GetTags

func (x *RestoreDatabaseRequest) GetTags() map[string]string

func (*RestoreDatabaseRequest) ProtoMessage

func (*RestoreDatabaseRequest) ProtoMessage()

func (*RestoreDatabaseRequest) ProtoReflect

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

func (*RestoreDatabaseRequest) Reset

func (x *RestoreDatabaseRequest) Reset()

func (*RestoreDatabaseRequest) String

func (x *RestoreDatabaseRequest) String() string

UnimplementedFirestoreAdminServer

type UnimplementedFirestoreAdminServer struct {
}

UnimplementedFirestoreAdminServer should be embedded to have forward compatible implementations.

func (UnimplementedFirestoreAdminServer) BulkDeleteDocuments

func (UnimplementedFirestoreAdminServer) BulkDeleteDocuments(context.Context, *BulkDeleteDocumentsRequest) (*longrunningpb.Operation, error)

func (UnimplementedFirestoreAdminServer) CloneDatabase

func (UnimplementedFirestoreAdminServer) CloneDatabase(context.Context, *CloneDatabaseRequest) (*longrunningpb.Operation, error)

func (UnimplementedFirestoreAdminServer) CreateBackupSchedule

func (UnimplementedFirestoreAdminServer) CreateBackupSchedule(context.Context, *CreateBackupScheduleRequest) (*BackupSchedule, error)

func (UnimplementedFirestoreAdminServer) CreateDatabase

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

func (UnimplementedFirestoreAdminServer) CreateIndex

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

func (UnimplementedFirestoreAdminServer) CreateUserCreds

func (UnimplementedFirestoreAdminServer) CreateUserCreds(context.Context, *CreateUserCredsRequest) (*UserCreds, error)

func (UnimplementedFirestoreAdminServer) DeleteBackup

func (UnimplementedFirestoreAdminServer) DeleteBackup(context.Context, *DeleteBackupRequest) (*emptypb.Empty, error)

func (UnimplementedFirestoreAdminServer) DeleteBackupSchedule

func (UnimplementedFirestoreAdminServer) DeleteBackupSchedule(context.Context, *DeleteBackupScheduleRequest) (*emptypb.Empty, error)

func (UnimplementedFirestoreAdminServer) DeleteDatabase

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

func (UnimplementedFirestoreAdminServer) DeleteIndex

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

func (UnimplementedFirestoreAdminServer) DeleteUserCreds

func (UnimplementedFirestoreAdminServer) DeleteUserCreds(context.Context, *DeleteUserCredsRequest) (*emptypb.Empty, error)

func (UnimplementedFirestoreAdminServer) DisableUserCreds

func (UnimplementedFirestoreAdminServer) DisableUserCreds(context.Context, *DisableUserCredsRequest) (*UserCreds, error)

func (UnimplementedFirestoreAdminServer) EnableUserCreds

func (UnimplementedFirestoreAdminServer) EnableUserCreds(context.Context, *EnableUserCredsRequest) (*UserCreds, error)

func (UnimplementedFirestoreAdminServer) ExportDocuments

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

func (UnimplementedFirestoreAdminServer) GetBackup

func (UnimplementedFirestoreAdminServer) GetBackup(context.Context, *GetBackupRequest) (*Backup, error)

func (UnimplementedFirestoreAdminServer) GetBackupSchedule

func (UnimplementedFirestoreAdminServer) GetBackupSchedule(context.Context, *GetBackupScheduleRequest) (*BackupSchedule, 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) GetUserCreds

func (UnimplementedFirestoreAdminServer) GetUserCreds(context.Context, *GetUserCredsRequest) (*UserCreds, error)

func (UnimplementedFirestoreAdminServer) ImportDocuments

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

func (UnimplementedFirestoreAdminServer) ListBackupSchedules

func (UnimplementedFirestoreAdminServer) ListBackupSchedules(context.Context, *ListBackupSchedulesRequest) (*ListBackupSchedulesResponse, error)

func (UnimplementedFirestoreAdminServer) ListBackups

func (UnimplementedFirestoreAdminServer) ListBackups(context.Context, *ListBackupsRequest) (*ListBackupsResponse, 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) ListUserCreds

func (UnimplementedFirestoreAdminServer) ListUserCreds(context.Context, *ListUserCredsRequest) (*ListUserCredsResponse, error)

func (UnimplementedFirestoreAdminServer) ResetUserPassword

func (UnimplementedFirestoreAdminServer) ResetUserPassword(context.Context, *ResetUserPasswordRequest) (*UserCreds, error)

func (UnimplementedFirestoreAdminServer) RestoreDatabase

func (UnimplementedFirestoreAdminServer) RestoreDatabase(context.Context, *RestoreDatabaseRequest) (*longrunningpb.Operation, error)

func (UnimplementedFirestoreAdminServer) UpdateBackupSchedule

func (UnimplementedFirestoreAdminServer) UpdateBackupSchedule(context.Context, *UpdateBackupScheduleRequest) (*BackupSchedule, 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)

UnsafeFirestoreAdminServer

type UnsafeFirestoreAdminServer interface {
	// contains filtered or unexported methods
}

UnsafeFirestoreAdminServer may be embedded to opt out of forward compatibility for this service. Use of this interface is not recommended, as added methods to FirestoreAdminServer will result in compilation errors.

UpdateBackupScheduleRequest

type UpdateBackupScheduleRequest struct {

	// Required. The backup schedule to update.
	BackupSchedule *BackupSchedule `protobuf:"bytes,1,opt,name=backup_schedule,json=backupSchedule,proto3" json:"backup_schedule,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.UpdateBackupSchedule][google.firestore.admin.v1.FirestoreAdmin.UpdateBackupSchedule].

func (*UpdateBackupScheduleRequest) Descriptor

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

Deprecated: Use UpdateBackupScheduleRequest.ProtoReflect.Descriptor instead.

func (*UpdateBackupScheduleRequest) GetBackupSchedule

func (x *UpdateBackupScheduleRequest) GetBackupSchedule() *BackupSchedule

func (*UpdateBackupScheduleRequest) GetUpdateMask

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

func (*UpdateBackupScheduleRequest) ProtoMessage

func (*UpdateBackupScheduleRequest) ProtoMessage()

func (*UpdateBackupScheduleRequest) ProtoReflect

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

func (*UpdateBackupScheduleRequest) Reset

func (x *UpdateBackupScheduleRequest) Reset()

func (*UpdateBackupScheduleRequest) String

func (x *UpdateBackupScheduleRequest) String() string

UpdateDatabaseMetadata

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

Metadata related to the update database operation.

func (*UpdateDatabaseMetadata) Descriptor

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

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

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

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

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

UserCreds

type UserCreds struct {

	// Identifier. The resource name of the UserCreds.
	// Format:
	// `projects/{project}/databases/{database}/userCreds/{user_creds}`
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// Output only. The time the user creds were created.
	CreateTime *timestamppb.Timestamp `protobuf:"bytes,2,opt,name=create_time,json=createTime,proto3" json:"create_time,omitempty"`
	// Output only. The time the user creds were last updated.
	UpdateTime *timestamppb.Timestamp `protobuf:"bytes,3,opt,name=update_time,json=updateTime,proto3" json:"update_time,omitempty"`
	// Output only. Whether the user creds are enabled or disabled. Defaults to
	// ENABLED on creation.
	State UserCreds_State `protobuf:"varint,4,opt,name=state,proto3,enum=google.firestore.admin.v1.UserCreds_State" json:"state,omitempty"`
	// Output only. The plaintext server-generated password for the user creds.
	// Only populated in responses for CreateUserCreds and ResetUserPassword.
	SecurePassword string `protobuf:"bytes,5,opt,name=secure_password,json=securePassword,proto3" json:"secure_password,omitempty"`
	// Identity associated with this User Creds.
	//
	// Types that are valid to be assigned to UserCredsIdentity:
	//
	//	*UserCreds_ResourceIdentity_
	UserCredsIdentity isUserCreds_UserCredsIdentity `protobuf_oneof:"UserCredsIdentity"`
	// contains filtered or unexported fields
}

A Cloud Firestore User Creds.

func (*UserCreds) Descriptor

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

Deprecated: Use UserCreds.ProtoReflect.Descriptor instead.

func (*UserCreds) GetCreateTime

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

func (*UserCreds) GetName

func (x *UserCreds) GetName() string

func (*UserCreds) GetResourceIdentity

func (x *UserCreds) GetResourceIdentity() *UserCreds_ResourceIdentity

func (*UserCreds) GetSecurePassword

func (x *UserCreds) GetSecurePassword() string

func (*UserCreds) GetState

func (x *UserCreds) GetState() UserCreds_State

func (*UserCreds) GetUpdateTime

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

func (*UserCreds) GetUserCredsIdentity

func (x *UserCreds) GetUserCredsIdentity() isUserCreds_UserCredsIdentity

func (*UserCreds) ProtoMessage

func (*UserCreds) ProtoMessage()

func (*UserCreds) ProtoReflect

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

func (*UserCreds) Reset

func (x *UserCreds) Reset()

func (*UserCreds) String

func (x *UserCreds) String() string

UserCreds_ResourceIdentity

type UserCreds_ResourceIdentity struct {

	// Output only. Principal identifier string.
	// See: https://cloud.google.com/iam/docs/principal-identifiers
	Principal string `protobuf:"bytes,1,opt,name=principal,proto3" json:"principal,omitempty"`
	// contains filtered or unexported fields
}

Describes a Resource Identity principal.

func (*UserCreds_ResourceIdentity) Descriptor

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

Deprecated: Use UserCreds_ResourceIdentity.ProtoReflect.Descriptor instead.

func (*UserCreds_ResourceIdentity) GetPrincipal

func (x *UserCreds_ResourceIdentity) GetPrincipal() string

func (*UserCreds_ResourceIdentity) ProtoMessage

func (*UserCreds_ResourceIdentity) ProtoMessage()

func (*UserCreds_ResourceIdentity) ProtoReflect

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

func (*UserCreds_ResourceIdentity) Reset

func (x *UserCreds_ResourceIdentity) Reset()

func (*UserCreds_ResourceIdentity) String

func (x *UserCreds_ResourceIdentity) String() string

UserCreds_ResourceIdentity_

type UserCreds_ResourceIdentity_ struct {
	// Resource Identity descriptor.
	ResourceIdentity *UserCreds_ResourceIdentity `protobuf:"bytes,6,opt,name=resource_identity,json=resourceIdentity,proto3,oneof"`
}

UserCreds_State

type UserCreds_State int32

The state of the user creds (ENABLED or DISABLED).

UserCreds_STATE_UNSPECIFIED, UserCreds_ENABLED, UserCreds_DISABLED

const (
	// The default value. Should not be used.
	UserCreds_STATE_UNSPECIFIED UserCreds_State = 0
	// The user creds are enabled.
	UserCreds_ENABLED UserCreds_State = 1
	// The user creds are disabled.
	UserCreds_DISABLED UserCreds_State = 2
)

func (UserCreds_State) Descriptor

func (UserCreds_State) Descriptor() protoreflect.EnumDescriptor

func (UserCreds_State) Enum

func (x UserCreds_State) Enum() *UserCreds_State

func (UserCreds_State) EnumDescriptor

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

Deprecated: Use UserCreds_State.Descriptor instead.

func (UserCreds_State) Number

func (x UserCreds_State) Number() protoreflect.EnumNumber

func (UserCreds_State) String

func (x UserCreds_State) String() string

func (UserCreds_State) Type

func (UserCreds_State) Type() protoreflect.EnumType

WeeklyRecurrence

type WeeklyRecurrence struct {

	// The day of week to run.
	//
	// DAY_OF_WEEK_UNSPECIFIED is not allowed.
	Day dayofweek.DayOfWeek `protobuf:"varint,2,opt,name=day,proto3,enum=google.type.DayOfWeek" json:"day,omitempty"`
	// contains filtered or unexported fields
}

Represents a recurring schedule that runs on a specified day of the week.

The time zone is UTC.

func (*WeeklyRecurrence) Descriptor

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

Deprecated: Use WeeklyRecurrence.ProtoReflect.Descriptor instead.

func (*WeeklyRecurrence) GetDay

func (x *WeeklyRecurrence) GetDay() dayofweek.DayOfWeek

func (*WeeklyRecurrence) ProtoMessage

func (*WeeklyRecurrence) ProtoMessage()

func (*WeeklyRecurrence) ProtoReflect

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

func (*WeeklyRecurrence) Reset

func (x *WeeklyRecurrence) Reset()

func (*WeeklyRecurrence) String

func (x *WeeklyRecurrence) String() string