rorresources

package
v1.13.2 Latest Latest
Warning

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

 Go to latest Published: Feb 10, 2026 License: Apache-2.0 Imports: 8 Imported by: 1

Documentation

Index

Constants

View Source 
const (
	FilterTypeString     FilterType = "string"
	FilterTypeInt        FilterType = "int"
	FilterTupeIntString  FilterType = "intstring"
	FilterTypeBool       FilterType = "bool"
	FilterTypeTime       FilterType = "time"
	FilterTypeTimeString FilterType = "timestring"

	// FilterOperatorEq is the equal operator.
	// It looks for an exact value.
	FilterOperatorEq FilterOperator = "eq"

	// FilterOperatorNe is the not equal operator.
	// It looks for not exact value.
	FilterOperatorNe FilterOperator = "ne"

	// FilterOperatorRegexp is the regex operator.
	// It searches with regex based search with the Value parameter in the Field parameter.
	FilterOperatorRegexp FilterOperator = "regexp"

	// FilterOperatorGt is the greater than operator.
	// It searches for the value in the Field paramter that is greater than the Value parameter.
	FilterOperatorGt FilterOperator = "gt"

	// FilterOperatorLt is the less than operator.
	// It searches for the value in the Field paramter that is less than the Value parameter.
	FilterOperatorLt FilterOperator = "lt"

	// FilterOperatorGe is the greater or equal operator.
	// It searches for the value in the Field paramter that is greater or equal to the Value parameter.
	FilterOperatorGe FilterOperator = "ge"

	// FilterOperatorLe is the less or equal operator.
	// It searches for the value in the Field paramter that is less or equal to the Value parameter.
	FilterOperatorLe FilterOperator = "le"
)

Variables

This section is empty.

Functions

This section is empty.

Types

type FilterOperator added in v0.3.5 

type FilterOperator string

FilterOperator is the operator in how the search is done.

type FilterType 

type FilterType string

FilterType is the type of the value you're looking for.

type Resource 

type Resource struct {
	rortypes.CommonResource `json:",inline" bson:",inline"`

	NamespaceResource                  *rortypes.ResourceNamespace                  `json:"namespace,omitempty" bson:"namespace,omitempty"`
	NodeResource                       *rortypes.ResourceNode                       `json:"node,omitempty" bson:"node,omitempty"`
	PersistentVolumeClaimResource      *rortypes.ResourcePersistentVolumeClaim      `json:"persistentvolumeclaim,omitempty" bson:"persistentvolumeclaim,omitempty"`
	DeploymentResource                 *rortypes.ResourceDeployment                 `json:"deployment,omitempty" bson:"deployment,omitempty"`
	StorageClassResource               *rortypes.ResourceStorageClass               `json:"storageclass,omitempty" bson:"storageclass,omitempty"`
	PolicyReportResource               *rortypes.ResourcePolicyReport               `json:"policyreport,omitempty" bson:"policyreport,omitempty"`
	ApplicationResource                *rortypes.ResourceApplication                `json:"application,omitempty" bson:"application,omitempty"`
	AppProjectResource                 *rortypes.ResourceAppProject                 `json:"appproject,omitempty" bson:"appproject,omitempty"`
	CertificateResource                *rortypes.ResourceCertificate                `json:"certificate,omitempty" bson:"certificate,omitempty"`
	ServiceResource                    *rortypes.ResourceService                    `json:"service,omitempty" bson:"service,omitempty"`
	PodResource                        *rortypes.ResourcePod                        `json:"pod,omitempty" bson:"pod,omitempty"`
	ReplicaSetResource                 *rortypes.ResourceReplicaSet                 `json:"replicaset,omitempty" bson:"replicaset,omitempty"`
	StatefulSetResource                *rortypes.ResourceStatefulSet                `json:"statefulset,omitempty" bson:"statefulset,omitempty"`
	DaemonSetResource                  *rortypes.ResourceDaemonSet                  `json:"daemonset,omitempty" bson:"daemonset,omitempty"`
	IngressResource                    *rortypes.ResourceIngress                    `json:"ingress,omitempty" bson:"ingress,omitempty"`
	IngressClassResource               *rortypes.ResourceIngressClass               `json:"ingressclass,omitempty" bson:"ingressclass,omitempty"`
	VulnerabilityReportResource        *rortypes.ResourceVulnerabilityReport        `json:"vulnerabilityreport,omitempty" bson:"vulnerabilityreport,omitempty"`
	ExposedSecretReportResource        *rortypes.ResourceExposedSecretReport        `json:"exposedsecretreport,omitempty" bson:"exposedsecretreport,omitempty"`
	ConfigAuditReportResource          *rortypes.ResourceConfigAuditReport          `json:"configauditreport,omitempty" bson:"configauditreport,omitempty"`
	RbacAssessmentReportResource       *rortypes.ResourceRbacAssessmentReport       `json:"rbacassessmentreport,omitempty" bson:"rbacassessmentreport,omitempty"`
	TanzuKubernetesClusterResource     *rortypes.ResourceTanzuKubernetesCluster     `json:"tanzukubernetescluster,omitempty" bson:"tanzukubernetescluster,omitempty"`
	TanzuKubernetesReleaseResource     *rortypes.ResourceTanzuKubernetesRelease     `json:"tanzukubernetesrelease,omitempty" bson:"tanzukubernetesrelease,omitempty"`
	VirtualMachineClassResource        *rortypes.ResourceVirtualMachineClass        `json:"virtualmachineclass,omitempty" bson:"virtualmachineclass,omitempty"`
	KubernetesClusterResource          *rortypes.ResourceKubernetesCluster          `json:"kubernetescluster,omitempty" bson:"kubernetescluster,omitempty"`
	ProviderResource                   *rortypes.ResourceProvider                   `json:"provider,omitempty" bson:"provider,omitempty"`
	WorkspaceResource                  *rortypes.ResourceWorkspace                  `json:"workspace,omitempty" bson:"workspace,omitempty"`
	KubernetesMachineClassResource     *rortypes.ResourceKubernetesMachineClass     `json:"kubernetesmachineclass,omitempty" bson:"kubernetesmachineclass,omitempty"`
	ClusterOrderResource               *rortypes.ResourceClusterOrder               `json:"clusterorder,omitempty" bson:"clusterorder,omitempty"`
	ProjectResource                    *rortypes.ResourceProject                    `json:"project,omitempty" bson:"project,omitempty"`
	ConfigurationResource              *rortypes.ResourceConfiguration              `json:"configuration,omitempty" bson:"configuration,omitempty"`
	ClusterComplianceReportResource    *rortypes.ResourceClusterComplianceReport    `json:"clustercompliancereport,omitempty" bson:"clustercompliancereport,omitempty"`
	ClusterVulnerabilityReportResource *rortypes.ResourceClusterVulnerabilityReport `json:"clustervulnerabilityreport,omitempty" bson:"clustervulnerabilityreport,omitempty"`
	RouteResource                      *rortypes.ResourceRoute                      `json:"route,omitempty" bson:"route,omitempty"`
	SlackMessageResource               *rortypes.ResourceSlackMessage               `json:"slackmessage,omitempty" bson:"slackmessage,omitempty"`
	VulnerabilityEventResource         *rortypes.ResourceVulnerabilityEvent         `json:"vulnerabilityevent,omitempty" bson:"vulnerabilityevent,omitempty"`
	VirtualMachineResource             *rortypes.ResourceVirtualMachine             `json:"virtualmachine,omitempty" bson:"virtualmachine,omitempty"`
	EndpointsResource                  *rortypes.ResourceEndpoints                  `json:"endpoints,omitempty" bson:"endpoints,omitempty"`
	NetworkPolicyResource              *rortypes.ResourceNetworkPolicy              `json:"networkpolicy,omitempty" bson:"networkpolicy,omitempty"`
	DatacenterResource                 *rortypes.ResourceDatacenter                 `json:"datacenter,omitempty" bson:"datacenter,omitempty"`
	BackupJobResource                  *rortypes.ResourceBackupJob                  `json:"backupjob,omitempty" bson:"backupjob,omitempty"`
	BackupRunResource                  *rortypes.ResourceBackupRun                  `json:"backuprun,omitempty" bson:"backuprun,omitempty"`
	UnknownResource                    *rortypes.ResourceUnknown                    `json:"unknown,omitempty" bson:"unknown,omitempty"`
	// contains filtered or unexported fields
}

The Resource struct represents one resource in ror.

It implement common and resource specific methods by providing interfaces to the underlying resources

func NewResourceFromStruct added in v0.3.0 

func NewResourceFromStruct(res Resource) *Resource

func NewRorResource 

func NewRorResource(kind string, apiversion string) *Resource

NewRorResource provides a empty resource of a given kind/apiversion

func (*Resource) AppProject 

func (r *Resource) AppProject() rortypes.AppProjectinterface

AppProject is a wrapper for the underlying resource, it provides a AppProjectinterface to work with appprojects

func (*Resource) Application 

func (r *Resource) Application() rortypes.Applicationinterface

Application is a wrapper for the underlying resource, it provides a Applicationinterface to work with applications

func (*Resource) ApplyInputFilter 

func (r *Resource) ApplyInputFilter() error

func (*Resource) BackupJob added in v1.1.0 

func (r *Resource) BackupJob() rortypes.BackupJobinterface

BackupJob is a wrapper for the underlying resource, it provides a BackupJobinterface to work with backupjobs

func (*Resource) BackupRun added in v1.4.16 

func (r *Resource) BackupRun() rortypes.BackupRuninterface

BackupRun is a wrapper for the underlying resource, it provides a BackupRuninterface to work with backupruns

func (*Resource) Certificate 

func (r *Resource) Certificate() rortypes.Certificateinterface

Certificate is a wrapper for the underlying resource, it provides a Certificateinterface to work with certificates

func (*Resource) ClusterComplianceReport 

func (r *Resource) ClusterComplianceReport() rortypes.ClusterComplianceReportinterface

ClusterComplianceReport is a wrapper for the underlying resource, it provides a ClusterComplianceReportinterface to work with clustercompliancereports

func (*Resource) ClusterOrder 

func (r *Resource) ClusterOrder() rortypes.ClusterOrderinterface

ClusterOrder is a wrapper for the underlying resource, it provides a ClusterOrderinterface to work with clusterorders

func (*Resource) ClusterVulnerabilityReport added in v0.2.3 

func (r *Resource) ClusterVulnerabilityReport() rortypes.ClusterVulnerabilityReportinterface

ClusterVulnerabilityReport is a wrapper for the underlying resource, it provides a ClusterVulnerabilityReportinterface to work with clustervulnerabilityreports

func (*Resource) ConfigAuditReport 

func (r *Resource) ConfigAuditReport() rortypes.ConfigAuditReportinterface

ConfigAuditReport is a wrapper for the underlying resource, it provides a ConfigAuditReportinterface to work with configauditreports

func (*Resource) Configuration 

func (r *Resource) Configuration() rortypes.Configurationinterface

Configuration is a wrapper for the underlying resource, it provides a Configurationinterface to work with configurations

func (*Resource) DaemonSet 

func (r *Resource) DaemonSet() rortypes.DaemonSetinterface

DaemonSet is a wrapper for the underlying resource, it provides a DaemonSetinterface to work with daemonsets

func (*Resource) Datacenter added in v1.1.0 

func (r *Resource) Datacenter() rortypes.Datacenterinterface

Datacenter is a wrapper for the underlying resource, it provides a Datacenterinterface to work with datacenters

func (*Resource) Deployment 

func (r *Resource) Deployment() rortypes.Deploymentinterface

Deployment is a wrapper for the underlying resource, it provides a Deploymentinterface to work with deployments

func (*Resource) Endpoints added in v0.3.11 

func (r *Resource) Endpoints() rortypes.Endpointsinterface

Endpoints is a wrapper for the underlying resource, it provides a Endpointsinterface to work with endpoints

func (*Resource) ExposedSecretReport 

func (r *Resource) ExposedSecretReport() rortypes.ExposedSecretReportinterface

ExposedSecretReport is a wrapper for the underlying resource, it provides a ExposedSecretReportinterface to work with exposedsecretreports

func (*Resource) GenRorHash added in v0.3.0 

func (r *Resource) GenRorHash()

(r *Resource) GenRorHash() calculates the hash of the resource and set the metadata header

func (*Resource) GetRorHash 

func (r *Resource) GetRorHash() string

(r *Resource) GetRorHash() returns the hash from the common interface

func (*Resource) Ingress 

func (r *Resource) Ingress() rortypes.Ingressinterface

Ingress is a wrapper for the underlying resource, it provides a Ingressinterface to work with ingresses

func (*Resource) IngressClass 

func (r *Resource) IngressClass() rortypes.IngressClassinterface

IngressClass is a wrapper for the underlying resource, it provides a IngressClassinterface to work with ingressclasses

func (*Resource) KubernetesCluster 

func (r *Resource) KubernetesCluster() rortypes.KubernetesClusterinterface

KubernetesCluster is a wrapper for the underlying resource, it provides a KubernetesClusterinterface to work with kubernetesclusters

func (*Resource) KubernetesMachineClass added in v1.2.0 

func (r *Resource) KubernetesMachineClass() rortypes.KubernetesMachineClassinterface

KubernetesMachineClass is a wrapper for the underlying resource, it provides a KubernetesMachineClassinterface to work with Kubernetesmachineclasses

func (*Resource) Namespace 

func (r *Resource) Namespace() rortypes.Namespaceinterface

Namespace is a wrapper for the underlying resource, it provides a Namespaceinterface to work with namespaces

func (*Resource) NetworkPolicy added in v0.3.11 

func (r *Resource) NetworkPolicy() rortypes.NetworkPolicyinterface

NetworkPolicy is a wrapper for the underlying resource, it provides a NetworkPolicyinterface to work with networkpolicies

func (*Resource) Node 

func (r *Resource) Node() rortypes.Nodeinterface

Node is a wrapper for the underlying resource, it provides a Nodeinterface to work with nodes

func (*Resource) PersistentVolumeClaim 

func (r *Resource) PersistentVolumeClaim() rortypes.PersistentVolumeClaiminterface

PersistentVolumeClaim is a wrapper for the underlying resource, it provides a PersistentVolumeClaiminterface to work with persistentvolumeclaims

func (*Resource) Pod 

func (r *Resource) Pod() rortypes.Podinterface

Pod is a wrapper for the underlying resource, it provides a Podinterface to work with pods

func (*Resource) PolicyReport 

func (r *Resource) PolicyReport() rortypes.PolicyReportinterface

PolicyReport is a wrapper for the underlying resource, it provides a PolicyReportinterface to work with policyreports

func (*Resource) Project 

func (r *Resource) Project() rortypes.Projectinterface

Project is a wrapper for the underlying resource, it provides a Projectinterface to work with projects

func (*Resource) Provider added in v1.2.0 

func (r *Resource) Provider() rortypes.Providerinterface

Provider is a wrapper for the underlying resource, it provides a Providerinterface to work with providers

func (*Resource) RbacAssessmentReport 

func (r *Resource) RbacAssessmentReport() rortypes.RbacAssessmentReportinterface

RbacAssessmentReport is a wrapper for the underlying resource, it provides a RbacAssessmentReportinterface to work with rbacassessmentreports

func (*Resource) ReplicaSet 

func (r *Resource) ReplicaSet() rortypes.ReplicaSetinterface

ReplicaSet is a wrapper for the underlying resource, it provides a ReplicaSetinterface to work with replicasets

func (*Resource) Route added in v0.2.3 

func (r *Resource) Route() rortypes.Routeinterface

Route is a wrapper for the underlying resource, it provides a Routeinterface to work with routes

func (*Resource) Service 

func (r *Resource) Service() rortypes.Serviceinterface

Service is a wrapper for the underlying resource, it provides a Serviceinterface to work with services

func (*Resource) SetAppProject 

func (r *Resource) SetAppProject(res *rortypes.ResourceAppProject)

func (*Resource) SetApplication 

func (r *Resource) SetApplication(res *rortypes.ResourceApplication)

func (*Resource) SetBackupJob added in v1.1.0 

func (r *Resource) SetBackupJob(res *rortypes.ResourceBackupJob)

func (*Resource) SetBackupRun added in v1.4.16 

func (r *Resource) SetBackupRun(res *rortypes.ResourceBackupRun)

func (*Resource) SetCertificate 

func (r *Resource) SetCertificate(res *rortypes.ResourceCertificate)

func (*Resource) SetClusterComplianceReport 

func (r *Resource) SetClusterComplianceReport(res *rortypes.ResourceClusterComplianceReport)

func (*Resource) SetClusterOrder 

func (r *Resource) SetClusterOrder(res *rortypes.ResourceClusterOrder)

func (*Resource) SetClusterVulnerabilityReport added in v0.2.3 

func (r *Resource) SetClusterVulnerabilityReport(res *rortypes.ResourceClusterVulnerabilityReport)

func (*Resource) SetCommonInterface added in v0.3.0 

func (r *Resource) SetCommonInterface(common rortypes.CommonResourceInterface)

SetCommonInterface sets the common interface of the resource, the common interface implements common methods of the resource

func (*Resource) SetCommonResource added in v0.3.0 

func (r *Resource) SetCommonResource(common rortypes.CommonResource)

SetCommonResource sets the common resource of the resource, the common resource implements common metadata of the resource

func (*Resource) SetConfigAuditReport 

func (r *Resource) SetConfigAuditReport(res *rortypes.ResourceConfigAuditReport)

func (*Resource) SetConfiguration 

func (r *Resource) SetConfiguration(res *rortypes.ResourceConfiguration)

func (*Resource) SetDaemonSet 

func (r *Resource) SetDaemonSet(res *rortypes.ResourceDaemonSet)

func (*Resource) SetDatacenter added in v1.1.0 

func (r *Resource) SetDatacenter(res *rortypes.ResourceDatacenter)

func (*Resource) SetDeployment 

func (r *Resource) SetDeployment(res *rortypes.ResourceDeployment)

func (*Resource) SetEndpoints added in v0.3.11 

func (r *Resource) SetEndpoints(res *rortypes.ResourceEndpoints)

func (*Resource) SetExposedSecretReport 

func (r *Resource) SetExposedSecretReport(res *rortypes.ResourceExposedSecretReport)

func (*Resource) SetIngress 

func (r *Resource) SetIngress(res *rortypes.ResourceIngress)

func (*Resource) SetIngressClass 

func (r *Resource) SetIngressClass(res *rortypes.ResourceIngressClass)

func (*Resource) SetKubernetesCluster 

func (r *Resource) SetKubernetesCluster(res *rortypes.ResourceKubernetesCluster)

func (*Resource) SetKubernetesMachineClass added in v1.2.0 

func (r *Resource) SetKubernetesMachineClass(res *rortypes.ResourceKubernetesMachineClass)

func (*Resource) SetNamespace 

func (r *Resource) SetNamespace(res *rortypes.ResourceNamespace)

func (*Resource) SetNetworkPolicy added in v0.3.11 

func (r *Resource) SetNetworkPolicy(res *rortypes.ResourceNetworkPolicy)

func (*Resource) SetNode 

func (r *Resource) SetNode(res *rortypes.ResourceNode)

func (*Resource) SetPersistentVolumeClaim 

func (r *Resource) SetPersistentVolumeClaim(res *rortypes.ResourcePersistentVolumeClaim)

func (*Resource) SetPod 

func (r *Resource) SetPod(res *rortypes.ResourcePod)

func (*Resource) SetPolicyReport 

func (r *Resource) SetPolicyReport(res *rortypes.ResourcePolicyReport)

func (*Resource) SetProject 

func (r *Resource) SetProject(res *rortypes.ResourceProject)

func (*Resource) SetProvider added in v1.2.0 

func (r *Resource) SetProvider(res *rortypes.ResourceProvider)

func (*Resource) SetRbacAssessmentReport 

func (r *Resource) SetRbacAssessmentReport(res *rortypes.ResourceRbacAssessmentReport)

func (*Resource) SetReplicaSet 

func (r *Resource) SetReplicaSet(res *rortypes.ResourceReplicaSet)

func (*Resource) SetRoute added in v0.2.3 

func (r *Resource) SetRoute(res *rortypes.ResourceRoute)

func (*Resource) SetService 

func (r *Resource) SetService(res *rortypes.ResourceService)

func (*Resource) SetSlackMessage added in v0.2.3 

func (r *Resource) SetSlackMessage(res *rortypes.ResourceSlackMessage)

func (*Resource) SetStatefulSet 

func (r *Resource) SetStatefulSet(res *rortypes.ResourceStatefulSet)

func (*Resource) SetStorageClass 

func (r *Resource) SetStorageClass(res *rortypes.ResourceStorageClass)

func (*Resource) SetTanzuKubernetesCluster 

func (r *Resource) SetTanzuKubernetesCluster(res *rortypes.ResourceTanzuKubernetesCluster)

func (*Resource) SetTanzuKubernetesRelease 

func (r *Resource) SetTanzuKubernetesRelease(res *rortypes.ResourceTanzuKubernetesRelease)

func (*Resource) SetUnknown added in v1.4.1 

func (r *Resource) SetUnknown(res *rortypes.ResourceUnknown)

func (*Resource) SetVirtualMachine added in v0.3.11 

func (r *Resource) SetVirtualMachine(res *rortypes.ResourceVirtualMachine)

func (*Resource) SetVirtualMachineClass 

func (r *Resource) SetVirtualMachineClass(res *rortypes.ResourceVirtualMachineClass)

func (*Resource) SetVulnerabilityEvent added in v0.3.10 

func (r *Resource) SetVulnerabilityEvent(res *rortypes.ResourceVulnerabilityEvent)

func (*Resource) SetVulnerabilityReport 

func (r *Resource) SetVulnerabilityReport(res *rortypes.ResourceVulnerabilityReport)

func (*Resource) SetWorkspace added in v1.2.0 

func (r *Resource) SetWorkspace(res *rortypes.ResourceWorkspace)

func (*Resource) SlackMessage added in v0.2.3 

func (r *Resource) SlackMessage() rortypes.SlackMessageinterface

SlackMessage is a wrapper for the underlying resource, it provides a SlackMessageinterface to work with slackmessages

func (*Resource) StatefulSet 

func (r *Resource) StatefulSet() rortypes.StatefulSetinterface

StatefulSet is a wrapper for the underlying resource, it provides a StatefulSetinterface to work with statefulsets

func (*Resource) StorageClass 

func (r *Resource) StorageClass() rortypes.StorageClassinterface

StorageClass is a wrapper for the underlying resource, it provides a StorageClassinterface to work with storageclasses

func (*Resource) TanzuKubernetesCluster 

func (r *Resource) TanzuKubernetesCluster() rortypes.TanzuKubernetesClusterinterface

TanzuKubernetesCluster is a wrapper for the underlying resource, it provides a TanzuKubernetesClusterinterface to work with tanzukubernetesclusters

func (*Resource) TanzuKubernetesRelease 

func (r *Resource) TanzuKubernetesRelease() rortypes.TanzuKubernetesReleaseinterface

TanzuKubernetesRelease is a wrapper for the underlying resource, it provides a TanzuKubernetesReleaseinterface to work with tanzukubernetesreleases

func (*Resource) Unknown added in v1.4.1 

func (r *Resource) Unknown() rortypes.Unknowninterface

Unknown is a wrapper for the underlying resource, it provides a Unknowninterface to work with unknowns

func (*Resource) VirtualMachine added in v0.3.11 

func (r *Resource) VirtualMachine() rortypes.VirtualMachineinterface

VirtualMachine is a wrapper for the underlying resource, it provides a VirtualMachineinterface to work with VirtualMachines

func (*Resource) VirtualMachineClass 

func (r *Resource) VirtualMachineClass() rortypes.VirtualMachineClassinterface

VirtualMachineClass is a wrapper for the underlying resource, it provides a VirtualMachineClassinterface to work with virtualmachineclasses

func (*Resource) VulnerabilityEvent added in v0.3.10 

func (r *Resource) VulnerabilityEvent() rortypes.VulnerabilityEventinterface

VulnerabilityEvent is a wrapper for the underlying resource, it provides a VulnerabilityEventinterface to work with vulnerabilityevents

func (*Resource) VulnerabilityReport 

func (r *Resource) VulnerabilityReport() rortypes.VulnerabilityReportinterface

VulnerabilityReport is a wrapper for the underlying resource, it provides a VulnerabilityReportinterface to work with vulnerabilityreports

func (*Resource) Workspace added in v1.2.0 

func (r *Resource) Workspace() rortypes.Workspaceinterface

Workspace is a wrapper for the underlying resource, it provides a Workspaceinterface to work with workspaces

type ResourceQuery 

type ResourceQuery struct {
	VersionKind      schema.GroupVersionKind                      `json:"versionkind,omitempty"`      // memory getparam: apiversion, kind
	Uids             []string                                     `json:"uids,omitempty"`             // memory
	OwnerRefs        []rorresourceowner.RorResourceOwnerReference `json:"ownerrefs,omitempty"`        // memory
	Fields           []string                                     `json:"fields,omitempty"`           // post or db
	Order            []ResourceQueryOrder                         `json:"order,omitempty"`            // post or db
	Filters          []ResourceQueryFilter                        `json:"filters,omitempty"`          // db
	Offset           int                                          `json:"offset,omitempty"`           // post or db
	Limit            int                                          `json:"limit,omitempty"`            // post or db
	RelatedResources []ResourceQuery                              `json:"relatedresources,omitempty"` // memory or db
}

func NewResourceQuery added in v0.3.0 

func NewResourceQuery() *ResourceQuery

func (ResourceQuery) GetOrderSorted added in v0.3.0 

func (rq ResourceQuery) GetOrderSorted() []ResourceQueryOrder

func (*ResourceQuery) SetLimit added in v1.0.0 

func (rq *ResourceQuery) SetLimit(limit int) *ResourceQuery

func (*ResourceQuery) WithUID added in v0.3.0 

func (rq *ResourceQuery) WithUID(uid string) *ResourceQuery

type ResourceQueryFilter 

type ResourceQueryFilter struct {

	// Field parameter starts based on the base of the object from the database view.
	// This parameter is case sensitive.
	Field string `json:"field,omitempty"`

	// Value parameter is the value you're searching with based on which Operator you use.
	// This parameter is case sensitive.
	Value    string         `json:"value,omitempty"`
	Type     FilterType     `json:"type,omitempty"`
	Operator FilterOperator `json:"operator,omitempty"`
}

ResourceQueryFilter is a definition of a filter.

For a truncated example resource: 

{
    _id: ObjectId('68d3daefc30906fc9314d1d5'),
    uid: '6035f8f2-eb39-56c0-a5dc-0bc1c3d3ff07',
    backuprun: {
        id: '16835:1758207900971270',
        status: {
            backupjobid: '4923908281402464:1614676439887:16835',
            backuptargets: [
                {
                    name: 'something-name',
                    id: '706',
                    externalid: '503f1b69-7998-b7bb-5cc2-56297656e04d',
                }
            ]
        },
    },
    metadata: {
        uid: '6035f8f2-eb39-56c0-a5dc-0bc1c3d3ff07',
        creationtimestamp: {
            time: ISODate('0001-01-01T00:00:00.000Z')
        },
    },
    typemeta: {
        kind: 'BackupRun',
        apiversion: 'backup.ror.internal/v1alpha1'
    }
}

Exmaple of a query based on a field within the object: 

filter := rorresources.ResourceQueryFilter{
        Field:    "backupjob.status.id",
        Value:    "16835:1758207900971270",
        Type:     rorresources.FilterTypeString,
        Operator: rorresources.FilterOperatorEq,
}

Exmaple of a query based on a field within the metadata: 

filter := rorresources.ResourceQueryFilter{
        Field:    "metadata.uid",
        Value:    "6035f8f2-eb39-56c0-a5dc-0bc1c3d3ff07",
        Type:     rorresources.FilterTypeString,
        Operator: rorresources.FilterOperatorEq,
}.

type ResourceQueryOrder 

type ResourceQueryOrder struct {
	Field      string `json:"field,omitempty"`
	Descending bool   `json:"descending,omitempty"`
	Index      int    `json:"index,omitempty"`
}

type ResourceSet 

type ResourceSet struct {
	Resources []*Resource `json:"resources,omitempty"`
	// contains filtered or unexported fields
}

ResourceSet is the common way to present one or more resources in ror.

func NewResourceSet 

func NewResourceSet() *ResourceSet

func NewResourceSetFromStruct 

func NewResourceSetFromStruct(in ResourceSet) *ResourceSet

NewResourceSetFromStruct creates a new ResourceSet from a struct of the type ResourceSet the function restores common methods after transit eg by json.

func (*ResourceSet) Add 

func (r *ResourceSet) Add(add *Resource)

Add adds a resource to the ResourceSet If resource already exists it will be replaced.

func (*ResourceSet) DeleteByUid 

func (r *ResourceSet) DeleteByUid(search string)

Function to delete resource by uid.

func (*ResourceSet) FilterByAPIVersionKind 

func (r *ResourceSet) FilterByAPIVersionKind(apiVersion string, kind string) *ResourceSet

FilterByAPIVersionKind returns a ResourceSet filtered by apiversion and kind.

func (*ResourceSet) FilterByLabels 

func (r *ResourceSet) FilterByLabels(search map[string]string) *ResourceSet

FilterByLabels returns a ResourceSet filtered by label.

func (*ResourceSet) FilterByOwnerReference 

func (r *ResourceSet) FilterByOwnerReference(ownerRef rorresourceowner.RorResourceOwnerReference) *ResourceSet

FilterByOwnerReference returns a ResourceSet filtered by ownerreference.

func (*ResourceSet) Get 

func (r *ResourceSet) Get() *Resource

Get returns the value of the current resource. can be used without moving the pointer in case the resourceset only contains one resource.

func (*ResourceSet) GetAll 

func (r *ResourceSet) GetAll() []*Resource

All returns a slice with all resources

func (*ResourceSet) GetByName 

func (r *ResourceSet) GetByName(search string) *Resource

Function to return resource by name.

func (*ResourceSet) GetByUid 

func (r *ResourceSet) GetByUid(search string) *Resource

Function to return resource by uid.

func (*ResourceSet) GetQuery added in v0.2.6 

func (rs *ResourceSet) GetQuery() *ResourceQuery

func (*ResourceSet) Len 

func (r *ResourceSet) Len() int

Len returns the number of resources in the ResourceSetr

func (*ResourceSet) Next 

func (r *ResourceSet) Next() bool

Next moves the cursor along, use Get() to fetch the value eg: 

    for resourceSet.Next(){
	     stringhelper.PrettyprintStruct(resourceSet.Get())
    }

func (*ResourceSet) SetQuery added in v0.2.6 

func (rs *ResourceSet) SetQuery(query *ResourceQuery)

func (*ResourceSet) ToJson 

func (r *ResourceSet) ToJson() ([]byte, error)

type ResourceUpdateResult 

type ResourceUpdateResult struct {
	Status  int    `json:"status,omitempty"`
	Message string `json:"message,omitempty"`
}

type ResourceUpdateResults 

type ResourceUpdateResults struct {
	Results map[string]ResourceUpdateResult `json:"results,omitempty"`
}

func (*ResourceUpdateResults) GetFailedResources 

func (r *ResourceUpdateResults) GetFailedResources() map[string]ResourceUpdateResult

FailedResources is a method to return a list of failed resources.

Source Files

View all Source files

Directories

Path Synopsis
The package provides the models and variables needed to generate code and endpoints for the implemented rorresources
 The package provides the models and variables needed to generate code and endpoints for the implemented rorresources
package delivers apicontracts for resources
 package delivers apicontracts for resources

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.