Class TripService.TripServiceClient
Client for TripService
Inheritance
Inherited Members
Namespace: Google.Maps.FleetEngine.V1
Assembly: Google.Maps.FleetEngine.V1.dll
Syntax
public class TripService.TripServiceClient : ClientBase<TripService.TripServiceClient>
Constructors
TripServiceClient()
Protected parameterless constructor to allow creation of test doubles.
Declaration
protected TripServiceClient()
TripServiceClient(CallInvoker)
Creates a new client for TripService that uses a custom CallInvoker.
Declaration
public TripServiceClient(CallInvoker callInvoker)
Parameters
| Type | Name | Description |
|---|---|---|
| CallInvoker | callInvoker | The callInvoker to use to make remote calls. |
TripServiceClient(ChannelBase)
Creates a new client for TripService
Declaration
public TripServiceClient(ChannelBase channel)
Parameters
| Type | Name | Description |
|---|---|---|
| ChannelBase | channel | The channel to use to make remote calls. |
TripServiceClient(ClientBaseConfiguration)
Protected constructor to allow creation of configured clients.
Declaration
protected TripServiceClient(ClientBase.ClientBaseConfiguration configuration)
Parameters
| Type | Name | Description |
|---|---|---|
| ClientBase.ClientBaseConfiguration | configuration | The client configuration. |
Methods
CreateTrip(CreateTripRequest, CallOptions)
Creates a trip in the Fleet Engine and returns the new trip.
Declaration
public virtual Trip CreateTrip(CreateTripRequest request, CallOptions options)
Parameters
| Type | Name | Description |
|---|---|---|
| CreateTripRequest | request | The request to send to the server. |
| CallOptions | options | The options for the call. |
Returns
| Type | Description |
|---|---|
| Trip | The response received from the server. |
CreateTrip(CreateTripRequest, Metadata, DateTime?, CancellationToken)
Creates a trip in the Fleet Engine and returns the new trip.
Declaration
public virtual Trip CreateTrip(CreateTripRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)
Parameters
| Type | Name | Description |
|---|---|---|
| CreateTripRequest | request | The request to send to the server. |
| Metadata | headers | The initial metadata to send with the call. This parameter is optional. |
| DateTime? | deadline | An optional deadline for the call. The call will be cancelled if deadline is hit. |
| CancellationToken | cancellationToken | An optional token for canceling the call. |
Returns
| Type | Description |
|---|---|
| Trip | The response received from the server. |
CreateTripAsync(CreateTripRequest, CallOptions)
Creates a trip in the Fleet Engine and returns the new trip.
Declaration
public virtual AsyncUnaryCall<Trip> CreateTripAsync(CreateTripRequest request, CallOptions options)
Parameters
| Type | Name | Description |
|---|---|---|
| CreateTripRequest | request | The request to send to the server. |
| CallOptions | options | The options for the call. |
Returns
| Type | Description |
|---|---|
| AsyncUnaryCall<Trip> | The call object. |
CreateTripAsync(CreateTripRequest, Metadata, DateTime?, CancellationToken)
Creates a trip in the Fleet Engine and returns the new trip.
Declaration
public virtual AsyncUnaryCall<Trip> CreateTripAsync(CreateTripRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)
Parameters
| Type | Name | Description |
|---|---|---|
| CreateTripRequest | request | The request to send to the server. |
| Metadata | headers | The initial metadata to send with the call. This parameter is optional. |
| DateTime? | deadline | An optional deadline for the call. The call will be cancelled if deadline is hit. |
| CancellationToken | cancellationToken | An optional token for canceling the call. |
Returns
| Type | Description |
|---|---|
| AsyncUnaryCall<Trip> | The call object. |
DeleteTrip(DeleteTripRequest, CallOptions)
Deletes a single Trip.
Returns FAILED_PRECONDITION if the Trip is active and assigned to a vehicle.
Declaration
public virtual Empty DeleteTrip(DeleteTripRequest request, CallOptions options)
Parameters
| Type | Name | Description |
|---|---|---|
| DeleteTripRequest | request | The request to send to the server. |
| CallOptions | options | The options for the call. |
Returns
| Type | Description |
|---|---|
| Empty | The response received from the server. |
DeleteTrip(DeleteTripRequest, Metadata, DateTime?, CancellationToken)
Deletes a single Trip.
Returns FAILED_PRECONDITION if the Trip is active and assigned to a vehicle.
Declaration
public virtual Empty DeleteTrip(DeleteTripRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)
Parameters
| Type | Name | Description |
|---|---|---|
| DeleteTripRequest | request | The request to send to the server. |
| Metadata | headers | The initial metadata to send with the call. This parameter is optional. |
| DateTime? | deadline | An optional deadline for the call. The call will be cancelled if deadline is hit. |
| CancellationToken | cancellationToken | An optional token for canceling the call. |
Returns
| Type | Description |
|---|---|
| Empty | The response received from the server. |
DeleteTripAsync(DeleteTripRequest, CallOptions)
Deletes a single Trip.
Returns FAILED_PRECONDITION if the Trip is active and assigned to a vehicle.
Declaration
public virtual AsyncUnaryCall<Empty> DeleteTripAsync(DeleteTripRequest request, CallOptions options)
Parameters
| Type | Name | Description |
|---|---|---|
| DeleteTripRequest | request | The request to send to the server. |
| CallOptions | options | The options for the call. |
Returns
| Type | Description |
|---|---|
| AsyncUnaryCall<Empty> | The call object. |
DeleteTripAsync(DeleteTripRequest, Metadata, DateTime?, CancellationToken)
Deletes a single Trip.
Returns FAILED_PRECONDITION if the Trip is active and assigned to a vehicle.
Declaration
public virtual AsyncUnaryCall<Empty> DeleteTripAsync(DeleteTripRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)
Parameters
| Type | Name | Description |
|---|---|---|
| DeleteTripRequest | request | The request to send to the server. |
| Metadata | headers | The initial metadata to send with the call. This parameter is optional. |
| DateTime? | deadline | An optional deadline for the call. The call will be cancelled if deadline is hit. |
| CancellationToken | cancellationToken | An optional token for canceling the call. |
Returns
| Type | Description |
|---|---|
| AsyncUnaryCall<Empty> | The call object. |
GetTrip(GetTripRequest, CallOptions)
Get information about a single trip.
Declaration
public virtual Trip GetTrip(GetTripRequest request, CallOptions options)
Parameters
| Type | Name | Description |
|---|---|---|
| GetTripRequest | request | The request to send to the server. |
| CallOptions | options | The options for the call. |
Returns
| Type | Description |
|---|---|
| Trip | The response received from the server. |
GetTrip(GetTripRequest, Metadata, DateTime?, CancellationToken)
Get information about a single trip.
Declaration
public virtual Trip GetTrip(GetTripRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)
Parameters
| Type | Name | Description |
|---|---|---|
| GetTripRequest | request | The request to send to the server. |
| Metadata | headers | The initial metadata to send with the call. This parameter is optional. |
| DateTime? | deadline | An optional deadline for the call. The call will be cancelled if deadline is hit. |
| CancellationToken | cancellationToken | An optional token for canceling the call. |
Returns
| Type | Description |
|---|---|
| Trip | The response received from the server. |
GetTripAsync(GetTripRequest, CallOptions)
Get information about a single trip.
Declaration
public virtual AsyncUnaryCall<Trip> GetTripAsync(GetTripRequest request, CallOptions options)
Parameters
| Type | Name | Description |
|---|---|---|
| GetTripRequest | request | The request to send to the server. |
| CallOptions | options | The options for the call. |
Returns
| Type | Description |
|---|---|
| AsyncUnaryCall<Trip> | The call object. |
GetTripAsync(GetTripRequest, Metadata, DateTime?, CancellationToken)
Get information about a single trip.
Declaration
public virtual AsyncUnaryCall<Trip> GetTripAsync(GetTripRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)
Parameters
| Type | Name | Description |
|---|---|---|
| GetTripRequest | request | The request to send to the server. |
| Metadata | headers | The initial metadata to send with the call. This parameter is optional. |
| DateTime? | deadline | An optional deadline for the call. The call will be cancelled if deadline is hit. |
| CancellationToken | cancellationToken | An optional token for canceling the call. |
Returns
| Type | Description |
|---|---|
| AsyncUnaryCall<Trip> | The call object. |
NewInstance(ClientBaseConfiguration)
Creates a new instance of client from given ClientBaseConfiguration.
Declaration
protected override TripService.TripServiceClient NewInstance(ClientBase.ClientBaseConfiguration configuration)
Parameters
| Type | Name | Description |
|---|---|---|
| ClientBase.ClientBaseConfiguration | configuration |
Returns
| Type | Description |
|---|---|
| TripService.TripServiceClient |
Overrides
ReportBillableTrip(ReportBillableTripRequest, CallOptions)
Report billable trip usage.
Declaration
public virtual Empty ReportBillableTrip(ReportBillableTripRequest request, CallOptions options)
Parameters
| Type | Name | Description |
|---|---|---|
| ReportBillableTripRequest | request | The request to send to the server. |
| CallOptions | options | The options for the call. |
Returns
| Type | Description |
|---|---|
| Empty | The response received from the server. |
ReportBillableTrip(ReportBillableTripRequest, Metadata, DateTime?, CancellationToken)
Report billable trip usage.
Declaration
public virtual Empty ReportBillableTrip(ReportBillableTripRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)
Parameters
| Type | Name | Description |
|---|---|---|
| ReportBillableTripRequest | request | The request to send to the server. |
| Metadata | headers | The initial metadata to send with the call. This parameter is optional. |
| DateTime? | deadline | An optional deadline for the call. The call will be cancelled if deadline is hit. |
| CancellationToken | cancellationToken | An optional token for canceling the call. |
Returns
| Type | Description |
|---|---|
| Empty | The response received from the server. |
ReportBillableTripAsync(ReportBillableTripRequest, CallOptions)
Report billable trip usage.
Declaration
public virtual AsyncUnaryCall<Empty> ReportBillableTripAsync(ReportBillableTripRequest request, CallOptions options)
Parameters
| Type | Name | Description |
|---|---|---|
| ReportBillableTripRequest | request | The request to send to the server. |
| CallOptions | options | The options for the call. |
Returns
| Type | Description |
|---|---|
| AsyncUnaryCall<Empty> | The call object. |
ReportBillableTripAsync(ReportBillableTripRequest, Metadata, DateTime?, CancellationToken)
Report billable trip usage.
Declaration
public virtual AsyncUnaryCall<Empty> ReportBillableTripAsync(ReportBillableTripRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)
Parameters
| Type | Name | Description |
|---|---|---|
| ReportBillableTripRequest | request | The request to send to the server. |
| Metadata | headers | The initial metadata to send with the call. This parameter is optional. |
| DateTime? | deadline | An optional deadline for the call. The call will be cancelled if deadline is hit. |
| CancellationToken | cancellationToken | An optional token for canceling the call. |
Returns
| Type | Description |
|---|---|
| AsyncUnaryCall<Empty> | The call object. |
SearchTrips(SearchTripsRequest, CallOptions)
Get all the trips for a specific vehicle.
Declaration
public virtual SearchTripsResponse SearchTrips(SearchTripsRequest request, CallOptions options)
Parameters
| Type | Name | Description |
|---|---|---|
| SearchTripsRequest | request | The request to send to the server. |
| CallOptions | options | The options for the call. |
Returns
| Type | Description |
|---|---|
| SearchTripsResponse | The response received from the server. |
SearchTrips(SearchTripsRequest, Metadata, DateTime?, CancellationToken)
Get all the trips for a specific vehicle.
Declaration
public virtual SearchTripsResponse SearchTrips(SearchTripsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)
Parameters
| Type | Name | Description |
|---|---|---|
| SearchTripsRequest | request | The request to send to the server. |
| Metadata | headers | The initial metadata to send with the call. This parameter is optional. |
| DateTime? | deadline | An optional deadline for the call. The call will be cancelled if deadline is hit. |
| CancellationToken | cancellationToken | An optional token for canceling the call. |
Returns
| Type | Description |
|---|---|
| SearchTripsResponse | The response received from the server. |
SearchTripsAsync(SearchTripsRequest, CallOptions)
Get all the trips for a specific vehicle.
Declaration
public virtual AsyncUnaryCall<SearchTripsResponse> SearchTripsAsync(SearchTripsRequest request, CallOptions options)
Parameters
| Type | Name | Description |
|---|---|---|
| SearchTripsRequest | request | The request to send to the server. |
| CallOptions | options | The options for the call. |
Returns
| Type | Description |
|---|---|
| AsyncUnaryCall<SearchTripsResponse> | The call object. |
SearchTripsAsync(SearchTripsRequest, Metadata, DateTime?, CancellationToken)
Get all the trips for a specific vehicle.
Declaration
public virtual AsyncUnaryCall<SearchTripsResponse> SearchTripsAsync(SearchTripsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)
Parameters
| Type | Name | Description |
|---|---|---|
| SearchTripsRequest | request | The request to send to the server. |
| Metadata | headers | The initial metadata to send with the call. This parameter is optional. |
| DateTime? | deadline | An optional deadline for the call. The call will be cancelled if deadline is hit. |
| CancellationToken | cancellationToken | An optional token for canceling the call. |
Returns
| Type | Description |
|---|---|
| AsyncUnaryCall<SearchTripsResponse> | The call object. |
UpdateTrip(UpdateTripRequest, CallOptions)
Updates trip data.
Declaration
public virtual Trip UpdateTrip(UpdateTripRequest request, CallOptions options)
Parameters
| Type | Name | Description |
|---|---|---|
| UpdateTripRequest | request | The request to send to the server. |
| CallOptions | options | The options for the call. |
Returns
| Type | Description |
|---|---|
| Trip | The response received from the server. |
UpdateTrip(UpdateTripRequest, Metadata, DateTime?, CancellationToken)
Updates trip data.
Declaration
public virtual Trip UpdateTrip(UpdateTripRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)
Parameters
| Type | Name | Description |
|---|---|---|
| UpdateTripRequest | request | The request to send to the server. |
| Metadata | headers | The initial metadata to send with the call. This parameter is optional. |
| DateTime? | deadline | An optional deadline for the call. The call will be cancelled if deadline is hit. |
| CancellationToken | cancellationToken | An optional token for canceling the call. |
Returns
| Type | Description |
|---|---|
| Trip | The response received from the server. |
UpdateTripAsync(UpdateTripRequest, CallOptions)
Updates trip data.
Declaration
public virtual AsyncUnaryCall<Trip> UpdateTripAsync(UpdateTripRequest request, CallOptions options)
Parameters
| Type | Name | Description |
|---|---|---|
| UpdateTripRequest | request | The request to send to the server. |
| CallOptions | options | The options for the call. |
Returns
| Type | Description |
|---|---|
| AsyncUnaryCall<Trip> | The call object. |
UpdateTripAsync(UpdateTripRequest, Metadata, DateTime?, CancellationToken)
Updates trip data.
Declaration
public virtual AsyncUnaryCall<Trip> UpdateTripAsync(UpdateTripRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)
Parameters
| Type | Name | Description |
|---|---|---|
| UpdateTripRequest | request | The request to send to the server. |
| Metadata | headers | The initial metadata to send with the call. This parameter is optional. |
| DateTime? | deadline | An optional deadline for the call. The call will be cancelled if deadline is hit. |
| CancellationToken | cancellationToken | An optional token for canceling the call. |
Returns
| Type | Description |
|---|---|
| AsyncUnaryCall<Trip> | The call object. |