registryv1beta1

package
v0.0.0-...-3ad35d1 Latest Latest
Warning

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

 Go to latest Published: Nov 5, 2024 License: Apache-2.0 Imports: 10 Imported by: 10

Documentation

Index

Constants

View Source 
const (
	RegistryAPI_GetAuthProviders_FullMethodName  = "/cs3.auth.registry.v1beta1.RegistryAPI/GetAuthProviders"
	RegistryAPI_ListAuthProviders_FullMethodName = "/cs3.auth.registry.v1beta1.RegistryAPI/ListAuthProviders"
)

Variables

View Source 
var File_cs3_auth_registry_v1beta1_registry_api_proto protoreflect.FileDescriptor
View Source 
var File_cs3_auth_registry_v1beta1_resources_proto protoreflect.FileDescriptor
View Source 
var RegistryAPI_ServiceDesc = grpc.ServiceDesc{
	ServiceName: "cs3.auth.registry.v1beta1.RegistryAPI",
	HandlerType: (*RegistryAPIServer)(nil),
	Methods: []grpc.MethodDesc{
		{
			MethodName: "GetAuthProviders",
			Handler:    _RegistryAPI_GetAuthProviders_Handler,
		},
		{
			MethodName: "ListAuthProviders",
			Handler:    _RegistryAPI_ListAuthProviders_Handler,
		},
	},
	Streams:  []grpc.StreamDesc{},
	Metadata: "cs3/auth/registry/v1beta1/registry_api.proto",
}

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

Functions

func RegisterRegistryAPIServer 

func RegisterRegistryAPIServer(s grpc.ServiceRegistrar, srv RegistryAPIServer)

Types

type GetAuthProvidersRequest 

type GetAuthProvidersRequest struct {

	// OPTIONAL.
	// Opaque information.
	Opaque *v1beta1.Opaque `protobuf:"bytes,1,opt,name=opaque,proto3" json:"opaque,omitempty"`
	// REQUIRED.
	// The type of authentication provider.
	Type string `protobuf:"bytes,2,opt,name=type,proto3" json:"type,omitempty"`
	// contains filtered or unexported fields
}

func (*GetAuthProvidersRequest) Descriptor deprecated 

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

Deprecated: Use GetAuthProvidersRequest.ProtoReflect.Descriptor instead.

func (*GetAuthProvidersRequest) GetOpaque 

func (x *GetAuthProvidersRequest) GetOpaque() *v1beta1.Opaque

func (*GetAuthProvidersRequest) GetType 

func (x *GetAuthProvidersRequest) GetType() string

func (*GetAuthProvidersRequest) ProtoMessage 

func (*GetAuthProvidersRequest) ProtoMessage()

func (*GetAuthProvidersRequest) ProtoReflect 

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

func (*GetAuthProvidersRequest) Reset 

func (x *GetAuthProvidersRequest) Reset()

func (*GetAuthProvidersRequest) String 

func (x *GetAuthProvidersRequest) String() string

type GetAuthProvidersResponse 

type GetAuthProvidersResponse struct {

	// REQUIRED.
	// The response status.
	Status *v1beta11.Status `protobuf:"bytes,1,opt,name=status,proto3" json:"status,omitempty"`
	// OPTIONAL.
	// Opaque information.
	Opaque *v1beta1.Opaque `protobuf:"bytes,2,opt,name=opaque,proto3" json:"opaque,omitempty"`
	// REQUIRED.
	// The auth providers handling the requested auth call.
	Providers []*ProviderInfo `protobuf:"bytes,3,rep,name=providers,proto3" json:"providers,omitempty"`
	// contains filtered or unexported fields
}

func (*GetAuthProvidersResponse) Descriptor deprecated 

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

Deprecated: Use GetAuthProvidersResponse.ProtoReflect.Descriptor instead.

func (*GetAuthProvidersResponse) GetOpaque 

func (x *GetAuthProvidersResponse) GetOpaque() *v1beta1.Opaque

func (*GetAuthProvidersResponse) GetProviders 

func (x *GetAuthProvidersResponse) GetProviders() []*ProviderInfo

func (*GetAuthProvidersResponse) GetStatus 

func (x *GetAuthProvidersResponse) GetStatus() *v1beta11.Status

func (*GetAuthProvidersResponse) ProtoMessage 

func (*GetAuthProvidersResponse) ProtoMessage()

func (*GetAuthProvidersResponse) ProtoReflect 

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

func (*GetAuthProvidersResponse) Reset 

func (x *GetAuthProvidersResponse) Reset()

func (*GetAuthProvidersResponse) String 

func (x *GetAuthProvidersResponse) String() string

type ListAuthProvidersRequest 

type ListAuthProvidersRequest struct {

	// OPTIONAL.
	// Opaque information.
	Opaque *v1beta1.Opaque `protobuf:"bytes,1,opt,name=opaque,proto3" json:"opaque,omitempty"` // TODO(labkode): maybe add some filter?
	// contains filtered or unexported fields
}

func (*ListAuthProvidersRequest) Descriptor deprecated 

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

Deprecated: Use ListAuthProvidersRequest.ProtoReflect.Descriptor instead.

func (*ListAuthProvidersRequest) GetOpaque 

func (x *ListAuthProvidersRequest) GetOpaque() *v1beta1.Opaque

func (*ListAuthProvidersRequest) ProtoMessage 

func (*ListAuthProvidersRequest) ProtoMessage()

func (*ListAuthProvidersRequest) ProtoReflect 

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

func (*ListAuthProvidersRequest) Reset 

func (x *ListAuthProvidersRequest) Reset()

func (*ListAuthProvidersRequest) String 

func (x *ListAuthProvidersRequest) String() string

type ListAuthProvidersResponse 

type ListAuthProvidersResponse struct {

	// REQUIRED.
	// The response status.
	Status *v1beta11.Status `protobuf:"bytes,1,opt,name=status,proto3" json:"status,omitempty"`
	// OPTIONAL.
	// Opaque information.
	Opaque *v1beta1.Opaque `protobuf:"bytes,2,opt,name=opaque,proto3" json:"opaque,omitempty"`
	// REQUIRED.
	// The list of auth providers this registry knows about.
	Providers []*ProviderInfo `protobuf:"bytes,3,rep,name=providers,proto3" json:"providers,omitempty"`
	// contains filtered or unexported fields
}

func (*ListAuthProvidersResponse) Descriptor deprecated 

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

Deprecated: Use ListAuthProvidersResponse.ProtoReflect.Descriptor instead.

func (*ListAuthProvidersResponse) GetOpaque 

func (x *ListAuthProvidersResponse) GetOpaque() *v1beta1.Opaque

func (*ListAuthProvidersResponse) GetProviders 

func (x *ListAuthProvidersResponse) GetProviders() []*ProviderInfo

func (*ListAuthProvidersResponse) GetStatus 

func (x *ListAuthProvidersResponse) GetStatus() *v1beta11.Status

func (*ListAuthProvidersResponse) ProtoMessage 

func (*ListAuthProvidersResponse) ProtoMessage()

func (*ListAuthProvidersResponse) ProtoReflect 

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

func (*ListAuthProvidersResponse) Reset 

func (x *ListAuthProvidersResponse) Reset()

func (*ListAuthProvidersResponse) String 

func (x *ListAuthProvidersResponse) String() string

type ProviderInfo 

type ProviderInfo struct {

	// OPTIONAL.
	// Opaque information (containing storage-specific information).
	// For example, additional metadata attached to the resource.
	Opaque *v1beta1.Opaque `protobuf:"bytes,1,opt,name=opaque,proto3" json:"opaque,omitempty"`
	// REQUIRED.
	// The storage provider id that will become part of the
	// resource id.
	// For example, if the provider_id is "home", resources obtained
	// from this storage provider will have a resource id like "home:1234".
	ProviderType string `protobuf:"bytes,2,opt,name=provider_type,json=providerType,proto3" json:"provider_type,omitempty"`
	// REQUIRED.
	// The address where the storage provider can be reached.
	// For example, tcp://localhost:1099.
	Address string `protobuf:"bytes,4,opt,name=address,proto3" json:"address,omitempty"`
	// OPTIONAL.
	// Information to describe the functionalities
	// offered by the storage provider. Meant to be read
	// by humans.
	Description string `protobuf:"bytes,5,opt,name=description,proto3" json:"description,omitempty"`
	// contains filtered or unexported fields
}

ProviderInfo provides the information about an authentication provider.

func (*ProviderInfo) Descriptor deprecated 

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

Deprecated: Use ProviderInfo.ProtoReflect.Descriptor instead.

func (*ProviderInfo) GetAddress 

func (x *ProviderInfo) GetAddress() string

func (*ProviderInfo) GetDescription 

func (x *ProviderInfo) GetDescription() string

func (*ProviderInfo) GetOpaque 

func (x *ProviderInfo) GetOpaque() *v1beta1.Opaque

func (*ProviderInfo) GetProviderType 

func (x *ProviderInfo) GetProviderType() string

func (*ProviderInfo) ProtoMessage 

func (*ProviderInfo) ProtoMessage()

func (*ProviderInfo) ProtoReflect 

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

func (*ProviderInfo) Reset 

func (x *ProviderInfo) Reset()

func (*ProviderInfo) String 

func (x *ProviderInfo) String() string

type RegistryAPIClient 

type RegistryAPIClient interface {
	// Returns the auth provider that is reponsible for the given
	// resource reference.
	// MUST return CODE_NOT_FOUND if the reference does not exist.
	GetAuthProviders(ctx context.Context, in *GetAuthProvidersRequest, opts ...grpc.CallOption) (*GetAuthProvidersResponse, error)
	// Returns a list of the available auth providers known by this registry.
	ListAuthProviders(ctx context.Context, in *ListAuthProvidersRequest, opts ...grpc.CallOption) (*ListAuthProvidersResponse, error)
}

RegistryAPIClient is the client API for RegistryAPI 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 NewRegistryAPIClient 

func NewRegistryAPIClient(cc grpc.ClientConnInterface) RegistryAPIClient

type RegistryAPIServer 

type RegistryAPIServer interface {
	// Returns the auth provider that is reponsible for the given
	// resource reference.
	// MUST return CODE_NOT_FOUND if the reference does not exist.
	GetAuthProviders(context.Context, *GetAuthProvidersRequest) (*GetAuthProvidersResponse, error)
	// Returns a list of the available auth providers known by this registry.
	ListAuthProviders(context.Context, *ListAuthProvidersRequest) (*ListAuthProvidersResponse, error)
}

RegistryAPIServer is the server API for RegistryAPI service. All implementations should embed UnimplementedRegistryAPIServer for forward compatibility

type UnimplementedRegistryAPIServer 

type UnimplementedRegistryAPIServer struct {
}

UnimplementedRegistryAPIServer should be embedded to have forward compatible implementations.

func (UnimplementedRegistryAPIServer) GetAuthProviders 

func (UnimplementedRegistryAPIServer) GetAuthProviders(context.Context, *GetAuthProvidersRequest) (*GetAuthProvidersResponse, error)

func (UnimplementedRegistryAPIServer) ListAuthProviders 

func (UnimplementedRegistryAPIServer) ListAuthProviders(context.Context, *ListAuthProvidersRequest) (*ListAuthProvidersResponse, error)

type UnsafeRegistryAPIServer 

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

UnsafeRegistryAPIServer may be embedded to opt out of forward compatibility for this service. Use of this interface is not recommended, as added methods to RegistryAPIServer 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.