Documentation ¶
Index ¶
- Variables
- func RegisterSecretManagerServer(s grpc.ServiceRegistrar, srv SecretManagerServer)
- type Secret
- type SecretAccessRequest
- func (*SecretAccessRequest) Descriptor() ([]byte, []int)deprecated
- func (x *SecretAccessRequest) GetSecretVersion() *SecretVersion
- func (*SecretAccessRequest) ProtoMessage()
- func (x *SecretAccessRequest) ProtoReflect() protoreflect.Message
- func (x *SecretAccessRequest) Reset()
- func (x *SecretAccessRequest) String() string
- type SecretAccessResponse
- func (*SecretAccessResponse) Descriptor() ([]byte, []int)deprecated
- func (x *SecretAccessResponse) GetSecretVersion() *SecretVersion
- func (x *SecretAccessResponse) GetValue() []byte
- func (*SecretAccessResponse) ProtoMessage()
- func (x *SecretAccessResponse) ProtoReflect() protoreflect.Message
- func (x *SecretAccessResponse) Reset()
- func (x *SecretAccessResponse) String() string
- type SecretManagerClient
- type SecretManagerServer
- type SecretPutRequest
- func (*SecretPutRequest) Descriptor() ([]byte, []int)deprecated
- func (x *SecretPutRequest) GetSecret() *Secret
- func (x *SecretPutRequest) GetValue() []byte
- func (*SecretPutRequest) ProtoMessage()
- func (x *SecretPutRequest) ProtoReflect() protoreflect.Message
- func (x *SecretPutRequest) Reset()
- func (x *SecretPutRequest) String() string
- type SecretPutResponse
- func (*SecretPutResponse) Descriptor() ([]byte, []int)deprecated
- func (x *SecretPutResponse) GetSecretVersion() *SecretVersion
- func (*SecretPutResponse) ProtoMessage()
- func (x *SecretPutResponse) ProtoReflect() protoreflect.Message
- func (x *SecretPutResponse) Reset()
- func (x *SecretPutResponse) String() string
- type SecretVersion
- func (*SecretVersion) Descriptor() ([]byte, []int)deprecated
- func (x *SecretVersion) GetSecret() *Secret
- func (x *SecretVersion) GetVersion() string
- func (*SecretVersion) ProtoMessage()
- func (x *SecretVersion) ProtoReflect() protoreflect.Message
- func (x *SecretVersion) Reset()
- func (x *SecretVersion) String() string
- type UnimplementedSecretManagerServer
- type UnsafeSecretManagerServer
Constants ¶
This section is empty.
Variables ¶
var File_nitric_proto_secrets_v1_secrets_proto protoreflect.FileDescriptor
var SecretManager_ServiceDesc = grpc.ServiceDesc{ ServiceName: "nitric.proto.secrets.v1.SecretManager", HandlerType: (*SecretManagerServer)(nil), Methods: []grpc.MethodDesc{ { MethodName: "Put", Handler: _SecretManager_Put_Handler, }, { MethodName: "Access", Handler: _SecretManager_Access_Handler, }, }, Streams: []grpc.StreamDesc{}, Metadata: "nitric/proto/secrets/v1/secrets.proto", }
SecretManager_ServiceDesc is the grpc.ServiceDesc for SecretManager service. It's only intended for direct use with grpc.RegisterService, and not to be introspected or modified (even as a copy)
Functions ¶
func RegisterSecretManagerServer ¶
func RegisterSecretManagerServer(s grpc.ServiceRegistrar, srv SecretManagerServer)
Types ¶
type Secret ¶
type Secret struct { // The secret name Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"` // contains filtered or unexported fields }
The secret container
func (*Secret) Descriptor
deprecated
func (*Secret) ProtoMessage ¶
func (*Secret) ProtoMessage()
func (*Secret) ProtoReflect ¶
func (x *Secret) ProtoReflect() protoreflect.Message
type SecretAccessRequest ¶
type SecretAccessRequest struct { // The id of the secret SecretVersion *SecretVersion `protobuf:"bytes,1,opt,name=secret_version,json=secretVersion,proto3" json:"secret_version,omitempty"` // contains filtered or unexported fields }
Request to get a secret from a Secret Store
func (*SecretAccessRequest) Descriptor
deprecated
func (*SecretAccessRequest) Descriptor() ([]byte, []int)
Deprecated: Use SecretAccessRequest.ProtoReflect.Descriptor instead.
func (*SecretAccessRequest) GetSecretVersion ¶
func (x *SecretAccessRequest) GetSecretVersion() *SecretVersion
func (*SecretAccessRequest) ProtoMessage ¶
func (*SecretAccessRequest) ProtoMessage()
func (*SecretAccessRequest) ProtoReflect ¶
func (x *SecretAccessRequest) ProtoReflect() protoreflect.Message
func (*SecretAccessRequest) Reset ¶
func (x *SecretAccessRequest) Reset()
func (*SecretAccessRequest) String ¶
func (x *SecretAccessRequest) String() string
type SecretAccessResponse ¶
type SecretAccessResponse struct { // The version of the secret that was requested SecretVersion *SecretVersion `protobuf:"bytes,1,opt,name=secret_version,json=secretVersion,proto3" json:"secret_version,omitempty"` // The value of the secret Value []byte `protobuf:"bytes,2,opt,name=value,proto3" json:"value,omitempty"` // contains filtered or unexported fields }
The secret response
func (*SecretAccessResponse) Descriptor
deprecated
func (*SecretAccessResponse) Descriptor() ([]byte, []int)
Deprecated: Use SecretAccessResponse.ProtoReflect.Descriptor instead.
func (*SecretAccessResponse) GetSecretVersion ¶
func (x *SecretAccessResponse) GetSecretVersion() *SecretVersion
func (*SecretAccessResponse) GetValue ¶
func (x *SecretAccessResponse) GetValue() []byte
func (*SecretAccessResponse) ProtoMessage ¶
func (*SecretAccessResponse) ProtoMessage()
func (*SecretAccessResponse) ProtoReflect ¶
func (x *SecretAccessResponse) ProtoReflect() protoreflect.Message
func (*SecretAccessResponse) Reset ¶
func (x *SecretAccessResponse) Reset()
func (*SecretAccessResponse) String ¶
func (x *SecretAccessResponse) String() string
type SecretManagerClient ¶
type SecretManagerClient interface { // Updates a secret, creating a new one if it doesn't already exist Put(ctx context.Context, in *SecretPutRequest, opts ...grpc.CallOption) (*SecretPutResponse, error) // Gets a secret from a Secret Store Access(ctx context.Context, in *SecretAccessRequest, opts ...grpc.CallOption) (*SecretAccessResponse, error) }
SecretManagerClient is the client API for SecretManager service.
For semantics around ctx use and closing/ending streaming RPCs, please refer to https://pkg.go.dev/google.golang.org/grpc/?tab=doc#ClientConn.NewStream.
func NewSecretManagerClient ¶
func NewSecretManagerClient(cc grpc.ClientConnInterface) SecretManagerClient
type SecretManagerServer ¶
type SecretManagerServer interface { // Updates a secret, creating a new one if it doesn't already exist Put(context.Context, *SecretPutRequest) (*SecretPutResponse, error) // Gets a secret from a Secret Store Access(context.Context, *SecretAccessRequest) (*SecretAccessResponse, error) }
SecretManagerServer is the server API for SecretManager service. All implementations should embed UnimplementedSecretManagerServer for forward compatibility
type SecretPutRequest ¶
type SecretPutRequest struct { // The Secret to put to the Secret store Secret *Secret `protobuf:"bytes,1,opt,name=secret,proto3" json:"secret,omitempty"` // The value to assign to that secret Value []byte `protobuf:"bytes,2,opt,name=value,proto3" json:"value,omitempty"` // contains filtered or unexported fields }
Request to put a secret to a Secret Store
func (*SecretPutRequest) Descriptor
deprecated
func (*SecretPutRequest) Descriptor() ([]byte, []int)
Deprecated: Use SecretPutRequest.ProtoReflect.Descriptor instead.
func (*SecretPutRequest) GetSecret ¶
func (x *SecretPutRequest) GetSecret() *Secret
func (*SecretPutRequest) GetValue ¶
func (x *SecretPutRequest) GetValue() []byte
func (*SecretPutRequest) ProtoMessage ¶
func (*SecretPutRequest) ProtoMessage()
func (*SecretPutRequest) ProtoReflect ¶
func (x *SecretPutRequest) ProtoReflect() protoreflect.Message
func (*SecretPutRequest) Reset ¶
func (x *SecretPutRequest) Reset()
func (*SecretPutRequest) String ¶
func (x *SecretPutRequest) String() string
type SecretPutResponse ¶
type SecretPutResponse struct { // The id of the secret SecretVersion *SecretVersion `protobuf:"bytes,1,opt,name=secret_version,json=secretVersion,proto3" json:"secret_version,omitempty"` // contains filtered or unexported fields }
Result from putting the secret to a Secret Store
func (*SecretPutResponse) Descriptor
deprecated
func (*SecretPutResponse) Descriptor() ([]byte, []int)
Deprecated: Use SecretPutResponse.ProtoReflect.Descriptor instead.
func (*SecretPutResponse) GetSecretVersion ¶
func (x *SecretPutResponse) GetSecretVersion() *SecretVersion
func (*SecretPutResponse) ProtoMessage ¶
func (*SecretPutResponse) ProtoMessage()
func (*SecretPutResponse) ProtoReflect ¶
func (x *SecretPutResponse) ProtoReflect() protoreflect.Message
func (*SecretPutResponse) Reset ¶
func (x *SecretPutResponse) Reset()
func (*SecretPutResponse) String ¶
func (x *SecretPutResponse) String() string
type SecretVersion ¶
type SecretVersion struct { // Reference to the secret container Secret *Secret `protobuf:"bytes,1,opt,name=secret,proto3" json:"secret,omitempty"` // The secret version Version string `protobuf:"bytes,2,opt,name=version,proto3" json:"version,omitempty"` // contains filtered or unexported fields }
A version of a secret
func (*SecretVersion) Descriptor
deprecated
func (*SecretVersion) Descriptor() ([]byte, []int)
Deprecated: Use SecretVersion.ProtoReflect.Descriptor instead.
func (*SecretVersion) GetSecret ¶
func (x *SecretVersion) GetSecret() *Secret
func (*SecretVersion) GetVersion ¶
func (x *SecretVersion) GetVersion() string
func (*SecretVersion) ProtoMessage ¶
func (*SecretVersion) ProtoMessage()
func (*SecretVersion) ProtoReflect ¶
func (x *SecretVersion) ProtoReflect() protoreflect.Message
func (*SecretVersion) Reset ¶
func (x *SecretVersion) Reset()
func (*SecretVersion) String ¶
func (x *SecretVersion) String() string
type UnimplementedSecretManagerServer ¶
type UnimplementedSecretManagerServer struct { }
UnimplementedSecretManagerServer should be embedded to have forward compatible implementations.
func (UnimplementedSecretManagerServer) Access ¶
func (UnimplementedSecretManagerServer) Access(context.Context, *SecretAccessRequest) (*SecretAccessResponse, error)
func (UnimplementedSecretManagerServer) Put ¶
func (UnimplementedSecretManagerServer) Put(context.Context, *SecretPutRequest) (*SecretPutResponse, error)
type UnsafeSecretManagerServer ¶
type UnsafeSecretManagerServer interface {
// contains filtered or unexported methods
}
UnsafeSecretManagerServer may be embedded to opt out of forward compatibility for this service. Use of this interface is not recommended, as added methods to SecretManagerServer will result in compilation errors.