identity

package
v0.0.0-...-8ac8c48 Latest Latest
Warning

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

 Go to latest Published: Jan 19, 2025 License: Apache-2.0 Imports: 8 Imported by: 5

Documentation

Index

Constants

View Source 
const (
	Identity_GetPluginMetadata_FullMethodName     = "/cnpgi.identity.v1.Identity/GetPluginMetadata"
	Identity_GetPluginCapabilities_FullMethodName = "/cnpgi.identity.v1.Identity/GetPluginCapabilities"
	Identity_Probe_FullMethodName                 = "/cnpgi.identity.v1.Identity/Probe"
)

Variables

View Source 
var (
	PluginCapability_Service_Type_name = map[int32]string{
		0: "TYPE_UNSPECIFIED",
		1: "TYPE_OPERATOR_SERVICE",
		2: "TYPE_WAL_SERVICE",
		3: "TYPE_BACKUP_SERVICE",
		4: "TYPE_LIFECYCLE_SERVICE",
		5: "TYPE_RECONCILER_HOOKS",
		6: "TYPE_RESTORE_JOB",
	}
	PluginCapability_Service_Type_value = map[string]int32{
		"TYPE_UNSPECIFIED":       0,
		"TYPE_OPERATOR_SERVICE":  1,
		"TYPE_WAL_SERVICE":       2,
		"TYPE_BACKUP_SERVICE":    3,
		"TYPE_LIFECYCLE_SERVICE": 4,
		"TYPE_RECONCILER_HOOKS":  5,
		"TYPE_RESTORE_JOB":       6,
	}
)

Enum value maps for PluginCapability_Service_Type.

View Source 
var File_proto_identity_proto protoreflect.FileDescriptor
View Source 
var Identity_ServiceDesc = grpc.ServiceDesc{
	ServiceName: "cnpgi.identity.v1.Identity",
	HandlerType: (*IdentityServer)(nil),
	Methods: []grpc.MethodDesc{
		{
			MethodName: "GetPluginMetadata",
			Handler:    _Identity_GetPluginMetadata_Handler,
		},
		{
			MethodName: "GetPluginCapabilities",
			Handler:    _Identity_GetPluginCapabilities_Handler,
		},
		{
			MethodName: "Probe",
			Handler:    _Identity_Probe_Handler,
		},
	},
	Streams:  []grpc.StreamDesc{},
	Metadata: "proto/identity.proto",
}

Identity_ServiceDesc is the grpc.ServiceDesc for Identity service. It's only intended for direct use with grpc.RegisterService, and not to be introspected or modified (even as a copy)

Functions

func RegisterIdentityServer 

func RegisterIdentityServer(s grpc.ServiceRegistrar, srv IdentityServer)

Types

type GetPluginCapabilitiesRequest 

type GetPluginCapabilitiesRequest struct {
	// contains filtered or unexported fields
}

func (*GetPluginCapabilitiesRequest) Descriptor deprecated 

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

Deprecated: Use GetPluginCapabilitiesRequest.ProtoReflect.Descriptor instead.

func (*GetPluginCapabilitiesRequest) ProtoMessage 

func (*GetPluginCapabilitiesRequest) ProtoMessage()

func (*GetPluginCapabilitiesRequest) ProtoReflect 

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

func (*GetPluginCapabilitiesRequest) Reset 

func (x *GetPluginCapabilitiesRequest) Reset()

func (*GetPluginCapabilitiesRequest) String 

func (x *GetPluginCapabilitiesRequest) String() string

type GetPluginCapabilitiesResponse 

type GetPluginCapabilitiesResponse struct {

	// All the capabilities that the controller service supports. This
	// field is OPTIONAL.
	Capabilities []*PluginCapability `protobuf:"bytes,1,rep,name=capabilities,proto3" json:"capabilities,omitempty"`
	// contains filtered or unexported fields
}

func (*GetPluginCapabilitiesResponse) Descriptor deprecated 

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

Deprecated: Use GetPluginCapabilitiesResponse.ProtoReflect.Descriptor instead.

func (*GetPluginCapabilitiesResponse) GetCapabilities 

func (x *GetPluginCapabilitiesResponse) GetCapabilities() []*PluginCapability

func (*GetPluginCapabilitiesResponse) ProtoMessage 

func (*GetPluginCapabilitiesResponse) ProtoMessage()

func (*GetPluginCapabilitiesResponse) ProtoReflect 

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

func (*GetPluginCapabilitiesResponse) Reset 

func (x *GetPluginCapabilitiesResponse) Reset()

func (*GetPluginCapabilitiesResponse) String 

func (x *GetPluginCapabilitiesResponse) String() string

type GetPluginMetadataRequest 

type GetPluginMetadataRequest struct {
	// contains filtered or unexported fields
}

func (*GetPluginMetadataRequest) Descriptor deprecated 

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

Deprecated: Use GetPluginMetadataRequest.ProtoReflect.Descriptor instead.

func (*GetPluginMetadataRequest) ProtoMessage 

func (*GetPluginMetadataRequest) ProtoMessage()

func (*GetPluginMetadataRequest) ProtoReflect 

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

func (*GetPluginMetadataRequest) Reset 

func (x *GetPluginMetadataRequest) Reset()

func (*GetPluginMetadataRequest) String 

func (x *GetPluginMetadataRequest) String() string

type GetPluginMetadataResponse 

type GetPluginMetadataResponse struct {

	// The name MUST follow domain name notation format
	// (https://tools.ietf.org/html/rfc1035#section-2.3.1). It SHOULD
	// include the plugin's host company name and the plugin name,
	// to minimize the possibility of collisions. It MUST be 63
	// characters or less, beginning and ending with an alphanumeric
	// character ([a-z0-9A-Z]) with dashes (-), dots (.), and
	// alphanumerics between. This field is REQUIRED.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// This field is REQUIRED. Value of this field is opaque.
	Version string `protobuf:"bytes,2,opt,name=version,proto3" json:"version,omitempty"`
	// A name to display for the plugin. This field is REQUIRED.
	DisplayName string `protobuf:"bytes,3,opt,name=display_name,json=displayName,proto3" json:"display_name,omitempty"`
	// A description for the plugin. This field is REQUIRED.
	Description string `protobuf:"bytes,4,opt,name=description,proto3" json:"description,omitempty"`
	// URL of the home page of the plugin project.
	ProjectUrl string `protobuf:"bytes,5,opt,name=project_url,json=projectUrl,proto3" json:"project_url,omitempty"`
	// URL of the source code repository for the plugin project.
	RepositoryUrl string `protobuf:"bytes,6,opt,name=repository_url,json=repositoryUrl,proto3" json:"repository_url,omitempty"`
	// License of the plugin. This field is REQUIRED.
	License string `protobuf:"bytes,7,opt,name=license,proto3" json:"license,omitempty"`
	// URL of the license of the plugin. This field is REQUIRED.
	LicenseUrl string `protobuf:"bytes,8,opt,name=license_url,json=licenseUrl,proto3" json:"license_url,omitempty"`
	// Maturity level (alpha, beta, stable)
	Maturity string `protobuf:"bytes,9,opt,name=maturity,proto3" json:"maturity,omitempty"`
	// Provider/vendor of the plugin, e.g. an organization
	Vendor string `protobuf:"bytes,10,opt,name=vendor,proto3" json:"vendor,omitempty"`
	// This field is OPTIONAL. Values are opaque.
	Manifest map[string]string `` /* 158-byte string literal not displayed */
	// contains filtered or unexported fields
}

func (*GetPluginMetadataResponse) Descriptor deprecated 

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

Deprecated: Use GetPluginMetadataResponse.ProtoReflect.Descriptor instead.

func (*GetPluginMetadataResponse) GetDescription 

func (x *GetPluginMetadataResponse) GetDescription() string

func (*GetPluginMetadataResponse) GetDisplayName 

func (x *GetPluginMetadataResponse) GetDisplayName() string

func (*GetPluginMetadataResponse) GetLicense 

func (x *GetPluginMetadataResponse) GetLicense() string

func (*GetPluginMetadataResponse) GetLicenseUrl 

func (x *GetPluginMetadataResponse) GetLicenseUrl() string

func (*GetPluginMetadataResponse) GetManifest 

func (x *GetPluginMetadataResponse) GetManifest() map[string]string

func (*GetPluginMetadataResponse) GetMaturity 

func (x *GetPluginMetadataResponse) GetMaturity() string

func (*GetPluginMetadataResponse) GetName 

func (x *GetPluginMetadataResponse) GetName() string

func (*GetPluginMetadataResponse) GetProjectUrl 

func (x *GetPluginMetadataResponse) GetProjectUrl() string

func (*GetPluginMetadataResponse) GetRepositoryUrl 

func (x *GetPluginMetadataResponse) GetRepositoryUrl() string

func (*GetPluginMetadataResponse) GetVendor 

func (x *GetPluginMetadataResponse) GetVendor() string

func (*GetPluginMetadataResponse) GetVersion 

func (x *GetPluginMetadataResponse) GetVersion() string

func (*GetPluginMetadataResponse) ProtoMessage 

func (*GetPluginMetadataResponse) ProtoMessage()

func (*GetPluginMetadataResponse) ProtoReflect 

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

func (*GetPluginMetadataResponse) Reset 

func (x *GetPluginMetadataResponse) Reset()

func (*GetPluginMetadataResponse) String 

func (x *GetPluginMetadataResponse) String() string

type IdentityClient 

type IdentityClient interface {
	// GetPluginMetadata gets the plugin metadata
	GetPluginMetadata(ctx context.Context, in *GetPluginMetadataRequest, opts ...grpc.CallOption) (*GetPluginMetadataResponse, error)
	// GetPluginCapabilities gets information about this plugin
	GetPluginCapabilities(ctx context.Context, in *GetPluginCapabilitiesRequest, opts ...grpc.CallOption) (*GetPluginCapabilitiesResponse, error)
	// Probe is used to tell if the plugin is ready to receive requests
	Probe(ctx context.Context, in *ProbeRequest, opts ...grpc.CallOption) (*ProbeResponse, error)
}

IdentityClient is the client API for Identity 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 NewIdentityClient 

func NewIdentityClient(cc grpc.ClientConnInterface) IdentityClient

type IdentityServer 

type IdentityServer interface {
	// GetPluginMetadata gets the plugin metadata
	GetPluginMetadata(context.Context, *GetPluginMetadataRequest) (*GetPluginMetadataResponse, error)
	// GetPluginCapabilities gets information about this plugin
	GetPluginCapabilities(context.Context, *GetPluginCapabilitiesRequest) (*GetPluginCapabilitiesResponse, error)
	// Probe is used to tell if the plugin is ready to receive requests
	Probe(context.Context, *ProbeRequest) (*ProbeResponse, error)
	// contains filtered or unexported methods
}

IdentityServer is the server API for Identity service. All implementations must embed UnimplementedIdentityServer for forward compatibility

type PluginCapability 

type PluginCapability struct {

	// Types that are assignable to Type:
	//
	//	*PluginCapability_Service_
	Type isPluginCapability_Type `protobuf_oneof:"type"`
	// contains filtered or unexported fields
}

func (*PluginCapability) Descriptor deprecated 

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

Deprecated: Use PluginCapability.ProtoReflect.Descriptor instead.

func (*PluginCapability) GetService 

func (x *PluginCapability) GetService() *PluginCapability_Service

func (*PluginCapability) GetType 

func (m *PluginCapability) GetType() isPluginCapability_Type

func (*PluginCapability) ProtoMessage 

func (*PluginCapability) ProtoMessage()

func (*PluginCapability) ProtoReflect 

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

func (*PluginCapability) Reset 

func (x *PluginCapability) Reset()

func (*PluginCapability) String 

func (x *PluginCapability) String() string

type PluginCapability_Service 

type PluginCapability_Service struct {
	Type PluginCapability_Service_Type `protobuf:"varint,1,opt,name=type,proto3,enum=cnpgi.identity.v1.PluginCapability_Service_Type" json:"type,omitempty"`
	// contains filtered or unexported fields
}

func (*PluginCapability_Service) Descriptor deprecated 

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

Deprecated: Use PluginCapability_Service.ProtoReflect.Descriptor instead.

func (*PluginCapability_Service) GetType 

func (x *PluginCapability_Service) GetType() PluginCapability_Service_Type

func (*PluginCapability_Service) ProtoMessage 

func (*PluginCapability_Service) ProtoMessage()

func (*PluginCapability_Service) ProtoReflect 

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

func (*PluginCapability_Service) Reset 

func (x *PluginCapability_Service) Reset()

func (*PluginCapability_Service) String 

func (x *PluginCapability_Service) String() string

type PluginCapability_Service_ 

type PluginCapability_Service_ struct {
	Service *PluginCapability_Service `protobuf:"bytes,1,opt,name=service,proto3,oneof"`
}

type PluginCapability_Service_Type 

type PluginCapability_Service_Type int32
const (
	PluginCapability_Service_TYPE_UNSPECIFIED PluginCapability_Service_Type = 0
	// TYPE_OPERATOR_SERVICE indicated that the Plugin provider RPCs
	// for the Operator service.
	// The presence of this capability determines whether the CO will
	// attempt to invoke the REQUIRED Operator RPCs, as well
	// as specific RPCs as indicated by GetCapabilities.
	PluginCapability_Service_TYPE_OPERATOR_SERVICE PluginCapability_Service_Type = 1
	// TYPE_WAL_SERVICE indicates that the Plugin provides RPCs for
	// the WAL service. Plugins MAY provide this capability.
	// The presence of this capability determines whether the CO will
	// attempt to invoke the REQUIRED WALService RPCs, as well
	// as specific RPCs as indicated by GetCapabilities.
	PluginCapability_Service_TYPE_WAL_SERVICE PluginCapability_Service_Type = 2
	// TYPE_BACKUP_SERVICE indicates that the Plugin provides RPCs for
	// the Backup service.
	// The presence of this capability determines whether the CO will
	// attempt to invoke the REQUIRED Backup Service RPCs, as well
	// as specific RPCs as indicated by GetCapabilities.
	PluginCapability_Service_TYPE_BACKUP_SERVICE PluginCapability_Service_Type = 3
	// TYPE_LIFECYCLE_SERVICE indicates that the Plugin provides RPCs for
	// the Lifecycle service.
	PluginCapability_Service_TYPE_LIFECYCLE_SERVICE PluginCapability_Service_Type = 4
	// TYPE_RECONCILER_HOOKS indicates that the Plugin provides RPCs to
	// enhance the behavior of the reconcilers
	PluginCapability_Service_TYPE_RECONCILER_HOOKS PluginCapability_Service_Type = 5
	// TYPE_RESTORE_JOB_HOOKS indicates that the Plugin provides RPCs to
	// enhance the behavior of the restore jobs
	PluginCapability_Service_TYPE_RESTORE_JOB PluginCapability_Service_Type = 6
)

func (PluginCapability_Service_Type) Descriptor 

func (PluginCapability_Service_Type) Descriptor() protoreflect.EnumDescriptor

func (PluginCapability_Service_Type) Enum 

func (x PluginCapability_Service_Type) Enum() *PluginCapability_Service_Type

func (PluginCapability_Service_Type) EnumDescriptor deprecated 

func (PluginCapability_Service_Type) EnumDescriptor() ([]byte, []int)

Deprecated: Use PluginCapability_Service_Type.Descriptor instead.

func (PluginCapability_Service_Type) Number 

func (x PluginCapability_Service_Type) Number() protoreflect.EnumNumber

func (PluginCapability_Service_Type) String 

func (x PluginCapability_Service_Type) String() string

func (PluginCapability_Service_Type) Type 

func (PluginCapability_Service_Type) Type() protoreflect.EnumType

type ProbeRequest 

type ProbeRequest struct {
	// contains filtered or unexported fields
}

func (*ProbeRequest) Descriptor deprecated 

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

Deprecated: Use ProbeRequest.ProtoReflect.Descriptor instead.

func (*ProbeRequest) ProtoMessage 

func (*ProbeRequest) ProtoMessage()

func (*ProbeRequest) ProtoReflect 

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

func (*ProbeRequest) Reset 

func (x *ProbeRequest) Reset()

func (*ProbeRequest) String 

func (x *ProbeRequest) String() string

type ProbeResponse 

type ProbeResponse struct {

	// This field is OPTIONAL. If not present, the caller SHALL assume
	// that the plugin is in a ready state and is accepting calls to its
	// Controller and/or Node services (according to the plugin's reported
	// capabilities).
	Ready bool `protobuf:"varint,1,opt,name=ready,proto3" json:"ready,omitempty"`
	// contains filtered or unexported fields
}

func (*ProbeResponse) Descriptor deprecated 

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

Deprecated: Use ProbeResponse.ProtoReflect.Descriptor instead.

func (*ProbeResponse) GetReady 

func (x *ProbeResponse) GetReady() bool

func (*ProbeResponse) ProtoMessage 

func (*ProbeResponse) ProtoMessage()

func (*ProbeResponse) ProtoReflect 

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

func (*ProbeResponse) Reset 

func (x *ProbeResponse) Reset()

func (*ProbeResponse) String 

func (x *ProbeResponse) String() string

type UnimplementedIdentityServer 

type UnimplementedIdentityServer struct {
}

UnimplementedIdentityServer must be embedded to have forward compatible implementations.

func (UnimplementedIdentityServer) GetPluginCapabilities 

func (UnimplementedIdentityServer) GetPluginCapabilities(context.Context, *GetPluginCapabilitiesRequest) (*GetPluginCapabilitiesResponse, error)

func (UnimplementedIdentityServer) GetPluginMetadata 

func (UnimplementedIdentityServer) GetPluginMetadata(context.Context, *GetPluginMetadataRequest) (*GetPluginMetadataResponse, error)

func (UnimplementedIdentityServer) Probe 

func (UnimplementedIdentityServer) Probe(context.Context, *ProbeRequest) (*ProbeResponse, error)

type UnsafeIdentityServer 

type UnsafeIdentityServer interface {
	// contains filtered or unexported methods
}

UnsafeIdentityServer may be embedded to opt out of forward compatibility for this service. Use of this interface is not recommended, as added methods to IdentityServer will result in compilation errors.

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.