v1

package
v0.79.29 Latest Latest
Warning

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

 Go to latest Published: Aug 22, 2023 License: Apache-2.0 Imports: 21 Imported by: 0

Documentation

Overview

Package prepaid/v1 contains the API of prepaid deployments.

Package v1 is a reverse proxy.

It translates gRPC into RESTful JSON APIs.

Index

Constants

View Source 
const (

	// PermissionPrepaidDeploymentList is required to list organizations PrepaidDeployments
	PermissionPrepaidDeploymentList = "prepaid.prepaiddeployment.list"

	// PermissionPrepaidDeploymentGet is required to get PrepaidDeployment by it's id
	PermissionPrepaidDeploymentGet = "prepaid.prepaiddeployment.get"
)
View Source 
const (
	// APIID contains identifier of this API
	APIID = "prepaid/v1"
	// APIMajorVersion contains major version of this API
	APIMajorVersion = 0
	// APIMinorVersion contains minor version of this API
	APIMinorVersion = 1
	// APIPatchVersion contains patch version of this API
	APIPatchVersion = 0
)
View Source 
const (
	// KindPrepaidDeployment is a constant for the kind of PrepaidDeployment resources.
	KindPrepaidDeployment = "PrepaidDeployment"
)

Variables

View Source 
var (
	ErrInvalidLengthPrepaid        = fmt.Errorf("proto: negative length found during unmarshaling")
	ErrIntOverflowPrepaid          = fmt.Errorf("proto: integer overflow")
	ErrUnexpectedEndOfGroupPrepaid = fmt.Errorf("proto: unexpected end of group")
)

Functions

func PrepaidDeploymentURL added in v0.66.1 

func PrepaidDeploymentURL(organizationID, prepaidDeploymentID string) string

PrepaidDeploymentURL returns an url for given organization and prepaid deployment

func RegisterPrepaidServiceHandler 

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

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

func RegisterPrepaidServiceHandlerClient 

func RegisterPrepaidServiceHandlerClient(ctx context.Context, mux *runtime.ServeMux, client PrepaidServiceClient) error

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

func RegisterPrepaidServiceHandlerFromEndpoint 

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

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

func RegisterPrepaidServiceHandlerServer 

func RegisterPrepaidServiceHandlerServer(ctx context.Context, mux *runtime.ServeMux, server PrepaidServiceServer) error

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

func RegisterPrepaidServiceServer 

func RegisterPrepaidServiceServer(s *grpc.Server, srv PrepaidServiceServer)

Types

type CloneFromBackupRequest 

type CloneFromBackupRequest struct {
	// Identifier of prepaid deployment
	PrepaidDeploymentId string `protobuf:"bytes,1,opt,name=prepaid_deployment_id,json=prepaidDeploymentId,proto3" json:"prepaid_deployment_id,omitempty"`
	// Identifier of the backup to restore from
	// Backup specification has to match prepaid_deployment specification in order to succeed
	BackupId             string   `protobuf:"bytes,2,opt,name=backup_id,json=backupId,proto3" json:"backup_id,omitempty"`
	XXX_NoUnkeyedLiteral struct{} `json:"-"`
	XXX_unrecognized     []byte   `json:"-"`
	XXX_sizecache        int32    `json:"-"`
}

CloneFromBackupRequest is used to create a new deployment based on PrepaidDeployment with prepaid_deployment_id and restore data from Backup with given backup_id

func (*CloneFromBackupRequest) Descriptor 

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

func (*CloneFromBackupRequest) GetBackupId 

func (m *CloneFromBackupRequest) GetBackupId() string

func (*CloneFromBackupRequest) GetPrepaidDeploymentId 

func (m *CloneFromBackupRequest) GetPrepaidDeploymentId() string

func (*CloneFromBackupRequest) Marshal 

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

func (*CloneFromBackupRequest) MarshalTo 

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

func (*CloneFromBackupRequest) MarshalToSizedBuffer 

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

func (*CloneFromBackupRequest) ProtoMessage 

func (*CloneFromBackupRequest) ProtoMessage()

func (*CloneFromBackupRequest) Reset 

func (m *CloneFromBackupRequest) Reset()

func (*CloneFromBackupRequest) Size 

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

func (*CloneFromBackupRequest) String 

func (m *CloneFromBackupRequest) String() string

func (*CloneFromBackupRequest) Unmarshal 

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

func (*CloneFromBackupRequest) XXX_DiscardUnknown 

func (m *CloneFromBackupRequest) XXX_DiscardUnknown()

func (*CloneFromBackupRequest) XXX_Marshal 

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

func (*CloneFromBackupRequest) XXX_Merge 

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

func (*CloneFromBackupRequest) XXX_Size 

func (m *CloneFromBackupRequest) XXX_Size() int

func (*CloneFromBackupRequest) XXX_Unmarshal 

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

type CreateDeploymentRequest 

type CreateDeploymentRequest struct {
	// Identifier of prepaid deployment to use as a specification and attach the newly created Deployment to
	PrepaidDeploymentId string `protobuf:"bytes,1,opt,name=prepaid_deployment_id,json=prepaidDeploymentId,proto3" json:"prepaid_deployment_id,omitempty"`
	// Identifier of the project that owns the newly created deployment.
	ProjectId string `protobuf:"bytes,2,opt,name=project_id,json=projectId,proto3" json:"project_id,omitempty"`
	// Optional identifier of IP allowlist to use for this deployment.
	IpallowlistId string `protobuf:"bytes,3,opt,name=ipallowlist_id,json=ipallowlistId,proto3" json:"ipallowlist_id,omitempty"`
	// ArangoDB version to use for this deployment.
	Version      string                                   `protobuf:"bytes,4,opt,name=version,proto3" json:"version,omitempty"`
	Certificates *CreateDeploymentRequest_CertificateSpec `protobuf:"bytes,5,opt,name=certificates,proto3" json:"certificates,omitempty"`
	// This field must be set to the identifier of the current Terms&Conditions
	// when creating a deployment from a prepaid deployment.
	// If the tier of the organization does not require a non-empty Terms&Condition
	// identifier, this field may be left empty.
	AcceptedTermsAndConditionsId string `` /* 151-byte string literal not displayed */
	// Determines if deployment is using platform authentication
	IsPlatformAuthenticationEnabled bool     `` /* 159-byte string literal not displayed */
	XXX_NoUnkeyedLiteral            struct{} `json:"-"`
	XXX_unrecognized                []byte   `json:"-"`
	XXX_sizecache                   int32    `json:"-"`
}

CreateDeploymentRequest is used to create a new deployment based on PrepaidDeployment with given prepaid_deployment_id and attach it to this PrepaidDeployment

func (*CreateDeploymentRequest) Descriptor 

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

func (*CreateDeploymentRequest) GetAcceptedTermsAndConditionsId added in v0.70.2 

func (m *CreateDeploymentRequest) GetAcceptedTermsAndConditionsId() string

func (*CreateDeploymentRequest) GetCertificates 

func (m *CreateDeploymentRequest) GetCertificates() *CreateDeploymentRequest_CertificateSpec

func (*CreateDeploymentRequest) GetIpallowlistId 

func (m *CreateDeploymentRequest) GetIpallowlistId() string

func (*CreateDeploymentRequest) GetIsPlatformAuthenticationEnabled added in v0.79.24 

func (m *CreateDeploymentRequest) GetIsPlatformAuthenticationEnabled() bool

func (*CreateDeploymentRequest) GetPrepaidDeploymentId 

func (m *CreateDeploymentRequest) GetPrepaidDeploymentId() string

func (*CreateDeploymentRequest) GetProjectId 

func (m *CreateDeploymentRequest) GetProjectId() string

func (*CreateDeploymentRequest) GetVersion 

func (m *CreateDeploymentRequest) GetVersion() string

func (*CreateDeploymentRequest) Marshal 

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

func (*CreateDeploymentRequest) MarshalTo 

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

func (*CreateDeploymentRequest) MarshalToSizedBuffer 

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

func (*CreateDeploymentRequest) ProtoMessage 

func (*CreateDeploymentRequest) ProtoMessage()

func (*CreateDeploymentRequest) Reset 

func (m *CreateDeploymentRequest) Reset()

func (*CreateDeploymentRequest) Size 

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

func (*CreateDeploymentRequest) String 

func (m *CreateDeploymentRequest) String() string

func (*CreateDeploymentRequest) Unmarshal 

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

func (*CreateDeploymentRequest) XXX_DiscardUnknown 

func (m *CreateDeploymentRequest) XXX_DiscardUnknown()

func (*CreateDeploymentRequest) XXX_Marshal 

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

func (*CreateDeploymentRequest) XXX_Merge 

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

func (*CreateDeploymentRequest) XXX_Size 

func (m *CreateDeploymentRequest) XXX_Size() int

func (*CreateDeploymentRequest) XXX_Unmarshal 

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

type CreateDeploymentRequest_CertificateSpec 

type CreateDeploymentRequest_CertificateSpec struct {
	// Identifier of the CACertificate used to sign TLS certificates for the deployment.
	// If you change this value after the creation of the deployment a complete
	// rotation of the deployment is required, which will result in some downtime.
	CaCertificateId string `protobuf:"bytes,1,opt,name=ca_certificate_id,json=caCertificateId,proto3" json:"ca_certificate_id,omitempty"`
	// Zero or more DNS names to include in the TLS certificate of the deployment.
	AlternateDnsNames    []string `protobuf:"bytes,2,rep,name=alternate_dns_names,json=alternateDnsNames,proto3" json:"alternate_dns_names,omitempty"`
	XXX_NoUnkeyedLiteral struct{} `json:"-"`
	XXX_unrecognized     []byte   `json:"-"`
	XXX_sizecache        int32    `json:"-"`
}

func (*CreateDeploymentRequest_CertificateSpec) Descriptor 

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

func (*CreateDeploymentRequest_CertificateSpec) GetAlternateDnsNames 

func (m *CreateDeploymentRequest_CertificateSpec) GetAlternateDnsNames() []string

func (*CreateDeploymentRequest_CertificateSpec) GetCaCertificateId 

func (m *CreateDeploymentRequest_CertificateSpec) GetCaCertificateId() string

func (*CreateDeploymentRequest_CertificateSpec) Marshal 

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

func (*CreateDeploymentRequest_CertificateSpec) MarshalTo 

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

func (*CreateDeploymentRequest_CertificateSpec) MarshalToSizedBuffer 

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

func (*CreateDeploymentRequest_CertificateSpec) ProtoMessage 

func (*CreateDeploymentRequest_CertificateSpec) ProtoMessage()

func (*CreateDeploymentRequest_CertificateSpec) Reset 

func (m *CreateDeploymentRequest_CertificateSpec) Reset()

func (*CreateDeploymentRequest_CertificateSpec) Size 

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

func (*CreateDeploymentRequest_CertificateSpec) String 

func (m *CreateDeploymentRequest_CertificateSpec) String() string

func (*CreateDeploymentRequest_CertificateSpec) Unmarshal 

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

func (*CreateDeploymentRequest_CertificateSpec) XXX_DiscardUnknown 

func (m *CreateDeploymentRequest_CertificateSpec) XXX_DiscardUnknown()

func (*CreateDeploymentRequest_CertificateSpec) XXX_Marshal 

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

func (*CreateDeploymentRequest_CertificateSpec) XXX_Merge 

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

func (*CreateDeploymentRequest_CertificateSpec) XXX_Size 

func (m *CreateDeploymentRequest_CertificateSpec) XXX_Size() int

func (*CreateDeploymentRequest_CertificateSpec) XXX_Unmarshal 

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

type ListPrepaidDeploymentsRequest 

type ListPrepaidDeploymentsRequest struct {
	// identifier of the organization to get a list of prepaid deployments for
	OrganizationId string `protobuf:"bytes,1,opt,name=organization_id,json=organizationId,proto3" json:"organization_id,omitempty"`
	// common listing options
	Options              *v11.ListOptions `protobuf:"bytes,10,opt,name=options,proto3" json:"options,omitempty"`
	XXX_NoUnkeyedLiteral struct{}         `json:"-"`
	XXX_unrecognized     []byte           `json:"-"`
	XXX_sizecache        int32            `json:"-"`
}

ListPrepaidDeploymentsRequest is used to request a list of PrepaidDeployments for organization with given organization_id

func (*ListPrepaidDeploymentsRequest) Descriptor 

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

func (*ListPrepaidDeploymentsRequest) GetOptions 

func (m *ListPrepaidDeploymentsRequest) GetOptions() *v11.ListOptions

func (*ListPrepaidDeploymentsRequest) GetOrganizationId 

func (m *ListPrepaidDeploymentsRequest) GetOrganizationId() string

func (*ListPrepaidDeploymentsRequest) Marshal 

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

func (*ListPrepaidDeploymentsRequest) MarshalTo 

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

func (*ListPrepaidDeploymentsRequest) MarshalToSizedBuffer 

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

func (*ListPrepaidDeploymentsRequest) ProtoMessage 

func (*ListPrepaidDeploymentsRequest) ProtoMessage()

func (*ListPrepaidDeploymentsRequest) Reset 

func (m *ListPrepaidDeploymentsRequest) Reset()

func (*ListPrepaidDeploymentsRequest) Size 

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

func (*ListPrepaidDeploymentsRequest) String 

func (m *ListPrepaidDeploymentsRequest) String() string

func (*ListPrepaidDeploymentsRequest) Unmarshal 

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

func (*ListPrepaidDeploymentsRequest) XXX_DiscardUnknown 

func (m *ListPrepaidDeploymentsRequest) XXX_DiscardUnknown()

func (*ListPrepaidDeploymentsRequest) XXX_Marshal 

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

func (*ListPrepaidDeploymentsRequest) XXX_Merge 

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

func (*ListPrepaidDeploymentsRequest) XXX_Size 

func (m *ListPrepaidDeploymentsRequest) XXX_Size() int

func (*ListPrepaidDeploymentsRequest) XXX_Unmarshal 

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

type PrepaidDeployment 

type PrepaidDeployment struct {
	// System identifier of the prepaid deployment.
	// This is a read-only value.
	Id string `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"`
	// URL of this resource
	// This is a read-only value.
	Url string `protobuf:"bytes,2,opt,name=url,proto3" json:"url,omitempty"`
	// The name of prepaid deployment, not related to created deployment
	Name string `protobuf:"bytes,3,opt,name=name,proto3" json:"name,omitempty"`
	// An optional description for prepaid deployment, not related to created deployment
	Description string `protobuf:"bytes,4,opt,name=description,proto3" json:"description,omitempty"`
	// Identifier of an organization that owns this prepaid deployment
	OrganizationId string `protobuf:"bytes,5,opt,name=organization_id,json=organizationId,proto3" json:"organization_id,omitempty"`
	// Identifier of the region in which a deployment is going to be created.
	RegionId string `protobuf:"bytes,6,opt,name=region_id,json=regionId,proto3" json:"region_id,omitempty"`
	// The creation timestamp of the prepaid deployment
	CreatedAt *types.Timestamp `protobuf:"bytes,7,opt,name=created_at,json=createdAt,proto3" json:"created_at,omitempty"`
	// The deletion timestamp of the prepaid deployment
	DeletedAt *types.Timestamp `protobuf:"bytes,8,opt,name=deleted_at,json=deletedAt,proto3" json:"deleted_at,omitempty"`
	// Set when this deployment is deleted.
	IsDeleted bool `protobuf:"varint,9,opt,name=is_deleted,json=isDeleted,proto3" json:"is_deleted,omitempty"`
	// Start of the period for which the PrepaidDeployment was purchased
	StartsAt *types.Timestamp `protobuf:"bytes,10,opt,name=starts_at,json=startsAt,proto3" json:"starts_at,omitempty"`
	// End of the period for which the PrepaidDeployment was purchased
	EndsAt *types.Timestamp `protobuf:"bytes,11,opt,name=ends_at,json=endsAt,proto3" json:"ends_at,omitempty"`
	// Set when current time is betweeen starts_at and ends_at
	// This is a read-only value
	IsActive bool `protobuf:"varint,12,opt,name=is_active,json=isActive,proto3" json:"is_active,omitempty"`
	// Identifier of the support plan selected for this prepaid deployment.
	SupportPlanId string `protobuf:"bytes,13,opt,name=support_plan_id,json=supportPlanId,proto3" json:"support_plan_id,omitempty"`
	// Model specification for created deployment
	Model *v1.Deployment_ModelSpec `protobuf:"bytes,102,opt,name=model,proto3" json:"model,omitempty"`
	// Identifies the addons that will be used on the deployment
	Addons []string `protobuf:"bytes,103,rep,name=addons,proto3" json:"addons,omitempty"`
	// Optional identifier of disk performance to use for this deployment.
	DiskPerformanceId    string                    `protobuf:"bytes,104,opt,name=disk_performance_id,json=diskPerformanceId,proto3" json:"disk_performance_id,omitempty"`
	Status               *PrepaidDeployment_Status `protobuf:"bytes,201,opt,name=status,proto3" json:"status,omitempty"`
	XXX_NoUnkeyedLiteral struct{}                  `json:"-"`
	XXX_unrecognized     []byte                    `json:"-"`
	XXX_sizecache        int32                     `json:"-"`
}

A PrepaidDeployment contains all attributes of a future deployment that is already paid for.

func (*PrepaidDeployment) CanDeploymentBeUpgraded added in v0.70.3 

func (pd *PrepaidDeployment) CanDeploymentBeUpgraded(depl *data.Deployment) bool

CanDeploymentBeUpgraded returns whenever the deployment spec differs from PrepaidDeployment specs

func (*PrepaidDeployment) Descriptor 

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

func (*PrepaidDeployment) GetAddons 

func (m *PrepaidDeployment) GetAddons() []string

func (*PrepaidDeployment) GetCreatedAt 

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

func (*PrepaidDeployment) GetDeletedAt 

func (m *PrepaidDeployment) GetDeletedAt() *types.Timestamp

func (*PrepaidDeployment) GetDescription 

func (m *PrepaidDeployment) GetDescription() string

func (*PrepaidDeployment) GetDiskPerformanceId added in v0.74.10 

func (m *PrepaidDeployment) GetDiskPerformanceId() string

func (*PrepaidDeployment) GetEndsAt 

func (m *PrepaidDeployment) GetEndsAt() *types.Timestamp

func (*PrepaidDeployment) GetId 

func (m *PrepaidDeployment) GetId() string

func (*PrepaidDeployment) GetIsActive 

func (m *PrepaidDeployment) GetIsActive() bool

func (*PrepaidDeployment) GetIsDeleted 

func (m *PrepaidDeployment) GetIsDeleted() bool

func (*PrepaidDeployment) GetModel 

func (m *PrepaidDeployment) GetModel() *v1.Deployment_ModelSpec

func (*PrepaidDeployment) GetName 

func (m *PrepaidDeployment) GetName() string

func (*PrepaidDeployment) GetOrganizationId 

func (m *PrepaidDeployment) GetOrganizationId() string

func (*PrepaidDeployment) GetRegionId 

func (m *PrepaidDeployment) GetRegionId() string

func (*PrepaidDeployment) GetStartsAt 

func (m *PrepaidDeployment) GetStartsAt() *types.Timestamp

func (*PrepaidDeployment) GetStatus 

func (m *PrepaidDeployment) GetStatus() *PrepaidDeployment_Status

func (*PrepaidDeployment) GetSupportPlanId 

func (m *PrepaidDeployment) GetSupportPlanId() string

func (*PrepaidDeployment) GetUrl 

func (m *PrepaidDeployment) GetUrl() string

func (*PrepaidDeployment) IsAddonAvailable added in v0.71.0 

func (pd *PrepaidDeployment) IsAddonAvailable(addon string) bool

IsAddonAvailable validates if the provided addon is part of the prepaid deployment

func (*PrepaidDeployment) Marshal 

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

func (*PrepaidDeployment) MarshalTo 

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

func (*PrepaidDeployment) MarshalToSizedBuffer 

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

func (*PrepaidDeployment) ProtoMessage 

func (*PrepaidDeployment) ProtoMessage()

func (*PrepaidDeployment) Reset 

func (m *PrepaidDeployment) Reset()

func (*PrepaidDeployment) Size 

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

func (*PrepaidDeployment) String 

func (m *PrepaidDeployment) String() string

func (*PrepaidDeployment) Unmarshal 

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

func (*PrepaidDeployment) XXX_DiscardUnknown 

func (m *PrepaidDeployment) XXX_DiscardUnknown()

func (*PrepaidDeployment) XXX_Marshal 

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

func (*PrepaidDeployment) XXX_Merge 

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

func (*PrepaidDeployment) XXX_Size 

func (m *PrepaidDeployment) XXX_Size() int

func (*PrepaidDeployment) XXX_Unmarshal 

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

type PrepaidDeploymentList 

type PrepaidDeploymentList struct {
	// prepaid deployment items
	Items                []*PrepaidDeployment `protobuf:"bytes,1,rep,name=items,proto3" json:"items,omitempty"`
	XXX_NoUnkeyedLiteral struct{}             `json:"-"`
	XXX_unrecognized     []byte               `json:"-"`
	XXX_sizecache        int32                `json:"-"`
}

PrepaidDeploymentList contains a list of PrepaidDeployment items

func (*PrepaidDeploymentList) Descriptor 

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

func (*PrepaidDeploymentList) GetItems 

func (m *PrepaidDeploymentList) GetItems() []*PrepaidDeployment

func (*PrepaidDeploymentList) Marshal 

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

func (*PrepaidDeploymentList) MarshalTo 

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

func (*PrepaidDeploymentList) MarshalToSizedBuffer 

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

func (*PrepaidDeploymentList) ProtoMessage 

func (*PrepaidDeploymentList) ProtoMessage()

func (*PrepaidDeploymentList) Reset 

func (m *PrepaidDeploymentList) Reset()

func (*PrepaidDeploymentList) Size 

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

func (*PrepaidDeploymentList) String 

func (m *PrepaidDeploymentList) String() string

func (*PrepaidDeploymentList) Unmarshal 

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

func (*PrepaidDeploymentList) XXX_DiscardUnknown 

func (m *PrepaidDeploymentList) XXX_DiscardUnknown()

func (*PrepaidDeploymentList) XXX_Marshal 

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

func (*PrepaidDeploymentList) XXX_Merge 

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

func (*PrepaidDeploymentList) XXX_Size 

func (m *PrepaidDeploymentList) XXX_Size() int

func (*PrepaidDeploymentList) XXX_Unmarshal 

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

type PrepaidDeployment_Status 

type PrepaidDeployment_Status struct {
	// id of created deployment
	// if there is no deployment associated with this prepaid deployment it's empty
	DeploymentId string `protobuf:"bytes,1,opt,name=deployment_id,json=deploymentId,proto3" json:"deployment_id,omitempty"`
	// timestamp when the deployment was created for or attached to PrepaidDeployment
	AttachedAt *types.Timestamp `protobuf:"bytes,2,opt,name=attached_at,json=attachedAt,proto3" json:"attached_at,omitempty"`
	// timestamp when the deployment was detached from PrepaidDeployment
	DetachedAt *types.Timestamp `protobuf:"bytes,3,opt,name=detached_at,json=detachedAt,proto3" json:"detached_at,omitempty"`
	// url of the given deployment
	DeploymentUrl string `protobuf:"bytes,4,opt,name=deployment_url,json=deploymentUrl,proto3" json:"deployment_url,omitempty"`
	// timestamp of the last warning email
	LastWarningEmailSendAt *types.Timestamp `` /* 133-byte string literal not displayed */
	XXX_NoUnkeyedLiteral   struct{}         `json:"-"`
	XXX_unrecognized       []byte           `json:"-"`
	XXX_sizecache          int32            `json:"-"`
}

Status of the prepaid deployment All members of this field are read-only.

func (*PrepaidDeployment_Status) Descriptor 

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

func (*PrepaidDeployment_Status) GetAttachedAt 

func (m *PrepaidDeployment_Status) GetAttachedAt() *types.Timestamp

func (*PrepaidDeployment_Status) GetDeploymentId 

func (m *PrepaidDeployment_Status) GetDeploymentId() string

func (*PrepaidDeployment_Status) GetDeploymentUrl added in v0.70.5 

func (m *PrepaidDeployment_Status) GetDeploymentUrl() string

func (*PrepaidDeployment_Status) GetDetachedAt 

func (m *PrepaidDeployment_Status) GetDetachedAt() *types.Timestamp

func (*PrepaidDeployment_Status) GetLastWarningEmailSendAt added in v0.70.6 

func (m *PrepaidDeployment_Status) GetLastWarningEmailSendAt() *types.Timestamp

func (*PrepaidDeployment_Status) Marshal 

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

func (*PrepaidDeployment_Status) MarshalTo 

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

func (*PrepaidDeployment_Status) MarshalToSizedBuffer 

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

func (*PrepaidDeployment_Status) ProtoMessage 

func (*PrepaidDeployment_Status) ProtoMessage()

func (*PrepaidDeployment_Status) Reset 

func (m *PrepaidDeployment_Status) Reset()

func (*PrepaidDeployment_Status) Size 

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

func (*PrepaidDeployment_Status) String 

func (m *PrepaidDeployment_Status) String() string

func (*PrepaidDeployment_Status) Unmarshal 

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

func (*PrepaidDeployment_Status) XXX_DiscardUnknown 

func (m *PrepaidDeployment_Status) XXX_DiscardUnknown()

func (*PrepaidDeployment_Status) XXX_Marshal 

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

func (*PrepaidDeployment_Status) XXX_Merge 

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

func (*PrepaidDeployment_Status) XXX_Size 

func (m *PrepaidDeployment_Status) XXX_Size() int

func (*PrepaidDeployment_Status) XXX_Unmarshal 

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

type PrepaidServiceClient 

type PrepaidServiceClient interface {
	// Get the current API version of this service.
	// Required permissions:
	// - None
	GetAPIVersion(ctx context.Context, in *v11.Empty, opts ...grpc.CallOption) (*v11.Version, error)
	// Fetch all prepaid deployments for organization.
	// Required permissions:
	// - prepaid.prepaiddeployment.list on the organization identified by given organization ID
	ListPrepaidDeployments(ctx context.Context, in *ListPrepaidDeploymentsRequest, opts ...grpc.CallOption) (*PrepaidDeploymentList, error)
	// Fetch a deployment by its id.
	// Required permissions:
	// - prepaid.prepaiddeployment.get on the deployment identified by the given ID
	GetPrepaidDeployment(ctx context.Context, in *v11.IDOptions, opts ...grpc.CallOption) (*PrepaidDeployment, error)
	// Creates a new deployment from a prepaid deployment and attached the newly created deployment to the prepaid deployment.
	// Required permissions:
	// - data.deployment.create on the project in which the deployment is going to be created
	// - prepaid.prepaiddeployment.get on the deployment identified by the given prepaid_deployment_id
	CreateDeployment(ctx context.Context, in *CreateDeploymentRequest, opts ...grpc.CallOption) (*v1.Deployment, error)
	// Update the deployment by prepaid deployment's id
	// Required permissions:
	// - data.deployment.update on the deployment attached to the prepaid deployment
	// - prepaid.prepaiddeployment.get on the deployment identified by the given prepaid_deployment_id
	UpdateDeployment(ctx context.Context, in *UpdateDeploymentRequest, opts ...grpc.CallOption) (*v1.Deployment, error)
	// Creates a cloned deployment from a backup and attaches it to the prepaid deployment. This takes the deployment specification from the prepaid deployment, which must match the specification mentioned in the backup.
	// Required permissions:
	// - prepaid.prepaiddeployment.get on the prepaid deployment identified by the given prepaid_deployment_id
	// - replication.deployment.clone-from-backup
	CloneDeploymentFromBackup(ctx context.Context, in *CloneFromBackupRequest, opts ...grpc.CallOption) (*v1.Deployment, error)
}

PrepaidServiceClient is the client API for PrepaidService service.

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

func NewPrepaidServiceClient 

func NewPrepaidServiceClient(cc *grpc.ClientConn) PrepaidServiceClient

type PrepaidServiceServer 

type PrepaidServiceServer interface {
	// Get the current API version of this service.
	// Required permissions:
	// - None
	GetAPIVersion(context.Context, *v11.Empty) (*v11.Version, error)
	// Fetch all prepaid deployments for organization.
	// Required permissions:
	// - prepaid.prepaiddeployment.list on the organization identified by given organization ID
	ListPrepaidDeployments(context.Context, *ListPrepaidDeploymentsRequest) (*PrepaidDeploymentList, error)
	// Fetch a deployment by its id.
	// Required permissions:
	// - prepaid.prepaiddeployment.get on the deployment identified by the given ID
	GetPrepaidDeployment(context.Context, *v11.IDOptions) (*PrepaidDeployment, error)
	// Creates a new deployment from a prepaid deployment and attached the newly created deployment to the prepaid deployment.
	// Required permissions:
	// - data.deployment.create on the project in which the deployment is going to be created
	// - prepaid.prepaiddeployment.get on the deployment identified by the given prepaid_deployment_id
	CreateDeployment(context.Context, *CreateDeploymentRequest) (*v1.Deployment, error)
	// Update the deployment by prepaid deployment's id
	// Required permissions:
	// - data.deployment.update on the deployment attached to the prepaid deployment
	// - prepaid.prepaiddeployment.get on the deployment identified by the given prepaid_deployment_id
	UpdateDeployment(context.Context, *UpdateDeploymentRequest) (*v1.Deployment, error)
	// Creates a cloned deployment from a backup and attaches it to the prepaid deployment. This takes the deployment specification from the prepaid deployment, which must match the specification mentioned in the backup.
	// Required permissions:
	// - prepaid.prepaiddeployment.get on the prepaid deployment identified by the given prepaid_deployment_id
	// - replication.deployment.clone-from-backup
	CloneDeploymentFromBackup(context.Context, *CloneFromBackupRequest) (*v1.Deployment, error)
}

PrepaidServiceServer is the server API for PrepaidService service.

type UnimplementedPrepaidServiceServer 

type UnimplementedPrepaidServiceServer struct {
}

UnimplementedPrepaidServiceServer can be embedded to have forward compatible implementations.

func (*UnimplementedPrepaidServiceServer) CloneDeploymentFromBackup 

func (*UnimplementedPrepaidServiceServer) CloneDeploymentFromBackup(ctx context.Context, req *CloneFromBackupRequest) (*v1.Deployment, error)

func (*UnimplementedPrepaidServiceServer) CreateDeployment 

func (*UnimplementedPrepaidServiceServer) CreateDeployment(ctx context.Context, req *CreateDeploymentRequest) (*v1.Deployment, error)

func (*UnimplementedPrepaidServiceServer) GetAPIVersion 

func (*UnimplementedPrepaidServiceServer) GetAPIVersion(ctx context.Context, req *v11.Empty) (*v11.Version, error)

func (*UnimplementedPrepaidServiceServer) GetPrepaidDeployment 

func (*UnimplementedPrepaidServiceServer) GetPrepaidDeployment(ctx context.Context, req *v11.IDOptions) (*PrepaidDeployment, error)

func (*UnimplementedPrepaidServiceServer) ListPrepaidDeployments 

func (*UnimplementedPrepaidServiceServer) ListPrepaidDeployments(ctx context.Context, req *ListPrepaidDeploymentsRequest) (*PrepaidDeploymentList, error)

func (*UnimplementedPrepaidServiceServer) UpdateDeployment 

func (*UnimplementedPrepaidServiceServer) UpdateDeployment(ctx context.Context, req *UpdateDeploymentRequest) (*v1.Deployment, error)

type UpdateDeploymentRequest 

type UpdateDeploymentRequest struct {
	// Identifier of prepaid deployment
	PrepaidDeploymentId  string   `protobuf:"bytes,1,opt,name=prepaid_deployment_id,json=prepaidDeploymentId,proto3" json:"prepaid_deployment_id,omitempty"`
	XXX_NoUnkeyedLiteral struct{} `json:"-"`
	XXX_unrecognized     []byte   `json:"-"`
	XXX_sizecache        int32    `json:"-"`
}

UpdateDeploymentRequest is used to update deployment attached to PrepaidDeployment with give prepaid_deployment_id

func (*UpdateDeploymentRequest) Descriptor 

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

func (*UpdateDeploymentRequest) GetPrepaidDeploymentId 

func (m *UpdateDeploymentRequest) GetPrepaidDeploymentId() string

func (*UpdateDeploymentRequest) Marshal 

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

func (*UpdateDeploymentRequest) MarshalTo 

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

func (*UpdateDeploymentRequest) MarshalToSizedBuffer 

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

func (*UpdateDeploymentRequest) ProtoMessage 

func (*UpdateDeploymentRequest) ProtoMessage()

func (*UpdateDeploymentRequest) Reset 

func (m *UpdateDeploymentRequest) Reset()

func (*UpdateDeploymentRequest) Size 

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

func (*UpdateDeploymentRequest) String 

func (m *UpdateDeploymentRequest) String() string

func (*UpdateDeploymentRequest) Unmarshal 

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

func (*UpdateDeploymentRequest) XXX_DiscardUnknown 

func (m *UpdateDeploymentRequest) XXX_DiscardUnknown()

func (*UpdateDeploymentRequest) XXX_Marshal 

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

func (*UpdateDeploymentRequest) XXX_Merge 

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

func (*UpdateDeploymentRequest) XXX_Size 

func (m *UpdateDeploymentRequest) XXX_Size() int

func (*UpdateDeploymentRequest) XXX_Unmarshal 

func (m *UpdateDeploymentRequest) XXX_Unmarshal(b []byte) 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.