BaseApiService
Stay organized with collections
Save and categorize content based on your preferences.
Base object encapsulating common functionality for interacting with Google APIs such as setting
credentials, request timeouts, error handling and retry etc.
Inherited Method Summary
From class
com.google.common.util.concurrent.AbstractIdleService
|
final
void
|
addListener(Service.Listener arg0, Executor arg1)
|
|
final
void
|
awaitRunning()
|
|
final
void
|
awaitRunning(long arg0, TimeUnit arg1)
|
|
final
void
|
awaitTerminated(long arg0, TimeUnit arg1)
|
|
final
void
|
awaitTerminated()
|
|
final
Throwable
|
failureCause()
|
|
final
boolean
|
isRunning()
|
|
final
Service
|
startAsync()
|
|
final
Service.State
|
state()
|
|
final
Service
|
stopAsync()
|
|
String
|
toString()
|
From class
java.lang.Object
|
boolean
|
equals(Object arg0)
|
|
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()
|
From interface
com.google.common.util.concurrent.Service
|
abstract
void
|
addListener(Service.Listener arg0, Executor arg1)
|
|
abstract
void
|
awaitRunning()
|
|
abstract
void
|
awaitRunning(long arg0, TimeUnit arg1)
|
|
abstract
void
|
awaitTerminated(long arg0, TimeUnit arg1)
|
|
abstract
void
|
awaitTerminated()
|
|
abstract
Throwable
|
failureCause()
|
|
abstract
boolean
|
isRunning()
|
|
abstract
Service
|
startAsync()
|
|
abstract
Service.State
|
state()
|
|
abstract
Service
|
stopAsync()
|
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-03-18 UTC.
[null,null,["Last updated 2025-03-18 UTC."],[],[],null,["# BaseApiService\n\npublic abstract class **BaseApiService** extends AbstractIdleService \n\n|---|---|---|\n| Known Direct Subclasses [ContentUploadServiceImpl](/workspace/cloud-search/docs/reference/sdk/com/google/enterprise/cloudsearch/sdk/indexing/ContentUploadServiceImpl), [GroupsServiceImpl](/workspace/cloud-search/docs/reference/sdk/com/google/enterprise/cloudsearch/sdk/identity/GroupsServiceImpl), [IndexingServiceImpl](/workspace/cloud-search/docs/reference/sdk/com/google/enterprise/cloudsearch/sdk/indexing/IndexingServiceImpl), [UsersServiceImpl](/workspace/cloud-search/docs/reference/sdk/com/google/enterprise/cloudsearch/sdk/identity/UsersServiceImpl) |------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | [ContentUploadServiceImpl](/workspace/cloud-search/docs/reference/sdk/com/google/enterprise/cloudsearch/sdk/indexing/ContentUploadServiceImpl) | Concrete class implementing [ContentUploadService](/workspace/cloud-search/docs/reference/sdk/com/google/enterprise/cloudsearch/sdk/indexing/ContentUploadService) Document content uploads normally occur \"in-line\" as part of the item's upload request. | | [GroupsServiceImpl](/workspace/cloud-search/docs/reference/sdk/com/google/enterprise/cloudsearch/sdk/identity/GroupsServiceImpl) | Wrapper for Cloud Identity Groups API for performing CRUD operations on Groups and Memberships. | | [IndexingServiceImpl](/workspace/cloud-search/docs/reference/sdk/com/google/enterprise/cloudsearch/sdk/indexing/IndexingServiceImpl) | Wrapper object for [CloudSearch.Indexing](https://developers.google.com/resources/api-libraries/documentation/cloudsearch/v1/java/latest/com/google/api/services/cloudsearch/v1/CloudSearch.Indexing.html). | | [UsersServiceImpl](/workspace/cloud-search/docs/reference/sdk/com/google/enterprise/cloudsearch/sdk/identity/UsersServiceImpl) | | |||\n\nBase object encapsulating common functionality for interacting with Google APIs such as setting\ncredentials, request timeouts, error handling and retry etc. \n\n### Nested Class Summary\n\n|-------|---|---|---------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| class | [BaseApiService.AbstractBuilder](/workspace/cloud-search/docs/reference/sdk/com/google/enterprise/cloudsearch/sdk/BaseApiService.AbstractBuilder)\\\u003cB extends [AbstractBuilder](/workspace/cloud-search/docs/reference/sdk/com/google/enterprise/cloudsearch/sdk/BaseApiService.AbstractBuilder)\\\u003cB, T extends AbstractGoogleJsonClient\\\u003e, T\\\u003e || Builder object for creating an instance of [BaseApiService](/workspace/cloud-search/docs/reference/sdk/com/google/enterprise/cloudsearch/sdk/BaseApiService). |\n| class | [BaseApiService.RetryRequestInitializer](/workspace/cloud-search/docs/reference/sdk/com/google/enterprise/cloudsearch/sdk/BaseApiService.RetryRequestInitializer) || Adds a backoff and retry response and exception handlers to the `HttpRequest`. |\n\n### Inherited Method Summary\n\nFrom class com.google.common.util.concurrent.AbstractIdleService \n\n|---------------------|---------------------------------------------------|\n| final void | addListener(Service.Listener arg0, Executor arg1) |\n| final void | awaitRunning() |\n| final void | awaitRunning(long arg0, TimeUnit arg1) |\n| final void | awaitTerminated(long arg0, TimeUnit arg1) |\n| final void | awaitTerminated() |\n| final Throwable | failureCause() |\n| final boolean | isRunning() |\n| final Service | startAsync() |\n| final Service.State | state() |\n| final Service | stopAsync() |\n| String | toString() |\n\nFrom class java.lang.Object \n\n|------------------|---------------------------|\n| boolean | equals(Object arg0) |\n| final Class\\\u003c?\\\u003e | getClass() |\n| int | hashCode() |\n| final void | notify() |\n| final void | notifyAll() |\n| String | toString() |\n| final void | wait(long arg0, int arg1) |\n| final void | wait(long arg0) |\n| final void | wait() |\n\nFrom interface com.google.common.util.concurrent.Service \n\n|------------------------|---------------------------------------------------|\n| abstract void | addListener(Service.Listener arg0, Executor arg1) |\n| abstract void | awaitRunning() |\n| abstract void | awaitRunning(long arg0, TimeUnit arg1) |\n| abstract void | awaitTerminated(long arg0, TimeUnit arg1) |\n| abstract void | awaitTerminated() |\n| abstract Throwable | failureCause() |\n| abstract boolean | isRunning() |\n| abstract Service | startAsync() |\n| abstract Service.State | state() |\n| abstract Service | stopAsync() |"]]
