Documentation ¶
Index ¶
- Variables
- type Key
- func (*Key) Descriptor() ([]byte, []int)deprecated
- func (x *Key) GetCreatedTime() *timestamppb.Timestamp
- func (x *Key) GetId() string
- func (x *Key) GetPurpose() string
- func (x *Key) GetScope() *ScopeInfo
- func (x *Key) GetType() string
- func (x *Key) GetVersions() []*KeyVersion
- func (*Key) ProtoMessage()
- func (x *Key) ProtoReflect() protoreflect.Message
- func (x *Key) Reset()
- func (x *Key) String() string
- type KeyVersion
- func (*KeyVersion) Descriptor() ([]byte, []int)deprecated
- func (x *KeyVersion) GetCreatedTime() *timestamppb.Timestamp
- func (x *KeyVersion) GetId() string
- func (x *KeyVersion) GetVersion() uint32
- func (*KeyVersion) ProtoMessage()
- func (x *KeyVersion) ProtoReflect() protoreflect.Message
- func (x *KeyVersion) Reset()
- func (x *KeyVersion) String() string
- type KeyVersionDestructionJob
- func (*KeyVersionDestructionJob) Descriptor() ([]byte, []int)deprecated
- func (x *KeyVersionDestructionJob) GetCompletedCount() int64
- func (x *KeyVersionDestructionJob) GetCreatedTime() *timestamppb.Timestamp
- func (x *KeyVersionDestructionJob) GetKeyVersionId() string
- func (x *KeyVersionDestructionJob) GetScope() *ScopeInfo
- func (x *KeyVersionDestructionJob) GetStatus() string
- func (x *KeyVersionDestructionJob) GetTotalCount() int64
- func (*KeyVersionDestructionJob) ProtoMessage()
- func (x *KeyVersionDestructionJob) ProtoReflect() protoreflect.Message
- func (x *KeyVersionDestructionJob) Reset()
- func (x *KeyVersionDestructionJob) String() string
- type Scope
- func (*Scope) Descriptor() ([]byte, []int)deprecated
- func (x *Scope) GetAuthorizedActions() []string
- func (x *Scope) GetAuthorizedCollectionActions() map[string]*structpb.ListValue
- func (x *Scope) GetCreatedTime() *timestamppb.Timestamp
- func (x *Scope) GetDescription() *wrapperspb.StringValue
- func (x *Scope) GetId() string
- func (x *Scope) GetName() *wrapperspb.StringValue
- func (x *Scope) GetPrimaryAuthMethodId() *wrapperspb.StringValue
- func (x *Scope) GetScope() *ScopeInfo
- func (x *Scope) GetScopeId() string
- func (x *Scope) GetType() string
- func (x *Scope) GetUpdatedTime() *timestamppb.Timestamp
- func (x *Scope) GetVersion() uint32
- func (*Scope) ProtoMessage()
- func (x *Scope) ProtoReflect() protoreflect.Message
- func (x *Scope) Reset()
- func (x *Scope) String() string
- func (req *Scope) Tags() ([]encrypt.PointerTag, error)
- type ScopeInfo
- func (*ScopeInfo) Descriptor() ([]byte, []int)deprecated
- func (x *ScopeInfo) GetDescription() string
- func (x *ScopeInfo) GetId() string
- func (x *ScopeInfo) GetName() string
- func (x *ScopeInfo) GetParentScopeId() string
- func (x *ScopeInfo) GetType() string
- func (*ScopeInfo) ProtoMessage()
- func (x *ScopeInfo) ProtoReflect() protoreflect.Message
- func (x *ScopeInfo) Reset()
- func (x *ScopeInfo) String() string
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) GetCreatedTime ¶ added in v0.0.26
func (x *Key) GetCreatedTime() *timestamppb.Timestamp
func (*Key) GetPurpose ¶ added in v0.0.26
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
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 { // Output only. The ID of the Scope. Id string `protobuf:"bytes,10,opt,name=id,proto3" json:"id,omitempty" class:"public"` // @gotags: `class:"public"` // 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"` // @gotags: `class:"public"` // Output only. 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"` // Output only. The time this resource was created. CreatedTime *timestamppb.Timestamp `protobuf:"bytes,60,opt,name=created_time,proto3" json:"created_time,omitempty" class:"public"` // @gotags: `class:"public"` // Output only. The time this resource was last updated. UpdatedTime *timestamppb.Timestamp `protobuf:"bytes,70,opt,name=updated_time,proto3" json:"updated_time,omitempty" class:"public"` // @gotags: `class:"public"` // 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"` // @gotags: `class:"public"` // 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 `protobuf:"bytes,100,opt,name=primary_auth_method_id,proto3" json:"primary_auth_method_id,omitempty" class:"public"` // @gotags: `class:"public"` // Output only. 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"` // Output only. The authorized actions for the scope's collections. AuthorizedCollectionActions map[string]*structpb.ListValue `` /* 201-byte string literal not displayed */ // contains filtered or unexported fields }
Scope contains all fields related to a Scope resource
func (*Scope) Descriptor
deprecated
func (*Scope) GetAuthorizedActions ¶
func (*Scope) GetAuthorizedCollectionActions ¶
func (*Scope) GetCreatedTime ¶
func (x *Scope) GetCreatedTime() *timestamppb.Timestamp
func (*Scope) GetDescription ¶
func (x *Scope) GetDescription() *wrapperspb.StringValue
func (*Scope) GetName ¶
func (x *Scope) GetName() *wrapperspb.StringValue
func (*Scope) GetPrimaryAuthMethodId ¶
func (x *Scope) GetPrimaryAuthMethodId() *wrapperspb.StringValue
func (*Scope) GetScopeId ¶
func (*Scope) GetUpdatedTime ¶
func (x *Scope) GetUpdatedTime() *timestamppb.Timestamp
func (*Scope) GetVersion ¶
func (*Scope) ProtoMessage ¶
func (*Scope) ProtoMessage()
func (*Scope) ProtoReflect ¶
func (x *Scope) ProtoReflect() protoreflect.Message
type ScopeInfo ¶
type ScopeInfo struct { // Output only. The ID of the Scope. Id string `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty" class:"public"` // @gotags: `class:"public"` // Output only. The type of the Scope. Type string `protobuf:"bytes,2,opt,name=type,proto3" json:"type,omitempty" class:"public"` // @gotags: `class:"public"` // Output only. The name of the Scope, if any. Name string `protobuf:"bytes,3,opt,name=name,proto3" json:"name,omitempty" class:"public"` // @gotags: `class:"public"` // Output only. The description of the Scope, if any. Description string `protobuf:"bytes,4,opt,name=description,proto3" json:"description,omitempty" class:"public"` // @gotags: `class:"public"` // Output only. The ID of the parent Scope, if any. This field will be empty if this is the "global" scope. ParentScopeId string `protobuf:"bytes,5,opt,name=parent_scope_id,proto3" json:"parent_scope_id,omitempty" class:"public"` // @gotags: `class:"public"` // contains filtered or unexported fields }
func (*ScopeInfo) Descriptor
deprecated
func (*ScopeInfo) GetDescription ¶
func (*ScopeInfo) GetParentScopeId ¶
func (*ScopeInfo) ProtoMessage ¶
func (*ScopeInfo) ProtoMessage()
func (*ScopeInfo) ProtoReflect ¶
func (x *ScopeInfo) ProtoReflect() protoreflect.Message
Click to show internal directories.
Click to hide internal directories.