providerv1beta1

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_ocm_provider_v1beta1_provider_api_proto protoreflect.FileDescriptor
View Source 
var File_cs3_ocm_provider_v1beta1_resources_proto protoreflect.FileDescriptor

Functions

func RegisterProviderAPIHandler 

func RegisterProviderAPIHandler(s server.Server, hdlr ProviderAPIHandler, opts ...server.HandlerOption) error

func RegisterProviderAPIServer 

func RegisterProviderAPIServer(s *grpc.Server, srv ProviderAPIServer)

Types

type GetInfoByDomainRequest 

type GetInfoByDomainRequest struct {

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

func (*GetInfoByDomainRequest) Descriptor deprecated 

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

Deprecated: Use GetInfoByDomainRequest.ProtoReflect.Descriptor instead.

func (*GetInfoByDomainRequest) GetDomain 

func (x *GetInfoByDomainRequest) GetDomain() string

func (*GetInfoByDomainRequest) GetOpaque 

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

func (*GetInfoByDomainRequest) ProtoMessage 

func (*GetInfoByDomainRequest) ProtoMessage()

func (*GetInfoByDomainRequest) ProtoReflect 

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

func (*GetInfoByDomainRequest) Reset 

func (x *GetInfoByDomainRequest) Reset()

func (*GetInfoByDomainRequest) String 

func (x *GetInfoByDomainRequest) String() string

type GetInfoByDomainResponse 

type GetInfoByDomainResponse 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 info of the provider
	ProviderInfo *ProviderInfo `protobuf:"bytes,3,opt,name=provider_info,json=providerInfo,proto3" json:"provider_info,omitempty"`
	// contains filtered or unexported fields
}

func (*GetInfoByDomainResponse) Descriptor deprecated 

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

Deprecated: Use GetInfoByDomainResponse.ProtoReflect.Descriptor instead.

func (*GetInfoByDomainResponse) GetOpaque 

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

func (*GetInfoByDomainResponse) GetProviderInfo 

func (x *GetInfoByDomainResponse) GetProviderInfo() *ProviderInfo

func (*GetInfoByDomainResponse) GetStatus 

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

func (*GetInfoByDomainResponse) ProtoMessage 

func (*GetInfoByDomainResponse) ProtoMessage()

func (*GetInfoByDomainResponse) ProtoReflect 

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

func (*GetInfoByDomainResponse) Reset 

func (x *GetInfoByDomainResponse) Reset()

func (*GetInfoByDomainResponse) String 

func (x *GetInfoByDomainResponse) String() string

type IsProviderAllowedRequest 

type IsProviderAllowedRequest struct {

	// OPTIONAL.
	// Opaque information.
	Opaque *v1beta1.Opaque `protobuf:"bytes,1,opt,name=opaque,proto3" json:"opaque,omitempty"`
	// REQUIRED.
	// The provider that we need to check against the list of verified mesh providers.
	Provider *ProviderInfo `protobuf:"bytes,2,opt,name=provider,proto3" json:"provider,omitempty"`
	// contains filtered or unexported fields
}

func (*IsProviderAllowedRequest) Descriptor deprecated 

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

Deprecated: Use IsProviderAllowedRequest.ProtoReflect.Descriptor instead.

func (*IsProviderAllowedRequest) GetOpaque 

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

func (*IsProviderAllowedRequest) GetProvider 

func (x *IsProviderAllowedRequest) GetProvider() *ProviderInfo

func (*IsProviderAllowedRequest) ProtoMessage 

func (*IsProviderAllowedRequest) ProtoMessage()

func (*IsProviderAllowedRequest) ProtoReflect 

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

func (*IsProviderAllowedRequest) Reset 

func (x *IsProviderAllowedRequest) Reset()

func (*IsProviderAllowedRequest) String 

func (x *IsProviderAllowedRequest) String() string

type IsProviderAllowedResponse 

type IsProviderAllowedResponse 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"`
	// contains filtered or unexported fields
}

func (*IsProviderAllowedResponse) Descriptor deprecated 

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

Deprecated: Use IsProviderAllowedResponse.ProtoReflect.Descriptor instead.

func (*IsProviderAllowedResponse) GetOpaque 

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

func (*IsProviderAllowedResponse) GetStatus 

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

func (*IsProviderAllowedResponse) ProtoMessage 

func (*IsProviderAllowedResponse) ProtoMessage()

func (*IsProviderAllowedResponse) ProtoReflect 

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

func (*IsProviderAllowedResponse) Reset 

func (x *IsProviderAllowedResponse) Reset()

func (*IsProviderAllowedResponse) String 

func (x *IsProviderAllowedResponse) String() string

type ListAllProvidersRequest 

type ListAllProvidersRequest struct {

	// OPTIONAL.
	// Opaque information.
	Opaque *v1beta1.Opaque `protobuf:"bytes,1,opt,name=opaque,proto3" json:"opaque,omitempty"`
	// contains filtered or unexported fields
}

func (*ListAllProvidersRequest) Descriptor deprecated 

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

Deprecated: Use ListAllProvidersRequest.ProtoReflect.Descriptor instead.

func (*ListAllProvidersRequest) GetOpaque 

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

func (*ListAllProvidersRequest) ProtoMessage 

func (*ListAllProvidersRequest) ProtoMessage()

func (*ListAllProvidersRequest) ProtoReflect 

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

func (*ListAllProvidersRequest) Reset 

func (x *ListAllProvidersRequest) Reset()

func (*ListAllProvidersRequest) String 

func (x *ListAllProvidersRequest) String() string

type ListAllProvidersResponse 

type ListAllProvidersResponse 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 share.
	Providers []*ProviderInfo `protobuf:"bytes,3,rep,name=providers,proto3" json:"providers,omitempty"`
	// contains filtered or unexported fields
}

func (*ListAllProvidersResponse) Descriptor deprecated 

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

Deprecated: Use ListAllProvidersResponse.ProtoReflect.Descriptor instead.

func (*ListAllProvidersResponse) GetOpaque 

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

func (*ListAllProvidersResponse) GetProviders 

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

func (*ListAllProvidersResponse) GetStatus 

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

func (*ListAllProvidersResponse) ProtoMessage 

func (*ListAllProvidersResponse) ProtoMessage()

func (*ListAllProvidersResponse) ProtoReflect 

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

func (*ListAllProvidersResponse) Reset 

func (x *ListAllProvidersResponse) Reset()

func (*ListAllProvidersResponse) String 

func (x *ListAllProvidersResponse) String() string

type ProviderAPIClient 

type ProviderAPIClient interface {
	// Check if a given system provider is registered in the mesh or not.
	// MUST return CODE_UNAUTHENTICATED if the system is not registered
	IsProviderAllowed(ctx context.Context, in *IsProviderAllowedRequest, opts ...grpc.CallOption) (*IsProviderAllowedResponse, error)
	// Get the information of the provider identified by a specific domain.
	// MUST return CODE_NOT_FOUND if the sync'n'share system provider does not exist.
	GetInfoByDomain(ctx context.Context, in *GetInfoByDomainRequest, opts ...grpc.CallOption) (*GetInfoByDomainResponse, error)
	// Get the information of all the providers registered in the mesh.
	ListAllProviders(ctx context.Context, in *ListAllProvidersRequest, opts ...grpc.CallOption) (*ListAllProvidersResponse, error)
}

ProviderAPIClient is the client API for ProviderAPI service.

For semantics around ctx use and closing/ending streaming RPCs, please refer to https://godoc.org/google.golang.org/grpc#ClientConn.NewStream.

func NewProviderAPIClient 

func NewProviderAPIClient(cc grpc.ClientConnInterface) ProviderAPIClient

type ProviderAPIHandler 

type ProviderAPIHandler interface {
	// Check if a given system provider is registered in the mesh or not.
	// MUST return CODE_UNAUTHENTICATED if the system is not registered
	IsProviderAllowed(context.Context, *IsProviderAllowedRequest, *IsProviderAllowedResponse) error
	// Get the information of the provider identified by a specific domain.
	// MUST return CODE_NOT_FOUND if the sync'n'share system provider does not exist.
	GetInfoByDomain(context.Context, *GetInfoByDomainRequest, *GetInfoByDomainResponse) error
	// Get the information of all the providers registered in the mesh.
	ListAllProviders(context.Context, *ListAllProvidersRequest, *ListAllProvidersResponse) error
}

type ProviderAPIServer 

type ProviderAPIServer interface {
	// Check if a given system provider is registered in the mesh or not.
	// MUST return CODE_UNAUTHENTICATED if the system is not registered
	IsProviderAllowed(context.Context, *IsProviderAllowedRequest) (*IsProviderAllowedResponse, error)
	// Get the information of the provider identified by a specific domain.
	// MUST return CODE_NOT_FOUND if the sync'n'share system provider does not exist.
	GetInfoByDomain(context.Context, *GetInfoByDomainRequest) (*GetInfoByDomainResponse, error)
	// Get the information of all the providers registered in the mesh.
	ListAllProviders(context.Context, *ListAllProvidersRequest) (*ListAllProvidersResponse, error)
}

ProviderAPIServer is the server API for ProviderAPI service.

type ProviderAPIService 

type ProviderAPIService interface {
	// Check if a given system provider is registered in the mesh or not.
	// MUST return CODE_UNAUTHENTICATED if the system is not registered
	IsProviderAllowed(ctx context.Context, in *IsProviderAllowedRequest, opts ...client.CallOption) (*IsProviderAllowedResponse, error)
	// Get the information of the provider identified by a specific domain.
	// MUST return CODE_NOT_FOUND if the sync'n'share system provider does not exist.
	GetInfoByDomain(ctx context.Context, in *GetInfoByDomainRequest, opts ...client.CallOption) (*GetInfoByDomainResponse, error)
	// Get the information of all the providers registered in the mesh.
	ListAllProviders(ctx context.Context, in *ListAllProvidersRequest, opts ...client.CallOption) (*ListAllProvidersResponse, error)
}

func NewProviderAPIService 

func NewProviderAPIService(name string, c client.Client) ProviderAPIService

type ProviderInfo 

type ProviderInfo struct {

	// REQUIRED.
	// The name of the provider.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// REQUIRED.
	// The full name of the provider.
	FullName string `protobuf:"bytes,2,opt,name=full_name,json=fullName,proto3" json:"full_name,omitempty"`
	// REQUIRED.
	// A description of the provider.
	Description string `protobuf:"bytes,3,opt,name=description,proto3" json:"description,omitempty"`
	// REQUIRED.
	// The organization to which the provider belongs.
	Organization string `protobuf:"bytes,4,opt,name=organization,proto3" json:"organization,omitempty"`
	// REQUIRED.
	// The domain of the sync'n'share provider.
	Domain string `protobuf:"bytes,5,opt,name=domain,proto3" json:"domain,omitempty"`
	// REQUIRED.
	// The homepage of the provider.
	Homepage string `protobuf:"bytes,6,opt,name=homepage,proto3" json:"homepage,omitempty"`
	// REQUIRED.
	// The email at which the provider can be reached.
	Email string `protobuf:"bytes,7,opt,name=email,proto3" json:"email,omitempty"`
	// REQUIRED.
	// The list of services provided by the provider.
	Services []*Service `protobuf:"bytes,8,rep,name=services,proto3" json:"services,omitempty"`
	// OPTIONAL.
	// Additional properties about the service.
	Properties map[string]string `` /* 161-byte string literal not displayed */
	// contains filtered or unexported fields
}

Details of the sync'n'share system provider.

func (*ProviderInfo) Descriptor deprecated 

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

Deprecated: Use ProviderInfo.ProtoReflect.Descriptor instead.

func (*ProviderInfo) GetDescription 

func (x *ProviderInfo) GetDescription() string

func (*ProviderInfo) GetDomain 

func (x *ProviderInfo) GetDomain() string

func (*ProviderInfo) GetEmail 

func (x *ProviderInfo) GetEmail() string

func (*ProviderInfo) GetFullName 

func (x *ProviderInfo) GetFullName() string

func (*ProviderInfo) GetHomepage 

func (x *ProviderInfo) GetHomepage() string

func (*ProviderInfo) GetName 

func (x *ProviderInfo) GetName() string

func (*ProviderInfo) GetOrganization 

func (x *ProviderInfo) GetOrganization() string

func (*ProviderInfo) GetProperties 

func (x *ProviderInfo) GetProperties() map[string]string

func (*ProviderInfo) GetServices 

func (x *ProviderInfo) GetServices() []*Service

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 Service 

type Service struct {

	// REQUIRED.
	// The URL at which the service is hosted.
	Host string `protobuf:"bytes,1,opt,name=host,proto3" json:"host,omitempty"`
	// REQUIRED.
	// The primary endpoint of the service.
	Endpoint *ServiceEndpoint `protobuf:"bytes,2,opt,name=endpoint,proto3" json:"endpoint,omitempty"`
	// REQUIRED.
	// The API version of the provided service.
	ApiVersion string `protobuf:"bytes,3,opt,name=api_version,json=apiVersion,proto3" json:"api_version,omitempty"`
	// OPTIONAL.
	// Additional endpoints at which the service is exposed.
	AdditionalEndpoints []*ServiceEndpoint `protobuf:"bytes,4,rep,name=additional_endpoints,json=additionalEndpoints,proto3" json:"additional_endpoints,omitempty"`
	// contains filtered or unexported fields
}

The services offered by sync'n'share system providers.

func (*Service) Descriptor deprecated 

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

Deprecated: Use Service.ProtoReflect.Descriptor instead.

func (*Service) GetAdditionalEndpoints 

func (x *Service) GetAdditionalEndpoints() []*ServiceEndpoint

func (*Service) GetApiVersion 

func (x *Service) GetApiVersion() string

func (*Service) GetEndpoint 

func (x *Service) GetEndpoint() *ServiceEndpoint

func (*Service) GetHost 

func (x *Service) GetHost() string

func (*Service) ProtoMessage 

func (*Service) ProtoMessage()

func (*Service) ProtoReflect 

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

func (*Service) Reset 

func (x *Service) Reset()

func (*Service) String 

func (x *Service) String() string

type ServiceEndpoint 

type ServiceEndpoint struct {

	// REQUIRED.
	// The type of service.
	Type *ServiceType `protobuf:"bytes,1,opt,name=type,proto3" json:"type,omitempty"`
	// REQUIRED.
	// The name of the service.
	Name string `protobuf:"bytes,2,opt,name=name,proto3" json:"name,omitempty"`
	// REQUIRED.
	// The path at which the service is hosted.
	Path string `protobuf:"bytes,3,opt,name=path,proto3" json:"path,omitempty"`
	// OPTIONAL.
	// Whether the service is monitored.
	IsMonitored bool `protobuf:"varint,4,opt,name=is_monitored,json=isMonitored,proto3" json:"is_monitored,omitempty"`
	// OPTIONAL.
	// Additional properties about the service.
	Properties map[string]string `` /* 161-byte string literal not displayed */
	// contains filtered or unexported fields
}

The endpoints exposed by particular services.

func (*ServiceEndpoint) Descriptor deprecated 

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

Deprecated: Use ServiceEndpoint.ProtoReflect.Descriptor instead.

func (*ServiceEndpoint) GetIsMonitored 

func (x *ServiceEndpoint) GetIsMonitored() bool

func (*ServiceEndpoint) GetName 

func (x *ServiceEndpoint) GetName() string

func (*ServiceEndpoint) GetPath 

func (x *ServiceEndpoint) GetPath() string

func (*ServiceEndpoint) GetProperties 

func (x *ServiceEndpoint) GetProperties() map[string]string

func (*ServiceEndpoint) GetType 

func (x *ServiceEndpoint) GetType() *ServiceType

func (*ServiceEndpoint) ProtoMessage 

func (*ServiceEndpoint) ProtoMessage()

func (*ServiceEndpoint) ProtoReflect 

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

func (*ServiceEndpoint) Reset 

func (x *ServiceEndpoint) Reset()

func (*ServiceEndpoint) String 

func (x *ServiceEndpoint) String() string

type ServiceType 

type ServiceType struct {

	// REQUIRED
	// The name of the service type.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// REQUIRED
	// The description of the service type.
	Description string `protobuf:"bytes,2,opt,name=description,proto3" json:"description,omitempty"`
	// contains filtered or unexported fields
}

Identifier for various types of services offered by sync'n'share system providers.

func (*ServiceType) Descriptor deprecated 

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

Deprecated: Use ServiceType.ProtoReflect.Descriptor instead.

func (*ServiceType) GetDescription 

func (x *ServiceType) GetDescription() string

func (*ServiceType) GetName 

func (x *ServiceType) GetName() string

func (*ServiceType) ProtoMessage 

func (*ServiceType) ProtoMessage()

func (*ServiceType) ProtoReflect 

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

func (*ServiceType) Reset 

func (x *ServiceType) Reset()

func (*ServiceType) String 

func (x *ServiceType) String() string

type UnimplementedProviderAPIServer 

type UnimplementedProviderAPIServer struct {
}

UnimplementedProviderAPIServer can be embedded to have forward compatible implementations.

func (*UnimplementedProviderAPIServer) GetInfoByDomain 

func (*UnimplementedProviderAPIServer) GetInfoByDomain(context.Context, *GetInfoByDomainRequest) (*GetInfoByDomainResponse, error)

func (*UnimplementedProviderAPIServer) IsProviderAllowed 

func (*UnimplementedProviderAPIServer) IsProviderAllowed(context.Context, *IsProviderAllowedRequest) (*IsProviderAllowedResponse, error)

func (*UnimplementedProviderAPIServer) ListAllProviders 

func (*UnimplementedProviderAPIServer) ListAllProviders(context.Context, *ListAllProvidersRequest) (*ListAllProvidersResponse, error)

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.