v1

package
v0.88.7 Latest Latest
Warning

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

 Go to latest Published: Feb 16, 2024 License: Apache-2.0 Imports: 20 Imported by: 2

Documentation

Overview

Package replication/v1 contains the API of replication services.

Package v1 is a reverse proxy.

It translates gRPC into RESTful JSON APIs.

Index

Constants

View Source 
const (

	// EventTypeDeploymentReplicationCreated is the type of event fired after a DeploymentReplication has been created.
	// SubjectID contains the Deployment ID of the DeploymentReplication.
	EventTypeDeploymentReplicationCreated = "replication.deploymentreplication.created"
	// EventTypeDeploymentReplicationUpdated is the type of event fired after a DeploymentReplication has been updated.
	// SubjectID contains the Deployment ID of the DeploymentReplication.
	EventTypeDeploymentReplicationUpdated = "replication.deploymentreplication.updated"
	// EventTypeDeploymentReplicationDeleted is the type of event fired after a DeploymentReplication has been deleted.
	// SubjectID contains the Deployment ID of the DeploymentReplication.
	EventTypeDeploymentReplicationDeleted = "replication.deploymentreplication.deleted"
)
View Source 
const (
	// EventTypeDeploymentMigrationCreated is the type of event fired after a DeploymentMigration has been created.
	// SubjectID contains the ID of the deployment being migrated.
	EventTypeDeploymentMigrationCreated = "replication.deploymentmigration.created"
	// EventTypeDeploymentMigrationUpdated is the type of event fired after a DeploymentMigration has been updated.
	// SubjectID contains the ID of the deployment being migrated.
	EventTypeDeploymentMigrationUpdated = "replication.deploymentmigration.updated"
)
View Source 
const (

	// PermissionGetDeploymentReplication is needed to get a DeploymentReplication for a given Deployment
	// [Deprecated] Deployment replication shouldn't be used anymore, the permission is removed from the system already to prevent usage.
	PermissionGetDeploymentReplication = "replication.deploymentreplication.get"

	// PermissionUpdateDeploymentReplication is needed to update / create a DeploymentReplication
	// [Deprecated] Deployment replication shouldn't be used anymore, the permission is removed from the system already to prevent usage.
	PermissionUpdateDeploymentReplication = "replication.deploymentreplication.update"

	// PermissionUpgradeConnectionToForwarder is needed to start streaming connection via migration-forwarder
	// [Deprecated] Deployment replication shouldn't be used anymore, the permission is removed from the system already to prevent usage.
	PermissionUpgradeConnectionToForwarder = "replication.migration-forwarder.upgrade-connection"
)
View Source 
const (

	// PermissionCreateDeploymentMigration is needed for creating a DeploymentMigration for a given deployment.
	PermissionCreateDeploymentMigration = "replication.deploymentmigration.create"
	// PermissionGetDeploymentMigration is needed for getting a DeploymentMigration for a given deployment.
	PermissionGetDeploymentMigration = "replication.deploymentmigration.get"
	// PermissionDeleteDeploymentMigration is needed for deleting a DeploymentMigration for a given deployment.
	PermissionDeleteDeploymentMigration = "replication.deploymentmigration.delete"
)
View Source 
const (
	// APIID contains identifier of this API
	APIID = "replication/v1"
	// APIMajorVersion contains major version of this API
	APIMajorVersion = 1
	// APIMinorVersion contains minor version of this API
	APIMinorVersion = 3
	// APIPatchVersion contains patch version of this API
	APIPatchVersion = 1
)
View Source 
const (
	// KindMigrationForwarder is a constant for the kind of MigrationForwarder resources.
	KindMigrationForwarder = "MigrationForwarder"
)
View Source 
const (

	// PermissionDeploymentCloneFromBackup is needed to clone a deployment from an existing backup.
	PermissionDeploymentCloneFromBackup = "replication.deployment.clone-from-backup"
)

Variables

View Source 
var (
	// Backup of the source deployment is in progress.
	MigrationPhaseSourceBackupInProgress = "SourceBackupInProgress"
	// Creation of the target deployment is in progress.
	MigrationPhaseTargetDeploymentCreationInProgress = "TargetDeploymentCreationInProgress"
	// Target deployment model update is in progress.
	MigrationPhaseTargetDeploymentModelUpdateInProgress = "TargetDeploymentModelUpdateInProgress"
	// An error has occurred during the migration process.
	MigrationPhaseError = "Error"
	// Migration has failed.
	MigrationPhaseFailed = "Failed"
	// Migration has completed.
	MigrationPhaseComplete = "Complete"
)
View Source 
var (
	ErrInvalidLengthReplication        = fmt.Errorf("proto: negative length found during unmarshaling")
	ErrIntOverflowReplication          = fmt.Errorf("proto: integer overflow")
	ErrUnexpectedEndOfGroupReplication = fmt.Errorf("proto: unexpected end of group")
)
View Source 
var (
	// Replication has started, waiting for sync masters / workers.
	DeploymentReplicationPhaseInitialising = "Initialising"
	// Replication has started and currently in progress.
	DeploymentReplicationPhaseInProgress = "In-Progress"
	// Replication is in an errored state.
	DeploymentReplicationPhaseError = "Error"
	// Replication could not complete successfully.
	DeploymentReplicationPhaseFailed = "Failed"
	// Replication is being stopped.
	DeploymentReplicationPhaseStopping = "Stopping"
	// Replication is stopped and all resources cleaned up properly.
	DeploymentReplicationPhaseCompleted = "Completed"
)

Functions

func RegisterReplicationServiceHandler 

func RegisterReplicationServiceHandler(ctx context.Context, mux *runtime.ServeMux, conn *grpc.ClientConn) error

RegisterReplicationServiceHandler registers the http handlers for service ReplicationService to "mux". The handlers forward requests to the grpc endpoint over "conn".

func RegisterReplicationServiceHandlerClient 

func RegisterReplicationServiceHandlerClient(ctx context.Context, mux *runtime.ServeMux, client ReplicationServiceClient) error

RegisterReplicationServiceHandlerClient registers the http handlers for service ReplicationService to "mux". The handlers forward requests to the grpc endpoint over the given implementation of "ReplicationServiceClient". Note: the gRPC framework executes interceptors within the gRPC handler. If the passed in "ReplicationServiceClient" doesn't go through the normal gRPC flow (creating a gRPC client etc.) then it will be up to the passed in "ReplicationServiceClient" to call the correct interceptors.

func RegisterReplicationServiceHandlerFromEndpoint 

func RegisterReplicationServiceHandlerFromEndpoint(ctx context.Context, mux *runtime.ServeMux, endpoint string, opts []grpc.DialOption) (err error)

RegisterReplicationServiceHandlerFromEndpoint is same as RegisterReplicationServiceHandler but automatically dials to "endpoint" and closes the connection when "ctx" gets done.

func RegisterReplicationServiceHandlerServer 

func RegisterReplicationServiceHandlerServer(ctx context.Context, mux *runtime.ServeMux, server ReplicationServiceServer) error

RegisterReplicationServiceHandlerServer registers the http handlers for service ReplicationService to "mux". UnaryRPC :call ReplicationServiceServer directly. StreamingRPC :currently unsupported pending https://github.com/grpc/grpc-go/issues/906.

func RegisterReplicationServiceServer 

func RegisterReplicationServiceServer(s *grpc.Server, srv ReplicationServiceServer)

Types

type CloneDeploymentFromBackupRequest 

type CloneDeploymentFromBackupRequest struct {
	// The ID of the backup to clone a deployment from.
	BackupId string `protobuf:"bytes,1,opt,name=backup_id,json=backupId,proto3" json:"backup_id,omitempty"`
	// Target region.
	// This is an optional field
	RegionId string `protobuf:"bytes,2,opt,name=region_id,json=regionId,proto3" json:"region_id,omitempty"`
	// This field must be set to the identifier of the current Terms&Conditions
	// when cloning a deployment.
	// If the tier of the organization does not require a non-empty Terms&Condition
	// identifier, this field may be left empty.
	// If this field is not set the terms and conditions of the source deployment will be used.
	AcceptedTermsAndConditionsId string `` /* 151-byte string literal not displayed */
	// Target project identifier.
	// This is an optional field
	ProjectId            string   `protobuf:"bytes,4,opt,name=project_id,json=projectId,proto3" json:"project_id,omitempty"`
	XXX_NoUnkeyedLiteral struct{} `json:"-"`
	XXX_unrecognized     []byte   `json:"-"`
	XXX_sizecache        int32    `json:"-"`
}

CloneDeploymentFromBackupRequest defines a request object for clone deployment call.

func (*CloneDeploymentFromBackupRequest) Descriptor 

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

func (*CloneDeploymentFromBackupRequest) GetAcceptedTermsAndConditionsId added in v0.50.3 

func (m *CloneDeploymentFromBackupRequest) GetAcceptedTermsAndConditionsId() string

func (*CloneDeploymentFromBackupRequest) GetBackupId 

func (m *CloneDeploymentFromBackupRequest) GetBackupId() string

func (*CloneDeploymentFromBackupRequest) GetProjectId added in v0.73.12 

func (m *CloneDeploymentFromBackupRequest) GetProjectId() string

func (*CloneDeploymentFromBackupRequest) GetRegionId 

func (m *CloneDeploymentFromBackupRequest) GetRegionId() string

func (*CloneDeploymentFromBackupRequest) Marshal 

func (m *CloneDeploymentFromBackupRequest) Marshal() (dAtA []byte, err error)

func (*CloneDeploymentFromBackupRequest) MarshalTo 

func (m *CloneDeploymentFromBackupRequest) MarshalTo(dAtA []byte) (int, error)

func (*CloneDeploymentFromBackupRequest) MarshalToSizedBuffer 

func (m *CloneDeploymentFromBackupRequest) MarshalToSizedBuffer(dAtA []byte) (int, error)

func (*CloneDeploymentFromBackupRequest) ProtoMessage 

func (*CloneDeploymentFromBackupRequest) ProtoMessage()

func (*CloneDeploymentFromBackupRequest) Reset 

func (m *CloneDeploymentFromBackupRequest) Reset()

func (*CloneDeploymentFromBackupRequest) Size 

func (m *CloneDeploymentFromBackupRequest) Size() (n int)

func (*CloneDeploymentFromBackupRequest) String 

func (m *CloneDeploymentFromBackupRequest) String() string

func (*CloneDeploymentFromBackupRequest) Unmarshal 

func (m *CloneDeploymentFromBackupRequest) Unmarshal(dAtA []byte) error

func (*CloneDeploymentFromBackupRequest) XXX_DiscardUnknown 

func (m *CloneDeploymentFromBackupRequest) XXX_DiscardUnknown()

func (*CloneDeploymentFromBackupRequest) XXX_Marshal 

func (m *CloneDeploymentFromBackupRequest) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*CloneDeploymentFromBackupRequest) XXX_Merge 

func (m *CloneDeploymentFromBackupRequest) XXX_Merge(src proto.Message)

func (*CloneDeploymentFromBackupRequest) XXX_Size 

func (m *CloneDeploymentFromBackupRequest) XXX_Size() int

func (*CloneDeploymentFromBackupRequest) XXX_Unmarshal 

func (m *CloneDeploymentFromBackupRequest) XXX_Unmarshal(b []byte) error

type DeploymentMigration added in v0.85.0 

type DeploymentMigration struct {
	// Identifier of the source deployment that needs to be migrated.
	// This is a required field.
	SourceDeploymentId string `protobuf:"bytes,1,opt,name=source_deployment_id,json=sourceDeploymentId,proto3" json:"source_deployment_id,omitempty"`
	// Specification of the target deployment.
	TargetDeployment *DeploymentMigration_DeploymentSpec `protobuf:"bytes,2,opt,name=target_deployment,json=targetDeployment,proto3" json:"target_deployment,omitempty"`
	// Timestamp of when this migration was initiated.
	// This is a read-only field.
	CreatedAt *types.Timestamp `protobuf:"bytes,3,opt,name=created_at,json=createdAt,proto3" json:"created_at,omitempty"`
	// Status of the migration.
	// This is a read-only field.
	Status               *DeploymentMigration_Status `protobuf:"bytes,100,opt,name=status,proto3" json:"status,omitempty"`
	XXX_NoUnkeyedLiteral struct{}                    `json:"-"`
	XXX_unrecognized     []byte                      `json:"-"`
	XXX_sizecache        int32                       `json:"-"`
}

DeploymentMigration defines a request for performing the migration of a deployment.

func (*DeploymentMigration) Descriptor added in v0.85.0 

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

func (*DeploymentMigration) GetCreatedAt added in v0.85.0 

func (m *DeploymentMigration) GetCreatedAt() *types.Timestamp

func (*DeploymentMigration) GetSourceDeploymentId added in v0.85.0 

func (m *DeploymentMigration) GetSourceDeploymentId() string

func (*DeploymentMigration) GetStatus added in v0.85.0 

func (m *DeploymentMigration) GetStatus() *DeploymentMigration_Status

func (*DeploymentMigration) GetTargetDeployment added in v0.85.0 

func (m *DeploymentMigration) GetTargetDeployment() *DeploymentMigration_DeploymentSpec

func (*DeploymentMigration) Marshal added in v0.85.0 

func (m *DeploymentMigration) Marshal() (dAtA []byte, err error)

func (*DeploymentMigration) MarshalTo added in v0.85.0 

func (m *DeploymentMigration) MarshalTo(dAtA []byte) (int, error)

func (*DeploymentMigration) MarshalToSizedBuffer added in v0.85.0 

func (m *DeploymentMigration) MarshalToSizedBuffer(dAtA []byte) (int, error)

func (*DeploymentMigration) ProtoMessage added in v0.85.0 

func (*DeploymentMigration) ProtoMessage()

func (*DeploymentMigration) Reset added in v0.85.0 

func (m *DeploymentMigration) Reset()

func (*DeploymentMigration) Size added in v0.85.0 

func (m *DeploymentMigration) Size() (n int)

func (*DeploymentMigration) String added in v0.85.0 

func (m *DeploymentMigration) String() string

func (*DeploymentMigration) Unmarshal added in v0.85.0 

func (m *DeploymentMigration) Unmarshal(dAtA []byte) error

func (*DeploymentMigration) XXX_DiscardUnknown added in v0.85.0 

func (m *DeploymentMigration) XXX_DiscardUnknown()

func (*DeploymentMigration) XXX_Marshal added in v0.85.0 

func (m *DeploymentMigration) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*DeploymentMigration) XXX_Merge added in v0.85.0 

func (m *DeploymentMigration) XXX_Merge(src proto.Message)

func (*DeploymentMigration) XXX_Size added in v0.85.0 

func (m *DeploymentMigration) XXX_Size() int

func (*DeploymentMigration) XXX_Unmarshal added in v0.85.0 

func (m *DeploymentMigration) XXX_Unmarshal(b []byte) error

type DeploymentMigration_DeploymentSpec added in v0.85.0 

type DeploymentMigration_DeploymentSpec struct {
	// Type of model being used
	Model string `protobuf:"bytes,1,opt,name=model,proto3" json:"model,omitempty"`
	// Size of nodes being used
	// This field is ignored set in case the flexible model is used.
	NodeSizeId string `protobuf:"bytes,2,opt,name=node_size_id,json=nodeSizeId,proto3" json:"node_size_id,omitempty"`
	// Number of nodes being used
	// This field is ignored set in case the flexible model is used.
	NodeCount int32 `protobuf:"varint,3,opt,name=node_count,json=nodeCount,proto3" json:"node_count,omitempty"`
	// Amount of disk space per node (in GB)
	// This field is ignored set in case the flexible model is used.
	NodeDiskSize int32 `protobuf:"varint,4,opt,name=node_disk_size,json=nodeDiskSize,proto3" json:"node_disk_size,omitempty"`
	// Identifier of the region in which the deployment is created.
	// After creation, this value cannot be changed.
	RegionId             string   `protobuf:"bytes,5,opt,name=region_id,json=regionId,proto3" json:"region_id,omitempty"`
	XXX_NoUnkeyedLiteral struct{} `json:"-"`
	XXX_unrecognized     []byte   `json:"-"`
	XXX_sizecache        int32    `json:"-"`
}

Specification of the target deployment.

func (*DeploymentMigration_DeploymentSpec) Descriptor added in v0.85.0 

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

func (*DeploymentMigration_DeploymentSpec) GetModel added in v0.85.0 

func (m *DeploymentMigration_DeploymentSpec) GetModel() string

func (*DeploymentMigration_DeploymentSpec) GetNodeCount added in v0.85.0 

func (m *DeploymentMigration_DeploymentSpec) GetNodeCount() int32

func (*DeploymentMigration_DeploymentSpec) GetNodeDiskSize added in v0.85.0 

func (m *DeploymentMigration_DeploymentSpec) GetNodeDiskSize() int32

func (*DeploymentMigration_DeploymentSpec) GetNodeSizeId added in v0.85.0 

func (m *DeploymentMigration_DeploymentSpec) GetNodeSizeId() string

func (*DeploymentMigration_DeploymentSpec) GetRegionId added in v0.85.0 

func (m *DeploymentMigration_DeploymentSpec) GetRegionId() string

func (*DeploymentMigration_DeploymentSpec) Marshal added in v0.85.0 

func (m *DeploymentMigration_DeploymentSpec) Marshal() (dAtA []byte, err error)

func (*DeploymentMigration_DeploymentSpec) MarshalTo added in v0.85.0 

func (m *DeploymentMigration_DeploymentSpec) MarshalTo(dAtA []byte) (int, error)

func (*DeploymentMigration_DeploymentSpec) MarshalToSizedBuffer added in v0.85.0 

func (m *DeploymentMigration_DeploymentSpec) MarshalToSizedBuffer(dAtA []byte) (int, error)

func (*DeploymentMigration_DeploymentSpec) ProtoMessage added in v0.85.0 

func (*DeploymentMigration_DeploymentSpec) ProtoMessage()

func (*DeploymentMigration_DeploymentSpec) Reset added in v0.85.0 

func (m *DeploymentMigration_DeploymentSpec) Reset()

func (*DeploymentMigration_DeploymentSpec) Size added in v0.85.0 

func (m *DeploymentMigration_DeploymentSpec) Size() (n int)

func (*DeploymentMigration_DeploymentSpec) String added in v0.85.0 

func (m *DeploymentMigration_DeploymentSpec) String() string

func (*DeploymentMigration_DeploymentSpec) Unmarshal added in v0.85.0 

func (m *DeploymentMigration_DeploymentSpec) Unmarshal(dAtA []byte) error

func (*DeploymentMigration_DeploymentSpec) XXX_DiscardUnknown added in v0.85.0 

func (m *DeploymentMigration_DeploymentSpec) XXX_DiscardUnknown()

func (*DeploymentMigration_DeploymentSpec) XXX_Marshal added in v0.85.0 

func (m *DeploymentMigration_DeploymentSpec) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*DeploymentMigration_DeploymentSpec) XXX_Merge added in v0.85.0 

func (m *DeploymentMigration_DeploymentSpec) XXX_Merge(src proto.Message)

func (*DeploymentMigration_DeploymentSpec) XXX_Size added in v0.85.0 

func (m *DeploymentMigration_DeploymentSpec) XXX_Size() int

func (*DeploymentMigration_DeploymentSpec) XXX_Unmarshal added in v0.85.0 

func (m *DeploymentMigration_DeploymentSpec) XXX_Unmarshal(b []byte) error

type DeploymentMigration_Status added in v0.85.0 

type DeploymentMigration_Status struct {
	// The current phase of the migration.
	// This will contain only one of the following values:
	// - SourceBackupInProgress:                Creation of backup of source deployment is in progress.
	// - TargetDeploymentCreationInProgress:    Creation of target deployment is in progress.
	// - TargetDeploymentModelChangeInProgress: The model of the target deployment is being updated.
	// - Error:                                 An error has occured during the migration process.
	// - Failed:                                Migration has failed due to errors.
	// - Complete:                              Migration process has completed.
	Phase string `protobuf:"bytes,1,opt,name=phase,proto3" json:"phase,omitempty"`
	// Additional information regarding the status.
	Description string `protobuf:"bytes,2,opt,name=description,proto3" json:"description,omitempty"`
	// Timestamp of when the status was last updated.
	LastUpdatedAt *types.Timestamp `protobuf:"bytes,3,opt,name=last_updated_at,json=lastUpdatedAt,proto3" json:"last_updated_at,omitempty"`
	// ID of the backup at the source deployment.
	// This backup will be used to perform a restore at the target deployment.
	BackupId string `protobuf:"bytes,4,opt,name=backup_id,json=backupId,proto3" json:"backup_id,omitempty"`
	// ID of the target deployment.
	TargetDeploymentId   string   `protobuf:"bytes,5,opt,name=target_deployment_id,json=targetDeploymentId,proto3" json:"target_deployment_id,omitempty"`
	XXX_NoUnkeyedLiteral struct{} `json:"-"`
	XXX_unrecognized     []byte   `json:"-"`
	XXX_sizecache        int32    `json:"-"`
}

Status of the DeploymentMigration.

func (*DeploymentMigration_Status) Descriptor added in v0.85.0 

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

func (*DeploymentMigration_Status) Equals added in v0.85.0 

func (source *DeploymentMigration_Status) Equals(other *DeploymentMigration_Status) bool

Equals returns true when source and other have the same values.

func (*DeploymentMigration_Status) GetBackupId added in v0.85.0 

func (m *DeploymentMigration_Status) GetBackupId() string

func (*DeploymentMigration_Status) GetDescription added in v0.85.0 

func (m *DeploymentMigration_Status) GetDescription() string

func (*DeploymentMigration_Status) GetLastUpdatedAt added in v0.85.0 

func (m *DeploymentMigration_Status) GetLastUpdatedAt() *types.Timestamp

func (*DeploymentMigration_Status) GetPhase added in v0.85.0 

func (m *DeploymentMigration_Status) GetPhase() string

func (*DeploymentMigration_Status) GetTargetDeploymentId added in v0.85.0 

func (m *DeploymentMigration_Status) GetTargetDeploymentId() string

func (*DeploymentMigration_Status) Marshal added in v0.85.0 

func (m *DeploymentMigration_Status) Marshal() (dAtA []byte, err error)

func (*DeploymentMigration_Status) MarshalTo added in v0.85.0 

func (m *DeploymentMigration_Status) MarshalTo(dAtA []byte) (int, error)

func (*DeploymentMigration_Status) MarshalToSizedBuffer added in v0.85.0 

func (m *DeploymentMigration_Status) MarshalToSizedBuffer(dAtA []byte) (int, error)

func (*DeploymentMigration_Status) ProtoMessage added in v0.85.0 

func (*DeploymentMigration_Status) ProtoMessage()

func (*DeploymentMigration_Status) Reset added in v0.85.0 

func (m *DeploymentMigration_Status) Reset()

func (*DeploymentMigration_Status) Size added in v0.85.0 

func (m *DeploymentMigration_Status) Size() (n int)

func (*DeploymentMigration_Status) String added in v0.85.0 

func (m *DeploymentMigration_Status) String() string

func (*DeploymentMigration_Status) Unmarshal added in v0.85.0 

func (m *DeploymentMigration_Status) Unmarshal(dAtA []byte) error

func (*DeploymentMigration_Status) XXX_DiscardUnknown added in v0.85.0 

func (m *DeploymentMigration_Status) XXX_DiscardUnknown()

func (*DeploymentMigration_Status) XXX_Marshal added in v0.85.0 

func (m *DeploymentMigration_Status) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*DeploymentMigration_Status) XXX_Merge added in v0.85.0 

func (m *DeploymentMigration_Status) XXX_Merge(src proto.Message)

func (*DeploymentMigration_Status) XXX_Size added in v0.85.0 

func (m *DeploymentMigration_Status) XXX_Size() int

func (*DeploymentMigration_Status) XXX_Unmarshal added in v0.85.0 

func (m *DeploymentMigration_Status) XXX_Unmarshal(b []byte) error

type DeploymentReplication added in v0.75.0 

type DeploymentReplication struct {
	// Identifier of the deployment for a given DeploymentReplication
	DeploymentId string `protobuf:"bytes,1,opt,name=deployment_id,json=deploymentId,proto3" json:"deployment_id,omitempty"`
	// Start the replication process for the given deployment.
	Started bool `protobuf:"varint,2,opt,name=started,proto3" json:"started,omitempty"`
	// A PEM encoded representation of the public key of the CA certificate used to verify sync master in source deployment.
	CertificatePem string `protobuf:"bytes,3,opt,name=certificate_pem,json=certificatePem,proto3" json:"certificate_pem,omitempty"`
	// A PEM encoded representation of the keyfile used for client authentication of the sync master (with the sync master in the source deployment).
	// A keyfile contains 1 or more certificates and a private key.
	TlsKeyfile string `protobuf:"bytes,4,opt,name=tls_keyfile,json=tlsKeyfile,proto3" json:"tls_keyfile,omitempty"`
	// Identifier of the user that initiated this deployment replication.
	// This is a read-only value.
	StartedById string `protobuf:"bytes,5,opt,name=started_by_id,json=startedById,proto3" json:"started_by_id,omitempty"`
	// CancelationOptions describes what to do during cancellation process of the migration-agent.
	CancelationOptions *DeploymentReplication_CancelationOptions `protobuf:"bytes,10,opt,name=cancelation_options,json=cancelationOptions,proto3" json:"cancelation_options,omitempty"`
	// Status of the DeploymentReplication.
	Status               *DeploymentReplication_Status `protobuf:"bytes,100,opt,name=status,proto3" json:"status,omitempty"`
	XXX_NoUnkeyedLiteral struct{}                      `json:"-"`
	XXX_unrecognized     []byte                        `json:"-"`
	XXX_sizecache        int32                         `json:"-"`
}

DeploymentReplication defines a request object for creating or updating a deployment replication

func (*DeploymentReplication) Descriptor added in v0.75.0 

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

func (*DeploymentReplication) GetCancelationOptions added in v0.77.11 

func (m *DeploymentReplication) GetCancelationOptions() *DeploymentReplication_CancelationOptions

func (*DeploymentReplication) GetCertificatePem added in v0.75.0 

func (m *DeploymentReplication) GetCertificatePem() string

func (*DeploymentReplication) GetDeploymentId added in v0.75.0 

func (m *DeploymentReplication) GetDeploymentId() string

func (*DeploymentReplication) GetStarted added in v0.75.0 

func (m *DeploymentReplication) GetStarted() bool

func (*DeploymentReplication) GetStartedById added in v0.79.21 

func (m *DeploymentReplication) GetStartedById() string

func (*DeploymentReplication) GetStatus added in v0.75.0 

func (m *DeploymentReplication) GetStatus() *DeploymentReplication_Status

func (*DeploymentReplication) GetTlsKeyfile added in v0.75.0 

func (m *DeploymentReplication) GetTlsKeyfile() string

func (*DeploymentReplication) Marshal added in v0.75.0 

func (m *DeploymentReplication) Marshal() (dAtA []byte, err error)

func (*DeploymentReplication) MarshalTo added in v0.75.0 

func (m *DeploymentReplication) MarshalTo(dAtA []byte) (int, error)

func (*DeploymentReplication) MarshalToSizedBuffer added in v0.75.0 

func (m *DeploymentReplication) MarshalToSizedBuffer(dAtA []byte) (int, error)

func (*DeploymentReplication) ProtoMessage added in v0.75.0 

func (*DeploymentReplication) ProtoMessage()

func (*DeploymentReplication) Reset added in v0.75.0 

func (m *DeploymentReplication) Reset()

func (*DeploymentReplication) Size added in v0.75.0 

func (m *DeploymentReplication) Size() (n int)

func (*DeploymentReplication) String added in v0.75.0 

func (m *DeploymentReplication) String() string

func (*DeploymentReplication) Unmarshal added in v0.75.0 

func (m *DeploymentReplication) Unmarshal(dAtA []byte) error

func (*DeploymentReplication) XXX_DiscardUnknown added in v0.75.0 

func (m *DeploymentReplication) XXX_DiscardUnknown()

func (*DeploymentReplication) XXX_Marshal added in v0.75.0 

func (m *DeploymentReplication) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*DeploymentReplication) XXX_Merge added in v0.75.0 

func (m *DeploymentReplication) XXX_Merge(src proto.Message)

func (*DeploymentReplication) XXX_Size added in v0.75.0 

func (m *DeploymentReplication) XXX_Size() int

func (*DeploymentReplication) XXX_Unmarshal added in v0.75.0 

func (m *DeploymentReplication) XXX_Unmarshal(b []byte) error

type DeploymentReplication_CancelationOptions added in v0.77.11 

type DeploymentReplication_CancelationOptions struct {
	// If set, during cancellation process data consistency is not required (otherwise data consistency is required).
	DataConsistencyNotRequired bool `` /* 144-byte string literal not displayed */
	// If set, after cancellation the source deployment will be in read-only mode.
	MakeSourceDeploymentReadOnly bool     `` /* 152-byte string literal not displayed */
	XXX_NoUnkeyedLiteral         struct{} `json:"-"`
	XXX_unrecognized             []byte   `json:"-"`
	XXX_sizecache                int32    `json:"-"`
}

CancelationOptions describes what to do during cancellation process of the migration-agent.

func (*DeploymentReplication_CancelationOptions) Descriptor added in v0.77.11 

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

func (*DeploymentReplication_CancelationOptions) GetDataConsistencyNotRequired added in v0.77.11 

func (m *DeploymentReplication_CancelationOptions) GetDataConsistencyNotRequired() bool

func (*DeploymentReplication_CancelationOptions) GetMakeSourceDeploymentReadOnly added in v0.77.11 

func (m *DeploymentReplication_CancelationOptions) GetMakeSourceDeploymentReadOnly() bool

func (*DeploymentReplication_CancelationOptions) Marshal added in v0.77.11 

func (m *DeploymentReplication_CancelationOptions) Marshal() (dAtA []byte, err error)

func (*DeploymentReplication_CancelationOptions) MarshalTo added in v0.77.11 

func (m *DeploymentReplication_CancelationOptions) MarshalTo(dAtA []byte) (int, error)

func (*DeploymentReplication_CancelationOptions) MarshalToSizedBuffer added in v0.77.11 

func (m *DeploymentReplication_CancelationOptions) MarshalToSizedBuffer(dAtA []byte) (int, error)

func (*DeploymentReplication_CancelationOptions) ProtoMessage added in v0.77.11 

func (*DeploymentReplication_CancelationOptions) ProtoMessage()

func (*DeploymentReplication_CancelationOptions) Reset added in v0.77.11 

func (m *DeploymentReplication_CancelationOptions) Reset()

func (*DeploymentReplication_CancelationOptions) Size added in v0.77.11 

func (m *DeploymentReplication_CancelationOptions) Size() (n int)

func (*DeploymentReplication_CancelationOptions) String added in v0.77.11 

func (m *DeploymentReplication_CancelationOptions) String() string

func (*DeploymentReplication_CancelationOptions) Unmarshal added in v0.77.11 

func (m *DeploymentReplication_CancelationOptions) Unmarshal(dAtA []byte) error

func (*DeploymentReplication_CancelationOptions) XXX_DiscardUnknown added in v0.77.11 

func (m *DeploymentReplication_CancelationOptions) XXX_DiscardUnknown()

func (*DeploymentReplication_CancelationOptions) XXX_Marshal added in v0.77.11 

func (m *DeploymentReplication_CancelationOptions) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*DeploymentReplication_CancelationOptions) XXX_Merge added in v0.77.11 

func (m *DeploymentReplication_CancelationOptions) XXX_Merge(src proto.Message)

func (*DeploymentReplication_CancelationOptions) XXX_Size added in v0.77.11 

func (m *DeploymentReplication_CancelationOptions) XXX_Size() int

func (*DeploymentReplication_CancelationOptions) XXX_Unmarshal added in v0.77.11 

func (m *DeploymentReplication_CancelationOptions) XXX_Unmarshal(b []byte) error

type DeploymentReplication_Status added in v0.75.0 

type DeploymentReplication_Status struct {
	// Where the deployment replication process is in its lifecycle at any given time.
	// Should only contain only one of the following values:
	// "Initialising"   - Replication has started, waiting for sync masters / workers.
	// "In-Progress"    - Replication has started and currently in progress.
	// "Error"          - Replication is in an errored state.
	// "Failed"         - Replication could not complete successfully.
	// "Stopping"       - Replication is being stopped.
	// "Completed"      - Replication is stopped and all resources cleaned up properly.
	Phase string `protobuf:"bytes,1,opt,name=phase,proto3" json:"phase,omitempty"`
	// Supporting information about the deployment replication phase - such as error messages in case of failures.
	// This field will be in JSON format and can be built using the `AsJSON()` helper.
	// Use `FromJSON()` helper to parse this field.
	// See - replication/v1/message.go in this repository.
	Message string `protobuf:"bytes,2,opt,name=message,proto3" json:"message,omitempty"`
	// Service (LoadBalancer) endpoint of the SyncMasters
	// This field has the format of a URL.
	// This is a readonly field.
	SyncEndpoint string `protobuf:"bytes,5,opt,name=sync_endpoint,json=syncEndpoint,proto3" json:"sync_endpoint,omitempty"`
	// The timestamp of when the Phase of the Deployment Replication was last updated.
	// This is a readonly field.
	PhaseUpdatedAt *types.Timestamp `protobuf:"bytes,6,opt,name=phase_updated_at,json=phaseUpdatedAt,proto3" json:"phase_updated_at,omitempty"`
	// Service (LoadBalancer) endpoint of the Forwarder service which allows to start streaming connection.
	// This field has the format of a URL.
	// This is a readonly field.
	ForwarderEndpoint string `protobuf:"bytes,7,opt,name=forwarder_endpoint,json=forwarderEndpoint,proto3" json:"forwarder_endpoint,omitempty"`
	// Progress of replication in percents (value from 0.0 to 1.0).
	// This is a readonly field.
	Progress             float32  `protobuf:"fixed32,8,opt,name=progress,proto3" json:"progress,omitempty"`
	XXX_NoUnkeyedLiteral struct{} `json:"-"`
	XXX_unrecognized     []byte   `json:"-"`
	XXX_sizecache        int32    `json:"-"`
}

DeploymentReplicationStatus defines the status of a deployment replication. Note: All fields in this message block are read-only.

func (*DeploymentReplication_Status) Descriptor added in v0.75.0 

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

func (*DeploymentReplication_Status) Equals added in v0.75.1 

func (source *DeploymentReplication_Status) Equals(other *DeploymentReplication_Status) bool

Equals returns true when source and other have the same values.

func (*DeploymentReplication_Status) GetForwarderEndpoint added in v0.78.5 

func (m *DeploymentReplication_Status) GetForwarderEndpoint() string

func (*DeploymentReplication_Status) GetMessage added in v0.75.0 

func (m *DeploymentReplication_Status) GetMessage() string

func (*DeploymentReplication_Status) GetPhase added in v0.75.0 

func (m *DeploymentReplication_Status) GetPhase() string

func (*DeploymentReplication_Status) GetPhaseUpdatedAt added in v0.76.3 

func (m *DeploymentReplication_Status) GetPhaseUpdatedAt() *types.Timestamp

func (*DeploymentReplication_Status) GetProgress added in v0.79.10 

func (m *DeploymentReplication_Status) GetProgress() float32

func (*DeploymentReplication_Status) GetSyncEndpoint added in v0.75.0 

func (m *DeploymentReplication_Status) GetSyncEndpoint() string

func (*DeploymentReplication_Status) Marshal added in v0.75.0 

func (m *DeploymentReplication_Status) Marshal() (dAtA []byte, err error)

func (*DeploymentReplication_Status) MarshalTo added in v0.75.0 

func (m *DeploymentReplication_Status) MarshalTo(dAtA []byte) (int, error)

func (*DeploymentReplication_Status) MarshalToSizedBuffer added in v0.75.0 

func (m *DeploymentReplication_Status) MarshalToSizedBuffer(dAtA []byte) (int, error)

func (*DeploymentReplication_Status) ProtoMessage added in v0.75.0 

func (*DeploymentReplication_Status) ProtoMessage()

func (*DeploymentReplication_Status) Reset added in v0.75.0 

func (m *DeploymentReplication_Status) Reset()

func (*DeploymentReplication_Status) Size added in v0.75.0 

func (m *DeploymentReplication_Status) Size() (n int)

func (*DeploymentReplication_Status) String added in v0.75.0 

func (m *DeploymentReplication_Status) String() string

func (*DeploymentReplication_Status) Unmarshal added in v0.75.0 

func (m *DeploymentReplication_Status) Unmarshal(dAtA []byte) error

func (*DeploymentReplication_Status) XXX_DiscardUnknown added in v0.75.0 

func (m *DeploymentReplication_Status) XXX_DiscardUnknown()

func (*DeploymentReplication_Status) XXX_Marshal added in v0.75.0 

func (m *DeploymentReplication_Status) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*DeploymentReplication_Status) XXX_Merge added in v0.75.0 

func (m *DeploymentReplication_Status) XXX_Merge(src proto.Message)

func (*DeploymentReplication_Status) XXX_Size added in v0.75.0 

func (m *DeploymentReplication_Status) XXX_Size() int

func (*DeploymentReplication_Status) XXX_Unmarshal added in v0.75.0 

func (m *DeploymentReplication_Status) XXX_Unmarshal(b []byte) error

type Message added in v0.76.1 

type Message struct {
	// Reason contains information related to the current state of the migration process
	// or any supporting information related to failures.
	Reason string `json:"reason,omitempty"`
	// DbErrors contains information related to database errors that could occur during the migration process.
	DbErrors string `json:"db_errors,omitempty"`
	// SyncErrors contains information related to errors from the ArangoSync component.
	SyncErrors string `json:"sync_errors,omitempty"`
}

Message holds any additional information that the user must know regarding the replication / migration process.

func NewMessage added in v0.76.1 

func NewMessage(reason, dbErrors, syncErrors string) Message

NewMessage returns a new Message type with the given reason, dbErrors and syncErrors strings.

func (Message) AsJSON added in v0.76.1 

func (m Message) AsJSON() string

AsJSON returns a JSON representation of the `Message` struct.

func (*Message) FromJSON added in v0.76.1 

func (m *Message) FromJSON(msg string) error

FromJSON converts a JSON string representation of `Message`, and decodes it into a `*Message` type.

type ReplicationServiceClient 

type ReplicationServiceClient interface {
	// Get the current API version of this service.
	// Required permissions:
	// - None
	GetAPIVersion(ctx context.Context, in *v1.Empty, opts ...grpc.CallOption) (*v1.Version, error)
	// Takes a backup and creates a deployment from it. For all intents and purposes this new deployment
	// will be the same as the deployment at that exact moment when the backup was taken from it. This means that
	// the new deployment will be in the same project and use the same provider as the old deployment did. Optionally
	// a different region can be provided using the region id field on the request. Furthermore, the new deployment
	// will have the same server settings ( count, mode, replication factor ) as the old deployment did at the time
	// of taking the backup. After the new deployment successfully started, the backup will be used to restore the
	// data into the new deployment. The new deployment will have a different endpoint, and the password will also
	// be reset for it. All other user settings will remain the same.
	// The old deployment will not be touched.
	// Required permissions:
	// if project_id is specified
	// - backup.backup.get on the backup specified by backup_id in request
	// - replication.deployment.clone-from-backup on the project specified in request
	// if project_id is not specified
	// - replication.deployment.clone-from-backup on the backup specified by backup_id
	CloneDeploymentFromBackup(ctx context.Context, in *CloneDeploymentFromBackupRequest, opts ...grpc.CallOption) (*v11.Deployment, error)
	// Get an existing DeploymentReplication using its deployment ID
	// Required permissions:
	// - replication.deploymentreplication.get
	// [Deprecated] This method shouldn't be used anymore, the permission is removed from the system already to prevent usage.
	GetDeploymentReplication(ctx context.Context, in *v1.IDOptions, opts ...grpc.CallOption) (*DeploymentReplication, error)
	// Update an existing DeploymentReplication spec. If does not exist, this will create a new one.
	// This call expects the complete entity with the updated fields.
	// Required permissions:
	// - replication.deploymentreplication.update
	// [Deprecated] This method shouldn't be used anymore, the permission is removed from the system already to prevent usage.
	UpdateDeploymentReplication(ctx context.Context, in *DeploymentReplication, opts ...grpc.CallOption) (*DeploymentReplication, error)
	// Create a new deployment migration.
	// Note: currently migration is supported only for Deployments with 'free' model.
	// Required permissions:
	// - replication.deploymentmigration.create on the specified deployment ID
	CreateDeploymentMigration(ctx context.Context, in *DeploymentMigration, opts ...grpc.CallOption) (*DeploymentMigration, error)
	// Get info about the deployment migration for a deployment identified by the given ID.
	// Required permissions:
	// - replication.deploymentmigration.get on the specified deployment ID
	GetDeploymentMigration(ctx context.Context, in *v1.IDOptions, opts ...grpc.CallOption) (*DeploymentMigration, error)
	// Delete an existing DeploymentMigration.
	// A DeploymentMigration may be deleted only if it is in COMPLETE or FAILED state.
	// Required permissions:
	// - replication.deploymentmigration.delete on the specified deployment ID.
	DeleteDeploymentMigration(ctx context.Context, in *v1.IDOptions, opts ...grpc.CallOption) (*v1.Empty, error)
}

ReplicationServiceClient is the client API for ReplicationService service.

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

func NewReplicationServiceClient 

func NewReplicationServiceClient(cc *grpc.ClientConn) ReplicationServiceClient

type ReplicationServiceServer 

type ReplicationServiceServer interface {
	// Get the current API version of this service.
	// Required permissions:
	// - None
	GetAPIVersion(context.Context, *v1.Empty) (*v1.Version, error)
	// Takes a backup and creates a deployment from it. For all intents and purposes this new deployment
	// will be the same as the deployment at that exact moment when the backup was taken from it. This means that
	// the new deployment will be in the same project and use the same provider as the old deployment did. Optionally
	// a different region can be provided using the region id field on the request. Furthermore, the new deployment
	// will have the same server settings ( count, mode, replication factor ) as the old deployment did at the time
	// of taking the backup. After the new deployment successfully started, the backup will be used to restore the
	// data into the new deployment. The new deployment will have a different endpoint, and the password will also
	// be reset for it. All other user settings will remain the same.
	// The old deployment will not be touched.
	// Required permissions:
	// if project_id is specified
	// - backup.backup.get on the backup specified by backup_id in request
	// - replication.deployment.clone-from-backup on the project specified in request
	// if project_id is not specified
	// - replication.deployment.clone-from-backup on the backup specified by backup_id
	CloneDeploymentFromBackup(context.Context, *CloneDeploymentFromBackupRequest) (*v11.Deployment, error)
	// Get an existing DeploymentReplication using its deployment ID
	// Required permissions:
	// - replication.deploymentreplication.get
	// [Deprecated] This method shouldn't be used anymore, the permission is removed from the system already to prevent usage.
	GetDeploymentReplication(context.Context, *v1.IDOptions) (*DeploymentReplication, error)
	// Update an existing DeploymentReplication spec. If does not exist, this will create a new one.
	// This call expects the complete entity with the updated fields.
	// Required permissions:
	// - replication.deploymentreplication.update
	// [Deprecated] This method shouldn't be used anymore, the permission is removed from the system already to prevent usage.
	UpdateDeploymentReplication(context.Context, *DeploymentReplication) (*DeploymentReplication, error)
	// Create a new deployment migration.
	// Note: currently migration is supported only for Deployments with 'free' model.
	// Required permissions:
	// - replication.deploymentmigration.create on the specified deployment ID
	CreateDeploymentMigration(context.Context, *DeploymentMigration) (*DeploymentMigration, error)
	// Get info about the deployment migration for a deployment identified by the given ID.
	// Required permissions:
	// - replication.deploymentmigration.get on the specified deployment ID
	GetDeploymentMigration(context.Context, *v1.IDOptions) (*DeploymentMigration, error)
	// Delete an existing DeploymentMigration.
	// A DeploymentMigration may be deleted only if it is in COMPLETE or FAILED state.
	// Required permissions:
	// - replication.deploymentmigration.delete on the specified deployment ID.
	DeleteDeploymentMigration(context.Context, *v1.IDOptions) (*v1.Empty, error)
}

ReplicationServiceServer is the server API for ReplicationService service.

type UnimplementedReplicationServiceServer 

type UnimplementedReplicationServiceServer struct {
}

UnimplementedReplicationServiceServer can be embedded to have forward compatible implementations.

func (*UnimplementedReplicationServiceServer) CloneDeploymentFromBackup 

func (*UnimplementedReplicationServiceServer) CloneDeploymentFromBackup(ctx context.Context, req *CloneDeploymentFromBackupRequest) (*v11.Deployment, error)

func (*UnimplementedReplicationServiceServer) CreateDeploymentMigration added in v0.85.0 

func (*UnimplementedReplicationServiceServer) CreateDeploymentMigration(ctx context.Context, req *DeploymentMigration) (*DeploymentMigration, error)

func (*UnimplementedReplicationServiceServer) DeleteDeploymentMigration added in v0.85.0 

func (*UnimplementedReplicationServiceServer) DeleteDeploymentMigration(ctx context.Context, req *v1.IDOptions) (*v1.Empty, error)

func (*UnimplementedReplicationServiceServer) GetAPIVersion 

func (*UnimplementedReplicationServiceServer) GetAPIVersion(ctx context.Context, req *v1.Empty) (*v1.Version, error)

func (*UnimplementedReplicationServiceServer) GetDeploymentMigration added in v0.85.0 

func (*UnimplementedReplicationServiceServer) GetDeploymentMigration(ctx context.Context, req *v1.IDOptions) (*DeploymentMigration, error)

func (*UnimplementedReplicationServiceServer) GetDeploymentReplication added in v0.75.0 

func (*UnimplementedReplicationServiceServer) GetDeploymentReplication(ctx context.Context, req *v1.IDOptions) (*DeploymentReplication, error)

func (*UnimplementedReplicationServiceServer) UpdateDeploymentReplication added in v0.75.0 

func (*UnimplementedReplicationServiceServer) UpdateDeploymentReplication(ctx context.Context, req *DeploymentReplication) (*DeploymentReplication, 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.