admin

package
v0.0.0-...-52d6a69 Latest Latest
Warning

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

 Go to latest Published: Jun 19, 2019 License: Apache-2.0, Apache-2.0 Imports: 8 Imported by: 0

Documentation

Overview

Package admin is a generated protocol buffer package.

It is generated from these files: 

google/datastore/admin/v1beta1/datastore_admin.proto

It has these top-level messages: 

CommonMetadata
Progress
ExportEntitiesRequest
ImportEntitiesRequest
ExportEntitiesResponse
ExportEntitiesMetadata
ImportEntitiesMetadata
EntityFilter

Index

Constants

This section is empty.

Variables

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",
}
View Source 
var CommonMetadata_State_value = map[string]int32{
	"STATE_UNSPECIFIED": 0,
	"INITIALIZING":      1,
	"PROCESSING":        2,
	"CANCELLING":        3,
	"FINALIZING":        4,
	"SUCCESSFUL":        5,
	"FAILED":            6,
	"CANCELLED":         7,
}
View Source 
var OperationType_name = map[int32]string{
	0: "OPERATION_TYPE_UNSPECIFIED",
	1: "EXPORT_ENTITIES",
	2: "IMPORT_ENTITIES",
}
View Source 
var OperationType_value = map[string]int32{
	"OPERATION_TYPE_UNSPECIFIED": 0,
	"EXPORT_ENTITIES":            1,
	"IMPORT_ENTITIES":            2,
}

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 *google_protobuf3.Timestamp `protobuf:"bytes,1,opt,name=start_time,json=startTime" json:"start_time,omitempty"`
	// The time the operation ended, either successfully or otherwise.
	EndTime *google_protobuf3.Timestamp `protobuf:"bytes,2,opt,name=end_time,json=endTime" json:"end_time,omitempty"`
	// The type of the operation.  Can be used as a filter in
	// ListOperationsRequest.
	OperationType OperationType `` /* 144-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 `` /* 132-byte string literal not displayed */
	// The current state of the Operation.
	State CommonMetadata_State `protobuf:"varint,5,opt,name=state,enum=google.datastore.admin.v1beta1.CommonMetadata_State" json:"state,omitempty"`
}

Metadata common to all Datastore Admin operations.

func (*CommonMetadata) Descriptor 

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

func (*CommonMetadata) GetEndTime 

func (m *CommonMetadata) GetEndTime() *google_protobuf3.Timestamp

func (*CommonMetadata) GetLabels 

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

func (*CommonMetadata) GetOperationType 

func (m *CommonMetadata) GetOperationType() OperationType

func (*CommonMetadata) GetStartTime 

func (m *CommonMetadata) GetStartTime() *google_protobuf3.Timestamp

func (*CommonMetadata) GetState 

func (m *CommonMetadata) GetState() CommonMetadata_State

func (*CommonMetadata) ProtoMessage 

func (*CommonMetadata) ProtoMessage()

func (*CommonMetadata) Reset 

func (m *CommonMetadata) Reset()

func (*CommonMetadata) String 

func (m *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
	// 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
	// longrunning.Operations.CancelOperation.
	CommonMetadata_CANCELLED CommonMetadata_State = 7
)

func (CommonMetadata_State) EnumDescriptor 

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

func (CommonMetadata_State) String 

func (x CommonMetadata_State) 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) (*google_longrunning.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) (*google_longrunning.Operation, error)
}

func NewDatastoreAdminClient 

func NewDatastoreAdminClient(cc *grpc.ClientConn) 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) (*google_longrunning.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) (*google_longrunning.Operation, error)
}

type EntityFilter 

type EntityFilter struct {
	// If empty, then this represents all kinds.
	Kinds []string `protobuf:"bytes,1,rep,name=kinds" 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" json:"namespace_ids,omitempty"`
}

Identifies a subset of entities in a project. This is specified as combinations of kind + namespace (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 

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

func (*EntityFilter) GetKinds 

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

func (*EntityFilter) GetNamespaceIds 

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

func (*EntityFilter) ProtoMessage 

func (*EntityFilter) ProtoMessage()

func (*EntityFilter) Reset 

func (m *EntityFilter) Reset()

func (*EntityFilter) String 

func (m *EntityFilter) String() string

type ExportEntitiesMetadata 

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

Metadata for ExportEntities operations.

func (*ExportEntitiesMetadata) Descriptor 

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

func (*ExportEntitiesMetadata) GetCommon 

func (m *ExportEntitiesMetadata) GetCommon() *CommonMetadata

func (*ExportEntitiesMetadata) GetEntityFilter 

func (m *ExportEntitiesMetadata) GetEntityFilter() *EntityFilter

func (*ExportEntitiesMetadata) GetOutputUrlPrefix 

func (m *ExportEntitiesMetadata) GetOutputUrlPrefix() string

func (*ExportEntitiesMetadata) GetProgressBytes 

func (m *ExportEntitiesMetadata) GetProgressBytes() *Progress

func (*ExportEntitiesMetadata) GetProgressEntities 

func (m *ExportEntitiesMetadata) GetProgressEntities() *Progress

func (*ExportEntitiesMetadata) ProtoMessage 

func (*ExportEntitiesMetadata) ProtoMessage()

func (*ExportEntitiesMetadata) Reset 

func (m *ExportEntitiesMetadata) Reset()

func (*ExportEntitiesMetadata) String 

func (m *ExportEntitiesMetadata) String() string

type ExportEntitiesRequest 

type ExportEntitiesRequest struct {
	// Project ID against which to make the request.
	ProjectId string `protobuf:"bytes,1,opt,name=project_id,json=projectId" json:"project_id,omitempty"`
	// Client-assigned labels.
	Labels map[string]string `` /* 132-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" json:"entity_filter,omitempty"`
	// 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.v1beta1.ExportEntitiesResponse.output_url][google.datastore.admin.v1beta1.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" json:"output_url_prefix,omitempty"`
}

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

func (*ExportEntitiesRequest) Descriptor 

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

func (*ExportEntitiesRequest) GetEntityFilter 

func (m *ExportEntitiesRequest) GetEntityFilter() *EntityFilter

func (*ExportEntitiesRequest) GetLabels 

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

func (*ExportEntitiesRequest) GetOutputUrlPrefix 

func (m *ExportEntitiesRequest) GetOutputUrlPrefix() string

func (*ExportEntitiesRequest) GetProjectId 

func (m *ExportEntitiesRequest) GetProjectId() string

func (*ExportEntitiesRequest) ProtoMessage 

func (*ExportEntitiesRequest) ProtoMessage()

func (*ExportEntitiesRequest) Reset 

func (m *ExportEntitiesRequest) Reset()

func (*ExportEntitiesRequest) String 

func (m *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.v1beta1.ImportEntitiesRequest.input_url][google.datastore.admin.v1beta1.ImportEntitiesRequest.input_url].
	// Only present if the operation completed successfully.
	OutputUrl string `protobuf:"bytes,1,opt,name=output_url,json=outputUrl" json:"output_url,omitempty"`
}

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

func (*ExportEntitiesResponse) Descriptor 

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

func (*ExportEntitiesResponse) GetOutputUrl 

func (m *ExportEntitiesResponse) GetOutputUrl() string

func (*ExportEntitiesResponse) ProtoMessage 

func (*ExportEntitiesResponse) ProtoMessage()

func (*ExportEntitiesResponse) Reset 

func (m *ExportEntitiesResponse) Reset()

func (*ExportEntitiesResponse) String 

func (m *ExportEntitiesResponse) String() string

type ImportEntitiesMetadata 

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

Metadata for ImportEntities operations.

func (*ImportEntitiesMetadata) Descriptor 

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

func (*ImportEntitiesMetadata) GetCommon 

func (m *ImportEntitiesMetadata) GetCommon() *CommonMetadata

func (*ImportEntitiesMetadata) GetEntityFilter 

func (m *ImportEntitiesMetadata) GetEntityFilter() *EntityFilter

func (*ImportEntitiesMetadata) GetInputUrl 

func (m *ImportEntitiesMetadata) GetInputUrl() string

func (*ImportEntitiesMetadata) GetProgressBytes 

func (m *ImportEntitiesMetadata) GetProgressBytes() *Progress

func (*ImportEntitiesMetadata) GetProgressEntities 

func (m *ImportEntitiesMetadata) GetProgressEntities() *Progress

func (*ImportEntitiesMetadata) ProtoMessage 

func (*ImportEntitiesMetadata) ProtoMessage()

func (*ImportEntitiesMetadata) Reset 

func (m *ImportEntitiesMetadata) Reset()

func (*ImportEntitiesMetadata) String 

func (m *ImportEntitiesMetadata) String() string

type ImportEntitiesRequest 

type ImportEntitiesRequest struct {
	// Project ID against which to make the request.
	ProjectId string `protobuf:"bytes,1,opt,name=project_id,json=projectId" json:"project_id,omitempty"`
	// Client-assigned labels.
	Labels map[string]string `` /* 132-byte string literal not displayed */
	// 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.v1beta1.ExportEntitiesResponse.output_url][google.datastore.admin.v1beta1.ExportEntitiesResponse.output_url].
	InputUrl string `protobuf:"bytes,3,opt,name=input_url,json=inputUrl" 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" json:"entity_filter,omitempty"`
}

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

func (*ImportEntitiesRequest) Descriptor 

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

func (*ImportEntitiesRequest) GetEntityFilter 

func (m *ImportEntitiesRequest) GetEntityFilter() *EntityFilter

func (*ImportEntitiesRequest) GetInputUrl 

func (m *ImportEntitiesRequest) GetInputUrl() string

func (*ImportEntitiesRequest) GetLabels 

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

func (*ImportEntitiesRequest) GetProjectId 

func (m *ImportEntitiesRequest) GetProjectId() string

func (*ImportEntitiesRequest) ProtoMessage 

func (*ImportEntitiesRequest) ProtoMessage()

func (*ImportEntitiesRequest) Reset 

func (m *ImportEntitiesRequest) Reset()

func (*ImportEntitiesRequest) String 

func (m *ImportEntitiesRequest) String() string

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
)

func (OperationType) EnumDescriptor 

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

func (OperationType) String 

func (x OperationType) String() string

type Progress 

type Progress struct {
	// Note that this may be greater than work_estimated.
	WorkCompleted int64 `protobuf:"varint,1,opt,name=work_completed,json=workCompleted" 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" json:"work_estimated,omitempty"`
}

Measures the progress of a particular metric.

func (*Progress) Descriptor 

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

func (*Progress) GetWorkCompleted 

func (m *Progress) GetWorkCompleted() int64

func (*Progress) GetWorkEstimated 

func (m *Progress) GetWorkEstimated() int64

func (*Progress) ProtoMessage 

func (*Progress) ProtoMessage()

func (*Progress) Reset 

func (m *Progress) Reset()

func (*Progress) String 

func (m *Progress) String() string

Source Files

View all Source files

Jump to

Keyboard shortcuts

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