shelfv1

type BatchGetShelvesRequest struct {

	// The ids of the requested shelves.
	Ids []string `protobuf:"bytes,1,rep,name=ids,proto3" json:"ids,omitempty"`
	// contains filtered or unexported fields
}

type BatchGetShelvesResponse struct {

	// The retrieved shelves.
	Shelves []*Shelf `protobuf:"bytes,1,rep,name=shelves,proto3" json:"shelves,omitempty"`
	// contains filtered or unexported fields
}

type CreateShelfRequest struct {

	// The shelf to create.
	Shelf *Shelf `protobuf:"bytes,1,opt,name=shelf,proto3" json:"shelf,omitempty"`
	// The unique id of the parent example where the shelf is to be created.
	ExampleId string `protobuf:"bytes,4,opt,name=example_id,json=exampleId,proto3" json:"example_id,omitempty"`
	// contains filtered or unexported fields
}

type CreateShelfResponse struct {

	// The created shelf.
	Shelf *Shelf `protobuf:"bytes,1,opt,name=shelf,proto3" json:"shelf,omitempty"`
	// contains filtered or unexported fields
}

type DeleteShelfRequest struct {

	// The id of the shelf to be deleted.
	Id string `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"`
	// contains filtered or unexported fields
}

type DeleteShelfResponse struct {

	// The deleted shelf.
	Shelf *Shelf `protobuf:"bytes,1,opt,name=shelf,proto3" json:"shelf,omitempty"`
	// contains filtered or unexported fields
}

type GetShelfRequest struct {

	// The id of the requested shelf.
	Id string `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"`
	// contains filtered or unexported fields
}

type GetShelfResponse struct {

	// The retrieved shelf.
	Shelf *Shelf `protobuf:"bytes,1,opt,name=shelf,proto3" json:"shelf,omitempty"`
	// contains filtered or unexported fields
}

type ListShelvesRequest struct {

	// Only retrieve shelves after this time.
	AfterTime *timestamppb.Timestamp `protobuf:"bytes,1,opt,name=after_time,json=afterTime,proto3" json:"after_time,omitempty"`
	// Only retrieve shelves before this time.
	BeforeTime *timestamppb.Timestamp `protobuf:"bytes,2,opt,name=before_time,json=beforeTime,proto3" json:"before_time,omitempty"`
	// The start index for pagination.
	Start uint64 `protobuf:"varint,3,opt,name=start,proto3" json:"start,omitempty"`
	// The maximum number of shelves to return.
	MaxSize uint64 `protobuf:"varint,4,opt,name=max_size,json=maxSize,proto3" json:"max_size,omitempty"`
	// The unique id of the parent example for which to list the shelves.
	ExampleId string `protobuf:"bytes,5,opt,name=example_id,json=exampleId,proto3" json:"example_id,omitempty"`
	// contains filtered or unexported fields
}

type ListShelvesResponse struct {

	// The retrieved list of shelves.
	Shelves []*Shelf `protobuf:"bytes,1,rep,name=shelves,proto3" json:"shelves,omitempty"`
	// True if more shelves are available.
	Next bool `protobuf:"varint,2,opt,name=next,proto3" json:"next,omitempty"`
	// contains filtered or unexported fields
}

type Shelf struct {

	// The unique shelf id.
	Id string `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"`
	// Indicates when the shelf was created.
	CreateTime *timestamppb.Timestamp `protobuf:"bytes,2,opt,name=create_time,json=createTime,proto3" json:"create_time,omitempty"`
	// Indicates when the shelf was last updated.
	UpdateTime *timestamppb.Timestamp `protobuf:"bytes,3,opt,name=update_time,json=updateTime,proto3" json:"update_time,omitempty"`
	// The unique id of the parent example resource.
	ExampleId string `protobuf:"bytes,4,opt,name=example_id,json=exampleId,proto3" json:"example_id,omitempty"`
	// The display name for the shelf.
	DisplayName string `protobuf:"bytes,5,opt,name=display_name,json=displayName,proto3" json:"display_name,omitempty"`
	// contains filtered or unexported fields
}

type ShelfServiceClient interface {
	// ListShelves retrieves a list of shelf resources from the server.
	ListShelves(ctx context.Context, in *ListShelvesRequest, opts ...grpc.CallOption) (*ListShelvesResponse, error)
	// BatchGetShelves retrieves multiple shelf resources from the server.
	BatchGetShelves(ctx context.Context, in *BatchGetShelvesRequest, opts ...grpc.CallOption) (*BatchGetShelvesResponse, error)
	// GetShelf retrieves a single shelf resource from the server.
	GetShelf(ctx context.Context, in *GetShelfRequest, opts ...grpc.CallOption) (*GetShelfResponse, error)
	// CreateShelf creates a new shelf resource on the server.
	CreateShelf(ctx context.Context, in *CreateShelfRequest, opts ...grpc.CallOption) (*CreateShelfResponse, error)
	// UpdateShelf updates the shelf resource on the server.
	UpdateShelf(ctx context.Context, in *UpdateShelfRequest, opts ...grpc.CallOption) (*UpdateShelfResponse, error)
	// DeleteShelf deletes the shelf resource from the server.
	DeleteShelf(ctx context.Context, in *DeleteShelfRequest, opts ...grpc.CallOption) (*DeleteShelfResponse, error)
}

type ShelfServiceServer interface {
	// ListShelves retrieves a list of shelf resources from the server.
	ListShelves(context.Context, *ListShelvesRequest) (*ListShelvesResponse, error)
	// BatchGetShelves retrieves multiple shelf resources from the server.
	BatchGetShelves(context.Context, *BatchGetShelvesRequest) (*BatchGetShelvesResponse, error)
	// GetShelf retrieves a single shelf resource from the server.
	GetShelf(context.Context, *GetShelfRequest) (*GetShelfResponse, error)
	// CreateShelf creates a new shelf resource on the server.
	CreateShelf(context.Context, *CreateShelfRequest) (*CreateShelfResponse, error)
	// UpdateShelf updates the shelf resource on the server.
	UpdateShelf(context.Context, *UpdateShelfRequest) (*UpdateShelfResponse, error)
	// DeleteShelf deletes the shelf resource from the server.
	DeleteShelf(context.Context, *DeleteShelfRequest) (*DeleteShelfResponse, error)
}

type UnimplementedShelfServiceServer struct {
}

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

type UpdateShelfRequest struct {

	// The id of the shelf to be updated.
	Id string `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"`
	// The shelf which replaces the shelf on the server.
	Shelf *Shelf `protobuf:"bytes,2,opt,name=shelf,proto3" json:"shelf,omitempty"`
	// The update mask applied to the shelf. See https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask.
	UpdateMask *fieldmaskpb.FieldMask `protobuf:"bytes,3,opt,name=update_mask,json=updateMask,proto3" json:"update_mask,omitempty"`
	// contains filtered or unexported fields
}

type UpdateShelfResponse struct {

	// The updated shelf.
	Shelf *Shelf `protobuf:"bytes,1,opt,name=shelf,proto3" json:"shelf,omitempty"`
	// contains filtered or unexported fields
}