scopes

package
v0.0.49 Latest Latest
Warning

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

 Go to latest Published: Sep 30, 2024 License: MPL-2.0 Imports: 11 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

View Source 
var File_controller_api_resources_scopes_v1_scope_proto protoreflect.FileDescriptor

Functions

This section is empty.

Types

type Key added in v0.0.26 

type Key struct {

	// The ID of the Key.
	Id string `protobuf:"bytes,10,opt,name=id,proto3" json:"id,omitempty" class:"public"` // @gotags: `class:"public"`
	// Scope information for this resource.
	Scope *ScopeInfo `protobuf:"bytes,20,opt,name=scope,proto3" json:"scope,omitempty"`
	// The purpose of the Key.
	Purpose string `protobuf:"bytes,30,opt,name=purpose,proto3" json:"purpose,omitempty" class:"public"` // @gotags: `class:"public"`
	// The time this Key was created.
	CreatedTime *timestamppb.Timestamp `protobuf:"bytes,40,opt,name=created_time,proto3" json:"created_time,omitempty" class:"public"` // @gotags: `class:"public"`
	// The type of the Key.
	Type string `protobuf:"bytes,50,opt,name=type,proto3" json:"type,omitempty" class:"public"` // @gotags: `class:"public"`
	// The versions of the key.
	Versions []*KeyVersion `protobuf:"bytes,60,rep,name=versions,proto3" json:"versions,omitempty"`
	// contains filtered or unexported fields
}

Key contains all fields related to a Key in a Scope.

func (*Key) Descriptor deprecated added in v0.0.26 

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

Deprecated: Use Key.ProtoReflect.Descriptor instead.

func (*Key) GetCreatedTime added in v0.0.26 

func (x *Key) GetCreatedTime() *timestamppb.Timestamp

func (*Key) GetId added in v0.0.26 

func (x *Key) GetId() string

func (*Key) GetPurpose added in v0.0.26 

func (x *Key) GetPurpose() string

func (*Key) GetScope added in v0.0.26 

func (x *Key) GetScope() *ScopeInfo

func (*Key) GetType added in v0.0.26 

func (x *Key) GetType() string

func (*Key) GetVersions added in v0.0.26 

func (x *Key) GetVersions() []*KeyVersion

func (*Key) ProtoMessage added in v0.0.26 

func (*Key) ProtoMessage()

func (*Key) ProtoReflect added in v0.0.26 

func (x *Key) ProtoReflect() protoreflect.Message

func (*Key) Reset added in v0.0.26 

func (x *Key) Reset()

func (*Key) String added in v0.0.26 

func (x *Key) String() string

type KeyVersion added in v0.0.26 

type KeyVersion struct {

	// The ID of the key version.
	Id string `protobuf:"bytes,10,opt,name=id,proto3" json:"id,omitempty" class:"public"` // @gotags: `class:"public"`
	// The iteration of the Key that this version represents.
	Version uint32 `protobuf:"varint,20,opt,name=version,proto3" json:"version,omitempty" class:"public"` // @gotags: `class:"public"`
	// When this version was created.
	CreatedTime *timestamppb.Timestamp `protobuf:"bytes,30,opt,name=created_time,proto3" json:"created_time,omitempty" class:"public"` // @gotags: `class:"public"`
	// contains filtered or unexported fields
}

KeyVersion describes a specific version of a key and holds the actual key material

func (*KeyVersion) Descriptor deprecated added in v0.0.26 

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

Deprecated: Use KeyVersion.ProtoReflect.Descriptor instead.

func (*KeyVersion) GetCreatedTime added in v0.0.26 

func (x *KeyVersion) GetCreatedTime() *timestamppb.Timestamp

func (*KeyVersion) GetId added in v0.0.26 

func (x *KeyVersion) GetId() string

func (*KeyVersion) GetVersion added in v0.0.26 

func (x *KeyVersion) GetVersion() uint32

func (*KeyVersion) ProtoMessage added in v0.0.26 

func (*KeyVersion) ProtoMessage()

func (*KeyVersion) ProtoReflect added in v0.0.26 

func (x *KeyVersion) ProtoReflect() protoreflect.Message

func (*KeyVersion) Reset added in v0.0.26 

func (x *KeyVersion) Reset()

func (*KeyVersion) String added in v0.0.26 

func (x *KeyVersion) String() string

type KeyVersionDestructionJob added in v0.0.26 

type KeyVersionDestructionJob struct {

	// The ID of the Key version this job relates to.
	KeyVersionId string `protobuf:"bytes,10,opt,name=key_version_id,json=keyVersionId,proto3" json:"key_version_id,omitempty" class:"public"` // @gotags: `class:"public"`
	// Scope information for this resource.
	Scope *ScopeInfo `protobuf:"bytes,20,opt,name=scope,proto3" json:"scope,omitempty"`
	// The current status of the key version destruction job. One of "pending", "running" or "completed".
	Status string `protobuf:"bytes,30,opt,name=status,proto3" json:"status,omitempty" class:"public"` // @gotags: `class:"public"`
	// The time this key version destruction job was created.
	CreatedTime *timestamppb.Timestamp `protobuf:"bytes,40,opt,name=created_time,proto3" json:"created_time,omitempty" class:"public"` // @gotags: `class:"public"`
	// The number of rows that have been successfully re-encrypted with a new key version.
	// All rows must be re-encrypted before the key version can be destroyed.
	CompletedCount int64 `protobuf:"varint,50,opt,name=completed_count,json=completedCount,proto3" json:"completed_count,omitempty" class:"public"` // @gotags: `class:"public"`
	// The total number of rows that need re-encrypting.
	TotalCount int64 `protobuf:"varint,60,opt,name=total_count,json=totalCount,proto3" json:"total_count,omitempty" class:"public"` // @gotags: `class:"public"`
	// contains filtered or unexported fields
}

KeyVersionDestructionJob holds information about a pending key version destruction job.

func (*KeyVersionDestructionJob) Descriptor deprecated added in v0.0.26 

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

Deprecated: Use KeyVersionDestructionJob.ProtoReflect.Descriptor instead.

func (*KeyVersionDestructionJob) GetCompletedCount added in v0.0.26 

func (x *KeyVersionDestructionJob) GetCompletedCount() int64

func (*KeyVersionDestructionJob) GetCreatedTime added in v0.0.26 

func (x *KeyVersionDestructionJob) GetCreatedTime() *timestamppb.Timestamp

func (*KeyVersionDestructionJob) GetKeyVersionId added in v0.0.26 

func (x *KeyVersionDestructionJob) GetKeyVersionId() string

func (*KeyVersionDestructionJob) GetScope added in v0.0.26 

func (x *KeyVersionDestructionJob) GetScope() *ScopeInfo

func (*KeyVersionDestructionJob) GetStatus added in v0.0.26 

func (x *KeyVersionDestructionJob) GetStatus() string

func (*KeyVersionDestructionJob) GetTotalCount added in v0.0.26 

func (x *KeyVersionDestructionJob) GetTotalCount() int64

func (*KeyVersionDestructionJob) ProtoMessage added in v0.0.26 

func (*KeyVersionDestructionJob) ProtoMessage()

func (*KeyVersionDestructionJob) ProtoReflect added in v0.0.26 

func (x *KeyVersionDestructionJob) ProtoReflect() protoreflect.Message

func (*KeyVersionDestructionJob) Reset added in v0.0.26 

func (x *KeyVersionDestructionJob) Reset()

func (*KeyVersionDestructionJob) String added in v0.0.26 

func (x *KeyVersionDestructionJob) String() string

type Scope 

type Scope struct {

	// The ID of the scope.
	Id string `protobuf:"bytes,10,opt,name=id,proto3" json:"id,omitempty" class:"public" eventstream:"observation"` // @gotags: `class:"public" eventstream:"observation"`
	// The ID of the scope this resource is in. If this is the "global" scope this field will be empty.
	ScopeId string `protobuf:"bytes,20,opt,name=scope_id,proto3" json:"scope_id,omitempty" class:"public" eventstream:"observation"` // @gotags: `class:"public" eventstream:"observation"`
	// Scope information for this resource.
	Scope *ScopeInfo `protobuf:"bytes,30,opt,name=scope,proto3" json:"scope,omitempty"`
	// Optional name for identification purposes.
	Name *wrapperspb.StringValue `protobuf:"bytes,40,opt,name=name,proto3" json:"name,omitempty" class:"public"` // @gotags: `class:"public"`
	// Optional user-set descripton for identification purposes.
	Description *wrapperspb.StringValue `protobuf:"bytes,50,opt,name=description,proto3" json:"description,omitempty" class:"public"` // @gotags: `class:"public"`
	// The time this resource was created.
	CreatedTime *timestamppb.Timestamp `protobuf:"bytes,60,opt,name=created_time,proto3" json:"created_time,omitempty" class:"public" eventstream:"observation"` // @gotags: `class:"public" eventstream:"observation"`
	// The time this resource was last updated.
	UpdatedTime *timestamppb.Timestamp `protobuf:"bytes,70,opt,name=updated_time,proto3" json:"updated_time,omitempty" class:"public" eventstream:"observation"` // @gotags: `class:"public" eventstream:"observation"`
	// Version is used in mutation requests, after the initial creation, to ensure this resource has not changed.
	// The mutation will fail if the version does not match the latest known good version.
	Version uint32 `protobuf:"varint,80,opt,name=version,proto3" json:"version,omitempty" class:"public"` // @gotags: `class:"public"`
	// The type of the resource.
	Type string `protobuf:"bytes,90,opt,name=type,proto3" json:"type,omitempty" class:"public" eventstream:"observation"` // @gotags: `class:"public" eventstream:"observation"`
	// The ID of the primary auth method for this scope.  A primary auth method
	// is allowed to vivify users when new accounts are created and is the source for the users account info
	PrimaryAuthMethodId *wrapperspb.StringValue `` // @gotags: `class:"public" eventstream:"observation"`
	/* 140-byte string literal not displayed */
	// The available actions on this resource for this user.
	AuthorizedActions []string `protobuf:"bytes,300,rep,name=authorized_actions,proto3" json:"authorized_actions,omitempty" class:"public"` // @gotags: `class:"public"`
	// The authorized actions for the scope's collections.
	AuthorizedCollectionActions map[string]*structpb.ListValue `` /* 201-byte string literal not displayed */
	// The attached storage policy id.
	StoragePolicyId string `protobuf:"bytes,320,opt,name=storage_policy_id,proto3" json:"storage_policy_id,omitempty" class:"public"` // @gotags: `class:"public"`
	// contains filtered or unexported fields
}

Scope contains all fields related to a scope resource

func (*Scope) Descriptor deprecated 

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

Deprecated: Use Scope.ProtoReflect.Descriptor instead.

func (*Scope) GetAuthorizedActions 

func (x *Scope) GetAuthorizedActions() []string

func (*Scope) GetAuthorizedCollectionActions 

func (x *Scope) GetAuthorizedCollectionActions() map[string]*structpb.ListValue

func (*Scope) GetCreatedTime 

func (x *Scope) GetCreatedTime() *timestamppb.Timestamp

func (*Scope) GetDescription 

func (x *Scope) GetDescription() *wrapperspb.StringValue

func (*Scope) GetId 

func (x *Scope) GetId() string

func (*Scope) GetName 

func (x *Scope) GetName() *wrapperspb.StringValue

func (*Scope) GetPrimaryAuthMethodId 

func (x *Scope) GetPrimaryAuthMethodId() *wrapperspb.StringValue

func (*Scope) GetScope 

func (x *Scope) GetScope() *ScopeInfo

func (*Scope) GetScopeId 

func (x *Scope) GetScopeId() string

func (*Scope) GetStoragePolicyId added in v0.0.42 

func (x *Scope) GetStoragePolicyId() string

func (*Scope) GetType 

func (x *Scope) GetType() string

func (*Scope) GetUpdatedTime 

func (x *Scope) GetUpdatedTime() *timestamppb.Timestamp

func (*Scope) GetVersion 

func (x *Scope) GetVersion() uint32

func (*Scope) ProtoMessage 

func (*Scope) ProtoMessage()

func (*Scope) ProtoReflect 

func (x *Scope) ProtoReflect() protoreflect.Message

func (*Scope) Reset 

func (x *Scope) Reset()

func (*Scope) String 

func (x *Scope) String() string

func (*Scope) Tags added in v0.0.12 

func (req *Scope) Tags() ([]encrypt.PointerTag, error)

Tags implements the encrypt.Taggable interface which allows Scope map fields to be classified for the encrypt filter.

type ScopeInfo 

type ScopeInfo struct {

	// The ID of the scope.
	Id string `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty" class:"public" eventstream:"observation"` // @gotags: `class:"public" eventstream:"observation"`
	// The type of the scope.
	Type string `protobuf:"bytes,2,opt,name=type,proto3" json:"type,omitempty" class:"public" eventstream:"observation"` // @gotags: `class:"public" eventstream:"observation"`
	// The name of the scope, if any.
	Name string `protobuf:"bytes,3,opt,name=name,proto3" json:"name,omitempty" class:"public"` // @gotags: `class:"public"`
	// The description of the scope, if any.
	Description string `protobuf:"bytes,4,opt,name=description,proto3" json:"description,omitempty" class:"public"` // @gotags: `class:"public"`
	// The ID of the parent scope, if any. This field is empty if it is the "global" scope.
	ParentScopeId string `protobuf:"bytes,5,opt,name=parent_scope_id,proto3" json:"parent_scope_id,omitempty" class:"public" eventstream:"observation"` // @gotags: `class:"public" eventstream:"observation"`
	// contains filtered or unexported fields
}

func (*ScopeInfo) Descriptor deprecated 

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

Deprecated: Use ScopeInfo.ProtoReflect.Descriptor instead.

func (*ScopeInfo) GetDescription 

func (x *ScopeInfo) GetDescription() string

func (*ScopeInfo) GetId 

func (x *ScopeInfo) GetId() string

func (*ScopeInfo) GetName 

func (x *ScopeInfo) GetName() string

func (*ScopeInfo) GetParentScopeId 

func (x *ScopeInfo) GetParentScopeId() string

func (*ScopeInfo) GetType 

func (x *ScopeInfo) GetType() string

func (*ScopeInfo) ProtoMessage 

func (*ScopeInfo) ProtoMessage()

func (*ScopeInfo) ProtoReflect 

func (x *ScopeInfo) ProtoReflect() protoreflect.Message

func (*ScopeInfo) Reset 

func (x *ScopeInfo) Reset()

func (*ScopeInfo) String 

func (x *ScopeInfo) String() string

Source Files

View all Source files

Jump to

Keyboard shortcuts

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