shelfv1

package
v0.0.0-...-04c85bf Latest Latest
Warning

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

Go to latest
Published: Sep 13, 2022 License: MIT Imports: 11 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

View Source
var File_acme_shelf_v1_request_response_proto protoreflect.FileDescriptor
View Source
var File_acme_shelf_v1_resource_proto protoreflect.FileDescriptor
View Source
var File_acme_shelf_v1_service_proto protoreflect.FileDescriptor
View Source
var ShelfService_ServiceDesc = grpc.ServiceDesc{
	ServiceName: "acme.shelf.v1.ShelfService",
	HandlerType: (*ShelfServiceServer)(nil),
	Methods: []grpc.MethodDesc{
		{
			MethodName: "ListShelves",
			Handler:    _ShelfService_ListShelves_Handler,
		},
		{
			MethodName: "GetShelf",
			Handler:    _ShelfService_GetShelf_Handler,
		},
		{
			MethodName: "CreateShelf",
			Handler:    _ShelfService_CreateShelf_Handler,
		},
		{
			MethodName: "UpdateShelf",
			Handler:    _ShelfService_UpdateShelf_Handler,
		},
		{
			MethodName: "DeleteShelf",
			Handler:    _ShelfService_DeleteShelf_Handler,
		},
	},
	Streams:  []grpc.StreamDesc{},
	Metadata: "acme/shelf/v1/service.proto",
}

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

Functions

func RegisterShelfServiceServer

func RegisterShelfServiceServer(s grpc.ServiceRegistrar, srv ShelfServiceServer)

Types

type CreateShelfRequest

type CreateShelfRequest struct {

	// The parent resource name where the shelf is to be created, for example, "examples/example1", or empty.
	Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
	// The unique id to use for this shelf, or empty.
	Uid string `protobuf:"bytes,2,opt,name=uid,proto3" json:"uid,omitempty"`
	// The shelf resource to create.
	Shelf *Shelf `protobuf:"bytes,3,opt,name=shelf,proto3" json:"shelf,omitempty"`
	// contains filtered or unexported fields
}

The standard Create request definition.

func (*CreateShelfRequest) Descriptor deprecated

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

Deprecated: Use CreateShelfRequest.ProtoReflect.Descriptor instead.

func (*CreateShelfRequest) GetParent

func (x *CreateShelfRequest) GetParent() string

func (*CreateShelfRequest) GetShelf

func (x *CreateShelfRequest) GetShelf() *Shelf

func (*CreateShelfRequest) GetUid

func (x *CreateShelfRequest) GetUid() string

func (*CreateShelfRequest) ProtoMessage

func (*CreateShelfRequest) ProtoMessage()

func (*CreateShelfRequest) ProtoReflect

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

func (*CreateShelfRequest) Reset

func (x *CreateShelfRequest) Reset()

func (*CreateShelfRequest) String

func (x *CreateShelfRequest) String() string

type DeleteShelfRequest

type DeleteShelfRequest struct {

	// The multi-segment resource name of the shelf to be deleted, for example, "examples/example1/shelves/shelf2".
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// contains filtered or unexported fields
}

The standard Delete request definition.

func (*DeleteShelfRequest) Descriptor deprecated

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

Deprecated: Use DeleteShelfRequest.ProtoReflect.Descriptor instead.

func (*DeleteShelfRequest) GetName

func (x *DeleteShelfRequest) GetName() string

func (*DeleteShelfRequest) ProtoMessage

func (*DeleteShelfRequest) ProtoMessage()

func (*DeleteShelfRequest) ProtoReflect

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

func (*DeleteShelfRequest) Reset

func (x *DeleteShelfRequest) Reset()

func (*DeleteShelfRequest) String

func (x *DeleteShelfRequest) String() string

type GetShelfRequest

type GetShelfRequest struct {

	// The multi-segment resource name of the requested shelf, for example, "examples/example1/shelves/shelf2".
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// contains filtered or unexported fields
}

The standard Get request definition.

func (*GetShelfRequest) Descriptor deprecated

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

Deprecated: Use GetShelfRequest.ProtoReflect.Descriptor instead.

func (*GetShelfRequest) GetName

func (x *GetShelfRequest) GetName() string

func (*GetShelfRequest) ProtoMessage

func (*GetShelfRequest) ProtoMessage()

func (*GetShelfRequest) ProtoReflect

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

func (*GetShelfRequest) Reset

func (x *GetShelfRequest) Reset()

func (*GetShelfRequest) String

func (x *GetShelfRequest) String() string

type ListShelvesRequest

type ListShelvesRequest struct {

	// The parent resource name, for example, "examples/example1", or empty.
	Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
	// The maximum number of items to return.
	PageSize int32 `protobuf:"varint,2,opt,name=page_size,json=pageSize,proto3" json:"page_size,omitempty"`
	// The next_page_token value returned from a previous List request, if any.
	PageToken string `protobuf:"bytes,3,opt,name=page_token,json=pageToken,proto3" json:"page_token,omitempty"`
	// The sort order for the items to return, or empty. See https://google.aip.dev/132#ordering.
	OrderBy string `protobuf:"bytes,4,opt,name=order_by,json=orderBy,proto3" json:"order_by,omitempty"`
	// The filter for the items to return, or empty. See https://google.aip.dev/132#filtering.
	Filter string `protobuf:"bytes,5,opt,name=filter,proto3" json:"filter,omitempty"`
	// contains filtered or unexported fields
}

The standard List request definition.

func (*ListShelvesRequest) Descriptor deprecated

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

Deprecated: Use ListShelvesRequest.ProtoReflect.Descriptor instead.

func (*ListShelvesRequest) GetFilter

func (x *ListShelvesRequest) GetFilter() string

func (*ListShelvesRequest) GetOrderBy

func (x *ListShelvesRequest) GetOrderBy() string

func (*ListShelvesRequest) GetPageSize

func (x *ListShelvesRequest) GetPageSize() int32

func (*ListShelvesRequest) GetPageToken

func (x *ListShelvesRequest) GetPageToken() string

func (*ListShelvesRequest) GetParent

func (x *ListShelvesRequest) GetParent() string

func (*ListShelvesRequest) ProtoMessage

func (*ListShelvesRequest) ProtoMessage()

func (*ListShelvesRequest) ProtoReflect

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

func (*ListShelvesRequest) Reset

func (x *ListShelvesRequest) Reset()

func (*ListShelvesRequest) String

func (x *ListShelvesRequest) String() string

type ListShelvesResponse

type ListShelvesResponse struct {

	// The retrieved list of shelves.
	Shelves []*Shelf `protobuf:"bytes,1,rep,name=shelves,proto3" json:"shelves,omitempty"`
	// Token to retrieve the next page of results, or empty if there are no more results in the list.
	NextPageToken string `protobuf:"bytes,2,opt,name=next_page_token,json=nextPageToken,proto3" json:"next_page_token,omitempty"`
	// contains filtered or unexported fields
}

The standard List response definition.

func (*ListShelvesResponse) Descriptor deprecated

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

Deprecated: Use ListShelvesResponse.ProtoReflect.Descriptor instead.

func (*ListShelvesResponse) GetNextPageToken

func (x *ListShelvesResponse) GetNextPageToken() string

func (*ListShelvesResponse) GetShelves

func (x *ListShelvesResponse) GetShelves() []*Shelf

func (*ListShelvesResponse) ProtoMessage

func (*ListShelvesResponse) ProtoMessage()

func (*ListShelvesResponse) ProtoReflect

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

func (*ListShelvesResponse) Reset

func (x *ListShelvesResponse) Reset()

func (*ListShelvesResponse) String

func (x *ListShelvesResponse) String() string

type Shelf

type Shelf struct {

	// The mult-segment resource name.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// The unique shelf id.
	Uid string `protobuf:"bytes,2,opt,name=uid,proto3" json:"uid,omitempty"`
	// Indicates when the shelf was created.
	CreateTime *timestamppb.Timestamp `protobuf:"bytes,3,opt,name=create_time,json=createTime,proto3" json:"create_time,omitempty"`
	// Indicates when the shelf was last updated.
	UpdateTime *timestamppb.Timestamp `protobuf:"bytes,4,opt,name=update_time,json=updateTime,proto3" json:"update_time,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
}

The default Shelf resource representation.

func (*Shelf) Descriptor deprecated

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

Deprecated: Use Shelf.ProtoReflect.Descriptor instead.

func (*Shelf) GetCreateTime

func (x *Shelf) GetCreateTime() *timestamppb.Timestamp

func (*Shelf) GetDisplayName

func (x *Shelf) GetDisplayName() string

func (*Shelf) GetName

func (x *Shelf) GetName() string

func (*Shelf) GetUid

func (x *Shelf) GetUid() string

func (*Shelf) GetUpdateTime

func (x *Shelf) GetUpdateTime() *timestamppb.Timestamp

func (*Shelf) ProtoMessage

func (*Shelf) ProtoMessage()

func (*Shelf) ProtoReflect

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

func (*Shelf) Reset

func (x *Shelf) Reset()

func (*Shelf) String

func (x *Shelf) String() string

type ShelfServiceClient

type ShelfServiceClient interface {
	// ListShelves retrieves a list of shelves from the server.
	ListShelves(ctx context.Context, in *ListShelvesRequest, opts ...grpc.CallOption) (*ListShelvesResponse, error)
	// GetShelf retrieves a single shelf from the server.
	GetShelf(ctx context.Context, in *GetShelfRequest, opts ...grpc.CallOption) (*Shelf, error)
	// CreateShelf creates a new shelf resource on the server.
	CreateShelf(ctx context.Context, in *CreateShelfRequest, opts ...grpc.CallOption) (*Shelf, error)
	// UpdateShelf updates the shelf resource on the server.
	UpdateShelf(ctx context.Context, in *UpdateShelfRequest, opts ...grpc.CallOption) (*Shelf, error)
	// DeleteShelf deletes the shelf resource from the server.
	DeleteShelf(ctx context.Context, in *DeleteShelfRequest, opts ...grpc.CallOption) (*emptypb.Empty, error)
}

ShelfServiceClient is the client API for ShelfService 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.

type ShelfServiceServer

type ShelfServiceServer interface {
	// ListShelves retrieves a list of shelves from the server.
	ListShelves(context.Context, *ListShelvesRequest) (*ListShelvesResponse, error)
	// GetShelf retrieves a single shelf from the server.
	GetShelf(context.Context, *GetShelfRequest) (*Shelf, error)
	// CreateShelf creates a new shelf resource on the server.
	CreateShelf(context.Context, *CreateShelfRequest) (*Shelf, error)
	// UpdateShelf updates the shelf resource on the server.
	UpdateShelf(context.Context, *UpdateShelfRequest) (*Shelf, error)
	// DeleteShelf deletes the shelf resource from the server.
	DeleteShelf(context.Context, *DeleteShelfRequest) (*emptypb.Empty, error)
}

ShelfServiceServer is the server API for ShelfService service. All implementations should embed UnimplementedShelfServiceServer for forward compatibility

type UnimplementedShelfServiceServer

type UnimplementedShelfServiceServer struct {
}

UnimplementedShelfServiceServer should be embedded to have forward compatible implementations.

func (UnimplementedShelfServiceServer) CreateShelf

func (UnimplementedShelfServiceServer) DeleteShelf

func (UnimplementedShelfServiceServer) GetShelf

func (UnimplementedShelfServiceServer) ListShelves

func (UnimplementedShelfServiceServer) UpdateShelf

type UnsafeShelfServiceServer

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

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

type UpdateShelfRequest

type UpdateShelfRequest struct {

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

The standard Update request definition.

func (*UpdateShelfRequest) Descriptor deprecated

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

Deprecated: Use UpdateShelfRequest.ProtoReflect.Descriptor instead.

func (*UpdateShelfRequest) GetShelf

func (x *UpdateShelfRequest) GetShelf() *Shelf

func (*UpdateShelfRequest) GetUpdateMask

func (x *UpdateShelfRequest) GetUpdateMask() *fieldmaskpb.FieldMask

func (*UpdateShelfRequest) ProtoMessage

func (*UpdateShelfRequest) ProtoMessage()

func (*UpdateShelfRequest) ProtoReflect

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

func (*UpdateShelfRequest) Reset

func (x *UpdateShelfRequest) Reset()

func (*UpdateShelfRequest) String

func (x *UpdateShelfRequest) String() string

Jump to

Keyboard shortcuts

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