adminpb

package
v1.15.0 Latest Latest
Warning

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

 Go to latest Published: Oct 7, 2023 License: Apache-2.0 Imports: 11 Imported by: 1

Documentation

Index

Constants

This section is empty.

Variables

View Source 
var (
	OperationType_name = map[int32]string{
		0: "OPERATION_TYPE_UNSPECIFIED",
		1: "EXPORT_ENTITIES",
		2: "IMPORT_ENTITIES",
		3: "CREATE_INDEX",
		4: "DELETE_INDEX",
	}
	OperationType_value = map[string]int32{
		"OPERATION_TYPE_UNSPECIFIED": 0,
		"EXPORT_ENTITIES":            1,
		"IMPORT_ENTITIES":            2,
		"CREATE_INDEX":               3,
		"DELETE_INDEX":               4,
	}
)

Enum value maps for OperationType.

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

Enum value maps for CommonMetadata_State.

View Source 
var (
	Index_AncestorMode_name = map[int32]string{
		0: "ANCESTOR_MODE_UNSPECIFIED",
		1: "NONE",
		2: "ALL_ANCESTORS",
	}
	Index_AncestorMode_value = map[string]int32{
		"ANCESTOR_MODE_UNSPECIFIED": 0,
		"NONE":                      1,
		"ALL_ANCESTORS":             2,
	}
)

Enum value maps for Index_AncestorMode.

View Source 
var (
	Index_Direction_name = map[int32]string{
		0: "DIRECTION_UNSPECIFIED",
		1: "ASCENDING",
		2: "DESCENDING",
	}
	Index_Direction_value = map[string]int32{
		"DIRECTION_UNSPECIFIED": 0,
		"ASCENDING":             1,
		"DESCENDING":            2,
	}
)

Enum value maps for Index_Direction.

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

Enum value maps for Index_State.

View Source 
var (
	MigrationState_name = map[int32]string{
		0: "MIGRATION_STATE_UNSPECIFIED",
		1: "RUNNING",
		2: "PAUSED",
		3: "COMPLETE",
	}
	MigrationState_value = map[string]int32{
		"MIGRATION_STATE_UNSPECIFIED": 0,
		"RUNNING":                     1,
		"PAUSED":                      2,
		"COMPLETE":                    3,
	}
)

Enum value maps for MigrationState.

View Source 
var (
	MigrationStep_name = map[int32]string{
		0: "MIGRATION_STEP_UNSPECIFIED",
		6: "PREPARE",
		1: "START",
		7: "APPLY_WRITES_SYNCHRONOUSLY",
		2: "COPY_AND_VERIFY",
		3: "REDIRECT_EVENTUALLY_CONSISTENT_READS",
		4: "REDIRECT_STRONGLY_CONSISTENT_READS",
		5: "REDIRECT_WRITES",
	}
	MigrationStep_value = map[string]int32{
		"MIGRATION_STEP_UNSPECIFIED":           0,
		"PREPARE":                              6,
		"START":                                1,
		"APPLY_WRITES_SYNCHRONOUSLY":           7,
		"COPY_AND_VERIFY":                      2,
		"REDIRECT_EVENTUALLY_CONSISTENT_READS": 3,
		"REDIRECT_STRONGLY_CONSISTENT_READS":   4,
		"REDIRECT_WRITES":                      5,
	}
)

Enum value maps for MigrationStep.

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

Enum value maps for MigrationProgressEvent_ConcurrencyMode.

View Source 
var File_google_datastore_admin_v1_datastore_admin_proto protoreflect.FileDescriptor
View Source 
var File_google_datastore_admin_v1_index_proto protoreflect.FileDescriptor
View Source 
var File_google_datastore_admin_v1_migration_proto protoreflect.FileDescriptor

Functions

func RegisterDatastoreAdminServer 

func RegisterDatastoreAdminServer(s *grpc.Server, srv DatastoreAdminServer)

Types

type CommonMetadata 

type CommonMetadata struct {

	// The time that work began on the operation.
	StartTime *timestamppb.Timestamp `protobuf:"bytes,1,opt,name=start_time,json=startTime,proto3" json:"start_time,omitempty"`
	// The time the operation ended, either successfully or otherwise.
	EndTime *timestamppb.Timestamp `protobuf:"bytes,2,opt,name=end_time,json=endTime,proto3" json:"end_time,omitempty"`
	// The type of the operation. Can be used as a filter in
	// ListOperationsRequest.
	OperationType OperationType `` /* 146-byte string literal not displayed */
	// The client-assigned labels which were provided when the operation was
	// created. May also include additional labels.
	Labels map[string]string `` /* 153-byte string literal not displayed */
	// The current state of the Operation.
	State CommonMetadata_State `protobuf:"varint,5,opt,name=state,proto3,enum=google.datastore.admin.v1.CommonMetadata_State" json:"state,omitempty"`
	// contains filtered or unexported fields
}

Metadata common to all Datastore Admin operations.

func (*CommonMetadata) Descriptor deprecated 

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

Deprecated: Use CommonMetadata.ProtoReflect.Descriptor instead.

func (*CommonMetadata) GetEndTime 

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

func (*CommonMetadata) GetLabels 

func (x *CommonMetadata) GetLabels() map[string]string

func (*CommonMetadata) GetOperationType 

func (x *CommonMetadata) GetOperationType() OperationType

func (*CommonMetadata) GetStartTime 

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

func (*CommonMetadata) GetState 

func (x *CommonMetadata) GetState() CommonMetadata_State

func (*CommonMetadata) ProtoMessage 

func (*CommonMetadata) ProtoMessage()

func (*CommonMetadata) ProtoReflect 

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

func (*CommonMetadata) Reset 

func (x *CommonMetadata) Reset()

func (*CommonMetadata) String 

func (x *CommonMetadata) String() string

type CommonMetadata_State 

type CommonMetadata_State int32

The various possible states for an ongoing Operation. 

const (
	// Unspecified.
	CommonMetadata_STATE_UNSPECIFIED CommonMetadata_State = 0
	// Request is being prepared for processing.
	CommonMetadata_INITIALIZING CommonMetadata_State = 1
	// Request is actively being processed.
	CommonMetadata_PROCESSING CommonMetadata_State = 2
	// Request is in the process of being cancelled after user called
	// google.longrunning.Operations.CancelOperation on the operation.
	CommonMetadata_CANCELLING CommonMetadata_State = 3
	// Request has been processed and is in its finalization stage.
	CommonMetadata_FINALIZING CommonMetadata_State = 4
	// Request has completed successfully.
	CommonMetadata_SUCCESSFUL CommonMetadata_State = 5
	// Request has finished being processed, but encountered an error.
	CommonMetadata_FAILED CommonMetadata_State = 6
	// Request has finished being cancelled after user called
	// google.longrunning.Operations.CancelOperation.
	CommonMetadata_CANCELLED CommonMetadata_State = 7
)

func (CommonMetadata_State) Descriptor 

func (CommonMetadata_State) Descriptor() protoreflect.EnumDescriptor

func (CommonMetadata_State) Enum 

func (x CommonMetadata_State) Enum() *CommonMetadata_State

func (CommonMetadata_State) EnumDescriptor deprecated 

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

Deprecated: Use CommonMetadata_State.Descriptor instead.

func (CommonMetadata_State) Number 

func (x CommonMetadata_State) Number() protoreflect.EnumNumber

func (CommonMetadata_State) String 

func (x CommonMetadata_State) String() string

func (CommonMetadata_State) Type 

func (CommonMetadata_State) Type() protoreflect.EnumType

type CreateIndexRequest 

type CreateIndexRequest struct {

	// Project ID against which to make the request.
	ProjectId string `protobuf:"bytes,1,opt,name=project_id,json=projectId,proto3" json:"project_id,omitempty"`
	// The index to create. The name and state fields are output only and will be
	// ignored. Single property indexes cannot be created or deleted.
	Index *Index `protobuf:"bytes,3,opt,name=index,proto3" json:"index,omitempty"`
	// contains filtered or unexported fields
}

The request for [google.datastore.admin.v1.DatastoreAdmin.CreateIndex][google.datastore.admin.v1.DatastoreAdmin.CreateIndex].

func (*CreateIndexRequest) Descriptor deprecated 

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

Deprecated: Use CreateIndexRequest.ProtoReflect.Descriptor instead.

func (*CreateIndexRequest) GetIndex 

func (x *CreateIndexRequest) GetIndex() *Index

func (*CreateIndexRequest) GetProjectId 

func (x *CreateIndexRequest) GetProjectId() string

func (*CreateIndexRequest) ProtoMessage 

func (*CreateIndexRequest) ProtoMessage()

func (*CreateIndexRequest) ProtoReflect 

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

func (*CreateIndexRequest) Reset 

func (x *CreateIndexRequest) Reset()

func (*CreateIndexRequest) String 

func (x *CreateIndexRequest) String() string

type DatastoreAdminClient 

type DatastoreAdminClient interface {
	// Exports a copy of all or a subset of entities from Google Cloud Datastore
	// to another storage system, such as Google Cloud Storage. Recent updates to
	// entities 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.
	ExportEntities(ctx context.Context, in *ExportEntitiesRequest, opts ...grpc.CallOption) (*longrunningpb.Operation, error)
	// Imports entities into Google Cloud Datastore. Existing entities with the
	// same key 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 ImportEntities operation is cancelled, it is possible
	// that a subset of the data has already been imported to Cloud Datastore.
	ImportEntities(ctx context.Context, in *ImportEntitiesRequest, opts ...grpc.CallOption) (*longrunningpb.Operation, error)
	// Creates the specified index.
	// A newly created index's initial state is `CREATING`. On completion of the
	// returned [google.longrunning.Operation][google.longrunning.Operation], the
	// state will be `READY`. If the index already exists, the call will return an
	// `ALREADY_EXISTS` status.
	//
	// During index creation, the process could result in an error, in which
	// case the index will move to the `ERROR` state. The process can be recovered
	// by fixing the data that caused the error, removing the index with
	// [delete][google.datastore.admin.v1.DatastoreAdmin.DeleteIndex], then
	// re-creating the index with [create]
	// [google.datastore.admin.v1.DatastoreAdmin.CreateIndex].
	//
	// Indexes with a single property cannot be created.
	CreateIndex(ctx context.Context, in *CreateIndexRequest, opts ...grpc.CallOption) (*longrunningpb.Operation, error)
	// Deletes an existing index.
	// An index can only be deleted if it is in a `READY` or `ERROR` state. On
	// successful execution of the request, the index will be in a `DELETING`
	// [state][google.datastore.admin.v1.Index.State]. And on completion of the
	// returned [google.longrunning.Operation][google.longrunning.Operation], the
	// index will be removed.
	//
	// During index deletion, the process could result in an error, in which
	// case the index will move to the `ERROR` state. The process can be recovered
	// by fixing the data that caused the error, followed by calling
	// [delete][google.datastore.admin.v1.DatastoreAdmin.DeleteIndex] again.
	DeleteIndex(ctx context.Context, in *DeleteIndexRequest, opts ...grpc.CallOption) (*longrunningpb.Operation, error)
	// Gets an index.
	GetIndex(ctx context.Context, in *GetIndexRequest, opts ...grpc.CallOption) (*Index, error)
	// Lists the indexes that match the specified filters.  Datastore uses an
	// eventually consistent query to fetch the list of indexes and may
	// occasionally return stale results.
	ListIndexes(ctx context.Context, in *ListIndexesRequest, opts ...grpc.CallOption) (*ListIndexesResponse, error)
}

DatastoreAdminClient is the client API for DatastoreAdmin service.

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

func NewDatastoreAdminClient 

func NewDatastoreAdminClient(cc grpc.ClientConnInterface) DatastoreAdminClient

type DatastoreAdminServer 

type DatastoreAdminServer interface {
	// Exports a copy of all or a subset of entities from Google Cloud Datastore
	// to another storage system, such as Google Cloud Storage. Recent updates to
	// entities 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.
	ExportEntities(context.Context, *ExportEntitiesRequest) (*longrunningpb.Operation, error)
	// Imports entities into Google Cloud Datastore. Existing entities with the
	// same key 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 ImportEntities operation is cancelled, it is possible
	// that a subset of the data has already been imported to Cloud Datastore.
	ImportEntities(context.Context, *ImportEntitiesRequest) (*longrunningpb.Operation, error)
	// Creates the specified index.
	// A newly created index's initial state is `CREATING`. On completion of the
	// returned [google.longrunning.Operation][google.longrunning.Operation], the
	// state will be `READY`. If the index already exists, the call will return an
	// `ALREADY_EXISTS` status.
	//
	// During index creation, the process could result in an error, in which
	// case the index will move to the `ERROR` state. The process can be recovered
	// by fixing the data that caused the error, removing the index with
	// [delete][google.datastore.admin.v1.DatastoreAdmin.DeleteIndex], then
	// re-creating the index with [create]
	// [google.datastore.admin.v1.DatastoreAdmin.CreateIndex].
	//
	// Indexes with a single property cannot be created.
	CreateIndex(context.Context, *CreateIndexRequest) (*longrunningpb.Operation, error)
	// Deletes an existing index.
	// An index can only be deleted if it is in a `READY` or `ERROR` state. On
	// successful execution of the request, the index will be in a `DELETING`
	// [state][google.datastore.admin.v1.Index.State]. And on completion of the
	// returned [google.longrunning.Operation][google.longrunning.Operation], the
	// index will be removed.
	//
	// During index deletion, the process could result in an error, in which
	// case the index will move to the `ERROR` state. The process can be recovered
	// by fixing the data that caused the error, followed by calling
	// [delete][google.datastore.admin.v1.DatastoreAdmin.DeleteIndex] again.
	DeleteIndex(context.Context, *DeleteIndexRequest) (*longrunningpb.Operation, error)
	// Gets an index.
	GetIndex(context.Context, *GetIndexRequest) (*Index, error)
	// Lists the indexes that match the specified filters.  Datastore uses an
	// eventually consistent query to fetch the list of indexes and may
	// occasionally return stale results.
	ListIndexes(context.Context, *ListIndexesRequest) (*ListIndexesResponse, error)
}

DatastoreAdminServer is the server API for DatastoreAdmin service.

type DatastoreFirestoreMigrationMetadata 

type DatastoreFirestoreMigrationMetadata struct {

	// The current state of migration from Cloud Datastore to Cloud Firestore in
	// Datastore mode.
	MigrationState MigrationState `` /* 150-byte string literal not displayed */
	// The current step of migration from Cloud Datastore to Cloud Firestore in
	// Datastore mode.
	MigrationStep MigrationStep `` /* 146-byte string literal not displayed */
	// contains filtered or unexported fields
}

Metadata for Datastore to Firestore migration operations.

The DatastoreFirestoreMigration operation is not started by the end-user via an explicit "creation" method. This is an intentional deviation from the LRO design pattern.

This singleton resource can be accessed at: "projects/{project_id}/operations/datastore-firestore-migration"

func (*DatastoreFirestoreMigrationMetadata) Descriptor deprecated 

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

Deprecated: Use DatastoreFirestoreMigrationMetadata.ProtoReflect.Descriptor instead.

func (*DatastoreFirestoreMigrationMetadata) GetMigrationState 

func (x *DatastoreFirestoreMigrationMetadata) GetMigrationState() MigrationState

func (*DatastoreFirestoreMigrationMetadata) GetMigrationStep 

func (x *DatastoreFirestoreMigrationMetadata) GetMigrationStep() MigrationStep

func (*DatastoreFirestoreMigrationMetadata) ProtoMessage 

func (*DatastoreFirestoreMigrationMetadata) ProtoMessage()

func (*DatastoreFirestoreMigrationMetadata) ProtoReflect 

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

func (*DatastoreFirestoreMigrationMetadata) Reset 

func (x *DatastoreFirestoreMigrationMetadata) Reset()

func (*DatastoreFirestoreMigrationMetadata) String 

func (x *DatastoreFirestoreMigrationMetadata) String() string

type DeleteIndexRequest 

type DeleteIndexRequest struct {

	// Project ID against which to make the request.
	ProjectId string `protobuf:"bytes,1,opt,name=project_id,json=projectId,proto3" json:"project_id,omitempty"`
	// The resource ID of the index to delete.
	IndexId string `protobuf:"bytes,3,opt,name=index_id,json=indexId,proto3" json:"index_id,omitempty"`
	// contains filtered or unexported fields
}

The request for [google.datastore.admin.v1.DatastoreAdmin.DeleteIndex][google.datastore.admin.v1.DatastoreAdmin.DeleteIndex].

func (*DeleteIndexRequest) Descriptor deprecated 

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

Deprecated: Use DeleteIndexRequest.ProtoReflect.Descriptor instead.

func (*DeleteIndexRequest) GetIndexId 

func (x *DeleteIndexRequest) GetIndexId() string

func (*DeleteIndexRequest) GetProjectId 

func (x *DeleteIndexRequest) GetProjectId() string

func (*DeleteIndexRequest) ProtoMessage 

func (*DeleteIndexRequest) ProtoMessage()

func (*DeleteIndexRequest) ProtoReflect 

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

func (*DeleteIndexRequest) Reset 

func (x *DeleteIndexRequest) Reset()

func (*DeleteIndexRequest) String 

func (x *DeleteIndexRequest) String() string

type EntityFilter 

type EntityFilter struct {

	// If empty, then this represents all kinds.
	Kinds []string `protobuf:"bytes,1,rep,name=kinds,proto3" json:"kinds,omitempty"`
	// An empty list represents all namespaces. This is the preferred
	// usage for projects that don't use namespaces.
	//
	// An empty string element represents the default namespace. This should be
	// used if the project 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,2,rep,name=namespace_ids,json=namespaceIds,proto3" json:"namespace_ids,omitempty"`
	// contains filtered or unexported fields
}

Identifies a subset of entities in a project. This is specified as combinations of kinds and namespaces (either or both of which may be all, as described in the following examples). Example usage:

Entire project: 

kinds=[], namespace_ids=[]

Kinds Foo and Bar in all namespaces: 

kinds=['Foo', 'Bar'], namespace_ids=[]

Kinds Foo and Bar only in the default namespace: 

kinds=['Foo', 'Bar'], namespace_ids=['']

Kinds Foo and Bar in both the default and Baz namespaces: 

kinds=['Foo', 'Bar'], namespace_ids=['', 'Baz']

The entire Baz namespace: 

kinds=[], namespace_ids=['Baz']

func (*EntityFilter) Descriptor deprecated 

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

Deprecated: Use EntityFilter.ProtoReflect.Descriptor instead.

func (*EntityFilter) GetKinds 

func (x *EntityFilter) GetKinds() []string

func (*EntityFilter) GetNamespaceIds 

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

func (*EntityFilter) ProtoMessage 

func (*EntityFilter) ProtoMessage()

func (*EntityFilter) ProtoReflect 

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

func (*EntityFilter) Reset 

func (x *EntityFilter) Reset()

func (*EntityFilter) String 

func (x *EntityFilter) String() string

type ExportEntitiesMetadata 

type ExportEntitiesMetadata struct {

	// Metadata common to all Datastore Admin operations.
	Common *CommonMetadata `protobuf:"bytes,1,opt,name=common,proto3" json:"common,omitempty"`
	// An estimate of the number of entities processed.
	ProgressEntities *Progress `protobuf:"bytes,2,opt,name=progress_entities,json=progressEntities,proto3" json:"progress_entities,omitempty"`
	// An estimate of the number of bytes processed.
	ProgressBytes *Progress `protobuf:"bytes,3,opt,name=progress_bytes,json=progressBytes,proto3" json:"progress_bytes,omitempty"`
	// Description of which entities are being exported.
	EntityFilter *EntityFilter `protobuf:"bytes,4,opt,name=entity_filter,json=entityFilter,proto3" json:"entity_filter,omitempty"`
	// Location for the export metadata and data files. This will be the same
	// value as the
	// [google.datastore.admin.v1.ExportEntitiesRequest.output_url_prefix][google.datastore.admin.v1.ExportEntitiesRequest.output_url_prefix]
	// field. The final output location is provided in
	// [google.datastore.admin.v1.ExportEntitiesResponse.output_url][google.datastore.admin.v1.ExportEntitiesResponse.output_url].
	OutputUrlPrefix string `protobuf:"bytes,5,opt,name=output_url_prefix,json=outputUrlPrefix,proto3" json:"output_url_prefix,omitempty"`
	// contains filtered or unexported fields
}

Metadata for ExportEntities operations.

func (*ExportEntitiesMetadata) Descriptor deprecated 

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

Deprecated: Use ExportEntitiesMetadata.ProtoReflect.Descriptor instead.

func (*ExportEntitiesMetadata) GetCommon 

func (x *ExportEntitiesMetadata) GetCommon() *CommonMetadata

func (*ExportEntitiesMetadata) GetEntityFilter 

func (x *ExportEntitiesMetadata) GetEntityFilter() *EntityFilter

func (*ExportEntitiesMetadata) GetOutputUrlPrefix 

func (x *ExportEntitiesMetadata) GetOutputUrlPrefix() string

func (*ExportEntitiesMetadata) GetProgressBytes 

func (x *ExportEntitiesMetadata) GetProgressBytes() *Progress

func (*ExportEntitiesMetadata) GetProgressEntities 

func (x *ExportEntitiesMetadata) GetProgressEntities() *Progress

func (*ExportEntitiesMetadata) ProtoMessage 

func (*ExportEntitiesMetadata) ProtoMessage()

func (*ExportEntitiesMetadata) ProtoReflect 

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

func (*ExportEntitiesMetadata) Reset 

func (x *ExportEntitiesMetadata) Reset()

func (*ExportEntitiesMetadata) String 

func (x *ExportEntitiesMetadata) String() string

type ExportEntitiesRequest 

type ExportEntitiesRequest struct {

	// Required. Project ID against which to make the request.
	ProjectId string `protobuf:"bytes,1,opt,name=project_id,json=projectId,proto3" json:"project_id,omitempty"`
	// Client-assigned labels.
	Labels map[string]string `` /* 153-byte string literal not displayed */
	// Description of what data from the project is included in the export.
	EntityFilter *EntityFilter `protobuf:"bytes,3,opt,name=entity_filter,json=entityFilter,proto3" json:"entity_filter,omitempty"`
	// Required. Location for the export metadata and data files.
	//
	// The full resource URL of the external storage location. Currently, only
	// Google Cloud Storage is supported. So output_url_prefix should be of the
	// form: `gs://BUCKET_NAME[/NAMESPACE_PATH]`, where `BUCKET_NAME` is the
	// name of the Cloud Storage bucket and `NAMESPACE_PATH` is an optional Cloud
	// Storage namespace path (this is not a Cloud Datastore namespace). For more
	// information about Cloud Storage namespace paths, see
	// [Object name
	// considerations](https://cloud.google.com/storage/docs/naming#object-considerations).
	//
	// The resulting files will be nested deeper than the specified URL prefix.
	// The final output URL will be provided in the
	// [google.datastore.admin.v1.ExportEntitiesResponse.output_url][google.datastore.admin.v1.ExportEntitiesResponse.output_url]
	// field. That value should be used for subsequent ImportEntities operations.
	//
	// By nesting the data files deeper, the same Cloud Storage bucket can be used
	// in multiple ExportEntities operations without conflict.
	OutputUrlPrefix string `protobuf:"bytes,4,opt,name=output_url_prefix,json=outputUrlPrefix,proto3" json:"output_url_prefix,omitempty"`
	// contains filtered or unexported fields
}

The request for [google.datastore.admin.v1.DatastoreAdmin.ExportEntities][google.datastore.admin.v1.DatastoreAdmin.ExportEntities].

func (*ExportEntitiesRequest) Descriptor deprecated 

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

Deprecated: Use ExportEntitiesRequest.ProtoReflect.Descriptor instead.

func (*ExportEntitiesRequest) GetEntityFilter 

func (x *ExportEntitiesRequest) GetEntityFilter() *EntityFilter

func (*ExportEntitiesRequest) GetLabels 

func (x *ExportEntitiesRequest) GetLabels() map[string]string

func (*ExportEntitiesRequest) GetOutputUrlPrefix 

func (x *ExportEntitiesRequest) GetOutputUrlPrefix() string

func (*ExportEntitiesRequest) GetProjectId 

func (x *ExportEntitiesRequest) GetProjectId() string

func (*ExportEntitiesRequest) ProtoMessage 

func (*ExportEntitiesRequest) ProtoMessage()

func (*ExportEntitiesRequest) ProtoReflect 

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

func (*ExportEntitiesRequest) Reset 

func (x *ExportEntitiesRequest) Reset()

func (*ExportEntitiesRequest) String 

func (x *ExportEntitiesRequest) String() string

type ExportEntitiesResponse 

type ExportEntitiesResponse struct {

	// Location of the output metadata file. This can be used to begin an import
	// into Cloud Datastore (this project or another project). See
	// [google.datastore.admin.v1.ImportEntitiesRequest.input_url][google.datastore.admin.v1.ImportEntitiesRequest.input_url].
	// Only present if the operation completed successfully.
	OutputUrl string `protobuf:"bytes,1,opt,name=output_url,json=outputUrl,proto3" json:"output_url,omitempty"`
	// contains filtered or unexported fields
}

The response for [google.datastore.admin.v1.DatastoreAdmin.ExportEntities][google.datastore.admin.v1.DatastoreAdmin.ExportEntities].

func (*ExportEntitiesResponse) Descriptor deprecated 

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

Deprecated: Use ExportEntitiesResponse.ProtoReflect.Descriptor instead.

func (*ExportEntitiesResponse) GetOutputUrl 

func (x *ExportEntitiesResponse) GetOutputUrl() string

func (*ExportEntitiesResponse) ProtoMessage 

func (*ExportEntitiesResponse) ProtoMessage()

func (*ExportEntitiesResponse) ProtoReflect 

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

func (*ExportEntitiesResponse) Reset 

func (x *ExportEntitiesResponse) Reset()

func (*ExportEntitiesResponse) String 

func (x *ExportEntitiesResponse) String() string

type GetIndexRequest 

type GetIndexRequest struct {

	// Project ID against which to make the request.
	ProjectId string `protobuf:"bytes,1,opt,name=project_id,json=projectId,proto3" json:"project_id,omitempty"`
	// The resource ID of the index to get.
	IndexId string `protobuf:"bytes,3,opt,name=index_id,json=indexId,proto3" json:"index_id,omitempty"`
	// contains filtered or unexported fields
}

The request for [google.datastore.admin.v1.DatastoreAdmin.GetIndex][google.datastore.admin.v1.DatastoreAdmin.GetIndex].

func (*GetIndexRequest) Descriptor deprecated 

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

Deprecated: Use GetIndexRequest.ProtoReflect.Descriptor instead.

func (*GetIndexRequest) GetIndexId 

func (x *GetIndexRequest) GetIndexId() string

func (*GetIndexRequest) GetProjectId 

func (x *GetIndexRequest) GetProjectId() string

func (*GetIndexRequest) ProtoMessage 

func (*GetIndexRequest) ProtoMessage()

func (*GetIndexRequest) ProtoReflect 

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

func (*GetIndexRequest) Reset 

func (x *GetIndexRequest) Reset()

func (*GetIndexRequest) String 

func (x *GetIndexRequest) String() string

type ImportEntitiesMetadata 

type ImportEntitiesMetadata struct {

	// Metadata common to all Datastore Admin operations.
	Common *CommonMetadata `protobuf:"bytes,1,opt,name=common,proto3" json:"common,omitempty"`
	// An estimate of the number of entities processed.
	ProgressEntities *Progress `protobuf:"bytes,2,opt,name=progress_entities,json=progressEntities,proto3" json:"progress_entities,omitempty"`
	// An estimate of the number of bytes processed.
	ProgressBytes *Progress `protobuf:"bytes,3,opt,name=progress_bytes,json=progressBytes,proto3" json:"progress_bytes,omitempty"`
	// Description of which entities are being imported.
	EntityFilter *EntityFilter `protobuf:"bytes,4,opt,name=entity_filter,json=entityFilter,proto3" json:"entity_filter,omitempty"`
	// The location of the import metadata file. This will be the same value as
	// the
	// [google.datastore.admin.v1.ExportEntitiesResponse.output_url][google.datastore.admin.v1.ExportEntitiesResponse.output_url]
	// field.
	InputUrl string `protobuf:"bytes,5,opt,name=input_url,json=inputUrl,proto3" json:"input_url,omitempty"`
	// contains filtered or unexported fields
}

Metadata for ImportEntities operations.

func (*ImportEntitiesMetadata) Descriptor deprecated 

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

Deprecated: Use ImportEntitiesMetadata.ProtoReflect.Descriptor instead.

func (*ImportEntitiesMetadata) GetCommon 

func (x *ImportEntitiesMetadata) GetCommon() *CommonMetadata

func (*ImportEntitiesMetadata) GetEntityFilter 

func (x *ImportEntitiesMetadata) GetEntityFilter() *EntityFilter

func (*ImportEntitiesMetadata) GetInputUrl 

func (x *ImportEntitiesMetadata) GetInputUrl() string

func (*ImportEntitiesMetadata) GetProgressBytes 

func (x *ImportEntitiesMetadata) GetProgressBytes() *Progress

func (*ImportEntitiesMetadata) GetProgressEntities 

func (x *ImportEntitiesMetadata) GetProgressEntities() *Progress

func (*ImportEntitiesMetadata) ProtoMessage 

func (*ImportEntitiesMetadata) ProtoMessage()

func (*ImportEntitiesMetadata) ProtoReflect 

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

func (*ImportEntitiesMetadata) Reset 

func (x *ImportEntitiesMetadata) Reset()

func (*ImportEntitiesMetadata) String 

func (x *ImportEntitiesMetadata) String() string

type ImportEntitiesRequest 

type ImportEntitiesRequest struct {

	// Required. Project ID against which to make the request.
	ProjectId string `protobuf:"bytes,1,opt,name=project_id,json=projectId,proto3" json:"project_id,omitempty"`
	// Client-assigned labels.
	Labels map[string]string `` /* 153-byte string literal not displayed */
	// Required. The full resource URL of the external storage location.
	// Currently, only Google Cloud Storage is supported. So input_url should be
	// of the form:
	// `gs://BUCKET_NAME[/NAMESPACE_PATH]/OVERALL_EXPORT_METADATA_FILE`, where
	// `BUCKET_NAME` is the name of the Cloud Storage bucket, `NAMESPACE_PATH` is
	// an optional Cloud Storage namespace path (this is not a Cloud Datastore
	// namespace), and `OVERALL_EXPORT_METADATA_FILE` is the metadata file written
	// by the ExportEntities operation. For more information about Cloud Storage
	// namespace paths, see
	// [Object name
	// considerations](https://cloud.google.com/storage/docs/naming#object-considerations).
	//
	// For more information, see
	// [google.datastore.admin.v1.ExportEntitiesResponse.output_url][google.datastore.admin.v1.ExportEntitiesResponse.output_url].
	InputUrl string `protobuf:"bytes,3,opt,name=input_url,json=inputUrl,proto3" json:"input_url,omitempty"`
	// Optionally specify which kinds/namespaces are to be imported. If provided,
	// the list must be a subset of the EntityFilter used in creating the export,
	// otherwise a FAILED_PRECONDITION error will be returned. If no filter is
	// specified then all entities from the export are imported.
	EntityFilter *EntityFilter `protobuf:"bytes,4,opt,name=entity_filter,json=entityFilter,proto3" json:"entity_filter,omitempty"`
	// contains filtered or unexported fields
}

The request for [google.datastore.admin.v1.DatastoreAdmin.ImportEntities][google.datastore.admin.v1.DatastoreAdmin.ImportEntities].

func (*ImportEntitiesRequest) Descriptor deprecated 

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

Deprecated: Use ImportEntitiesRequest.ProtoReflect.Descriptor instead.

func (*ImportEntitiesRequest) GetEntityFilter 

func (x *ImportEntitiesRequest) GetEntityFilter() *EntityFilter

func (*ImportEntitiesRequest) GetInputUrl 

func (x *ImportEntitiesRequest) GetInputUrl() string

func (*ImportEntitiesRequest) GetLabels 

func (x *ImportEntitiesRequest) GetLabels() map[string]string

func (*ImportEntitiesRequest) GetProjectId 

func (x *ImportEntitiesRequest) GetProjectId() string

func (*ImportEntitiesRequest) ProtoMessage 

func (*ImportEntitiesRequest) ProtoMessage()

func (*ImportEntitiesRequest) ProtoReflect 

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

func (*ImportEntitiesRequest) Reset 

func (x *ImportEntitiesRequest) Reset()

func (*ImportEntitiesRequest) String 

func (x *ImportEntitiesRequest) String() string

type Index 

type Index struct {

	// Output only. Project ID.
	ProjectId string `protobuf:"bytes,1,opt,name=project_id,json=projectId,proto3" json:"project_id,omitempty"`
	// Output only. The resource ID of the index.
	IndexId string `protobuf:"bytes,3,opt,name=index_id,json=indexId,proto3" json:"index_id,omitempty"`
	// Required. The entity kind to which this index applies.
	Kind string `protobuf:"bytes,4,opt,name=kind,proto3" json:"kind,omitempty"`
	// Required. The index's ancestor mode.  Must not be
	// ANCESTOR_MODE_UNSPECIFIED.
	Ancestor Index_AncestorMode `protobuf:"varint,5,opt,name=ancestor,proto3,enum=google.datastore.admin.v1.Index_AncestorMode" json:"ancestor,omitempty"`
	// Required. An ordered sequence of property names and their index attributes.
	//
	// Requires:
	//
	// * A maximum of 100 properties.
	Properties []*Index_IndexedProperty `protobuf:"bytes,6,rep,name=properties,proto3" json:"properties,omitempty"`
	// Output only. The state of the index.
	State Index_State `protobuf:"varint,7,opt,name=state,proto3,enum=google.datastore.admin.v1.Index_State" json:"state,omitempty"`
	// contains filtered or unexported fields
}

Datastore composite index definition.

func (*Index) Descriptor deprecated 

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

Deprecated: Use Index.ProtoReflect.Descriptor instead.

func (*Index) GetAncestor 

func (x *Index) GetAncestor() Index_AncestorMode

func (*Index) GetIndexId 

func (x *Index) GetIndexId() string

func (*Index) GetKind 

func (x *Index) GetKind() string

func (*Index) GetProjectId 

func (x *Index) GetProjectId() string

func (*Index) GetProperties 

func (x *Index) GetProperties() []*Index_IndexedProperty

func (*Index) GetState 

func (x *Index) GetState() Index_State

func (*Index) ProtoMessage 

func (*Index) ProtoMessage()

func (*Index) ProtoReflect 

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

func (*Index) Reset 

func (x *Index) Reset()

func (*Index) String 

func (x *Index) String() string

type IndexOperationMetadata 

type IndexOperationMetadata struct {

	// Metadata common to all Datastore Admin operations.
	Common *CommonMetadata `protobuf:"bytes,1,opt,name=common,proto3" json:"common,omitempty"`
	// An estimate of the number of entities processed.
	ProgressEntities *Progress `protobuf:"bytes,2,opt,name=progress_entities,json=progressEntities,proto3" json:"progress_entities,omitempty"`
	// The index resource ID that this operation is acting on.
	IndexId string `protobuf:"bytes,3,opt,name=index_id,json=indexId,proto3" json:"index_id,omitempty"`
	// contains filtered or unexported fields
}

Metadata for Index operations.

func (*IndexOperationMetadata) Descriptor deprecated 

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

Deprecated: Use IndexOperationMetadata.ProtoReflect.Descriptor instead.

func (*IndexOperationMetadata) GetCommon 

func (x *IndexOperationMetadata) GetCommon() *CommonMetadata

func (*IndexOperationMetadata) GetIndexId 

func (x *IndexOperationMetadata) GetIndexId() string

func (*IndexOperationMetadata) GetProgressEntities 

func (x *IndexOperationMetadata) GetProgressEntities() *Progress

func (*IndexOperationMetadata) ProtoMessage 

func (*IndexOperationMetadata) ProtoMessage()

func (*IndexOperationMetadata) ProtoReflect 

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

func (*IndexOperationMetadata) Reset 

func (x *IndexOperationMetadata) Reset()

func (*IndexOperationMetadata) String 

func (x *IndexOperationMetadata) String() string

type Index_AncestorMode 

type Index_AncestorMode int32

For an ordered index, specifies whether each of the entity's ancestors will be included. 

const (
	// The ancestor mode is unspecified.
	Index_ANCESTOR_MODE_UNSPECIFIED Index_AncestorMode = 0
	// Do not include the entity's ancestors in the index.
	Index_NONE Index_AncestorMode = 1
	// Include all the entity's ancestors in the index.
	Index_ALL_ANCESTORS Index_AncestorMode = 2
)

func (Index_AncestorMode) Descriptor 

func (Index_AncestorMode) Descriptor() protoreflect.EnumDescriptor

func (Index_AncestorMode) Enum 

func (x Index_AncestorMode) Enum() *Index_AncestorMode

func (Index_AncestorMode) EnumDescriptor deprecated 

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

Deprecated: Use Index_AncestorMode.Descriptor instead.

func (Index_AncestorMode) Number 

func (x Index_AncestorMode) Number() protoreflect.EnumNumber

func (Index_AncestorMode) String 

func (x Index_AncestorMode) String() string

func (Index_AncestorMode) Type 

func (Index_AncestorMode) Type() protoreflect.EnumType

type Index_Direction 

type Index_Direction int32

The direction determines how a property is indexed. 

const (
	// The direction is unspecified.
	Index_DIRECTION_UNSPECIFIED Index_Direction = 0
	// The property's values are indexed so as to support sequencing in
	// ascending order and also query by <, >, <=, >=, and =.
	Index_ASCENDING Index_Direction = 1
	// The property's values are indexed so as to support sequencing in
	// descending order and also query by <, >, <=, >=, and =.
	Index_DESCENDING Index_Direction = 2
)

func (Index_Direction) Descriptor 

func (Index_Direction) Descriptor() protoreflect.EnumDescriptor

func (Index_Direction) Enum 

func (x Index_Direction) Enum() *Index_Direction

func (Index_Direction) EnumDescriptor deprecated 

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

Deprecated: Use Index_Direction.Descriptor instead.

func (Index_Direction) Number 

func (x Index_Direction) Number() protoreflect.EnumNumber

func (Index_Direction) String 

func (x Index_Direction) String() string

func (Index_Direction) Type 

func (Index_Direction) Type() protoreflect.EnumType

type Index_IndexedProperty 

type Index_IndexedProperty struct {

	// Required. The property name to index.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// Required. The indexed property's direction.  Must not be
	// DIRECTION_UNSPECIFIED.
	Direction Index_Direction `protobuf:"varint,2,opt,name=direction,proto3,enum=google.datastore.admin.v1.Index_Direction" json:"direction,omitempty"`
	// contains filtered or unexported fields
}

A property of an index.

func (*Index_IndexedProperty) Descriptor deprecated 

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

Deprecated: Use Index_IndexedProperty.ProtoReflect.Descriptor instead.

func (*Index_IndexedProperty) GetDirection 

func (x *Index_IndexedProperty) GetDirection() Index_Direction

func (*Index_IndexedProperty) GetName 

func (x *Index_IndexedProperty) GetName() string

func (*Index_IndexedProperty) ProtoMessage 

func (*Index_IndexedProperty) ProtoMessage()

func (*Index_IndexedProperty) ProtoReflect 

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

func (*Index_IndexedProperty) Reset 

func (x *Index_IndexedProperty) Reset()

func (*Index_IndexedProperty) String 

func (x *Index_IndexedProperty) String() string

type Index_State 

type Index_State int32

The possible set of states of an index. 

const (
	// The state is unspecified.
	Index_STATE_UNSPECIFIED Index_State = 0
	// The index is being created, and cannot be used by queries.
	// There is an active long-running operation for the index.
	// The index is updated when writing an entity.
	// Some index data may exist.
	Index_CREATING Index_State = 1
	// The index is ready to be used.
	// The index is updated when writing an entity.
	// The index is fully populated from all stored entities it applies to.
	Index_READY Index_State = 2
	// The index is being deleted, and cannot be used by queries.
	// There is an active long-running operation for the index.
	// The index is not updated when writing an entity.
	// Some index data may exist.
	Index_DELETING Index_State = 3
	// The index was being created or deleted, but something went wrong.
	// The index cannot by used by queries.
	// 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 an entity.
	// Some index data may exist.
	Index_ERROR Index_State = 4
)

func (Index_State) Descriptor 

func (Index_State) Descriptor() protoreflect.EnumDescriptor

func (Index_State) Enum 

func (x Index_State) Enum() *Index_State

func (Index_State) EnumDescriptor deprecated 

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

Deprecated: Use Index_State.Descriptor instead.

func (Index_State) Number 

func (x Index_State) Number() protoreflect.EnumNumber

func (Index_State) String 

func (x Index_State) String() string

func (Index_State) Type 

func (Index_State) Type() protoreflect.EnumType

type ListIndexesRequest 

type ListIndexesRequest struct {

	// Project ID against which to make the request.
	ProjectId string `protobuf:"bytes,1,opt,name=project_id,json=projectId,proto3" json:"project_id,omitempty"`
	Filter    string `protobuf:"bytes,3,opt,name=filter,proto3" json:"filter,omitempty"`
	// The maximum number of items to return.  If zero, then all results will be
	// returned.
	PageSize int32 `protobuf:"varint,4,opt,name=page_size,json=pageSize,proto3" json:"page_size,omitempty"`
	// The next_page_token value returned from a previous List request, if any.
	PageToken string `protobuf:"bytes,5,opt,name=page_token,json=pageToken,proto3" json:"page_token,omitempty"`
	// contains filtered or unexported fields
}

The request for [google.datastore.admin.v1.DatastoreAdmin.ListIndexes][google.datastore.admin.v1.DatastoreAdmin.ListIndexes].

func (*ListIndexesRequest) Descriptor deprecated 

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

Deprecated: Use ListIndexesRequest.ProtoReflect.Descriptor instead.

func (*ListIndexesRequest) GetFilter 

func (x *ListIndexesRequest) GetFilter() string

func (*ListIndexesRequest) GetPageSize 

func (x *ListIndexesRequest) GetPageSize() int32

func (*ListIndexesRequest) GetPageToken 

func (x *ListIndexesRequest) GetPageToken() string

func (*ListIndexesRequest) GetProjectId 

func (x *ListIndexesRequest) GetProjectId() string

func (*ListIndexesRequest) ProtoMessage 

func (*ListIndexesRequest) ProtoMessage()

func (*ListIndexesRequest) ProtoReflect 

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

func (*ListIndexesRequest) Reset 

func (x *ListIndexesRequest) Reset()

func (*ListIndexesRequest) String 

func (x *ListIndexesRequest) String() string

type ListIndexesResponse 

type ListIndexesResponse struct {

	// The indexes.
	Indexes []*Index `protobuf:"bytes,1,rep,name=indexes,proto3" json:"indexes,omitempty"`
	// The standard List next-page token.
	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 [google.datastore.admin.v1.DatastoreAdmin.ListIndexes][google.datastore.admin.v1.DatastoreAdmin.ListIndexes].

func (*ListIndexesResponse) Descriptor deprecated 

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

Deprecated: Use ListIndexesResponse.ProtoReflect.Descriptor instead.

func (*ListIndexesResponse) GetIndexes 

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

func (*ListIndexesResponse) GetNextPageToken 

func (x *ListIndexesResponse) GetNextPageToken() string

func (*ListIndexesResponse) ProtoMessage 

func (*ListIndexesResponse) ProtoMessage()

func (*ListIndexesResponse) ProtoReflect 

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

func (*ListIndexesResponse) Reset 

func (x *ListIndexesResponse) Reset()

func (*ListIndexesResponse) String 

func (x *ListIndexesResponse) String() string

type MigrationProgressEvent 

type MigrationProgressEvent struct {

	// The step that is starting.
	//
	// An event with step set to `START` indicates that the migration
	// has been reverted back to the initial pre-migration state.
	Step MigrationStep `protobuf:"varint,1,opt,name=step,proto3,enum=google.datastore.admin.v1.MigrationStep" json:"step,omitempty"`
	// Details about this step.
	//
	// Types that are assignable to StepDetails:
	//	*MigrationProgressEvent_PrepareStepDetails_
	//	*MigrationProgressEvent_RedirectWritesStepDetails_
	StepDetails isMigrationProgressEvent_StepDetails `protobuf_oneof:"step_details"`
	// contains filtered or unexported fields
}

An event signifying the start of a new step in a [migration from Cloud Datastore to Cloud Firestore in Datastore mode](https://cloud.google.com/datastore/docs/upgrade-to-firestore).

func (*MigrationProgressEvent) Descriptor deprecated 

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

Deprecated: Use MigrationProgressEvent.ProtoReflect.Descriptor instead.

func (*MigrationProgressEvent) GetPrepareStepDetails 

func (x *MigrationProgressEvent) GetPrepareStepDetails() *MigrationProgressEvent_PrepareStepDetails

func (*MigrationProgressEvent) GetRedirectWritesStepDetails 

func (x *MigrationProgressEvent) GetRedirectWritesStepDetails() *MigrationProgressEvent_RedirectWritesStepDetails

func (*MigrationProgressEvent) GetStep 

func (x *MigrationProgressEvent) GetStep() MigrationStep

func (*MigrationProgressEvent) GetStepDetails 

func (m *MigrationProgressEvent) GetStepDetails() isMigrationProgressEvent_StepDetails

func (*MigrationProgressEvent) ProtoMessage 

func (*MigrationProgressEvent) ProtoMessage()

func (*MigrationProgressEvent) ProtoReflect 

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

func (*MigrationProgressEvent) Reset 

func (x *MigrationProgressEvent) Reset()

func (*MigrationProgressEvent) String 

func (x *MigrationProgressEvent) String() string

type MigrationProgressEvent_ConcurrencyMode 

type MigrationProgressEvent_ConcurrencyMode int32

Concurrency modes for transactions in Cloud Firestore. 

const (
	// Unspecified.
	MigrationProgressEvent_CONCURRENCY_MODE_UNSPECIFIED MigrationProgressEvent_ConcurrencyMode = 0
	// Pessimistic concurrency.
	MigrationProgressEvent_PESSIMISTIC MigrationProgressEvent_ConcurrencyMode = 1
	// Optimistic concurrency.
	MigrationProgressEvent_OPTIMISTIC MigrationProgressEvent_ConcurrencyMode = 2
	// Optimistic concurrency with entity groups.
	MigrationProgressEvent_OPTIMISTIC_WITH_ENTITY_GROUPS MigrationProgressEvent_ConcurrencyMode = 3
)

func (MigrationProgressEvent_ConcurrencyMode) Descriptor 

func (MigrationProgressEvent_ConcurrencyMode) Descriptor() protoreflect.EnumDescriptor

func (MigrationProgressEvent_ConcurrencyMode) Enum 

func (x MigrationProgressEvent_ConcurrencyMode) Enum() *MigrationProgressEvent_ConcurrencyMode

func (MigrationProgressEvent_ConcurrencyMode) EnumDescriptor deprecated 

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

Deprecated: Use MigrationProgressEvent_ConcurrencyMode.Descriptor instead.

func (MigrationProgressEvent_ConcurrencyMode) Number 

func (x MigrationProgressEvent_ConcurrencyMode) Number() protoreflect.EnumNumber

func (MigrationProgressEvent_ConcurrencyMode) String 

func (x MigrationProgressEvent_ConcurrencyMode) String() string

func (MigrationProgressEvent_ConcurrencyMode) Type 

func (MigrationProgressEvent_ConcurrencyMode) Type() protoreflect.EnumType

type MigrationProgressEvent_PrepareStepDetails 

type MigrationProgressEvent_PrepareStepDetails struct {

	// The concurrency mode this database will use when it reaches the
	// `REDIRECT_WRITES` step.
	ConcurrencyMode MigrationProgressEvent_ConcurrencyMode `` /* 177-byte string literal not displayed */
	// contains filtered or unexported fields
}

Details for the `PREPARE` step.

func (*MigrationProgressEvent_PrepareStepDetails) Descriptor deprecated 

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

Deprecated: Use MigrationProgressEvent_PrepareStepDetails.ProtoReflect.Descriptor instead.

func (*MigrationProgressEvent_PrepareStepDetails) GetConcurrencyMode 

func (x *MigrationProgressEvent_PrepareStepDetails) GetConcurrencyMode() MigrationProgressEvent_ConcurrencyMode

func (*MigrationProgressEvent_PrepareStepDetails) ProtoMessage 

func (*MigrationProgressEvent_PrepareStepDetails) ProtoMessage()

func (*MigrationProgressEvent_PrepareStepDetails) ProtoReflect 

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

func (*MigrationProgressEvent_PrepareStepDetails) Reset 

func (x *MigrationProgressEvent_PrepareStepDetails) Reset()

func (*MigrationProgressEvent_PrepareStepDetails) String 

func (x *MigrationProgressEvent_PrepareStepDetails) String() string

type MigrationProgressEvent_PrepareStepDetails_ 

type MigrationProgressEvent_PrepareStepDetails_ struct {
	// Details for the `PREPARE` step.
	PrepareStepDetails *MigrationProgressEvent_PrepareStepDetails `protobuf:"bytes,2,opt,name=prepare_step_details,json=prepareStepDetails,proto3,oneof"`
}

type MigrationProgressEvent_RedirectWritesStepDetails 

type MigrationProgressEvent_RedirectWritesStepDetails struct {

	// Ths concurrency mode for this database.
	ConcurrencyMode MigrationProgressEvent_ConcurrencyMode `` /* 177-byte string literal not displayed */
	// contains filtered or unexported fields
}

Details for the `REDIRECT_WRITES` step.

func (*MigrationProgressEvent_RedirectWritesStepDetails) Descriptor deprecated 

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

Deprecated: Use MigrationProgressEvent_RedirectWritesStepDetails.ProtoReflect.Descriptor instead.

func (*MigrationProgressEvent_RedirectWritesStepDetails) GetConcurrencyMode 

func (x *MigrationProgressEvent_RedirectWritesStepDetails) GetConcurrencyMode() MigrationProgressEvent_ConcurrencyMode

func (*MigrationProgressEvent_RedirectWritesStepDetails) ProtoMessage 

func (*MigrationProgressEvent_RedirectWritesStepDetails) ProtoMessage()

func (*MigrationProgressEvent_RedirectWritesStepDetails) ProtoReflect 

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

func (*MigrationProgressEvent_RedirectWritesStepDetails) Reset 

func (x *MigrationProgressEvent_RedirectWritesStepDetails) Reset()

func (*MigrationProgressEvent_RedirectWritesStepDetails) String 

func (x *MigrationProgressEvent_RedirectWritesStepDetails) String() string

type MigrationProgressEvent_RedirectWritesStepDetails_ 

type MigrationProgressEvent_RedirectWritesStepDetails_ struct {
	// Details for the `REDIRECT_WRITES` step.
	RedirectWritesStepDetails *MigrationProgressEvent_RedirectWritesStepDetails `protobuf:"bytes,3,opt,name=redirect_writes_step_details,json=redirectWritesStepDetails,proto3,oneof"`
}

type MigrationState 

type MigrationState int32

States for a migration. 

const (
	// Unspecified.
	MigrationState_MIGRATION_STATE_UNSPECIFIED MigrationState = 0
	// The migration is running.
	MigrationState_RUNNING MigrationState = 1
	// The migration is paused.
	MigrationState_PAUSED MigrationState = 2
	// The migration is complete.
	MigrationState_COMPLETE MigrationState = 3
)

func (MigrationState) Descriptor 

func (MigrationState) Descriptor() protoreflect.EnumDescriptor

func (MigrationState) Enum 

func (x MigrationState) Enum() *MigrationState

func (MigrationState) EnumDescriptor deprecated 

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

Deprecated: Use MigrationState.Descriptor instead.

func (MigrationState) Number 

func (x MigrationState) Number() protoreflect.EnumNumber

func (MigrationState) String 

func (x MigrationState) String() string

func (MigrationState) Type 

func (MigrationState) Type() protoreflect.EnumType

type MigrationStateEvent 

type MigrationStateEvent struct {

	// The new state of the migration.
	State MigrationState `protobuf:"varint,1,opt,name=state,proto3,enum=google.datastore.admin.v1.MigrationState" json:"state,omitempty"`
	// contains filtered or unexported fields
}

An event signifying a change in state of a [migration from Cloud Datastore to Cloud Firestore in Datastore mode](https://cloud.google.com/datastore/docs/upgrade-to-firestore).

func (*MigrationStateEvent) Descriptor deprecated 

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

Deprecated: Use MigrationStateEvent.ProtoReflect.Descriptor instead.

func (*MigrationStateEvent) GetState 

func (x *MigrationStateEvent) GetState() MigrationState

func (*MigrationStateEvent) ProtoMessage 

func (*MigrationStateEvent) ProtoMessage()

func (*MigrationStateEvent) ProtoReflect 

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

func (*MigrationStateEvent) Reset 

func (x *MigrationStateEvent) Reset()

func (*MigrationStateEvent) String 

func (x *MigrationStateEvent) String() string

type MigrationStep 

type MigrationStep int32

Steps in a migration. 

const (
	// Unspecified.
	MigrationStep_MIGRATION_STEP_UNSPECIFIED MigrationStep = 0
	// Pre-migration: the database is prepared for migration.
	MigrationStep_PREPARE MigrationStep = 6
	// Start of migration.
	MigrationStep_START MigrationStep = 1
	// Writes are applied synchronously to at least one replica.
	MigrationStep_APPLY_WRITES_SYNCHRONOUSLY MigrationStep = 7
	// Data is copied to Cloud Firestore and then verified to match the data in
	// Cloud Datastore.
	MigrationStep_COPY_AND_VERIFY MigrationStep = 2
	// Eventually-consistent reads are redirected to Cloud Firestore.
	MigrationStep_REDIRECT_EVENTUALLY_CONSISTENT_READS MigrationStep = 3
	// Strongly-consistent reads are redirected to Cloud Firestore.
	MigrationStep_REDIRECT_STRONGLY_CONSISTENT_READS MigrationStep = 4
	// Writes are redirected to Cloud Firestore.
	MigrationStep_REDIRECT_WRITES MigrationStep = 5
)

func (MigrationStep) Descriptor 

func (MigrationStep) Descriptor() protoreflect.EnumDescriptor

func (MigrationStep) Enum 

func (x MigrationStep) Enum() *MigrationStep

func (MigrationStep) EnumDescriptor deprecated 

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

Deprecated: Use MigrationStep.Descriptor instead.

func (MigrationStep) Number 

func (x MigrationStep) Number() protoreflect.EnumNumber

func (MigrationStep) String 

func (x MigrationStep) String() string

func (MigrationStep) Type 

func (MigrationStep) Type() protoreflect.EnumType

type OperationType 

type OperationType int32

Operation types. 

const (
	// Unspecified.
	OperationType_OPERATION_TYPE_UNSPECIFIED OperationType = 0
	// ExportEntities.
	OperationType_EXPORT_ENTITIES OperationType = 1
	// ImportEntities.
	OperationType_IMPORT_ENTITIES OperationType = 2
	// CreateIndex.
	OperationType_CREATE_INDEX OperationType = 3
	// DeleteIndex.
	OperationType_DELETE_INDEX OperationType = 4
)

func (OperationType) Descriptor 

func (OperationType) Descriptor() protoreflect.EnumDescriptor

func (OperationType) Enum 

func (x OperationType) Enum() *OperationType

func (OperationType) EnumDescriptor deprecated 

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

Deprecated: Use OperationType.Descriptor instead.

func (OperationType) Number 

func (x OperationType) Number() protoreflect.EnumNumber

func (OperationType) String 

func (x OperationType) String() string

func (OperationType) Type 

func (OperationType) Type() protoreflect.EnumType

type Progress 

type Progress struct {

	// The amount of work that has been completed. Note that this may be greater
	// than work_estimated.
	WorkCompleted int64 `protobuf:"varint,1,opt,name=work_completed,json=workCompleted,proto3" json:"work_completed,omitempty"`
	// An estimate of how much work needs to be performed. May be zero if the
	// work estimate is unavailable.
	WorkEstimated int64 `protobuf:"varint,2,opt,name=work_estimated,json=workEstimated,proto3" json:"work_estimated,omitempty"`
	// contains filtered or unexported fields
}

Measures the progress of a particular metric.

func (*Progress) Descriptor deprecated 

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

Deprecated: Use Progress.ProtoReflect.Descriptor instead.

func (*Progress) GetWorkCompleted 

func (x *Progress) GetWorkCompleted() int64

func (*Progress) GetWorkEstimated 

func (x *Progress) GetWorkEstimated() int64

func (*Progress) ProtoMessage 

func (*Progress) ProtoMessage()

func (*Progress) ProtoReflect 

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

func (*Progress) Reset 

func (x *Progress) Reset()

func (*Progress) String 

func (x *Progress) String() string

type UnimplementedDatastoreAdminServer 

type UnimplementedDatastoreAdminServer struct {
}

UnimplementedDatastoreAdminServer can be embedded to have forward compatible implementations.

func (*UnimplementedDatastoreAdminServer) CreateIndex 

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

func (*UnimplementedDatastoreAdminServer) DeleteIndex 

func (*UnimplementedDatastoreAdminServer) DeleteIndex(context.Context, *DeleteIndexRequest) (*longrunningpb.Operation, error)

func (*UnimplementedDatastoreAdminServer) ExportEntities 

func (*UnimplementedDatastoreAdminServer) ExportEntities(context.Context, *ExportEntitiesRequest) (*longrunningpb.Operation, error)

func (*UnimplementedDatastoreAdminServer) GetIndex 

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

func (*UnimplementedDatastoreAdminServer) ImportEntities 

func (*UnimplementedDatastoreAdminServer) ImportEntities(context.Context, *ImportEntitiesRequest) (*longrunningpb.Operation, error)

func (*UnimplementedDatastoreAdminServer) ListIndexes 

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

Source Files

View all Source files

Jump to

Keyboard shortcuts

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