As of January 1, 2020 this library no longer supports Python 2 on the latest released version. Library versions released prior to that date will continue to be available. For more information please visit Python 2 support on Google Cloud.

VehicleService¶

class google.maps.fleetengine_v1.services.vehicle_service.VehicleServiceAsyncClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.maps.fleetengine_v1.services.vehicle_service.transports.base.VehicleServiceTransport, typing.Callable[[...], google.maps.fleetengine_v1.services.vehicle_service.transports.base.VehicleServiceTransport]]] = 'grpc_asyncio', client_options: typing.Optional[google.api_core.client_options.ClientOptions] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo = <google.api_core.gapic_v1.client_info.ClientInfo object>)[source]¶

Vehicle management service.

Instantiates the vehicle service async client.

Parameters

credentials (Optional[google.auth.credentials.Credentials]) – The authorization credentials to attach to requests. These credentials identify the application to the service; if none are specified, the client will attempt to ascertain the credentials from the environment.
transport (Optional[Union[str,VehicleServiceTransport,Callable[..., VehicleServiceTransport]]]) – The transport to use, or a Callable that constructs and returns a new transport to use. If a Callable is given, it will be called with the same set of initialization arguments as used in the VehicleServiceTransport constructor. If set to None, a transport is chosen automatically.
client_options (Optional[Union[google.api_core.client_options.ClientOptions, dict]]) –
Custom options for the client.

1. The api_endpoint property can be used to override the default endpoint provided by the client when transport is not explicitly provided. Only if this property is not set and transport was not explicitly provided, the endpoint is determined by the GOOGLE_API_USE_MTLS_ENDPOINT environment variable, which have one of the following values: “always” (always use the default mTLS endpoint), “never” (always use the default regular endpoint) and “auto” (auto-switch to the default mTLS endpoint if client certificate is present; this is the default value).

2. If the GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is “true”, then the client_cert_source property can be used to provide a client certificate for mTLS transport. If not provided, the default SSL client certificate will be used if present. If GOOGLE_API_USE_CLIENT_CERTIFICATE is “false” or not set, no client certificate will be used.

3. The universe_domain property can be used to override the default “googleapis.com” universe. Note that api_endpoint property still takes precedence; and universe_domain is currently not supported for mTLS.
client_info (google.api_core.gapic_v1.client_info.ClientInfo) – The client info used to send a user-agent string along with API requests. If None, then default info will be used. Generally, you only need to set this if you’re developing your own client library.

Raises

google.auth.exceptions.MutualTlsChannelError – If mutual TLS transport creation failed for any reason.

property api_endpoint¶

Return the API endpoint used by the client instance.

Returns: The API endpoint used by the client instance.
Return type: str

static common_billing_account_path(billing_account: str) → str¶: Returns a fully-qualified billing_account string.

static common_folder_path(folder: str) → str¶: Returns a fully-qualified folder string.

static common_location_path(project: str, location: str) → str¶: Returns a fully-qualified location string.

static common_organization_path(organization: str) → str¶: Returns a fully-qualified organization string.

static common_project_path(project: str) → str¶: Returns a fully-qualified project string.

async create_vehicle(request: Optional[Union[google.maps.fleetengine_v1.types.vehicle_api.CreateVehicleRequest, dict]] = None, *, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.maps.fleetengine_v1.types.vehicles.Vehicle[source]¶

Instantiates a new vehicle associated with an on-demand rideshare or deliveries provider. Each Vehicle must have a unique vehicle ID.

The following Vehicle fields are required when creating a Vehicle:

vehicleState
supportedTripTypes
maximumCapacity
vehicleType

The following Vehicle fields are ignored when creating a Vehicle:

name
currentTrips
availableCapacity
current_route_segment
current_route_segment_end_point
current_route_segment_version
current_route_segment_traffic
route
waypoints
waypoints_version
remaining_distance_meters
remaining_time_seconds
eta_to_next_waypoint
navigation_status

All other fields are optional and used if provided.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.maps import fleetengine_v1

async def sample_create_vehicle():
    # Create a client
    client = fleetengine_v1.VehicleServiceAsyncClient()

    # Initialize request argument(s)
    request = fleetengine_v1.CreateVehicleRequest(
        parent="parent_value",
        vehicle_id="vehicle_id_value",
    )

    # Make the request
    response = await client.create_vehicle(request=request)

    # Handle the response
    print(response)

Parameters

request (Optional[Union[google.maps.fleetengine_v1.types.CreateVehicleRequest, dict]]) – The request object. CreateVehicle request message.
retry (google.api_core.retry_async.AsyncRetry) – Designation of what errors, if any, should be retried.
timeout (float) – The timeout for this request.
metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

Returns

Vehicle metadata.

Return type

google.maps.fleetengine_v1.types.Vehicle

classmethod from_service_account_file(filename: str, *args, **kwargs)[source]¶

Creates an instance of this client using the provided credentials: file.

Parameters

filename (str) – The path to the service account private key json file.
args – Additional arguments to pass to the constructor.
kwargs – Additional arguments to pass to the constructor.

Returns

The constructed client.

Return type

VehicleServiceAsyncClient

classmethod from_service_account_info(info: dict, *args, **kwargs)[source]¶

Creates an instance of this client using the provided credentials: info.

Parameters

info (dict) – The service account private key info.
args – Additional arguments to pass to the constructor.
kwargs – Additional arguments to pass to the constructor.

Returns

The constructed client.

Return type

VehicleServiceAsyncClient

classmethod from_service_account_json(filename: str, *args, **kwargs)¶

Creates an instance of this client using the provided credentials: file.

Parameters

filename (str) – The path to the service account private key json file.
args – Additional arguments to pass to the constructor.
kwargs – Additional arguments to pass to the constructor.

Returns

The constructed client.

Return type

VehicleServiceAsyncClient

classmethod get_mtls_endpoint_and_cert_source(client_options: Optional[google.api_core.client_options.ClientOptions] = None)[source]¶

Return the API endpoint and client cert source for mutual TLS.

The client cert source is determined in the following order: (1) if GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is not “true”, the client cert source is None. (2) if client_options.client_cert_source is provided, use the provided one; if the default client cert source exists, use the default one; otherwise the client cert source is None.

The API endpoint is determined in the following order: (1) if client_options.api_endpoint if provided, use the provided one. (2) if GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is “always”, use the default mTLS endpoint; if the environment variable is “never”, use the default API endpoint; otherwise if client cert source exists, use the default mTLS endpoint, otherwise use the default API endpoint.

More details can be found at https://google.aip.dev/auth/4114.

Parameters

client_options (google.api_core.client_options.ClientOptions) – Custom options for the client. Only the api_endpoint and client_cert_source properties may be used in this method.

Returns

returns the API endpoint and the: client cert source to use.

Return type

Tuple[str, Callable[[], Tuple[bytes, bytes]]]

Raises

google.auth.exceptions.MutualTLSChannelError – If any errors happen.

classmethod get_transport_class(label: Optional[str] = None) → Type[google.maps.fleetengine_v1.services.vehicle_service.transports.base.VehicleServiceTransport]¶

Returns an appropriate transport class.

Parameters: label – The name of the desired transport. If none is provided, then the first transport in the registry is used.
Returns: The transport class to use.

async get_vehicle(request: Optional[Union[google.maps.fleetengine_v1.types.vehicle_api.GetVehicleRequest, dict]] = None, *, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.maps.fleetengine_v1.types.vehicles.Vehicle[source]¶

Returns a vehicle from the Fleet Engine.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.maps import fleetengine_v1

async def sample_get_vehicle():
    # Create a client
    client = fleetengine_v1.VehicleServiceAsyncClient()

    # Initialize request argument(s)
    request = fleetengine_v1.GetVehicleRequest(
        name="name_value",
    )

    # Make the request
    response = await client.get_vehicle(request=request)

    # Handle the response
    print(response)

Parameters

request (Optional[Union[google.maps.fleetengine_v1.types.GetVehicleRequest, dict]]) – The request object. GetVehicle request message.
retry (google.api_core.retry_async.AsyncRetry) – Designation of what errors, if any, should be retried.
timeout (float) – The timeout for this request.
metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

Returns

Vehicle metadata.

Return type

google.maps.fleetengine_v1.types.Vehicle

async list_vehicles(request: Optional[Union[google.maps.fleetengine_v1.types.vehicle_api.ListVehiclesRequest, dict]] = None, *, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.maps.fleetengine_v1.services.vehicle_service.pagers.ListVehiclesAsyncPager[source]¶

Returns a paginated list of vehicles associated with a provider that match the request options.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.maps import fleetengine_v1

async def sample_list_vehicles():
    # Create a client
    client = fleetengine_v1.VehicleServiceAsyncClient()

    # Initialize request argument(s)
    request = fleetengine_v1.ListVehiclesRequest(
        parent="parent_value",
        vehicle_type_categories=['PEDESTRIAN'],
    )

    # Make the request
    page_result = client.list_vehicles(request=request)

    # Handle the response
    async for response in page_result:
        print(response)

Parameters

request (Optional[Union[google.maps.fleetengine_v1.types.ListVehiclesRequest, dict]]) – The request object. ListVehicles request message.
retry (google.api_core.retry_async.AsyncRetry) – Designation of what errors, if any, should be retried.
timeout (float) – The timeout for this request.
metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

Returns

ListVehicles response message.

Iterating over this object will yield results and resolve additional pages automatically.

Return type

google.maps.fleetengine_v1.services.vehicle_service.pagers.ListVehiclesAsyncPager

static parse_common_billing_account_path(path: str) → Dict[str, str]¶: Parse a billing_account path into its component segments.

static parse_common_folder_path(path: str) → Dict[str, str]¶: Parse a folder path into its component segments.

static parse_common_location_path(path: str) → Dict[str, str]¶: Parse a location path into its component segments.

static parse_common_organization_path(path: str) → Dict[str, str]¶: Parse a organization path into its component segments.

static parse_common_project_path(path: str) → Dict[str, str]¶: Parse a project path into its component segments.

static parse_vehicle_path(path: str) → Dict[str, str]¶: Parses a vehicle path into its component segments.

async search_vehicles(request: Optional[Union[google.maps.fleetengine_v1.types.vehicle_api.SearchVehiclesRequest, dict]] = None, *, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.maps.fleetengine_v1.types.vehicle_api.SearchVehiclesResponse[source]¶

Returns a list of vehicles that match the request options.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.maps import fleetengine_v1

async def sample_search_vehicles():
    # Create a client
    client = fleetengine_v1.VehicleServiceAsyncClient()

    # Initialize request argument(s)
    request = fleetengine_v1.SearchVehiclesRequest(
        parent="parent_value",
        pickup_radius_meters=2146,
        count=553,
        minimum_capacity=1705,
        trip_types=['EXCLUSIVE'],
        order_by="COST",
    )

    # Make the request
    response = await client.search_vehicles(request=request)

    # Handle the response
    print(response)

Parameters

request (Optional[Union[google.maps.fleetengine_v1.types.SearchVehiclesRequest, dict]]) – The request object. SearchVehicles request message.
retry (google.api_core.retry_async.AsyncRetry) – Designation of what errors, if any, should be retried.
timeout (float) – The timeout for this request.
metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

Returns

SearchVehicles response message.

Return type

google.maps.fleetengine_v1.types.SearchVehiclesResponse

property transport: google.maps.fleetengine_v1.services.vehicle_service.transports.base.VehicleServiceTransport¶

Returns the transport used by the client instance.

Returns: The transport used by the client instance.
Return type: VehicleServiceTransport

property universe_domain: str¶

Return the universe domain used by the client instance.

Returns

The universe domain used: by the client instance.

Return type

str

async update_vehicle(request: Optional[Union[google.maps.fleetengine_v1.types.vehicle_api.UpdateVehicleRequest, dict]] = None, *, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.maps.fleetengine_v1.types.vehicles.Vehicle[source]¶

Writes updated vehicle data to the Fleet Engine.

When updating a Vehicle, the following fields cannot be updated since they are managed by the server:

currentTrips
availableCapacity
current_route_segment_version
waypoints_version

The vehicle name also cannot be updated.

If the attributes field is updated, all the vehicle’s attributes are replaced with the attributes provided in the request. If you want to update only some attributes, see the UpdateVehicleAttributes method. Likewise, the waypoints field can be updated, but must contain all the waypoints currently on the vehicle, and no other waypoints.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.maps import fleetengine_v1

async def sample_update_vehicle():
    # Create a client
    client = fleetengine_v1.VehicleServiceAsyncClient()

    # Initialize request argument(s)
    request = fleetengine_v1.UpdateVehicleRequest(
        name="name_value",
    )

    # Make the request
    response = await client.update_vehicle(request=request)

    # Handle the response
    print(response)

Parameters

request (Optional[Union[google.maps.fleetengine_v1.types.UpdateVehicleRequest, dict]]) – The request object. `UpdateVehicle request message.
retry (google.api_core.retry_async.AsyncRetry) – Designation of what errors, if any, should be retried.
timeout (float) – The timeout for this request.
metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

Returns

Vehicle metadata.

Return type

google.maps.fleetengine_v1.types.Vehicle

async update_vehicle_attributes(request: Optional[Union[google.maps.fleetengine_v1.types.vehicle_api.UpdateVehicleAttributesRequest, dict]] = None, *, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.maps.fleetengine_v1.types.vehicle_api.UpdateVehicleAttributesResponse[source]¶

Partially updates a vehicle’s attributes. Only the attributes mentioned in the request will be updated, other attributes will NOT be altered. Note: this is different in UpdateVehicle, where the whole attributes field will be replaced by the one in UpdateVehicleRequest, attributes not in the request would be removed.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.maps import fleetengine_v1

async def sample_update_vehicle_attributes():
    # Create a client
    client = fleetengine_v1.VehicleServiceAsyncClient()

    # Initialize request argument(s)
    attributes = fleetengine_v1.VehicleAttribute()
    attributes.string_value = "string_value_value"

    request = fleetengine_v1.UpdateVehicleAttributesRequest(
        name="name_value",
        attributes=attributes,
    )

    # Make the request
    response = await client.update_vehicle_attributes(request=request)

    # Handle the response
    print(response)

Parameters

request (Optional[Union[google.maps.fleetengine_v1.types.UpdateVehicleAttributesRequest, dict]]) – The request object. UpdateVehicleAttributes request message.
retry (google.api_core.retry_async.AsyncRetry) – Designation of what errors, if any, should be retried.
timeout (float) – The timeout for this request.
metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

Returns

UpdateVehicleAttributes response message.

Return type

google.maps.fleetengine_v1.types.UpdateVehicleAttributesResponse

static vehicle_path(provider: str, vehicle: str) → str¶: Returns a fully-qualified vehicle string.

class google.maps.fleetengine_v1.services.vehicle_service.VehicleServiceClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.maps.fleetengine_v1.services.vehicle_service.transports.base.VehicleServiceTransport, typing.Callable[[...], google.maps.fleetengine_v1.services.vehicle_service.transports.base.VehicleServiceTransport]]] = None, client_options: typing.Optional[typing.Union[google.api_core.client_options.ClientOptions, dict]] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo = <google.api_core.gapic_v1.client_info.ClientInfo object>)[source]¶

Vehicle management service.

Instantiates the vehicle service client.

Parameters

credentials (Optional[google.auth.credentials.Credentials]) – The authorization credentials to attach to requests. These credentials identify the application to the service; if none are specified, the client will attempt to ascertain the credentials from the environment.
transport (Optional[Union[str,VehicleServiceTransport,Callable[..., VehicleServiceTransport]]]) – The transport to use, or a Callable that constructs and returns a new transport. If a Callable is given, it will be called with the same set of initialization arguments as used in the VehicleServiceTransport constructor. If set to None, a transport is chosen automatically.
client_options (Optional[Union[google.api_core.client_options.ClientOptions, dict]]) –
Custom options for the client.

1. The api_endpoint property can be used to override the default endpoint provided by the client when transport is not explicitly provided. Only if this property is not set and transport was not explicitly provided, the endpoint is determined by the GOOGLE_API_USE_MTLS_ENDPOINT environment variable, which have one of the following values: “always” (always use the default mTLS endpoint), “never” (always use the default regular endpoint) and “auto” (auto-switch to the default mTLS endpoint if client certificate is present; this is the default value).

2. If the GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is “true”, then the client_cert_source property can be used to provide a client certificate for mTLS transport. If not provided, the default SSL client certificate will be used if present. If GOOGLE_API_USE_CLIENT_CERTIFICATE is “false” or not set, no client certificate will be used.

3. The universe_domain property can be used to override the default “googleapis.com” universe. Note that the api_endpoint property still takes precedence; and universe_domain is currently not supported for mTLS.
client_info (google.api_core.gapic_v1.client_info.ClientInfo) – The client info used to send a user-agent string along with API requests. If None, then default info will be used. Generally, you only need to set this if you’re developing your own client library.

Raises

google.auth.exceptions.MutualTLSChannelError – If mutual TLS transport creation failed for any reason.

__exit__(type, value, traceback)[source]¶: Releases underlying transport’s resources.

Warning

ONLY use as a context manager if the transport is NOT shared with other clients! Exiting the with block will CLOSE the transport and may cause errors in other clients!

property api_endpoint¶

Return the API endpoint used by the client instance.

Returns: The API endpoint used by the client instance.
Return type: str

static common_billing_account_path(billing_account: str) → str[source]¶: Returns a fully-qualified billing_account string.

static common_folder_path(folder: str) → str[source]¶: Returns a fully-qualified folder string.

static common_location_path(project: str, location: str) → str[source]¶: Returns a fully-qualified location string.

static common_organization_path(organization: str) → str[source]¶: Returns a fully-qualified organization string.

static common_project_path(project: str) → str[source]¶: Returns a fully-qualified project string.

create_vehicle(request: Optional[Union[google.maps.fleetengine_v1.types.vehicle_api.CreateVehicleRequest, dict]] = None, *, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.maps.fleetengine_v1.types.vehicles.Vehicle[source]¶

Instantiates a new vehicle associated with an on-demand rideshare or deliveries provider. Each Vehicle must have a unique vehicle ID.

The following Vehicle fields are required when creating a Vehicle:

vehicleState
supportedTripTypes
maximumCapacity
vehicleType

The following Vehicle fields are ignored when creating a Vehicle:

name
currentTrips
availableCapacity
current_route_segment
current_route_segment_end_point
current_route_segment_version
current_route_segment_traffic
route
waypoints
waypoints_version
remaining_distance_meters
remaining_time_seconds
eta_to_next_waypoint
navigation_status

All other fields are optional and used if provided.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.maps import fleetengine_v1

def sample_create_vehicle():
    # Create a client
    client = fleetengine_v1.VehicleServiceClient()

    # Initialize request argument(s)
    request = fleetengine_v1.CreateVehicleRequest(
        parent="parent_value",
        vehicle_id="vehicle_id_value",
    )

    # Make the request
    response = client.create_vehicle(request=request)

    # Handle the response
    print(response)

Parameters

request (Union[google.maps.fleetengine_v1.types.CreateVehicleRequest, dict]) – The request object. CreateVehicle request message.
retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.
timeout (float) – The timeout for this request.
metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

Returns

Vehicle metadata.

Return type

google.maps.fleetengine_v1.types.Vehicle

classmethod from_service_account_file(filename: str, *args, **kwargs)[source]¶

Creates an instance of this client using the provided credentials: file.

Parameters

filename (str) – The path to the service account private key json file.
args – Additional arguments to pass to the constructor.
kwargs – Additional arguments to pass to the constructor.

Returns

The constructed client.

Return type

VehicleServiceClient

classmethod from_service_account_info(info: dict, *args, **kwargs)[source]¶

Creates an instance of this client using the provided credentials: info.

Parameters

info (dict) – The service account private key info.
args – Additional arguments to pass to the constructor.
kwargs – Additional arguments to pass to the constructor.

Returns

The constructed client.

Return type

VehicleServiceClient

classmethod from_service_account_json(filename: str, *args, **kwargs)¶

Creates an instance of this client using the provided credentials: file.

Parameters

filename (str) – The path to the service account private key json file.
args – Additional arguments to pass to the constructor.
kwargs – Additional arguments to pass to the constructor.

Returns

The constructed client.

Return type

VehicleServiceClient

classmethod get_mtls_endpoint_and_cert_source(client_options: Optional[google.api_core.client_options.ClientOptions] = None)[source]¶

Deprecated. Return the API endpoint and client cert source for mutual TLS.

The client cert source is determined in the following order: (1) if GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is not “true”, the client cert source is None. (2) if client_options.client_cert_source is provided, use the provided one; if the default client cert source exists, use the default one; otherwise the client cert source is None.

The API endpoint is determined in the following order: (1) if client_options.api_endpoint if provided, use the provided one. (2) if GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is “always”, use the default mTLS endpoint; if the environment variable is “never”, use the default API endpoint; otherwise if client cert source exists, use the default mTLS endpoint, otherwise use the default API endpoint.

More details can be found at https://google.aip.dev/auth/4114.

Parameters

client_options (google.api_core.client_options.ClientOptions) – Custom options for the client. Only the api_endpoint and client_cert_source properties may be used in this method.

Returns

returns the API endpoint and the: client cert source to use.

Return type

Tuple[str, Callable[[], Tuple[bytes, bytes]]]

Raises

google.auth.exceptions.MutualTLSChannelError – If any errors happen.

get_vehicle(request: Optional[Union[google.maps.fleetengine_v1.types.vehicle_api.GetVehicleRequest, dict]] = None, *, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.maps.fleetengine_v1.types.vehicles.Vehicle[source]¶

Returns a vehicle from the Fleet Engine.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.maps import fleetengine_v1

def sample_get_vehicle():
    # Create a client
    client = fleetengine_v1.VehicleServiceClient()

    # Initialize request argument(s)
    request = fleetengine_v1.GetVehicleRequest(
        name="name_value",
    )

    # Make the request
    response = client.get_vehicle(request=request)

    # Handle the response
    print(response)

Parameters

request (Union[google.maps.fleetengine_v1.types.GetVehicleRequest, dict]) – The request object. GetVehicle request message.
retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.
timeout (float) – The timeout for this request.
metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

Returns

Vehicle metadata.

Return type

google.maps.fleetengine_v1.types.Vehicle

list_vehicles(request: Optional[Union[google.maps.fleetengine_v1.types.vehicle_api.ListVehiclesRequest, dict]] = None, *, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.maps.fleetengine_v1.services.vehicle_service.pagers.ListVehiclesPager[source]¶

Returns a paginated list of vehicles associated with a provider that match the request options.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.maps import fleetengine_v1

def sample_list_vehicles():
    # Create a client
    client = fleetengine_v1.VehicleServiceClient()

    # Initialize request argument(s)
    request = fleetengine_v1.ListVehiclesRequest(
        parent="parent_value",
        vehicle_type_categories=['PEDESTRIAN'],
    )

    # Make the request
    page_result = client.list_vehicles(request=request)

    # Handle the response
    for response in page_result:
        print(response)

Parameters

request (Union[google.maps.fleetengine_v1.types.ListVehiclesRequest, dict]) – The request object. ListVehicles request message.
retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.
timeout (float) – The timeout for this request.
metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

Returns

ListVehicles response message.

Iterating over this object will yield results and resolve additional pages automatically.

Return type

google.maps.fleetengine_v1.services.vehicle_service.pagers.ListVehiclesPager

static parse_common_billing_account_path(path: str) → Dict[str, str][source]¶: Parse a billing_account path into its component segments.

static parse_common_folder_path(path: str) → Dict[str, str][source]¶: Parse a folder path into its component segments.

static parse_common_location_path(path: str) → Dict[str, str][source]¶: Parse a location path into its component segments.

static parse_common_organization_path(path: str) → Dict[str, str][source]¶: Parse a organization path into its component segments.

static parse_common_project_path(path: str) → Dict[str, str][source]¶: Parse a project path into its component segments.

static parse_vehicle_path(path: str) → Dict[str, str][source]¶: Parses a vehicle path into its component segments.

search_vehicles(request: Optional[Union[google.maps.fleetengine_v1.types.vehicle_api.SearchVehiclesRequest, dict]] = None, *, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.maps.fleetengine_v1.types.vehicle_api.SearchVehiclesResponse[source]¶

Returns a list of vehicles that match the request options.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.maps import fleetengine_v1

def sample_search_vehicles():
    # Create a client
    client = fleetengine_v1.VehicleServiceClient()

    # Initialize request argument(s)
    request = fleetengine_v1.SearchVehiclesRequest(
        parent="parent_value",
        pickup_radius_meters=2146,
        count=553,
        minimum_capacity=1705,
        trip_types=['EXCLUSIVE'],
        order_by="COST",
    )

    # Make the request
    response = client.search_vehicles(request=request)

    # Handle the response
    print(response)

Parameters

request (Union[google.maps.fleetengine_v1.types.SearchVehiclesRequest, dict]) – The request object. SearchVehicles request message.
retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.
timeout (float) – The timeout for this request.
metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

Returns

SearchVehicles response message.

Return type

google.maps.fleetengine_v1.types.SearchVehiclesResponse

property transport: google.maps.fleetengine_v1.services.vehicle_service.transports.base.VehicleServiceTransport¶

Returns the transport used by the client instance.

Returns

The transport used by the client: instance.

Return type

VehicleServiceTransport

property universe_domain: str¶

Return the universe domain used by the client instance.

Returns: The universe domain used by the client instance.
Return type: str

update_vehicle(request: Optional[Union[google.maps.fleetengine_v1.types.vehicle_api.UpdateVehicleRequest, dict]] = None, *, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.maps.fleetengine_v1.types.vehicles.Vehicle[source]¶

Writes updated vehicle data to the Fleet Engine.

When updating a Vehicle, the following fields cannot be updated since they are managed by the server:

currentTrips
availableCapacity
current_route_segment_version
waypoints_version

The vehicle name also cannot be updated.

If the attributes field is updated, all the vehicle’s attributes are replaced with the attributes provided in the request. If you want to update only some attributes, see the UpdateVehicleAttributes method. Likewise, the waypoints field can be updated, but must contain all the waypoints currently on the vehicle, and no other waypoints.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.maps import fleetengine_v1

def sample_update_vehicle():
    # Create a client
    client = fleetengine_v1.VehicleServiceClient()

    # Initialize request argument(s)
    request = fleetengine_v1.UpdateVehicleRequest(
        name="name_value",
    )

    # Make the request
    response = client.update_vehicle(request=request)

    # Handle the response
    print(response)

Parameters

request (Union[google.maps.fleetengine_v1.types.UpdateVehicleRequest, dict]) – The request object. `UpdateVehicle request message.
retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.
timeout (float) – The timeout for this request.
metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

Returns

Vehicle metadata.

Return type

google.maps.fleetengine_v1.types.Vehicle

update_vehicle_attributes(request: Optional[Union[google.maps.fleetengine_v1.types.vehicle_api.UpdateVehicleAttributesRequest, dict]] = None, *, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.maps.fleetengine_v1.types.vehicle_api.UpdateVehicleAttributesResponse[source]¶

Partially updates a vehicle’s attributes. Only the attributes mentioned in the request will be updated, other attributes will NOT be altered. Note: this is different in UpdateVehicle, where the whole attributes field will be replaced by the one in UpdateVehicleRequest, attributes not in the request would be removed.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.maps import fleetengine_v1

def sample_update_vehicle_attributes():
    # Create a client
    client = fleetengine_v1.VehicleServiceClient()

    # Initialize request argument(s)
    attributes = fleetengine_v1.VehicleAttribute()
    attributes.string_value = "string_value_value"

    request = fleetengine_v1.UpdateVehicleAttributesRequest(
        name="name_value",
        attributes=attributes,
    )

    # Make the request
    response = client.update_vehicle_attributes(request=request)

    # Handle the response
    print(response)

Parameters

request (Union[google.maps.fleetengine_v1.types.UpdateVehicleAttributesRequest, dict]) – The request object. UpdateVehicleAttributes request message.
retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.
timeout (float) – The timeout for this request.
metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

Returns

UpdateVehicleAttributes response message.

Return type

google.maps.fleetengine_v1.types.UpdateVehicleAttributesResponse

static vehicle_path(provider: str, vehicle: str) → str[source]¶: Returns a fully-qualified vehicle string.

class google.maps.fleetengine_v1.services.vehicle_service.pagers.ListVehiclesAsyncPager(method: Callable[[...], Awaitable[google.maps.fleetengine_v1.types.vehicle_api.ListVehiclesResponse]], request: google.maps.fleetengine_v1.types.vehicle_api.ListVehiclesRequest, response: google.maps.fleetengine_v1.types.vehicle_api.ListVehiclesResponse, *, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ())[source]¶

A pager for iterating through list_vehicles requests.

This class thinly wraps an initial google.maps.fleetengine_v1.types.ListVehiclesResponse object, and provides an __aiter__ method to iterate through its vehicles field.

If there are more pages, the __aiter__ method will make additional ListVehicles requests and continue to iterate through the vehicles field on the corresponding responses.

All the usual google.maps.fleetengine_v1.types.ListVehiclesResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

Instantiates the pager.

Parameters

method (Callable) – The method that was originally called, and which instantiated this pager.
request (google.maps.fleetengine_v1.types.ListVehiclesRequest) – The initial request object.
response (google.maps.fleetengine_v1.types.ListVehiclesResponse) – The initial response object.
retry (google.api_core.retry.AsyncRetry) – Designation of what errors, if any, should be retried.
timeout (float) – The timeout for this request.
metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

class google.maps.fleetengine_v1.services.vehicle_service.pagers.ListVehiclesPager(method: Callable[[...], google.maps.fleetengine_v1.types.vehicle_api.ListVehiclesResponse], request: google.maps.fleetengine_v1.types.vehicle_api.ListVehiclesRequest, response: google.maps.fleetengine_v1.types.vehicle_api.ListVehiclesResponse, *, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ())[source]¶

A pager for iterating through list_vehicles requests.

This class thinly wraps an initial google.maps.fleetengine_v1.types.ListVehiclesResponse object, and provides an __iter__ method to iterate through its vehicles field.

If there are more pages, the __iter__ method will make additional ListVehicles requests and continue to iterate through the vehicles field on the corresponding responses.

All the usual google.maps.fleetengine_v1.types.ListVehiclesResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

Instantiate the pager.

Parameters

method (Callable) – The method that was originally called, and which instantiated this pager.
request (google.maps.fleetengine_v1.types.ListVehiclesRequest) – The initial request object.
response (google.maps.fleetengine_v1.types.ListVehiclesResponse) – The initial response object.
retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.
timeout (float) – The timeout for this request.
metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

VehicleService¶

google-maps-fleetengine

Navigation

Related Topics