presentationContracts

package module
v1.0.8 Latest Latest
Warning

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

 Go to latest Published: May 15, 2023 License: MIT Imports: 9 Imported by: 0

README

presentation-contracts

gRPC contracts between API and presentation services

How to Run

protoc --go_out=. --go_opt=paths=source_relative --go-grpc_out=. --go-grpc_opt=paths=source_relative *.proto

Documentation

Index

Constants

This section is empty.

Variables

View Source 
var File_presentation_proto protoreflect.FileDescriptor
View Source 
var Presentation_ServiceDesc = grpc.ServiceDesc{
	ServiceName: "Presentation",
	HandlerType: (*PresentationServer)(nil),
	Methods: []grpc.MethodDesc{
		{
			MethodName: "CheckHealth",
			Handler:    _Presentation_CheckHealth_Handler,
		},
		{
			MethodName: "GetArtist",
			Handler:    _Presentation_GetArtist_Handler,
		},
		{
			MethodName: "GetRelease",
			Handler:    _Presentation_GetRelease_Handler,
		},
	},
	Streams:  []grpc.StreamDesc{},
	Metadata: "presentation.proto",
}

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

Functions

func RegisterPresentationServer 

func RegisterPresentationServer(s grpc.ServiceRegistrar, srv PresentationServer)

Types

type Artist 

type Artist struct {
	Id                 int32                  `protobuf:"varint,1,opt,name=Id,proto3" json:"Id,omitempty"`
	Name               string                 `protobuf:"bytes,2,opt,name=Name,proto3" json:"Name,omitempty"`
	PresentationConfig *PresentationConfig    `protobuf:"bytes,3,opt,name=PresentationConfig,proto3" json:"PresentationConfig,omitempty"`
	Releases           []*SlimRelease         `protobuf:"bytes,4,rep,name=Releases,proto3" json:"Releases,omitempty"`
	ReleaseStats       *ReleaseStats          `protobuf:"bytes,5,opt,name=ReleaseStats,proto3" json:"ReleaseStats,omitempty"`
	SocialNetworks     []*ArtistSocialNetwork `protobuf:"bytes,6,rep,name=SocialNetworks,proto3" json:"SocialNetworks,omitempty"`
	// contains filtered or unexported fields
}

func (*Artist) Descriptor deprecated 

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

Deprecated: Use Artist.ProtoReflect.Descriptor instead.

func (*Artist) GetId 

func (x *Artist) GetId() int32

func (*Artist) GetName 

func (x *Artist) GetName() string

func (*Artist) GetPresentationConfig added in v1.0.7 

func (x *Artist) GetPresentationConfig() *PresentationConfig

func (*Artist) GetReleaseStats added in v1.0.7 

func (x *Artist) GetReleaseStats() *ReleaseStats

func (*Artist) GetReleases 

func (x *Artist) GetReleases() []*SlimRelease

func (*Artist) GetSocialNetworks added in v1.0.7 

func (x *Artist) GetSocialNetworks() []*ArtistSocialNetwork

func (*Artist) ProtoMessage 

func (*Artist) ProtoMessage()

func (*Artist) ProtoReflect 

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

func (*Artist) Reset 

func (x *Artist) Reset()

func (*Artist) String 

func (x *Artist) String() string

type ArtistRequest 

type ArtistRequest struct {
	Id int32 `protobuf:"varint,1,opt,name=Id,proto3" json:"Id,omitempty"`
	// contains filtered or unexported fields
}

func (*ArtistRequest) Descriptor deprecated 

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

Deprecated: Use ArtistRequest.ProtoReflect.Descriptor instead.

func (*ArtistRequest) GetId 

func (x *ArtistRequest) GetId() int32

func (*ArtistRequest) ProtoMessage 

func (*ArtistRequest) ProtoMessage()

func (*ArtistRequest) ProtoReflect 

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

func (*ArtistRequest) Reset 

func (x *ArtistRequest) Reset()

func (*ArtistRequest) String 

func (x *ArtistRequest) String() string

type ArtistSocialNetwork added in v1.0.7 

type ArtistSocialNetwork struct {
	Id  string `protobuf:"bytes,1,opt,name=Id,proto3" json:"Id,omitempty"`
	Url string `protobuf:"bytes,2,opt,name=Url,proto3" json:"Url,omitempty"`
	// contains filtered or unexported fields
}

func (*ArtistSocialNetwork) Descriptor deprecated added in v1.0.7 

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

Deprecated: Use ArtistSocialNetwork.ProtoReflect.Descriptor instead.

func (*ArtistSocialNetwork) GetId added in v1.0.7 

func (x *ArtistSocialNetwork) GetId() string

func (*ArtistSocialNetwork) GetUrl added in v1.0.7 

func (x *ArtistSocialNetwork) GetUrl() string

func (*ArtistSocialNetwork) ProtoMessage added in v1.0.7 

func (*ArtistSocialNetwork) ProtoMessage()

func (*ArtistSocialNetwork) ProtoReflect added in v1.0.7 

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

func (*ArtistSocialNetwork) Reset added in v1.0.7 

func (x *ArtistSocialNetwork) Reset()

func (*ArtistSocialNetwork) String added in v1.0.7 

func (x *ArtistSocialNetwork) String() string

type HealthCheckRequest added in v1.0.5 

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

func (*HealthCheckRequest) Descriptor deprecated added in v1.0.5 

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

Deprecated: Use HealthCheckRequest.ProtoReflect.Descriptor instead.

func (*HealthCheckRequest) ProtoMessage added in v1.0.5 

func (*HealthCheckRequest) ProtoMessage()

func (*HealthCheckRequest) ProtoReflect added in v1.0.5 

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

func (*HealthCheckRequest) Reset added in v1.0.5 

func (x *HealthCheckRequest) Reset()

func (*HealthCheckRequest) String added in v1.0.5 

func (x *HealthCheckRequest) String() string

type HealthCheckResponse added in v1.0.5 

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

func (*HealthCheckResponse) Descriptor deprecated added in v1.0.5 

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

Deprecated: Use HealthCheckResponse.ProtoReflect.Descriptor instead.

func (*HealthCheckResponse) ProtoMessage added in v1.0.5 

func (*HealthCheckResponse) ProtoMessage()

func (*HealthCheckResponse) ProtoReflect added in v1.0.5 

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

func (*HealthCheckResponse) Reset added in v1.0.5 

func (x *HealthCheckResponse) Reset()

func (*HealthCheckResponse) String added in v1.0.5 

func (x *HealthCheckResponse) String() string

type ImageDetails 

type ImageDetails struct {
	AltText string `protobuf:"bytes,1,opt,name=AltText,proto3" json:"AltText,omitempty"`
	Height  int32  `protobuf:"varint,2,opt,name=Height,proto3" json:"Height,omitempty"`
	Url     string `protobuf:"bytes,3,opt,name=Url,proto3" json:"Url,omitempty"`
	Width   int32  `protobuf:"varint,4,opt,name=Width,proto3" json:"Width,omitempty"`
	// contains filtered or unexported fields
}

func (*ImageDetails) Descriptor deprecated 

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

Deprecated: Use ImageDetails.ProtoReflect.Descriptor instead.

func (*ImageDetails) GetAltText 

func (x *ImageDetails) GetAltText() string

func (*ImageDetails) GetHeight 

func (x *ImageDetails) GetHeight() int32

func (*ImageDetails) GetUrl 

func (x *ImageDetails) GetUrl() string

func (*ImageDetails) GetWidth 

func (x *ImageDetails) GetWidth() int32

func (*ImageDetails) ProtoMessage 

func (*ImageDetails) ProtoMessage()

func (*ImageDetails) ProtoReflect 

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

func (*ImageDetails) Reset 

func (x *ImageDetails) Reset()

func (*ImageDetails) String 

func (x *ImageDetails) String() string

type PlatformUrl added in v1.0.1 

type PlatformUrl struct {
	PlatformId string `protobuf:"bytes,1,opt,name=PlatformId,proto3" json:"PlatformId,omitempty"`
	Url        string `protobuf:"bytes,2,opt,name=Url,proto3" json:"Url,omitempty"`
	// contains filtered or unexported fields
}

func (*PlatformUrl) Descriptor deprecated added in v1.0.1 

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

Deprecated: Use PlatformUrl.ProtoReflect.Descriptor instead.

func (*PlatformUrl) GetPlatformId added in v1.0.1 

func (x *PlatformUrl) GetPlatformId() string

func (*PlatformUrl) GetUrl added in v1.0.1 

func (x *PlatformUrl) GetUrl() string

func (*PlatformUrl) ProtoMessage added in v1.0.1 

func (*PlatformUrl) ProtoMessage()

func (*PlatformUrl) ProtoReflect added in v1.0.1 

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

func (*PlatformUrl) Reset added in v1.0.1 

func (x *PlatformUrl) Reset()

func (*PlatformUrl) String added in v1.0.1 

func (x *PlatformUrl) String() string

type PresentationClient 

type PresentationClient interface {
	CheckHealth(ctx context.Context, in *HealthCheckRequest, opts ...grpc.CallOption) (*HealthCheckResponse, error)
	GetArtist(ctx context.Context, in *ArtistRequest, opts ...grpc.CallOption) (*Artist, error)
	GetRelease(ctx context.Context, in *ReleaseRequest, opts ...grpc.CallOption) (*Release, error)
}

PresentationClient is the client API for Presentation 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 NewPresentationClient 

func NewPresentationClient(cc grpc.ClientConnInterface) PresentationClient

type PresentationConfig added in v1.0.7 

type PresentationConfig struct {
	ShareableSocialNetworkIds []string `protobuf:"bytes,1,rep,name=ShareableSocialNetworkIds,proto3" json:"ShareableSocialNetworkIds,omitempty"`
	// contains filtered or unexported fields
}

func (*PresentationConfig) Descriptor deprecated added in v1.0.7 

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

Deprecated: Use PresentationConfig.ProtoReflect.Descriptor instead.

func (*PresentationConfig) GetShareableSocialNetworkIds added in v1.0.7 

func (x *PresentationConfig) GetShareableSocialNetworkIds() []string

func (*PresentationConfig) ProtoMessage added in v1.0.7 

func (*PresentationConfig) ProtoMessage()

func (*PresentationConfig) ProtoReflect added in v1.0.7 

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

func (*PresentationConfig) Reset added in v1.0.7 

func (x *PresentationConfig) Reset()

func (*PresentationConfig) String added in v1.0.7 

func (x *PresentationConfig) String() string

type PresentationServer 

type PresentationServer interface {
	CheckHealth(context.Context, *HealthCheckRequest) (*HealthCheckResponse, error)
	GetArtist(context.Context, *ArtistRequest) (*Artist, error)
	GetRelease(context.Context, *ReleaseRequest) (*Release, error)
	// contains filtered or unexported methods
}

PresentationServer is the server API for Presentation service. All implementations must embed UnimplementedPresentationServer for forward compatibility

type Release 

type Release struct {
	Id                 int32                  `protobuf:"varint,1,opt,name=Id,proto3" json:"Id,omitempty"`
	Description        string                 `protobuf:"bytes,2,opt,name=Description,proto3" json:"Description,omitempty"`
	ImageDetails       *ImageDetails          `protobuf:"bytes,3,opt,name=ImageDetails,proto3" json:"ImageDetails,omitempty"`
	Label              string                 `protobuf:"bytes,4,opt,name=Label,proto3" json:"Label,omitempty"`
	Name               string                 `protobuf:"bytes,5,opt,name=Name,proto3" json:"Name,omitempty"`
	PlatformUrls       []*PlatformUrl         `protobuf:"bytes,6,rep,name=PlatformUrls,proto3" json:"PlatformUrls,omitempty"`
	PresentationConfig *PresentationConfig    `protobuf:"bytes,7,opt,name=PresentationConfig,proto3" json:"PresentationConfig,omitempty"`
	ReleaseArtists     []*SlimArtist          `protobuf:"bytes,8,rep,name=ReleaseArtists,proto3" json:"ReleaseArtists,omitempty"`
	ReleaseStats       *ReleaseStats          `protobuf:"bytes,9,opt,name=ReleaseStats,proto3" json:"ReleaseStats,omitempty"`
	ReleaseDate        *timestamppb.Timestamp `protobuf:"bytes,10,opt,name=ReleaseDate,proto3" json:"ReleaseDate,omitempty"`
	Tags               []string               `protobuf:"bytes,11,rep,name=Tags,proto3" json:"Tags,omitempty"`
	Tracks             []*Track               `protobuf:"bytes,12,rep,name=Tracks,proto3" json:"Tracks,omitempty"`
	Type               string                 `protobuf:"bytes,13,opt,name=Type,proto3" json:"Type,omitempty"`
	// contains filtered or unexported fields
}

func (*Release) Descriptor deprecated 

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

Deprecated: Use Release.ProtoReflect.Descriptor instead.

func (*Release) GetDescription added in v1.0.4 

func (x *Release) GetDescription() string

func (*Release) GetId 

func (x *Release) GetId() int32

func (*Release) GetImageDetails 

func (x *Release) GetImageDetails() *ImageDetails

func (*Release) GetLabel 

func (x *Release) GetLabel() string

func (*Release) GetName 

func (x *Release) GetName() string

func (*Release) GetPlatformUrls added in v1.0.1 

func (x *Release) GetPlatformUrls() []*PlatformUrl

func (*Release) GetPresentationConfig added in v1.0.7 

func (x *Release) GetPresentationConfig() *PresentationConfig

func (*Release) GetReleaseArtists 

func (x *Release) GetReleaseArtists() []*SlimArtist

func (*Release) GetReleaseDate 

func (x *Release) GetReleaseDate() *timestamppb.Timestamp

func (*Release) GetReleaseStats added in v1.0.7 

func (x *Release) GetReleaseStats() *ReleaseStats

func (*Release) GetTags added in v1.0.4 

func (x *Release) GetTags() []string

func (*Release) GetTracks 

func (x *Release) GetTracks() []*Track

func (*Release) GetType 

func (x *Release) GetType() string

func (*Release) ProtoMessage 

func (*Release) ProtoMessage()

func (*Release) ProtoReflect 

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

func (*Release) Reset 

func (x *Release) Reset()

func (*Release) String 

func (x *Release) String() string

type ReleaseRequest 

type ReleaseRequest struct {
	Id int32 `protobuf:"varint,1,opt,name=Id,proto3" json:"Id,omitempty"`
	// contains filtered or unexported fields
}

func (*ReleaseRequest) Descriptor deprecated 

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

Deprecated: Use ReleaseRequest.ProtoReflect.Descriptor instead.

func (*ReleaseRequest) GetId 

func (x *ReleaseRequest) GetId() int32

func (*ReleaseRequest) ProtoMessage 

func (*ReleaseRequest) ProtoMessage()

func (*ReleaseRequest) ProtoReflect 

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

func (*ReleaseRequest) Reset 

func (x *ReleaseRequest) Reset()

func (*ReleaseRequest) String 

func (x *ReleaseRequest) String() string

type ReleaseStats added in v1.0.7 

type ReleaseStats struct {
	AlbumNumber       int32 `protobuf:"varint,1,opt,name=AlbumNumber,proto3" json:"AlbumNumber,omitempty"`
	CompilationNumber int32 `protobuf:"varint,2,opt,name=CompilationNumber,proto3" json:"CompilationNumber,omitempty"`
	SingleNumber      int32 `protobuf:"varint,3,opt,name=SingleNumber,proto3" json:"SingleNumber,omitempty"`
	// contains filtered or unexported fields
}

func (*ReleaseStats) Descriptor deprecated added in v1.0.7 

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

Deprecated: Use ReleaseStats.ProtoReflect.Descriptor instead.

func (*ReleaseStats) GetAlbumNumber added in v1.0.7 

func (x *ReleaseStats) GetAlbumNumber() int32

func (*ReleaseStats) GetCompilationNumber added in v1.0.7 

func (x *ReleaseStats) GetCompilationNumber() int32

func (*ReleaseStats) GetSingleNumber added in v1.0.7 

func (x *ReleaseStats) GetSingleNumber() int32

func (*ReleaseStats) ProtoMessage added in v1.0.7 

func (*ReleaseStats) ProtoMessage()

func (*ReleaseStats) ProtoReflect added in v1.0.7 

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

func (*ReleaseStats) Reset added in v1.0.7 

func (x *ReleaseStats) Reset()

func (*ReleaseStats) String added in v1.0.7 

func (x *ReleaseStats) String() string

type SlimArtist 

type SlimArtist struct {
	Id   int32  `protobuf:"varint,1,opt,name=Id,proto3" json:"Id,omitempty"`
	Name string `protobuf:"bytes,2,opt,name=Name,proto3" json:"Name,omitempty"`
	// contains filtered or unexported fields
}

func (*SlimArtist) Descriptor deprecated 

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

Deprecated: Use SlimArtist.ProtoReflect.Descriptor instead.

func (*SlimArtist) GetId 

func (x *SlimArtist) GetId() int32

func (*SlimArtist) GetName 

func (x *SlimArtist) GetName() string

func (*SlimArtist) ProtoMessage 

func (*SlimArtist) ProtoMessage()

func (*SlimArtist) ProtoReflect 

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

func (*SlimArtist) Reset 

func (x *SlimArtist) Reset()

func (*SlimArtist) String 

func (x *SlimArtist) String() string

type SlimRelease added in v1.0.1 

type SlimRelease struct {
	Id           int32                  `protobuf:"varint,1,opt,name=Id,proto3" json:"Id,omitempty"`
	ImageDetails *ImageDetails          `protobuf:"bytes,2,opt,name=ImageDetails,proto3" json:"ImageDetails,omitempty"`
	Name         string                 `protobuf:"bytes,3,opt,name=Name,proto3" json:"Name,omitempty"`
	ReleaseDate  *timestamppb.Timestamp `protobuf:"bytes,4,opt,name=ReleaseDate,proto3" json:"ReleaseDate,omitempty"`
	Type         string                 `protobuf:"bytes,5,opt,name=Type,proto3" json:"Type,omitempty"`
	// contains filtered or unexported fields
}

func (*SlimRelease) Descriptor deprecated added in v1.0.1 

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

Deprecated: Use SlimRelease.ProtoReflect.Descriptor instead.

func (*SlimRelease) GetId added in v1.0.1 

func (x *SlimRelease) GetId() int32

func (*SlimRelease) GetImageDetails added in v1.0.1 

func (x *SlimRelease) GetImageDetails() *ImageDetails

func (*SlimRelease) GetName added in v1.0.1 

func (x *SlimRelease) GetName() string

func (*SlimRelease) GetReleaseDate added in v1.0.1 

func (x *SlimRelease) GetReleaseDate() *timestamppb.Timestamp

func (*SlimRelease) GetType added in v1.0.1 

func (x *SlimRelease) GetType() string

func (*SlimRelease) ProtoMessage added in v1.0.1 

func (*SlimRelease) ProtoMessage()

func (*SlimRelease) ProtoReflect added in v1.0.1 

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

func (*SlimRelease) Reset added in v1.0.1 

func (x *SlimRelease) Reset()

func (*SlimRelease) String added in v1.0.1 

func (x *SlimRelease) String() string

type Track 

type Track struct {
	Artists     []*SlimArtist `protobuf:"bytes,1,rep,name=Artists,proto3" json:"Artists,omitempty"`
	DiscNumber  int32         `protobuf:"varint,2,opt,name=DiscNumber,proto3" json:"DiscNumber,omitempty"`
	IsExplicit  bool          `protobuf:"varint,3,opt,name=IsExplicit,proto3" json:"IsExplicit,omitempty"`
	Name        string        `protobuf:"bytes,4,opt,name=Name,proto3" json:"Name,omitempty"`
	TrackNumber int32         `protobuf:"varint,5,opt,name=TrackNumber,proto3" json:"TrackNumber,omitempty"`
	// contains filtered or unexported fields
}

func (*Track) Descriptor deprecated 

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

Deprecated: Use Track.ProtoReflect.Descriptor instead.

func (*Track) GetArtists 

func (x *Track) GetArtists() []*SlimArtist

func (*Track) GetDiscNumber 

func (x *Track) GetDiscNumber() int32

func (*Track) GetIsExplicit 

func (x *Track) GetIsExplicit() bool

func (*Track) GetName 

func (x *Track) GetName() string

func (*Track) GetTrackNumber 

func (x *Track) GetTrackNumber() int32

func (*Track) ProtoMessage 

func (*Track) ProtoMessage()

func (*Track) ProtoReflect 

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

func (*Track) Reset 

func (x *Track) Reset()

func (*Track) String 

func (x *Track) String() string

type UnimplementedPresentationServer 

type UnimplementedPresentationServer struct {
}

UnimplementedPresentationServer must be embedded to have forward compatible implementations.

func (UnimplementedPresentationServer) CheckHealth added in v1.0.5 

func (UnimplementedPresentationServer) CheckHealth(context.Context, *HealthCheckRequest) (*HealthCheckResponse, error)

func (UnimplementedPresentationServer) GetArtist 

func (UnimplementedPresentationServer) GetArtist(context.Context, *ArtistRequest) (*Artist, error)

func (UnimplementedPresentationServer) GetRelease 

func (UnimplementedPresentationServer) GetRelease(context.Context, *ReleaseRequest) (*Release, error)

type UnsafePresentationServer 

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

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

Source Files

View all Source files

Directories

Path Synopsis

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.