v1beta1

package
v1.9.2 Latest Latest
Warning

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

Go to latest
Published: Dec 19, 2024 License: Apache-2.0 Imports: 12 Imported by: 1

Documentation

Overview

+kubebuilder:object:generate=true +groupName=containeranalysis.gcp.upbound.io +versionName=v1beta1

Index

Constants

View Source
const (
	CRDGroup   = "containeranalysis.gcp.upbound.io"
	CRDVersion = "v1beta1"
)

Package type metadata.

Variables

View Source
var (
	// CRDGroupVersion is the API Group Version used to register the objects
	CRDGroupVersion = schema.GroupVersion{Group: CRDGroup, Version: CRDVersion}

	// SchemeBuilder is used to add go types to the GroupVersionKind scheme
	SchemeBuilder = &scheme.Builder{GroupVersion: CRDGroupVersion}

	// AddToScheme adds the types in this group-version to the given scheme.
	AddToScheme = SchemeBuilder.AddToScheme
)
View Source
var (
	Note_Kind             = "Note"
	Note_GroupKind        = schema.GroupKind{Group: CRDGroup, Kind: Note_Kind}.String()
	Note_KindAPIVersion   = Note_Kind + "." + CRDGroupVersion.String()
	Note_GroupVersionKind = CRDGroupVersion.WithKind(Note_Kind)
)

Repository type metadata.

Functions

This section is empty.

Types

type AttestationAuthorityInitParameters added in v0.35.0

type AttestationAuthorityInitParameters struct {

	// This submessage provides human-readable hints about the purpose of
	// the AttestationAuthority. Because the name of a Note acts as its
	// resource reference, it is important to disambiguate the canonical
	// name of the Note (which might be a UUID for security purposes)
	// from "readable" names more suitable for debug output. Note that
	// these hints should NOT be used to look up AttestationAuthorities
	// in security sensitive contexts, such as when looking up
	// Attestations to verify.
	// Structure is documented below.
	Hint []HintInitParameters `json:"hint,omitempty" tf:"hint,omitempty"`
}

func (*AttestationAuthorityInitParameters) DeepCopy added in v0.35.0

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new AttestationAuthorityInitParameters.

func (*AttestationAuthorityInitParameters) DeepCopyInto added in v0.35.0

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type AttestationAuthorityObservation

type AttestationAuthorityObservation struct {

	// This submessage provides human-readable hints about the purpose of
	// the AttestationAuthority. Because the name of a Note acts as its
	// resource reference, it is important to disambiguate the canonical
	// name of the Note (which might be a UUID for security purposes)
	// from "readable" names more suitable for debug output. Note that
	// these hints should NOT be used to look up AttestationAuthorities
	// in security sensitive contexts, such as when looking up
	// Attestations to verify.
	// Structure is documented below.
	Hint []HintObservation `json:"hint,omitempty" tf:"hint,omitempty"`
}

func (*AttestationAuthorityObservation) DeepCopy

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new AttestationAuthorityObservation.

func (*AttestationAuthorityObservation) DeepCopyInto

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type AttestationAuthorityParameters

type AttestationAuthorityParameters struct {

	// This submessage provides human-readable hints about the purpose of
	// the AttestationAuthority. Because the name of a Note acts as its
	// resource reference, it is important to disambiguate the canonical
	// name of the Note (which might be a UUID for security purposes)
	// from "readable" names more suitable for debug output. Note that
	// these hints should NOT be used to look up AttestationAuthorities
	// in security sensitive contexts, such as when looking up
	// Attestations to verify.
	// Structure is documented below.
	// +kubebuilder:validation:Optional
	Hint []HintParameters `json:"hint" tf:"hint,omitempty"`
}

func (*AttestationAuthorityParameters) DeepCopy

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new AttestationAuthorityParameters.

func (*AttestationAuthorityParameters) DeepCopyInto

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type HintInitParameters added in v0.35.0

type HintInitParameters struct {

	// The human readable name of this Attestation Authority, for
	// example "qa".
	HumanReadableName *string `json:"humanReadableName,omitempty" tf:"human_readable_name,omitempty"`
}

func (*HintInitParameters) DeepCopy added in v0.35.0

func (in *HintInitParameters) DeepCopy() *HintInitParameters

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new HintInitParameters.

func (*HintInitParameters) DeepCopyInto added in v0.35.0

func (in *HintInitParameters) DeepCopyInto(out *HintInitParameters)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type HintObservation

type HintObservation struct {

	// The human readable name of this Attestation Authority, for
	// example "qa".
	HumanReadableName *string `json:"humanReadableName,omitempty" tf:"human_readable_name,omitempty"`
}

func (*HintObservation) DeepCopy

func (in *HintObservation) DeepCopy() *HintObservation

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new HintObservation.

func (*HintObservation) DeepCopyInto

func (in *HintObservation) DeepCopyInto(out *HintObservation)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type HintParameters

type HintParameters struct {

	// The human readable name of this Attestation Authority, for
	// example "qa".
	// +kubebuilder:validation:Optional
	HumanReadableName *string `json:"humanReadableName" tf:"human_readable_name,omitempty"`
}

func (*HintParameters) DeepCopy

func (in *HintParameters) DeepCopy() *HintParameters

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new HintParameters.

func (*HintParameters) DeepCopyInto

func (in *HintParameters) DeepCopyInto(out *HintParameters)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type Note

type Note struct {
	metav1.TypeMeta   `json:",inline"`
	metav1.ObjectMeta `json:"metadata,omitempty"`
	// +kubebuilder:validation:XValidation:rule="!('*' in self.managementPolicies || 'Create' in self.managementPolicies || 'Update' in self.managementPolicies) || has(self.forProvider.attestationAuthority) || (has(self.initProvider) && has(self.initProvider.attestationAuthority))",message="spec.forProvider.attestationAuthority is a required parameter"
	Spec   NoteSpec   `json:"spec"`
	Status NoteStatus `json:"status,omitempty"`
}

Note is the Schema for the Notes API. A Container Analysis note is a high-level piece of metadata that describes a type of analysis that can be done for a resource. +kubebuilder:printcolumn:name="SYNCED",type="string",JSONPath=".status.conditions[?(@.type=='Synced')].status" +kubebuilder:printcolumn:name="READY",type="string",JSONPath=".status.conditions[?(@.type=='Ready')].status" +kubebuilder:printcolumn:name="EXTERNAL-NAME",type="string",JSONPath=".metadata.annotations.crossplane\\.io/external-name" +kubebuilder:printcolumn:name="AGE",type="date",JSONPath=".metadata.creationTimestamp" +kubebuilder:resource:scope=Cluster,categories={crossplane,managed,gcp}

func (*Note) ConvertFrom added in v1.2.0

func (tr *Note) ConvertFrom(srcRaw conversion.Hub) error

ConvertFrom converts from the hub type to the Note type.

func (*Note) ConvertTo added in v1.2.0

func (tr *Note) ConvertTo(dstRaw conversion.Hub) error

ConvertTo converts this Note to the hub type.

func (*Note) DeepCopy

func (in *Note) DeepCopy() *Note

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Note.

func (*Note) DeepCopyInto

func (in *Note) DeepCopyInto(out *Note)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (*Note) DeepCopyObject

func (in *Note) DeepCopyObject() runtime.Object

DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.

func (*Note) GetCondition

func (mg *Note) GetCondition(ct xpv1.ConditionType) xpv1.Condition

GetCondition of this Note.

func (*Note) GetConnectionDetailsMapping

func (tr *Note) GetConnectionDetailsMapping() map[string]string

GetConnectionDetailsMapping for this Note

func (*Note) GetDeletionPolicy

func (mg *Note) GetDeletionPolicy() xpv1.DeletionPolicy

GetDeletionPolicy of this Note.

func (*Note) GetID

func (tr *Note) GetID() string

GetID returns ID of underlying Terraform resource of this Note

func (*Note) GetInitParameters added in v0.35.0

func (tr *Note) GetInitParameters() (map[string]any, error)

GetInitParameters of this Note

func (*Note) GetManagementPolicies added in v0.35.0

func (mg *Note) GetManagementPolicies() xpv1.ManagementPolicies

GetManagementPolicies of this Note.

func (*Note) GetMergedParameters added in v0.40.0

func (tr *Note) GetMergedParameters(shouldMergeInitProvider bool) (map[string]any, error)

GetInitParameters of this Note

func (*Note) GetObservation

func (tr *Note) GetObservation() (map[string]any, error)

GetObservation of this Note

func (*Note) GetParameters

func (tr *Note) GetParameters() (map[string]any, error)

GetParameters of this Note

func (*Note) GetProviderConfigReference

func (mg *Note) GetProviderConfigReference() *xpv1.Reference

GetProviderConfigReference of this Note.

func (*Note) GetPublishConnectionDetailsTo

func (mg *Note) GetPublishConnectionDetailsTo() *xpv1.PublishConnectionDetailsTo

GetPublishConnectionDetailsTo of this Note.

func (*Note) GetTerraformResourceType

func (mg *Note) GetTerraformResourceType() string

GetTerraformResourceType returns Terraform resource type for this Note

func (*Note) GetTerraformSchemaVersion

func (tr *Note) GetTerraformSchemaVersion() int

GetTerraformSchemaVersion returns the associated Terraform schema version

func (*Note) GetWriteConnectionSecretToReference

func (mg *Note) GetWriteConnectionSecretToReference() *xpv1.SecretReference

GetWriteConnectionSecretToReference of this Note.

func (*Note) LateInitialize

func (tr *Note) LateInitialize(attrs []byte) (bool, error)

LateInitialize this Note using its observed tfState. returns True if there are any spec changes for the resource.

func (*Note) SetConditions

func (mg *Note) SetConditions(c ...xpv1.Condition)

SetConditions of this Note.

func (*Note) SetDeletionPolicy

func (mg *Note) SetDeletionPolicy(r xpv1.DeletionPolicy)

SetDeletionPolicy of this Note.

func (*Note) SetManagementPolicies added in v0.35.0

func (mg *Note) SetManagementPolicies(r xpv1.ManagementPolicies)

SetManagementPolicies of this Note.

func (*Note) SetObservation

func (tr *Note) SetObservation(obs map[string]any) error

SetObservation for this Note

func (*Note) SetParameters

func (tr *Note) SetParameters(params map[string]any) error

SetParameters for this Note

func (*Note) SetProviderConfigReference

func (mg *Note) SetProviderConfigReference(r *xpv1.Reference)

SetProviderConfigReference of this Note.

func (*Note) SetPublishConnectionDetailsTo

func (mg *Note) SetPublishConnectionDetailsTo(r *xpv1.PublishConnectionDetailsTo)

SetPublishConnectionDetailsTo of this Note.

func (*Note) SetWriteConnectionSecretToReference

func (mg *Note) SetWriteConnectionSecretToReference(r *xpv1.SecretReference)

SetWriteConnectionSecretToReference of this Note.

type NoteInitParameters added in v0.35.0

type NoteInitParameters struct {

	// Note kind that represents a logical attestation "role" or "authority".
	// For example, an organization might have one AttestationAuthority for
	// "QA" and one for "build". This Note is intended to act strictly as a
	// grouping mechanism for the attached Occurrences (Attestations). This
	// grouping mechanism also provides a security boundary, since IAM ACLs
	// gate the ability for a principle to attach an Occurrence to a given
	// Note. It also provides a single point of lookup to find all attached
	// Attestation Occurrences, even if they don't all live in the same
	// project.
	// Structure is documented below.
	AttestationAuthority []AttestationAuthorityInitParameters `json:"attestationAuthority,omitempty" tf:"attestation_authority,omitempty"`

	// Time of expiration for this note. Leave empty if note does not expire.
	ExpirationTime *string `json:"expirationTime,omitempty" tf:"expiration_time,omitempty"`

	// A detailed description of the note
	LongDescription *string `json:"longDescription,omitempty" tf:"long_description,omitempty"`

	// The ID of the project in which the resource belongs.
	// If it is not provided, the provider project is used.
	Project *string `json:"project,omitempty" tf:"project,omitempty"`

	// Names of other notes related to this note.
	// +listType=set
	RelatedNoteNames []*string `json:"relatedNoteNames,omitempty" tf:"related_note_names,omitempty"`

	// URLs associated with this note and related metadata.
	// Structure is documented below.
	RelatedURL []RelatedURLInitParameters `json:"relatedUrl,omitempty" tf:"related_url,omitempty"`

	// A one sentence description of the note.
	ShortDescription *string `json:"shortDescription,omitempty" tf:"short_description,omitempty"`
}

func (*NoteInitParameters) DeepCopy added in v0.35.0

func (in *NoteInitParameters) DeepCopy() *NoteInitParameters

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new NoteInitParameters.

func (*NoteInitParameters) DeepCopyInto added in v0.35.0

func (in *NoteInitParameters) DeepCopyInto(out *NoteInitParameters)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type NoteList

type NoteList struct {
	metav1.TypeMeta `json:",inline"`
	metav1.ListMeta `json:"metadata,omitempty"`
	Items           []Note `json:"items"`
}

NoteList contains a list of Notes

func (*NoteList) DeepCopy

func (in *NoteList) DeepCopy() *NoteList

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new NoteList.

func (*NoteList) DeepCopyInto

func (in *NoteList) DeepCopyInto(out *NoteList)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (*NoteList) DeepCopyObject

func (in *NoteList) DeepCopyObject() runtime.Object

DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.

func (*NoteList) GetItems

func (l *NoteList) GetItems() []resource.Managed

GetItems of this NoteList.

type NoteObservation

type NoteObservation struct {

	// Note kind that represents a logical attestation "role" or "authority".
	// For example, an organization might have one AttestationAuthority for
	// "QA" and one for "build". This Note is intended to act strictly as a
	// grouping mechanism for the attached Occurrences (Attestations). This
	// grouping mechanism also provides a security boundary, since IAM ACLs
	// gate the ability for a principle to attach an Occurrence to a given
	// Note. It also provides a single point of lookup to find all attached
	// Attestation Occurrences, even if they don't all live in the same
	// project.
	// Structure is documented below.
	AttestationAuthority []AttestationAuthorityObservation `json:"attestationAuthority,omitempty" tf:"attestation_authority,omitempty"`

	// The time this note was created.
	CreateTime *string `json:"createTime,omitempty" tf:"create_time,omitempty"`

	// Time of expiration for this note. Leave empty if note does not expire.
	ExpirationTime *string `json:"expirationTime,omitempty" tf:"expiration_time,omitempty"`

	// an identifier for the resource with format projects/{{project}}/notes/{{name}}
	ID *string `json:"id,omitempty" tf:"id,omitempty"`

	// The type of analysis this note describes
	Kind *string `json:"kind,omitempty" tf:"kind,omitempty"`

	// A detailed description of the note
	LongDescription *string `json:"longDescription,omitempty" tf:"long_description,omitempty"`

	// The ID of the project in which the resource belongs.
	// If it is not provided, the provider project is used.
	Project *string `json:"project,omitempty" tf:"project,omitempty"`

	// Names of other notes related to this note.
	// +listType=set
	RelatedNoteNames []*string `json:"relatedNoteNames,omitempty" tf:"related_note_names,omitempty"`

	// URLs associated with this note and related metadata.
	// Structure is documented below.
	RelatedURL []RelatedURLObservation `json:"relatedUrl,omitempty" tf:"related_url,omitempty"`

	// A one sentence description of the note.
	ShortDescription *string `json:"shortDescription,omitempty" tf:"short_description,omitempty"`

	// The time this note was last updated.
	UpdateTime *string `json:"updateTime,omitempty" tf:"update_time,omitempty"`
}

func (*NoteObservation) DeepCopy

func (in *NoteObservation) DeepCopy() *NoteObservation

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new NoteObservation.

func (*NoteObservation) DeepCopyInto

func (in *NoteObservation) DeepCopyInto(out *NoteObservation)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type NoteParameters

type NoteParameters struct {

	// Note kind that represents a logical attestation "role" or "authority".
	// For example, an organization might have one AttestationAuthority for
	// "QA" and one for "build". This Note is intended to act strictly as a
	// grouping mechanism for the attached Occurrences (Attestations). This
	// grouping mechanism also provides a security boundary, since IAM ACLs
	// gate the ability for a principle to attach an Occurrence to a given
	// Note. It also provides a single point of lookup to find all attached
	// Attestation Occurrences, even if they don't all live in the same
	// project.
	// Structure is documented below.
	// +kubebuilder:validation:Optional
	AttestationAuthority []AttestationAuthorityParameters `json:"attestationAuthority,omitempty" tf:"attestation_authority,omitempty"`

	// Time of expiration for this note. Leave empty if note does not expire.
	// +kubebuilder:validation:Optional
	ExpirationTime *string `json:"expirationTime,omitempty" tf:"expiration_time,omitempty"`

	// A detailed description of the note
	// +kubebuilder:validation:Optional
	LongDescription *string `json:"longDescription,omitempty" tf:"long_description,omitempty"`

	// The ID of the project in which the resource belongs.
	// If it is not provided, the provider project is used.
	// +kubebuilder:validation:Optional
	Project *string `json:"project,omitempty" tf:"project,omitempty"`

	// Names of other notes related to this note.
	// +kubebuilder:validation:Optional
	// +listType=set
	RelatedNoteNames []*string `json:"relatedNoteNames,omitempty" tf:"related_note_names,omitempty"`

	// URLs associated with this note and related metadata.
	// Structure is documented below.
	// +kubebuilder:validation:Optional
	RelatedURL []RelatedURLParameters `json:"relatedUrl,omitempty" tf:"related_url,omitempty"`

	// A one sentence description of the note.
	// +kubebuilder:validation:Optional
	ShortDescription *string `json:"shortDescription,omitempty" tf:"short_description,omitempty"`
}

func (*NoteParameters) DeepCopy

func (in *NoteParameters) DeepCopy() *NoteParameters

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new NoteParameters.

func (*NoteParameters) DeepCopyInto

func (in *NoteParameters) DeepCopyInto(out *NoteParameters)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type NoteSpec

type NoteSpec struct {
	v1.ResourceSpec `json:",inline"`
	ForProvider     NoteParameters `json:"forProvider"`
	// THIS IS A BETA FIELD. It will be honored
	// unless the Management Policies feature flag is disabled.
	// InitProvider holds the same fields as ForProvider, with the exception
	// of Identifier and other resource reference fields. The fields that are
	// in InitProvider are merged into ForProvider when the resource is created.
	// The same fields are also added to the terraform ignore_changes hook, to
	// avoid updating them after creation. This is useful for fields that are
	// required on creation, but we do not desire to update them after creation,
	// for example because of an external controller is managing them, like an
	// autoscaler.
	InitProvider NoteInitParameters `json:"initProvider,omitempty"`
}

NoteSpec defines the desired state of Note

func (*NoteSpec) DeepCopy

func (in *NoteSpec) DeepCopy() *NoteSpec

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new NoteSpec.

func (*NoteSpec) DeepCopyInto

func (in *NoteSpec) DeepCopyInto(out *NoteSpec)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type NoteStatus

type NoteStatus struct {
	v1.ResourceStatus `json:",inline"`
	AtProvider        NoteObservation `json:"atProvider,omitempty"`
}

NoteStatus defines the observed state of Note.

func (*NoteStatus) DeepCopy

func (in *NoteStatus) DeepCopy() *NoteStatus

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new NoteStatus.

func (*NoteStatus) DeepCopyInto

func (in *NoteStatus) DeepCopyInto(out *NoteStatus)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type RelatedURLInitParameters added in v0.35.0

type RelatedURLInitParameters struct {

	// Label to describe usage of the URL
	Label *string `json:"label,omitempty" tf:"label,omitempty"`

	// Specific URL associated with the resource.
	URL *string `json:"url,omitempty" tf:"url,omitempty"`
}

func (*RelatedURLInitParameters) DeepCopy added in v0.35.0

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new RelatedURLInitParameters.

func (*RelatedURLInitParameters) DeepCopyInto added in v0.35.0

func (in *RelatedURLInitParameters) DeepCopyInto(out *RelatedURLInitParameters)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type RelatedURLObservation

type RelatedURLObservation struct {

	// Label to describe usage of the URL
	Label *string `json:"label,omitempty" tf:"label,omitempty"`

	// Specific URL associated with the resource.
	URL *string `json:"url,omitempty" tf:"url,omitempty"`
}

func (*RelatedURLObservation) DeepCopy

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new RelatedURLObservation.

func (*RelatedURLObservation) DeepCopyInto

func (in *RelatedURLObservation) DeepCopyInto(out *RelatedURLObservation)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type RelatedURLParameters

type RelatedURLParameters struct {

	// Label to describe usage of the URL
	// +kubebuilder:validation:Optional
	Label *string `json:"label,omitempty" tf:"label,omitempty"`

	// Specific URL associated with the resource.
	// +kubebuilder:validation:Optional
	URL *string `json:"url" tf:"url,omitempty"`
}

func (*RelatedURLParameters) DeepCopy

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new RelatedURLParameters.

func (*RelatedURLParameters) DeepCopyInto

func (in *RelatedURLParameters) DeepCopyInto(out *RelatedURLParameters)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL