var File_einride_example_freight_v1_freight_service_proto protoreflect.FileDescriptor
var File_einride_example_freight_v1_shipment_proto protoreflect.FileDescriptor
var File_einride_example_freight_v1_shipper_proto protoreflect.FileDescriptor
var File_einride_example_freight_v1_site_proto protoreflect.FileDescriptor
FreightService_ServiceDesc is the grpc.ServiceDesc for FreightService service. It's only intended for direct use with grpc.RegisterService, and not to be introspected or modified (even as a copy)
var FreightService_ServiceDesc = grpc.ServiceDesc{ ServiceName: "einride.example.freight.v1.FreightService", HandlerType: (*FreightServiceServer)(nil), Methods: []grpc.MethodDesc{ { MethodName: "GetShipper", Handler: _FreightService_GetShipper_Handler, }, { MethodName: "ListShippers", Handler: _FreightService_ListShippers_Handler, }, { MethodName: "CreateShipper", Handler: _FreightService_CreateShipper_Handler, }, { MethodName: "UpdateShipper", Handler: _FreightService_UpdateShipper_Handler, }, { MethodName: "DeleteShipper", Handler: _FreightService_DeleteShipper_Handler, }, { MethodName: "GetSite", Handler: _FreightService_GetSite_Handler, }, { MethodName: "ListSites", Handler: _FreightService_ListSites_Handler, }, { MethodName: "CreateSite", Handler: _FreightService_CreateSite_Handler, }, { MethodName: "UpdateSite", Handler: _FreightService_UpdateSite_Handler, }, { MethodName: "DeleteSite", Handler: _FreightService_DeleteSite_Handler, }, { MethodName: "BatchGetSites", Handler: _FreightService_BatchGetSites_Handler, }, { MethodName: "GetShipment", Handler: _FreightService_GetShipment_Handler, }, { MethodName: "ListShipments", Handler: _FreightService_ListShipments_Handler, }, { MethodName: "CreateShipment", Handler: _FreightService_CreateShipment_Handler, }, { MethodName: "UpdateShipment", Handler: _FreightService_UpdateShipment_Handler, }, { MethodName: "DeleteShipment", Handler: _FreightService_DeleteShipment_Handler, }, }, Streams: []grpc.StreamDesc{}, Metadata: "einride/example/freight/v1/freight_service.proto", }
func RegisterFreightServiceServer(s grpc.ServiceRegistrar, srv FreightServiceServer)
Request message for FreightService.BatchGetSites.
type BatchGetSitesRequest struct {
// The parent resource shared by all sites being retrieved.
// If this is set, the parent of all of the sites specified in `names`
// must match this field.
// Format: `shippers/{shipper}`
Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
// The names of the sites to retrieve.
// A maximum of 1000 sites can be retrieved in a batch.
// Format: `shippers/{shipper}/sites/{site}`
Names []string `protobuf:"bytes,2,rep,name=names,proto3" json:"names,omitempty"`
// contains filtered or unexported fields
}
func (*BatchGetSitesRequest) Descriptor() ([]byte, []int)
Deprecated: Use BatchGetSitesRequest.ProtoReflect.Descriptor instead.
func (x *BatchGetSitesRequest) GetNames() []string
func (x *BatchGetSitesRequest) GetParent() string
func (*BatchGetSitesRequest) ProtoMessage()
func (x *BatchGetSitesRequest) ProtoReflect() protoreflect.Message
func (x *BatchGetSitesRequest) Reset()
func (x *BatchGetSitesRequest) String() string
Response message for FreightService.BatchGetSites.
type BatchGetSitesResponse struct {
// Sites requested.
Sites []*Site `protobuf:"bytes,1,rep,name=sites,proto3" json:"sites,omitempty"`
// contains filtered or unexported fields
}
func (*BatchGetSitesResponse) Descriptor() ([]byte, []int)
Deprecated: Use BatchGetSitesResponse.ProtoReflect.Descriptor instead.
func (x *BatchGetSitesResponse) GetSites() []*Site
func (*BatchGetSitesResponse) ProtoMessage()
func (x *BatchGetSitesResponse) ProtoReflect() protoreflect.Message
func (x *BatchGetSitesResponse) Reset()
func (x *BatchGetSitesResponse) String() string
Request message for FreightService.CreateShipment.
type CreateShipmentRequest struct {
// The resource name of the parent shipper for which this shipment will be created.
// Format: shippers/{shipper}
Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
// The shipment to create.
Shipment *Shipment `protobuf:"bytes,2,opt,name=shipment,proto3" json:"shipment,omitempty"`
// contains filtered or unexported fields
}
func (*CreateShipmentRequest) Descriptor() ([]byte, []int)
Deprecated: Use CreateShipmentRequest.ProtoReflect.Descriptor instead.
func (x *CreateShipmentRequest) GetParent() string
func (x *CreateShipmentRequest) GetShipment() *Shipment
func (*CreateShipmentRequest) ProtoMessage()
func (x *CreateShipmentRequest) ProtoReflect() protoreflect.Message
func (x *CreateShipmentRequest) Reset()
func (x *CreateShipmentRequest) String() string
Request message for FreightService.CreateShipper.
type CreateShipperRequest struct {
// The shipper to create.
Shipper *Shipper `protobuf:"bytes,1,opt,name=shipper,proto3" json:"shipper,omitempty"`
// contains filtered or unexported fields
}
func (*CreateShipperRequest) Descriptor() ([]byte, []int)
Deprecated: Use CreateShipperRequest.ProtoReflect.Descriptor instead.
func (x *CreateShipperRequest) GetShipper() *Shipper
func (*CreateShipperRequest) ProtoMessage()
func (x *CreateShipperRequest) ProtoReflect() protoreflect.Message
func (x *CreateShipperRequest) Reset()
func (x *CreateShipperRequest) String() string
Request message for FreightService.CreateSite.
type CreateSiteRequest struct {
// The resource name of the parent shipper for which this site will be created.
// Format: shippers/{shipper}
Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
// The site to create.
Site *Site `protobuf:"bytes,2,opt,name=site,proto3" json:"site,omitempty"`
// contains filtered or unexported fields
}
func (*CreateSiteRequest) Descriptor() ([]byte, []int)
Deprecated: Use CreateSiteRequest.ProtoReflect.Descriptor instead.
func (x *CreateSiteRequest) GetParent() string
func (x *CreateSiteRequest) GetSite() *Site
func (*CreateSiteRequest) ProtoMessage()
func (x *CreateSiteRequest) ProtoReflect() protoreflect.Message
func (x *CreateSiteRequest) Reset()
func (x *CreateSiteRequest) String() string
Request message for FreightService.DeleteShipment.
type DeleteShipmentRequest struct {
// The resource name of the shipment to delete.
// Format: shippers/{shipper}/shipments/{shipment}
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// contains filtered or unexported fields
}
func (*DeleteShipmentRequest) Descriptor() ([]byte, []int)
Deprecated: Use DeleteShipmentRequest.ProtoReflect.Descriptor instead.
func (x *DeleteShipmentRequest) GetName() string
func (*DeleteShipmentRequest) ProtoMessage()
func (x *DeleteShipmentRequest) ProtoReflect() protoreflect.Message
func (x *DeleteShipmentRequest) Reset()
func (x *DeleteShipmentRequest) String() string
Request message for FreightService.DeleteShipper.
type DeleteShipperRequest struct {
// The resource name of the shipper to delete.
// Format: shippers/{shipper}
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// contains filtered or unexported fields
}
func (*DeleteShipperRequest) Descriptor() ([]byte, []int)
Deprecated: Use DeleteShipperRequest.ProtoReflect.Descriptor instead.
func (x *DeleteShipperRequest) GetName() string
func (*DeleteShipperRequest) ProtoMessage()
func (x *DeleteShipperRequest) ProtoReflect() protoreflect.Message
func (x *DeleteShipperRequest) Reset()
func (x *DeleteShipperRequest) String() string
Request message for FreightService.DeleteSite.
type DeleteSiteRequest struct {
// The resource name of the site to delete.
// Format: shippers/{shipper}/sites/{site}
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// contains filtered or unexported fields
}
func (*DeleteSiteRequest) Descriptor() ([]byte, []int)
Deprecated: Use DeleteSiteRequest.ProtoReflect.Descriptor instead.
func (x *DeleteSiteRequest) GetName() string
func (*DeleteSiteRequest) ProtoMessage()
func (x *DeleteSiteRequest) ProtoReflect() protoreflect.Message
func (x *DeleteSiteRequest) Reset()
func (x *DeleteSiteRequest) String() string
FreightServiceClient is the client API for FreightService 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 FreightServiceClient interface {
// Get a shipper.
//
// See: https://google.aip.dev/131 (Standard methods: Get).
GetShipper(ctx context.Context, in *GetShipperRequest, opts ...grpc.CallOption) (*Shipper, error)
// List shippers.
//
// See: https://google.aip.dev/132 (Standard methods: List).
ListShippers(ctx context.Context, in *ListShippersRequest, opts ...grpc.CallOption) (*ListShippersResponse, error)
// Create a shipper.
//
// See: https://google.aip.dev/133 (Standard methods: Create).
CreateShipper(ctx context.Context, in *CreateShipperRequest, opts ...grpc.CallOption) (*Shipper, error)
// Update a shipper.
//
// See: https://google.aip.dev/134 (Standard methods: Update).
UpdateShipper(ctx context.Context, in *UpdateShipperRequest, opts ...grpc.CallOption) (*Shipper, error)
// Delete a shipper.
//
// See: https://google.aip.dev/135 (Standard methods: Delete).
// See: https://google.aip.dev/164 (Soft delete).
DeleteShipper(ctx context.Context, in *DeleteShipperRequest, opts ...grpc.CallOption) (*Shipper, error)
// Get a site.
//
// See: https://google.aip.dev/131 (Standard methods: Get).
GetSite(ctx context.Context, in *GetSiteRequest, opts ...grpc.CallOption) (*Site, error)
// List sites for a shipper.
//
// See: https://google.aip.dev/132 (Standard methods: List).
ListSites(ctx context.Context, in *ListSitesRequest, opts ...grpc.CallOption) (*ListSitesResponse, error)
// Create a site.
//
// See: https://google.aip.dev/133 (Standard methods: Create).
CreateSite(ctx context.Context, in *CreateSiteRequest, opts ...grpc.CallOption) (*Site, error)
// Update a site.
//
// See: https://google.aip.dev/134 (Standard methods: Update).
UpdateSite(ctx context.Context, in *UpdateSiteRequest, opts ...grpc.CallOption) (*Site, error)
// Delete a site.
//
// See: https://google.aip.dev/135 (Standard methods: Delete).
// See: https://google.aip.dev/164 (Soft delete).
DeleteSite(ctx context.Context, in *DeleteSiteRequest, opts ...grpc.CallOption) (*Site, error)
// Batch get sites.
//
// See: https://google.aip.dev/231 (Batch methods: Get).
BatchGetSites(ctx context.Context, in *BatchGetSitesRequest, opts ...grpc.CallOption) (*BatchGetSitesResponse, error)
// Get a shipment.
//
// See: https://google.aip.dev/131 (Standard methods: Get).
GetShipment(ctx context.Context, in *GetShipmentRequest, opts ...grpc.CallOption) (*Shipment, error)
// List shipments for a shipper.
//
// See: https://google.aip.dev/132 (Standard methods: List).
ListShipments(ctx context.Context, in *ListShipmentsRequest, opts ...grpc.CallOption) (*ListShipmentsResponse, error)
// Create a shipment.
//
// See: https://google.aip.dev/133 (Standard methods: Create).
CreateShipment(ctx context.Context, in *CreateShipmentRequest, opts ...grpc.CallOption) (*Shipment, error)
// Update a shipment.
//
// See: https://google.aip.dev/134 (Standard methods: Update).
UpdateShipment(ctx context.Context, in *UpdateShipmentRequest, opts ...grpc.CallOption) (*Shipment, error)
// Delete a shipment.
//
// See: https://google.aip.dev/135 (Standard methods: Delete).
// See: https://google.aip.dev/164 (Soft delete).
DeleteShipment(ctx context.Context, in *DeleteShipmentRequest, opts ...grpc.CallOption) (*Shipment, error)
}
func NewFreightServiceClient(cc grpc.ClientConnInterface) FreightServiceClient
FreightServiceServer is the server API for FreightService service. All implementations should embed UnimplementedFreightServiceServer for forward compatibility
type FreightServiceServer interface {
// Get a shipper.
//
// See: https://google.aip.dev/131 (Standard methods: Get).
GetShipper(context.Context, *GetShipperRequest) (*Shipper, error)
// List shippers.
//
// See: https://google.aip.dev/132 (Standard methods: List).
ListShippers(context.Context, *ListShippersRequest) (*ListShippersResponse, error)
// Create a shipper.
//
// See: https://google.aip.dev/133 (Standard methods: Create).
CreateShipper(context.Context, *CreateShipperRequest) (*Shipper, error)
// Update a shipper.
//
// See: https://google.aip.dev/134 (Standard methods: Update).
UpdateShipper(context.Context, *UpdateShipperRequest) (*Shipper, error)
// Delete a shipper.
//
// See: https://google.aip.dev/135 (Standard methods: Delete).
// See: https://google.aip.dev/164 (Soft delete).
DeleteShipper(context.Context, *DeleteShipperRequest) (*Shipper, error)
// Get a site.
//
// See: https://google.aip.dev/131 (Standard methods: Get).
GetSite(context.Context, *GetSiteRequest) (*Site, error)
// List sites for a shipper.
//
// See: https://google.aip.dev/132 (Standard methods: List).
ListSites(context.Context, *ListSitesRequest) (*ListSitesResponse, error)
// Create a site.
//
// See: https://google.aip.dev/133 (Standard methods: Create).
CreateSite(context.Context, *CreateSiteRequest) (*Site, error)
// Update a site.
//
// See: https://google.aip.dev/134 (Standard methods: Update).
UpdateSite(context.Context, *UpdateSiteRequest) (*Site, error)
// Delete a site.
//
// See: https://google.aip.dev/135 (Standard methods: Delete).
// See: https://google.aip.dev/164 (Soft delete).
DeleteSite(context.Context, *DeleteSiteRequest) (*Site, error)
// Batch get sites.
//
// See: https://google.aip.dev/231 (Batch methods: Get).
BatchGetSites(context.Context, *BatchGetSitesRequest) (*BatchGetSitesResponse, error)
// Get a shipment.
//
// See: https://google.aip.dev/131 (Standard methods: Get).
GetShipment(context.Context, *GetShipmentRequest) (*Shipment, error)
// List shipments for a shipper.
//
// See: https://google.aip.dev/132 (Standard methods: List).
ListShipments(context.Context, *ListShipmentsRequest) (*ListShipmentsResponse, error)
// Create a shipment.
//
// See: https://google.aip.dev/133 (Standard methods: Create).
CreateShipment(context.Context, *CreateShipmentRequest) (*Shipment, error)
// Update a shipment.
//
// See: https://google.aip.dev/134 (Standard methods: Update).
UpdateShipment(context.Context, *UpdateShipmentRequest) (*Shipment, error)
// Delete a shipment.
//
// See: https://google.aip.dev/135 (Standard methods: Delete).
// See: https://google.aip.dev/164 (Soft delete).
DeleteShipment(context.Context, *DeleteShipmentRequest) (*Shipment, error)
}
Request message for FreightService.GetShipment.
type GetShipmentRequest struct {
// The resource name of the shipment to retrieve.
// Format: shippers/{shipper}/shipments/{shipment}
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// contains filtered or unexported fields
}
func (*GetShipmentRequest) Descriptor() ([]byte, []int)
Deprecated: Use GetShipmentRequest.ProtoReflect.Descriptor instead.
func (x *GetShipmentRequest) GetName() string
func (*GetShipmentRequest) ProtoMessage()
func (x *GetShipmentRequest) ProtoReflect() protoreflect.Message
func (x *GetShipmentRequest) Reset()
func (x *GetShipmentRequest) String() string
Request message for FreightService.GetShipper.
type GetShipperRequest struct {
// The resource name of the shipper to retrieve.
// Format: shippers/{shipper}
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// contains filtered or unexported fields
}
func (*GetShipperRequest) Descriptor() ([]byte, []int)
Deprecated: Use GetShipperRequest.ProtoReflect.Descriptor instead.
func (x *GetShipperRequest) GetName() string
func (*GetShipperRequest) ProtoMessage()
func (x *GetShipperRequest) ProtoReflect() protoreflect.Message
func (x *GetShipperRequest) Reset()
func (x *GetShipperRequest) String() string
Request message for FreightService.GetSite.
type GetSiteRequest struct {
// The resource name of the site to retrieve.
// Format: shippers/{shipper}/sites/{site}
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// contains filtered or unexported fields
}
func (*GetSiteRequest) Descriptor() ([]byte, []int)
Deprecated: Use GetSiteRequest.ProtoReflect.Descriptor instead.
func (x *GetSiteRequest) GetName() string
func (*GetSiteRequest) ProtoMessage()
func (x *GetSiteRequest) ProtoReflect() protoreflect.Message
func (x *GetSiteRequest) Reset()
func (x *GetSiteRequest) String() string
A shipment line item.
type LineItem struct {
// The title of the line item.
Title string `protobuf:"bytes,1,opt,name=title,proto3" json:"title,omitempty"`
// The quantity of the line item.
Quantity float32 `protobuf:"fixed32,2,opt,name=quantity,proto3" json:"quantity,omitempty"`
// The weight of the line item in kilograms.
WeightKg float32 `protobuf:"fixed32,3,opt,name=weight_kg,json=weightKg,proto3" json:"weight_kg,omitempty"`
// The volume of the line item in cubic meters.
VolumeM3 float32 `protobuf:"fixed32,4,opt,name=volume_m3,json=volumeM3,proto3" json:"volume_m3,omitempty"`
// Reference ID provided by external system.
ExternalReferenceId string `protobuf:"bytes,5,opt,name=external_reference_id,json=externalReferenceId,proto3" json:"external_reference_id,omitempty"`
// contains filtered or unexported fields
}
func (*LineItem) Descriptor() ([]byte, []int)
Deprecated: Use LineItem.ProtoReflect.Descriptor instead.
func (x *LineItem) GetExternalReferenceId() string
func (x *LineItem) GetQuantity() float32
func (x *LineItem) GetTitle() string
func (x *LineItem) GetVolumeM3() float32
func (x *LineItem) GetWeightKg() float32
func (*LineItem) ProtoMessage()
func (x *LineItem) ProtoReflect() protoreflect.Message
func (x *LineItem) Reset()
func (x *LineItem) String() string
Request message for FreightService.ListShipments.
type ListShipmentsRequest struct {
// The resource name of the parent, which owns this collection of shipments.
// Format: shippers/{shipper}
Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
// Requested page size. Server may return fewer shipments than requested.
// If unspecified, server will pick an appropriate default.
PageSize int32 `protobuf:"varint,2,opt,name=page_size,json=pageSize,proto3" json:"page_size,omitempty"`
// A token identifying a page of results the server should return.
// Typically, this is the value of
// [ListShipmentsResponse.next_page_token][einride.example.freight.v1.ListShipmentsResponse.next_page_token]
// returned from the previous call to `ListShipments` method.
PageToken string `protobuf:"bytes,3,opt,name=page_token,json=pageToken,proto3" json:"page_token,omitempty"`
// contains filtered or unexported fields
}
func (*ListShipmentsRequest) Descriptor() ([]byte, []int)
Deprecated: Use ListShipmentsRequest.ProtoReflect.Descriptor instead.
func (x *ListShipmentsRequest) GetPageSize() int32
func (x *ListShipmentsRequest) GetPageToken() string
func (x *ListShipmentsRequest) GetParent() string
func (*ListShipmentsRequest) ProtoMessage()
func (x *ListShipmentsRequest) ProtoReflect() protoreflect.Message
func (x *ListShipmentsRequest) Reset()
func (x *ListShipmentsRequest) String() string
Response message for FreightService.ListShipments.
type ListShipmentsResponse struct {
// The list of shipments.
Shipments []*Shipment `protobuf:"bytes,1,rep,name=shipments,proto3" json:"shipments,omitempty"`
// A token to retrieve next page of results. Pass this value in the
// [ListShipmentsRequest.page_token][einride.example.freight.v1.ListShipmentsRequest.page_token]
// field in the subsequent call to `ListShipments` method to retrieve the next
// page of results.
NextPageToken string `protobuf:"bytes,2,opt,name=next_page_token,json=nextPageToken,proto3" json:"next_page_token,omitempty"`
// contains filtered or unexported fields
}
func (*ListShipmentsResponse) Descriptor() ([]byte, []int)
Deprecated: Use ListShipmentsResponse.ProtoReflect.Descriptor instead.
func (x *ListShipmentsResponse) GetNextPageToken() string
func (x *ListShipmentsResponse) GetShipments() []*Shipment
func (*ListShipmentsResponse) ProtoMessage()
func (x *ListShipmentsResponse) ProtoReflect() protoreflect.Message
func (x *ListShipmentsResponse) Reset()
func (x *ListShipmentsResponse) String() string
Request message for FreightService.ListShippers.
type ListShippersRequest struct {
// Requested page size. Server may return fewer shippers than requested.
// If unspecified, server will pick an appropriate default.
PageSize int32 `protobuf:"varint,1,opt,name=page_size,json=pageSize,proto3" json:"page_size,omitempty"`
// A token identifying a page of results the server should return.
// Typically, this is the value of
// [ListShippersResponse.next_page_token][einride.example.freight.v1.ListShippersResponse.next_page_token]
// returned from the previous call to `ListShippers` method.
PageToken string `protobuf:"bytes,2,opt,name=page_token,json=pageToken,proto3" json:"page_token,omitempty"`
// contains filtered or unexported fields
}
func (*ListShippersRequest) Descriptor() ([]byte, []int)
Deprecated: Use ListShippersRequest.ProtoReflect.Descriptor instead.
func (x *ListShippersRequest) GetPageSize() int32
func (x *ListShippersRequest) GetPageToken() string
func (*ListShippersRequest) ProtoMessage()
func (x *ListShippersRequest) ProtoReflect() protoreflect.Message
func (x *ListShippersRequest) Reset()
func (x *ListShippersRequest) String() string
Response message for FreightService.ListShippers.
type ListShippersResponse struct {
// The list of shippers.
Shippers []*Shipper `protobuf:"bytes,1,rep,name=shippers,proto3" json:"shippers,omitempty"`
// A token to retrieve next page of results. Pass this value in the
// [ListShippersRequest.page_token][einride.example.freight.v1.ListShippersRequest.page_token]
// field in the subsequent call to `ListShippers` method to retrieve the next
// page of results.
NextPageToken string `protobuf:"bytes,2,opt,name=next_page_token,json=nextPageToken,proto3" json:"next_page_token,omitempty"`
// contains filtered or unexported fields
}
func (*ListShippersResponse) Descriptor() ([]byte, []int)
Deprecated: Use ListShippersResponse.ProtoReflect.Descriptor instead.
func (x *ListShippersResponse) GetNextPageToken() string
func (x *ListShippersResponse) GetShippers() []*Shipper
func (*ListShippersResponse) ProtoMessage()
func (x *ListShippersResponse) ProtoReflect() protoreflect.Message
func (x *ListShippersResponse) Reset()
func (x *ListShippersResponse) String() string
Request message for FreightService.ListSites.
type ListSitesRequest struct {
// The resource name of the parent, which owns this collection of sites.
// Format: shippers/{shipper}
Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
// Requested page size. Server may return fewer sites than requested.
// If unspecified, server will pick an appropriate default.
PageSize int32 `protobuf:"varint,2,opt,name=page_size,json=pageSize,proto3" json:"page_size,omitempty"`
// A token identifying a page of results the server should return.
// Typically, this is the value of
// [ListSitesResponse.next_page_token][einride.example.freight.v1.ListSitesResponse.next_page_token]
// returned from the previous call to `ListSites` method.
PageToken string `protobuf:"bytes,3,opt,name=page_token,json=pageToken,proto3" json:"page_token,omitempty"`
// Number of resource to skip in the request.
// - A request with no page token and a skip value of 30 returns a single
// page of results starting with the 31st result.
// - A request with a page token corresponding to the 51st result (because the
// first 50 results were returned on the first page) and a skip value of 30
// returns a single page of results starting with the 81st result.
Skip int32 `protobuf:"varint,4,opt,name=skip,proto3" json:"skip,omitempty"`
// contains filtered or unexported fields
}
func (*ListSitesRequest) Descriptor() ([]byte, []int)
Deprecated: Use ListSitesRequest.ProtoReflect.Descriptor instead.
func (x *ListSitesRequest) GetPageSize() int32
func (x *ListSitesRequest) GetPageToken() string
func (x *ListSitesRequest) GetParent() string
func (x *ListSitesRequest) GetSkip() int32
func (*ListSitesRequest) ProtoMessage()
func (x *ListSitesRequest) ProtoReflect() protoreflect.Message
func (x *ListSitesRequest) Reset()
func (x *ListSitesRequest) String() string
Response message for FreightService.ListSites.
type ListSitesResponse struct {
// The list of sites.
Sites []*Site `protobuf:"bytes,1,rep,name=sites,proto3" json:"sites,omitempty"`
// A token to retrieve next page of results. Pass this value in the
// [ListSitesRequest.page_token][einride.example.freight.v1.ListSitesRequest.page_token]
// field in the subsequent call to `ListSites` method to retrieve the next
// page of results.
NextPageToken string `protobuf:"bytes,2,opt,name=next_page_token,json=nextPageToken,proto3" json:"next_page_token,omitempty"`
// contains filtered or unexported fields
}
func (*ListSitesResponse) Descriptor() ([]byte, []int)
Deprecated: Use ListSitesResponse.ProtoReflect.Descriptor instead.
func (x *ListSitesResponse) GetNextPageToken() string
func (x *ListSitesResponse) GetSites() []*Site
func (*ListSitesResponse) ProtoMessage()
func (x *ListSitesResponse) ProtoReflect() protoreflect.Message
func (x *ListSitesResponse) Reset()
func (x *ListSitesResponse) String() string
A shipment represents transportation of goods between an origin [site][einride.example.freight.v1.Site] and a destination [site][einride.example.freight.v1.Site].
type Shipment struct {
// The resource name of the shipment.
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// The creation timestamp of the shipment.
CreateTime *timestamppb.Timestamp `protobuf:"bytes,2,opt,name=create_time,json=createTime,proto3" json:"create_time,omitempty"`
// The last update timestamp of the shipment.
//
// Updated when create/update/delete operation is shipment.
UpdateTime *timestamppb.Timestamp `protobuf:"bytes,3,opt,name=update_time,json=updateTime,proto3" json:"update_time,omitempty"`
// The deletion timestamp of the shipment.
DeleteTime *timestamppb.Timestamp `protobuf:"bytes,4,opt,name=delete_time,json=deleteTime,proto3" json:"delete_time,omitempty"`
// The resource name of the origin site of the shipment.
// Format: shippers/{shipper}/sites/{site}
OriginSite string `protobuf:"bytes,5,opt,name=origin_site,json=originSite,proto3" json:"origin_site,omitempty"`
// The resource name of the destination site of the shipment.
// Format: shippers/{shipper}/sites/{site}
DestinationSite string `protobuf:"bytes,6,opt,name=destination_site,json=destinationSite,proto3" json:"destination_site,omitempty"`
// The earliest pickup time of the shipment at the origin site.
PickupEarliestTime *timestamppb.Timestamp `protobuf:"bytes,7,opt,name=pickup_earliest_time,json=pickupEarliestTime,proto3" json:"pickup_earliest_time,omitempty"`
// The latest pickup time of the shipment at the origin site.
PickupLatestTime *timestamppb.Timestamp `protobuf:"bytes,8,opt,name=pickup_latest_time,json=pickupLatestTime,proto3" json:"pickup_latest_time,omitempty"`
// The earliest delivery time of the shipment at the destination site.
DeliveryEarliestTime *timestamppb.Timestamp `protobuf:"bytes,9,opt,name=delivery_earliest_time,json=deliveryEarliestTime,proto3" json:"delivery_earliest_time,omitempty"`
// The latest delivery time of the shipment at the destination site.
DeliveryLatestTime *timestamppb.Timestamp `protobuf:"bytes,10,opt,name=delivery_latest_time,json=deliveryLatestTime,proto3" json:"delivery_latest_time,omitempty"`
// The line items of the shipment.
LineItems []*LineItem `protobuf:"bytes,11,rep,name=line_items,json=lineItems,proto3" json:"line_items,omitempty"`
// Annotations of the shipment.
Annotations map[string]string `protobuf:"bytes,12,rep,name=annotations,proto3" json:"annotations,omitempty" protobuf_key:"bytes,1,opt,name=key,proto3" protobuf_val:"bytes,2,opt,name=value,proto3"`
// Reference ID provided by external system.
ExternalReferenceId string `protobuf:"bytes,13,opt,name=external_reference_id,json=externalReferenceId,proto3" json:"external_reference_id,omitempty"`
// contains filtered or unexported fields
}
func (*Shipment) Descriptor() ([]byte, []int)
Deprecated: Use Shipment.ProtoReflect.Descriptor instead.
func (x *Shipment) GetAnnotations() map[string]string
func (x *Shipment) GetCreateTime() *timestamppb.Timestamp
func (x *Shipment) GetDeleteTime() *timestamppb.Timestamp
func (x *Shipment) GetDeliveryEarliestTime() *timestamppb.Timestamp
func (x *Shipment) GetDeliveryLatestTime() *timestamppb.Timestamp
func (x *Shipment) GetDestinationSite() string
func (x *Shipment) GetExternalReferenceId() string
func (x *Shipment) GetLineItems() []*LineItem
func (x *Shipment) GetName() string
func (x *Shipment) GetOriginSite() string
func (x *Shipment) GetPickupEarliestTime() *timestamppb.Timestamp
func (x *Shipment) GetPickupLatestTime() *timestamppb.Timestamp
func (x *Shipment) GetUpdateTime() *timestamppb.Timestamp
func (*Shipment) ProtoMessage()
func (x *Shipment) ProtoReflect() protoreflect.Message
func (x *Shipment) Reset()
func (x *Shipment) String() string
type ShipmentResourceName struct {
Shipper string
Shipment string
}
func (n ShipmentResourceName) ContainsWildcard() bool
func (n ShipmentResourceName) MarshalString() (string, error)
func (n ShipmentResourceName) ShipperResourceName() ShipperResourceName
func (n ShipmentResourceName) String() string
func (n *ShipmentResourceName) UnmarshalString(name string) error
func (n ShipmentResourceName) Validate() error
A shipper is a supplier or owner of goods to be transported.
type Shipper struct {
// The resource name of the shipper.
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// The creation timestamp of the shipper.
CreateTime *timestamppb.Timestamp `protobuf:"bytes,2,opt,name=create_time,json=createTime,proto3" json:"create_time,omitempty"`
// The last update timestamp of the shipper.
//
// Updated when create/update/delete operation is performed.
UpdateTime *timestamppb.Timestamp `protobuf:"bytes,3,opt,name=update_time,json=updateTime,proto3" json:"update_time,omitempty"`
// The deletion timestamp of the shipper.
DeleteTime *timestamppb.Timestamp `protobuf:"bytes,4,opt,name=delete_time,json=deleteTime,proto3" json:"delete_time,omitempty"`
// The display name of the shipper.
DisplayName string `protobuf:"bytes,5,opt,name=display_name,json=displayName,proto3" json:"display_name,omitempty"`
// contains filtered or unexported fields
}
func (*Shipper) Descriptor() ([]byte, []int)
Deprecated: Use Shipper.ProtoReflect.Descriptor instead.
func (x *Shipper) GetCreateTime() *timestamppb.Timestamp
func (x *Shipper) GetDeleteTime() *timestamppb.Timestamp
func (x *Shipper) GetDisplayName() string
func (x *Shipper) GetName() string
func (x *Shipper) GetUpdateTime() *timestamppb.Timestamp
func (*Shipper) ProtoMessage()
func (x *Shipper) ProtoReflect() protoreflect.Message
func (x *Shipper) Reset()
func (x *Shipper) String() string
type ShipperResourceName struct {
Shipper string
}
func (n ShipperResourceName) ContainsWildcard() bool
func (n ShipperResourceName) MarshalString() (string, error)
func (n ShipperResourceName) ShipmentResourceName( shipment string, ) ShipmentResourceName
func (n ShipperResourceName) SiteResourceName( site string, ) SiteResourceName
func (n ShipperResourceName) String() string
func (n *ShipperResourceName) UnmarshalString(name string) error
func (n ShipperResourceName) Validate() error
A site is a node in a [shipper][einride.example.freight.v1.Shipper]'s transport network.
type Site struct {
// The resource name of the site.
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// The creation timestamp of the site.
CreateTime *timestamppb.Timestamp `protobuf:"bytes,2,opt,name=create_time,json=createTime,proto3" json:"create_time,omitempty"`
// The last update timestamp of the site.
//
// Updated when create/update/delete operation is performed.
UpdateTime *timestamppb.Timestamp `protobuf:"bytes,3,opt,name=update_time,json=updateTime,proto3" json:"update_time,omitempty"`
// The deletion timestamp of the site.
DeleteTime *timestamppb.Timestamp `protobuf:"bytes,4,opt,name=delete_time,json=deleteTime,proto3" json:"delete_time,omitempty"`
// The display name of the site.
DisplayName string `protobuf:"bytes,5,opt,name=display_name,json=displayName,proto3" json:"display_name,omitempty"`
// The geographic location of the site.
LatLng *latlng.LatLng `protobuf:"bytes,6,opt,name=lat_lng,json=latLng,proto3" json:"lat_lng,omitempty"`
// contains filtered or unexported fields
}
func (*Site) Descriptor() ([]byte, []int)
Deprecated: Use Site.ProtoReflect.Descriptor instead.
func (x *Site) GetCreateTime() *timestamppb.Timestamp
func (x *Site) GetDeleteTime() *timestamppb.Timestamp
func (x *Site) GetDisplayName() string
func (x *Site) GetLatLng() *latlng.LatLng
func (x *Site) GetName() string
func (x *Site) GetUpdateTime() *timestamppb.Timestamp
func (*Site) ProtoMessage()
func (x *Site) ProtoReflect() protoreflect.Message
func (x *Site) Reset()
func (x *Site) String() string
type SiteResourceName struct {
Shipper string
Site string
}
func (n SiteResourceName) ContainsWildcard() bool
func (n SiteResourceName) MarshalString() (string, error)
func (n SiteResourceName) ShipperResourceName() ShipperResourceName
func (n SiteResourceName) String() string
func (n *SiteResourceName) UnmarshalString(name string) error
func (n SiteResourceName) Validate() error
UnimplementedFreightServiceServer should be embedded to have forward compatible implementations.
type UnimplementedFreightServiceServer struct {
}
func (UnimplementedFreightServiceServer) BatchGetSites(context.Context, *BatchGetSitesRequest) (*BatchGetSitesResponse, error)
func (UnimplementedFreightServiceServer) CreateShipment(context.Context, *CreateShipmentRequest) (*Shipment, error)
func (UnimplementedFreightServiceServer) CreateShipper(context.Context, *CreateShipperRequest) (*Shipper, error)
func (UnimplementedFreightServiceServer) CreateSite(context.Context, *CreateSiteRequest) (*Site, error)
func (UnimplementedFreightServiceServer) DeleteShipment(context.Context, *DeleteShipmentRequest) (*Shipment, error)
func (UnimplementedFreightServiceServer) DeleteShipper(context.Context, *DeleteShipperRequest) (*Shipper, error)
func (UnimplementedFreightServiceServer) DeleteSite(context.Context, *DeleteSiteRequest) (*Site, error)
func (UnimplementedFreightServiceServer) GetShipment(context.Context, *GetShipmentRequest) (*Shipment, error)
func (UnimplementedFreightServiceServer) GetShipper(context.Context, *GetShipperRequest) (*Shipper, error)
func (UnimplementedFreightServiceServer) GetSite(context.Context, *GetSiteRequest) (*Site, error)
func (UnimplementedFreightServiceServer) ListShipments(context.Context, *ListShipmentsRequest) (*ListShipmentsResponse, error)
func (UnimplementedFreightServiceServer) ListShippers(context.Context, *ListShippersRequest) (*ListShippersResponse, error)
func (UnimplementedFreightServiceServer) ListSites(context.Context, *ListSitesRequest) (*ListSitesResponse, error)
func (UnimplementedFreightServiceServer) UpdateShipment(context.Context, *UpdateShipmentRequest) (*Shipment, error)
func (UnimplementedFreightServiceServer) UpdateShipper(context.Context, *UpdateShipperRequest) (*Shipper, error)
func (UnimplementedFreightServiceServer) UpdateSite(context.Context, *UpdateSiteRequest) (*Site, error)
UnsafeFreightServiceServer may be embedded to opt out of forward compatibility for this service. Use of this interface is not recommended, as added methods to FreightServiceServer will result in compilation errors.
type UnsafeFreightServiceServer interface {
// contains filtered or unexported methods
}
Request message for FreightService.UpdateShipment.
type UpdateShipmentRequest struct {
// The shipment to update with. The name must match or be empty.
// The shipment's `name` field is used to identify the shipment to be updated.
// Format: shippers/{shipper}/shipments/{shipment}
Shipment *Shipment `protobuf:"bytes,1,opt,name=shipment,proto3" json:"shipment,omitempty"`
// The list of fields to be updated.
UpdateMask *fieldmaskpb.FieldMask `protobuf:"bytes,2,opt,name=update_mask,json=updateMask,proto3" json:"update_mask,omitempty"`
// contains filtered or unexported fields
}
func (*UpdateShipmentRequest) Descriptor() ([]byte, []int)
Deprecated: Use UpdateShipmentRequest.ProtoReflect.Descriptor instead.
func (x *UpdateShipmentRequest) GetShipment() *Shipment
func (x *UpdateShipmentRequest) GetUpdateMask() *fieldmaskpb.FieldMask
func (*UpdateShipmentRequest) ProtoMessage()
func (x *UpdateShipmentRequest) ProtoReflect() protoreflect.Message
func (x *UpdateShipmentRequest) Reset()
func (x *UpdateShipmentRequest) String() string
Request message for FreightService.UpdateShipper.
type UpdateShipperRequest struct {
// The shipper to update with. The name must match or be empty.
// The shipper's `name` field is used to identify the shipper to be updated.
// Format: shippers/{shipper}
Shipper *Shipper `protobuf:"bytes,1,opt,name=shipper,proto3" json:"shipper,omitempty"`
// The list of fields to be updated.
UpdateMask *fieldmaskpb.FieldMask `protobuf:"bytes,2,opt,name=update_mask,json=updateMask,proto3" json:"update_mask,omitempty"`
// contains filtered or unexported fields
}
func (*UpdateShipperRequest) Descriptor() ([]byte, []int)
Deprecated: Use UpdateShipperRequest.ProtoReflect.Descriptor instead.
func (x *UpdateShipperRequest) GetShipper() *Shipper
func (x *UpdateShipperRequest) GetUpdateMask() *fieldmaskpb.FieldMask
func (*UpdateShipperRequest) ProtoMessage()
func (x *UpdateShipperRequest) ProtoReflect() protoreflect.Message
func (x *UpdateShipperRequest) Reset()
func (x *UpdateShipperRequest) String() string
Request message for FreightService.UpdateSite.
type UpdateSiteRequest struct {
// The site to update with. The name must match or be empty.
// The site's `name` field is used to identify the site to be updated.
// Format: shippers/{shipper}/sites/{site}
Site *Site `protobuf:"bytes,1,opt,name=site,proto3" json:"site,omitempty"`
// The list of fields to be updated.
UpdateMask *fieldmaskpb.FieldMask `protobuf:"bytes,2,opt,name=update_mask,json=updateMask,proto3" json:"update_mask,omitempty"`
// contains filtered or unexported fields
}
func (*UpdateSiteRequest) Descriptor() ([]byte, []int)
Deprecated: Use UpdateSiteRequest.ProtoReflect.Descriptor instead.
func (x *UpdateSiteRequest) GetSite() *Site
func (x *UpdateSiteRequest) GetUpdateMask() *fieldmaskpb.FieldMask
func (*UpdateSiteRequest) ProtoMessage()
func (x *UpdateSiteRequest) ProtoReflect() protoreflect.Message
func (x *UpdateSiteRequest) Reset()
func (x *UpdateSiteRequest) String() string