warehouse_v1

package
v0.1.2 Latest Latest
Warning

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

 Go to latest Published: Dec 13, 2023 License: BSD-3-Clause Imports: 8 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

View Source 
var File_proto_warehouse_v1_warehouse_proto protoreflect.FileDescriptor
View Source 
var Warehouse_ServiceDesc = grpc.ServiceDesc{
	ServiceName: "yoshikishibata.courier.example.api.warehouse.v1.Warehouse",
	HandlerType: (*WarehouseServer)(nil),
	Methods: []grpc.MethodDesc{
		{
			MethodName: "ListProductInventories",
			Handler:    _Warehouse_ListProductInventories_Handler,
		},
		{
			MethodName: "ShipProduct",
			Handler:    _Warehouse_ShipProduct_Handler,
		},
	},
	Streams:  []grpc.StreamDesc{},
	Metadata: "proto/warehouse/v1/warehouse.proto",
}

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

Functions

func RegisterWarehouseServer 

func RegisterWarehouseServer(s grpc.ServiceRegistrar, srv WarehouseServer)

Types

type ListProductInventoriesRequest 

type ListProductInventoriesRequest struct {
	NumOfProducts uint32 `protobuf:"varint,1,opt,name=num_of_products,json=numOfProducts,proto3" json:"num_of_products,omitempty"`
	PageToken     string `protobuf:"bytes,2,opt,name=page_token,json=pageToken,proto3" json:"page_token,omitempty"`
	// contains filtered or unexported fields
}

* ListProductInventoriesは、扱っている商品一覧を返します。 - num_of_productsは、一覧として返す最大個数を指定します。 - page_tokenには、空文字列もしくはレスポンスで返されるnext_page_tokenを設定します。

  • 空文字列の場合は、商品一覧の最初から返されます。

- 商品一覧は、nameのアルファベット順に昇順に返されます。

[エラー] - InvalidArgument:

  • num_of_productsが0
  • page_tokenが不正な値

func (*ListProductInventoriesRequest) Descriptor deprecated 

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

Deprecated: Use ListProductInventoriesRequest.ProtoReflect.Descriptor instead.

func (*ListProductInventoriesRequest) GetNumOfProducts 

func (x *ListProductInventoriesRequest) GetNumOfProducts() uint32

func (*ListProductInventoriesRequest) GetPageToken 

func (x *ListProductInventoriesRequest) GetPageToken() string

func (*ListProductInventoriesRequest) ProtoMessage 

func (*ListProductInventoriesRequest) ProtoMessage()

func (*ListProductInventoriesRequest) ProtoReflect 

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

func (*ListProductInventoriesRequest) Reset 

func (x *ListProductInventoriesRequest) Reset()

func (*ListProductInventoriesRequest) String 

func (x *ListProductInventoriesRequest) String() string

type ListProductInventoriesResponse 

type ListProductInventoriesResponse struct {
	ProductInventories []*ProductInventory `protobuf:"bytes,1,rep,name=product_inventories,json=productInventories,proto3" json:"product_inventories,omitempty"`
	// 商品がさらに存在しない場合、空文字列が返されます。
	NextPageToken string `protobuf:"bytes,2,opt,name=next_page_token,json=nextPageToken,proto3" json:"next_page_token,omitempty"`
	// contains filtered or unexported fields
}

func (*ListProductInventoriesResponse) Descriptor deprecated 

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

Deprecated: Use ListProductInventoriesResponse.ProtoReflect.Descriptor instead.

func (*ListProductInventoriesResponse) GetNextPageToken 

func (x *ListProductInventoriesResponse) GetNextPageToken() string

func (*ListProductInventoriesResponse) GetProductInventories 

func (x *ListProductInventoriesResponse) GetProductInventories() []*ProductInventory

func (*ListProductInventoriesResponse) ProtoMessage 

func (*ListProductInventoriesResponse) ProtoMessage()

func (*ListProductInventoriesResponse) ProtoReflect 

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

func (*ListProductInventoriesResponse) Reset 

func (x *ListProductInventoriesResponse) Reset()

func (*ListProductInventoriesResponse) String 

func (x *ListProductInventoriesResponse) String() string

type ProductInventory 

type ProductInventory struct {

	// 商品番号
	Number string `protobuf:"bytes,1,opt,name=number,proto3" json:"number,omitempty"`
	// 商品名
	Name string `protobuf:"bytes,2,opt,name=name,proto3" json:"name,omitempty"`
	// 価格（円）
	Price uint32 `protobuf:"varint,3,opt,name=price,proto3" json:"price,omitempty"`
	// 在庫数
	QuantityAvailable uint32 `protobuf:"varint,4,opt,name=quantity_available,json=quantityAvailable,proto3" json:"quantity_available,omitempty"`
	// contains filtered or unexported fields
}

* ProductInventoryは、扱っている商品の情報を表します。

func (*ProductInventory) Descriptor deprecated 

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

Deprecated: Use ProductInventory.ProtoReflect.Descriptor instead.

func (*ProductInventory) GetName 

func (x *ProductInventory) GetName() string

func (*ProductInventory) GetNumber 

func (x *ProductInventory) GetNumber() string

func (*ProductInventory) GetPrice 

func (x *ProductInventory) GetPrice() uint32

func (*ProductInventory) GetQuantityAvailable 

func (x *ProductInventory) GetQuantityAvailable() uint32

func (*ProductInventory) ProtoMessage 

func (*ProductInventory) ProtoMessage()

func (*ProductInventory) ProtoReflect 

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

func (*ProductInventory) Reset 

func (x *ProductInventory) Reset()

func (*ProductInventory) String 

func (x *ProductInventory) String() string

type ShipProductRequest 

type ShipProductRequest struct {

	// 注文番号
	OrderId string `protobuf:"bytes,1,opt,name=order_id,json=orderId,proto3" json:"order_id,omitempty"`
	// 商品番号
	Number string `protobuf:"bytes,2,opt,name=number,proto3" json:"number,omitempty"`
	// 個数
	NumOfItems uint32 `protobuf:"varint,3,opt,name=num_of_items,json=numOfItems,proto3" json:"num_of_items,omitempty"`
	// 送付先
	ShippingAddress string `protobuf:"bytes,4,opt,name=shipping_address,json=shippingAddress,proto3" json:"shipping_address,omitempty"`
	// contains filtered or unexported fields
}

* ShipProductは、指定された商品を出荷します。

  • Shippingサービスでステータスを問い合わせるための shipping_idを返します。

[エラー] - InvalidArgument:

  • order_idが空文字列
  • numberが空文字列
  • num_of_itemsが0
  • shipping_addressが空文字列

- NotFound:

  • numberで指定された商品は扱っていない

- FailedPrecondition:

  • num_of_itemsで指定された個数の在庫がないため出荷できない。

func (*ShipProductRequest) Descriptor deprecated 

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

Deprecated: Use ShipProductRequest.ProtoReflect.Descriptor instead.

func (*ShipProductRequest) GetNumOfItems 

func (x *ShipProductRequest) GetNumOfItems() uint32

func (*ShipProductRequest) GetNumber 

func (x *ShipProductRequest) GetNumber() string

func (*ShipProductRequest) GetOrderId 

func (x *ShipProductRequest) GetOrderId() string

func (*ShipProductRequest) GetShippingAddress 

func (x *ShipProductRequest) GetShippingAddress() string

func (*ShipProductRequest) ProtoMessage 

func (*ShipProductRequest) ProtoMessage()

func (*ShipProductRequest) ProtoReflect 

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

func (*ShipProductRequest) Reset 

func (x *ShipProductRequest) Reset()

func (*ShipProductRequest) String 

func (x *ShipProductRequest) String() string

type ShipProductResponse 

type ShipProductResponse struct {

	// 出荷番号
	ShippingId string `protobuf:"bytes,1,opt,name=shipping_id,json=shippingId,proto3" json:"shipping_id,omitempty"`
	// contains filtered or unexported fields
}

func (*ShipProductResponse) Descriptor deprecated 

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

Deprecated: Use ShipProductResponse.ProtoReflect.Descriptor instead.

func (*ShipProductResponse) GetShippingId 

func (x *ShipProductResponse) GetShippingId() string

func (*ShipProductResponse) ProtoMessage 

func (*ShipProductResponse) ProtoMessage()

func (*ShipProductResponse) ProtoReflect 

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

func (*ShipProductResponse) Reset 

func (x *ShipProductResponse) Reset()

func (*ShipProductResponse) String 

func (x *ShipProductResponse) String() string

type UnimplementedWarehouseServer 

type UnimplementedWarehouseServer struct {
}

UnimplementedWarehouseServer must be embedded to have forward compatible implementations.

func (UnimplementedWarehouseServer) ListProductInventories 

func (UnimplementedWarehouseServer) ListProductInventories(context.Context, *ListProductInventoriesRequest) (*ListProductInventoriesResponse, error)

func (UnimplementedWarehouseServer) ShipProduct 

func (UnimplementedWarehouseServer) ShipProduct(context.Context, *ShipProductRequest) (*ShipProductResponse, error)

type UnsafeWarehouseServer 

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

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

type WarehouseClient 

type WarehouseClient interface {
	// 扱っている商品一覧を返します。
	ListProductInventories(ctx context.Context, in *ListProductInventoriesRequest, opts ...grpc.CallOption) (*ListProductInventoriesResponse, error)
	// 商品を出荷します。
	ShipProduct(ctx context.Context, in *ShipProductRequest, opts ...grpc.CallOption) (*ShipProductResponse, error)
}

WarehouseClient is the client API for Warehouse 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 NewWarehouseClient 

func NewWarehouseClient(cc grpc.ClientConnInterface) WarehouseClient

type WarehouseServer 

type WarehouseServer interface {
	// 扱っている商品一覧を返します。
	ListProductInventories(context.Context, *ListProductInventoriesRequest) (*ListProductInventoriesResponse, error)
	// 商品を出荷します。
	ShipProduct(context.Context, *ShipProductRequest) (*ShipProductResponse, error)
	// contains filtered or unexported methods
}

WarehouseServer is the server API for Warehouse service. All implementations must embed UnimplementedWarehouseServer for forward compatibility

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.