registryv1beta1

package
v0.0.0-...-6b5d9df Latest Latest
Warning

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

Go to latest
Published: Jul 15, 2020 License: Apache-2.0 Imports: 15 Imported by: 0

Documentation

Index

Constants

This section is empty.

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

Functions

func RegisterRegistryAPIHandler

func RegisterRegistryAPIHandler(s server.Server, hdlr RegistryAPIHandler, opts ...server.HandlerOption) error

func RegisterRegistryAPIServer

func RegisterRegistryAPIServer(s *grpc.Server, srv RegistryAPIServer)

Types

type GetAuthProviderRequest

type GetAuthProviderRequest 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 (*GetAuthProviderRequest) Descriptor deprecated

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

Deprecated: Use GetAuthProviderRequest.ProtoReflect.Descriptor instead.

func (*GetAuthProviderRequest) GetOpaque

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

func (*GetAuthProviderRequest) GetType

func (x *GetAuthProviderRequest) GetType() string

func (*GetAuthProviderRequest) ProtoMessage

func (*GetAuthProviderRequest) ProtoMessage()

func (*GetAuthProviderRequest) ProtoReflect

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

func (*GetAuthProviderRequest) Reset

func (x *GetAuthProviderRequest) Reset()

func (*GetAuthProviderRequest) String

func (x *GetAuthProviderRequest) String() string

type GetAuthProviderResponse

type GetAuthProviderResponse 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 provider handling the requested auth call.
	Provider *ProviderInfo `protobuf:"bytes,3,opt,name=provider,proto3" json:"provider,omitempty"`
	// contains filtered or unexported fields
}

func (*GetAuthProviderResponse) Descriptor deprecated

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

Deprecated: Use GetAuthProviderResponse.ProtoReflect.Descriptor instead.

func (*GetAuthProviderResponse) GetOpaque

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

func (*GetAuthProviderResponse) GetProvider

func (x *GetAuthProviderResponse) GetProvider() *ProviderInfo

func (*GetAuthProviderResponse) GetStatus

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

func (*GetAuthProviderResponse) ProtoMessage

func (*GetAuthProviderResponse) ProtoMessage()

func (*GetAuthProviderResponse) ProtoReflect

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

func (*GetAuthProviderResponse) Reset

func (x *GetAuthProviderResponse) Reset()

func (*GetAuthProviderResponse) String

func (x *GetAuthProviderResponse) 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 (*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.
	GetAuthProvider(ctx context.Context, in *GetAuthProviderRequest, opts ...grpc.CallOption) (*GetAuthProviderResponse, 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://godoc.org/google.golang.org/grpc#ClientConn.NewStream.

type RegistryAPIHandler

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

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.
	GetAuthProvider(context.Context, *GetAuthProviderRequest) (*GetAuthProviderResponse, 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.

type RegistryAPIService

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

func NewRegistryAPIService

func NewRegistryAPIService(name string, c client.Client) RegistryAPIService

type UnimplementedRegistryAPIServer

type UnimplementedRegistryAPIServer struct {
}

UnimplementedRegistryAPIServer can be embedded to have forward compatible implementations.

func (*UnimplementedRegistryAPIServer) GetAuthProvider

func (*UnimplementedRegistryAPIServer) ListAuthProviders

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL