ConsumerApiOptions
Stay organized with collections
Save and categorize content based on your preferences.
Options class that contains configuration information used when initializing the Consumer
API.
Public Constructor Summary
Inherited Method Summary
From class java.lang.Object
|
Object
|
clone()
|
| boolean |
|
| void |
finalize()
|
|
final Class<?>
|
getClass()
|
| int |
hashCode()
|
| final void |
notify()
|
| final void |
notifyAll()
|
|
String
|
toString()
|
| final void |
wait(long arg0, int arg1)
|
| final void |
wait(long arg0)
|
| final void |
wait()
|
Public Constructors
public ConsumerApiOptions ()
Public Methods
public abstract String getFleetEngineAddress ()
The server address for the Fleet Engine instance.
public abstract String getProviderId ()
The identification string associated with a given provider.
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-08-27 UTC.
[null,null,["Last updated 2025-08-27 UTC."],[[["\u003cp\u003e\u003ccode\u003eConsumerApiOptions\u003c/code\u003e is an abstract class used for configuring the Consumer API.\u003c/p\u003e\n"],["\u003cp\u003eIt includes details like the Fleet Engine server address and the provider ID.\u003c/p\u003e\n"],["\u003cp\u003eA builder class (\u003ccode\u003eConsumerApiOptions.Builder\u003c/code\u003e) helps to create instances of \u003ccode\u003eConsumerApiOptions\u003c/code\u003e.\u003c/p\u003e\n"],["\u003cp\u003eYou can access methods to get the Fleet Engine address and Provider Id, and create a builder instance for customization.\u003c/p\u003e\n"]]],[],null,["# ConsumerApiOptions\n\npublic abstract class **ConsumerApiOptions** extends [Object](//developer.android.com/reference/java/lang/Object.html) \nOptions class that contains configuration information used when initializing the Consumer\nAPI. \n\n### Nested Class Summary\n\n|-------|---|---|---------------------------------|\n| class | [ConsumerApiOptions.Builder](/maps/documentation/mobility/journey-sharing/on-demand/reference/consumer_2/android/reference/com/google/android/libraries/mapsplatform/transportation/consumer/ConsumerApiOptions.Builder) || Builder for ConsumerApiOptions. |\n\n### Public Constructor Summary\n\n|---|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| | [ConsumerApiOptions](/maps/documentation/mobility/journey-sharing/on-demand/reference/consumer_2/android/reference/com/google/android/libraries/mapsplatform/transportation/consumer/ConsumerApiOptions#ConsumerApiOptions())() |\n\n### Public Method Summary\n\n|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| static [ConsumerApiOptions.Builder](/maps/documentation/mobility/journey-sharing/on-demand/reference/consumer_2/android/reference/com/google/android/libraries/mapsplatform/transportation/consumer/ConsumerApiOptions.Builder) | [builder](/maps/documentation/mobility/journey-sharing/on-demand/reference/consumer_2/android/reference/com/google/android/libraries/mapsplatform/transportation/consumer/ConsumerApiOptions#builder())() |\n| abstract [String](//developer.android.com/reference/java/lang/String.html) | [getFleetEngineAddress](/maps/documentation/mobility/journey-sharing/on-demand/reference/consumer_2/android/reference/com/google/android/libraries/mapsplatform/transportation/consumer/ConsumerApiOptions#getFleetEngineAddress())() The server address for the Fleet Engine instance. |\n| abstract [String](//developer.android.com/reference/java/lang/String.html) | [getProviderId](/maps/documentation/mobility/journey-sharing/on-demand/reference/consumer_2/android/reference/com/google/android/libraries/mapsplatform/transportation/consumer/ConsumerApiOptions#getProviderId())() The identification string associated with a given provider. |\n| abstract [ConsumerApiOptions.Builder](/maps/documentation/mobility/journey-sharing/on-demand/reference/consumer_2/android/reference/com/google/android/libraries/mapsplatform/transportation/consumer/ConsumerApiOptions.Builder) | [toBuilder](/maps/documentation/mobility/journey-sharing/on-demand/reference/consumer_2/android/reference/com/google/android/libraries/mapsplatform/transportation/consumer/ConsumerApiOptions#toBuilder())() |\n\n### Inherited Method Summary\n\nFrom class java.lang.Object \n\n|----------------------------------------------------------------------------|--------------------------------------------------------------------------------|\n| [Object](//developer.android.com/reference/java/lang/Object.html) | clone() |\n| boolean | equals([Object](//developer.android.com/reference/java/lang/Object.html) arg0) |\n| void | finalize() |\n| final [Class](//developer.android.com/reference/java/lang/Class.html)\\\u003c?\\\u003e | getClass() |\n| int | hashCode() |\n| final void | notify() |\n| final void | notifyAll() |\n| [String](//developer.android.com/reference/java/lang/String.html) | toString() |\n| final void | wait(long arg0, int arg1) |\n| final void | wait(long arg0) |\n| final void | wait() |\n\nPublic Constructors\n-------------------\n\n#### public **ConsumerApiOptions** ()\n\nPublic Methods\n--------------\n\n#### public static [ConsumerApiOptions.Builder](/maps/documentation/mobility/journey-sharing/on-demand/reference/consumer_2/android/reference/com/google/android/libraries/mapsplatform/transportation/consumer/ConsumerApiOptions.Builder) **builder**\n()\n\n#### public abstract [String](//developer.android.com/reference/java/lang/String.html) **getFleetEngineAddress** ()\n\nThe server address for the Fleet Engine instance. \n\n#### public abstract [String](//developer.android.com/reference/java/lang/String.html) **getProviderId** ()\n\nThe identification string associated with a given provider. \n\n#### public abstract [ConsumerApiOptions.Builder](/maps/documentation/mobility/journey-sharing/on-demand/reference/consumer_2/android/reference/com/google/android/libraries/mapsplatform/transportation/consumer/ConsumerApiOptions.Builder) **toBuilder** ()"]]
