
target.apidocs.com.google.api.services.firebase.v1beta1.FirebaseManagement.Projects.SearchApps.html Maven / Gradle / Ivy
FirebaseManagement.Projects.SearchApps (Firebase Management API v1beta1-rev20230202-2.0.0)
com.google.api.services.firebase.v1beta1
Class FirebaseManagement.Projects.SearchApps
- java.lang.Object
-
- java.util.AbstractMap<String,Object>
-
- com.google.api.client.util.GenericData
-
- com.google.api.client.googleapis.services.AbstractGoogleClientRequest<T>
-
- com.google.api.client.googleapis.services.json.AbstractGoogleJsonClientRequest<T>
-
- com.google.api.services.firebase.v1beta1.FirebaseManagementRequest<SearchFirebaseAppsResponse>
-
- com.google.api.services.firebase.v1beta1.FirebaseManagement.Projects.SearchApps
-
- Enclosing class:
- FirebaseManagement.Projects
public class FirebaseManagement.Projects.SearchApps
extends FirebaseManagementRequest<SearchFirebaseAppsResponse>
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from class com.google.api.client.util.GenericData
com.google.api.client.util.GenericData.Flags
-
Nested classes/interfaces inherited from class java.util.AbstractMap
AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>
-
Constructor Summary
Constructors
Modifier
Constructor and Description
protected
SearchApps(String parent)
Lists all available Apps for the specified FirebaseProject.
-
Method Summary
All Methods Instance Methods Concrete Methods
Modifier and Type
Method and Description
com.google.api.client.http.HttpRequest
buildHttpRequestUsingHead()
com.google.api.client.http.HttpResponse
executeUsingHead()
String
getFilter()
A query string compatible with Google's [AIP-160 standard](https://google.aip.dev/160).
Integer
getPageSize()
The maximum number of Apps to return in the response.
String
getPageToken()
Token returned from a previous call to `SearchFirebaseApps` indicating where in the set of Apps to
resume listing.
String
getParent()
The parent FirebaseProject for which to list Apps, in the format: projects/ PROJECT_IDENTIFIER
Refer to the `FirebaseProject` [`name`](../projects#FirebaseProject.FIELDS.name) field for details
about PROJECT_IDENTIFIER values.
Boolean
getShowDeleted()
Controls whether Apps in the DELETED state should be returned.
FirebaseManagement.Projects.SearchApps
set(String parameterName,
Object value)
FirebaseManagement.Projects.SearchApps
set$Xgafv(String $Xgafv)
V1 error format.
FirebaseManagement.Projects.SearchApps
setAccessToken(String accessToken)
OAuth access token.
FirebaseManagement.Projects.SearchApps
setAlt(String alt)
Data format for response.
FirebaseManagement.Projects.SearchApps
setCallback(String callback)
JSONP
FirebaseManagement.Projects.SearchApps
setFields(String fields)
Selector specifying which fields to include in a partial response.
FirebaseManagement.Projects.SearchApps
setFilter(String filter)
A query string compatible with Google's [AIP-160 standard](https://google.aip.dev/160).
FirebaseManagement.Projects.SearchApps
setKey(String key)
API key.
FirebaseManagement.Projects.SearchApps
setOauthToken(String oauthToken)
OAuth 2.0 token for the current user.
FirebaseManagement.Projects.SearchApps
setPageSize(Integer pageSize)
The maximum number of Apps to return in the response.
FirebaseManagement.Projects.SearchApps
setPageToken(String pageToken)
Token returned from a previous call to `SearchFirebaseApps` indicating where in the set of
Apps to resume listing.
FirebaseManagement.Projects.SearchApps
setParent(String parent)
The parent FirebaseProject for which to list Apps, in the format: projects/
PROJECT_IDENTIFIER Refer to the `FirebaseProject`
[`name`](../projects#FirebaseProject.FIELDS.name) field for details about
PROJECT_IDENTIFIER values.
FirebaseManagement.Projects.SearchApps
setPrettyPrint(Boolean prettyPrint)
Returns response with indentations and line breaks.
FirebaseManagement.Projects.SearchApps
setQuotaUser(String quotaUser)
Available to use for quota purposes for server-side applications.
FirebaseManagement.Projects.SearchApps
setShowDeleted(Boolean showDeleted)
Controls whether Apps in the DELETED state should be returned.
FirebaseManagement.Projects.SearchApps
setUploadProtocol(String uploadProtocol)
Upload protocol for media (e.g.
FirebaseManagement.Projects.SearchApps
setUploadType(String uploadType)
Legacy upload protocol for media (e.g.
-
Methods inherited from class com.google.api.services.firebase.v1beta1.FirebaseManagementRequest
get$Xgafv, getAbstractGoogleClient, getAccessToken, getAlt, getCallback, getFields, getKey, getOauthToken, getPrettyPrint, getQuotaUser, getUploadProtocol, getUploadType, setDisableGZipContent, setRequestHeaders
-
Methods inherited from class com.google.api.client.googleapis.services.json.AbstractGoogleJsonClientRequest
getJsonContent, newExceptionOnError, queue
-
Methods inherited from class com.google.api.client.googleapis.services.AbstractGoogleClientRequest
buildHttpRequest, buildHttpRequestUrl, checkRequiredParameter, execute, executeAndDownloadTo, executeAsInputStream, executeMedia, executeMediaAndDownloadTo, executeMediaAsInputStream, executeUnparsed, getDisableGZipContent, getHttpContent, getLastResponseHeaders, getLastStatusCode, getLastStatusMessage, getMediaHttpDownloader, getMediaHttpUploader, getRequestHeaders, getRequestMethod, getResponseClass, getReturnRawInputSteam, getUriTemplate, initializeMediaDownload, initializeMediaUpload, queue, setReturnRawInputStream
-
Methods inherited from class com.google.api.client.util.GenericData
clone, entrySet, equals, get, getClassInfo, getUnknownKeys, hashCode, put, putAll, remove, setUnknownKeys, toString
-
Methods inherited from class java.util.AbstractMap
clear, containsKey, containsValue, isEmpty, keySet, size, values
-
Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface java.util.Map
compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll
-
-
Constructor Detail
-
SearchApps
protected SearchApps(String parent)
Lists all available Apps for the specified FirebaseProject. This is a convenience method.
Typically, interaction with an App should be done using the platform-specific service, but some
tool use-cases require a summary of all known Apps (such as for App selector interfaces).
Create a request for the method "projects.searchApps".
This request holds the parameters needed by the the firebase server. After setting any
optional parameters, call the AbstractGoogleClientRequest.execute()
method to invoke the remote
operation. FirebaseManagement.initialize(com.google.api.client.googleapis.services.AbstractGoogleClientRequest)
must be called to initialize this instance immediately after invoking the constructor.
- Parameters:
parent
- The parent FirebaseProject for which to list Apps, in the format: projects/ PROJECT_IDENTIFIER Refer
to the `FirebaseProject` [`name`](../projects#FirebaseProject.FIELDS.name) field for
details about PROJECT_IDENTIFIER values.
- Since:
- 1.13
-
Method Detail
-
executeUsingHead
public com.google.api.client.http.HttpResponse executeUsingHead()
throws IOException
- Overrides:
executeUsingHead
in class com.google.api.client.googleapis.services.AbstractGoogleClientRequest<SearchFirebaseAppsResponse>
- Throws:
IOException
-
buildHttpRequestUsingHead
public com.google.api.client.http.HttpRequest buildHttpRequestUsingHead()
throws IOException
- Overrides:
buildHttpRequestUsingHead
in class com.google.api.client.googleapis.services.AbstractGoogleClientRequest<SearchFirebaseAppsResponse>
- Throws:
IOException
-
set$Xgafv
public FirebaseManagement.Projects.SearchApps set$Xgafv(String $Xgafv)
Description copied from class: FirebaseManagementRequest
V1 error format.
- Overrides:
set$Xgafv
in class FirebaseManagementRequest<SearchFirebaseAppsResponse>
-
setAccessToken
public FirebaseManagement.Projects.SearchApps setAccessToken(String accessToken)
Description copied from class: FirebaseManagementRequest
OAuth access token.
- Overrides:
setAccessToken
in class FirebaseManagementRequest<SearchFirebaseAppsResponse>
-
setAlt
public FirebaseManagement.Projects.SearchApps setAlt(String alt)
Description copied from class: FirebaseManagementRequest
Data format for response.
- Overrides:
setAlt
in class FirebaseManagementRequest<SearchFirebaseAppsResponse>
-
setCallback
public FirebaseManagement.Projects.SearchApps setCallback(String callback)
Description copied from class: FirebaseManagementRequest
JSONP
- Overrides:
setCallback
in class FirebaseManagementRequest<SearchFirebaseAppsResponse>
-
setFields
public FirebaseManagement.Projects.SearchApps setFields(String fields)
Description copied from class: FirebaseManagementRequest
Selector specifying which fields to include in a partial response.
- Overrides:
setFields
in class FirebaseManagementRequest<SearchFirebaseAppsResponse>
-
setKey
public FirebaseManagement.Projects.SearchApps setKey(String key)
Description copied from class: FirebaseManagementRequest
API key. Your API key identifies your project and provides you with API access, quota, and
reports. Required unless you provide an OAuth 2.0 token.
- Overrides:
setKey
in class FirebaseManagementRequest<SearchFirebaseAppsResponse>
-
setOauthToken
public FirebaseManagement.Projects.SearchApps setOauthToken(String oauthToken)
Description copied from class: FirebaseManagementRequest
OAuth 2.0 token for the current user.
- Overrides:
setOauthToken
in class FirebaseManagementRequest<SearchFirebaseAppsResponse>
-
setPrettyPrint
public FirebaseManagement.Projects.SearchApps setPrettyPrint(Boolean prettyPrint)
Description copied from class: FirebaseManagementRequest
Returns response with indentations and line breaks.
- Overrides:
setPrettyPrint
in class FirebaseManagementRequest<SearchFirebaseAppsResponse>
-
setQuotaUser
public FirebaseManagement.Projects.SearchApps setQuotaUser(String quotaUser)
Description copied from class: FirebaseManagementRequest
Available to use for quota purposes for server-side applications. Can be any arbitrary string
assigned to a user, but should not exceed 40 characters.
- Overrides:
setQuotaUser
in class FirebaseManagementRequest<SearchFirebaseAppsResponse>
-
setUploadType
public FirebaseManagement.Projects.SearchApps setUploadType(String uploadType)
Description copied from class: FirebaseManagementRequest
Legacy upload protocol for media (e.g. "media", "multipart").
- Overrides:
setUploadType
in class FirebaseManagementRequest<SearchFirebaseAppsResponse>
-
setUploadProtocol
public FirebaseManagement.Projects.SearchApps setUploadProtocol(String uploadProtocol)
Description copied from class: FirebaseManagementRequest
Upload protocol for media (e.g. "raw", "multipart").
- Overrides:
setUploadProtocol
in class FirebaseManagementRequest<SearchFirebaseAppsResponse>
-
getParent
public String getParent()
The parent FirebaseProject for which to list Apps, in the format: projects/ PROJECT_IDENTIFIER
Refer to the `FirebaseProject` [`name`](../projects#FirebaseProject.FIELDS.name) field for details
about PROJECT_IDENTIFIER values.
-
setParent
public FirebaseManagement.Projects.SearchApps setParent(String parent)
The parent FirebaseProject for which to list Apps, in the format: projects/
PROJECT_IDENTIFIER Refer to the `FirebaseProject`
[`name`](../projects#FirebaseProject.FIELDS.name) field for details about
PROJECT_IDENTIFIER values.
-
getFilter
public String getFilter()
A query string compatible with Google's [AIP-160 standard](https://google.aip.dev/160). Use any of
the following fields in a query: * [`app_id`](../projects/searchApps#FirebaseAppInfo.FIELDS.app_id)
[`namespace`](../projects/searchApps#FirebaseAppInfo.FIELDS.namespace) *
[`platform`](../projects/searchApps#FirebaseAppInfo.FIELDS.platform) This query also supports the
following "virtual" fields. These are fields which are not actually part of the returned resource
object, but they can be queried as if they are pre-populated with specific values. * `sha1_hash` or
`sha1_hashes`: This field is considered to be a _repeated_ `string` field, populated with the list
of all SHA-1 certificate fingerprints registered with the AndroidApp. This list is empty if the App
is not an `AndroidApp`. * `sha256_hash` or `sha256_hashes`: This field is considered to be a
_repeated_ `string` field, populated with the list of all SHA-256 certificate fingerprints
registered with the AndroidApp. This list is empty if the App is not an `AndroidApp`. *
`app_store_id`: This field is considered to be a _singular_ `string` field, populated with the
Apple App Store ID registered with the IosApp. This field is empty if the App is not an `IosApp`. *
`team_id`: This field is considered to be a _singular_ `string` field, populated with the Apple
team ID registered with the IosApp. This field is empty if the App is not an `IosApp`.
-
setFilter
public FirebaseManagement.Projects.SearchApps setFilter(String filter)
A query string compatible with Google's [AIP-160 standard](https://google.aip.dev/160). Use
any of the following fields in a query: *
[`app_id`](../projects/searchApps#FirebaseAppInfo.FIELDS.app_id) *
[`namespace`](../projects/searchApps#FirebaseAppInfo.FIELDS.namespace) *
[`platform`](../projects/searchApps#FirebaseAppInfo.FIELDS.platform) This query also
supports the following "virtual" fields. These are fields which are not actually part of
the returned resource object, but they can be queried as if they are pre-populated with
specific values. * `sha1_hash` or `sha1_hashes`: This field is considered to be a
_repeated_ `string` field, populated with the list of all SHA-1 certificate fingerprints
registered with the AndroidApp. This list is empty if the App is not an `AndroidApp`. *
`sha256_hash` or `sha256_hashes`: This field is considered to be a _repeated_ `string`
field, populated with the list of all SHA-256 certificate fingerprints registered with the
AndroidApp. This list is empty if the App is not an `AndroidApp`. * `app_store_id`: This
field is considered to be a _singular_ `string` field, populated with the Apple App Store
ID registered with the IosApp. This field is empty if the App is not an `IosApp`. *
`team_id`: This field is considered to be a _singular_ `string` field, populated with the
Apple team ID registered with the IosApp. This field is empty if the App is not an
`IosApp`.
-
getPageSize
public Integer getPageSize()
The maximum number of Apps to return in the response. The server may return fewer than this value
at its discretion. If no value is specified (or too large a value is specified), then the server
will impose its own limit. This value cannot be negative.
-
setPageSize
public FirebaseManagement.Projects.SearchApps setPageSize(Integer pageSize)
The maximum number of Apps to return in the response. The server may return fewer than this
value at its discretion. If no value is specified (or too large a value is specified), then
the server will impose its own limit. This value cannot be negative.
-
getPageToken
public String getPageToken()
Token returned from a previous call to `SearchFirebaseApps` indicating where in the set of Apps to
resume listing.
-
setPageToken
public FirebaseManagement.Projects.SearchApps setPageToken(String pageToken)
Token returned from a previous call to `SearchFirebaseApps` indicating where in the set of
Apps to resume listing.
-
getShowDeleted
public Boolean getShowDeleted()
Controls whether Apps in the DELETED state should be returned. If not specified, only `ACTIVE` Apps
will be returned.
-
setShowDeleted
public FirebaseManagement.Projects.SearchApps setShowDeleted(Boolean showDeleted)
Controls whether Apps in the DELETED state should be returned. If not specified, only
`ACTIVE` Apps will be returned.
-
set
public FirebaseManagement.Projects.SearchApps set(String parameterName,
Object value)
- Overrides:
set
in class FirebaseManagementRequest<SearchFirebaseAppsResponse>
Copyright © 2011–2023 Google. All rights reserved.
© 2015 - 2025 Weber Informatics LLC | Privacy Policy