Apigee.Organizations.Apps.List (Apigee API v1-rev20251125-2.0.0)

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.apigee.v1.ApigeeRequest<GoogleCloudApigeeV1ListAppsResponse>
        
        com.google.api.services.apigee.v1.Apigee.Organizations.Apps.List

All Implemented Interfaces:: Cloneable, Map<String,Object>

Enclosing class:: Apigee.Organizations.Apps

public class Apigee.Organizations.Apps.List
extends ApigeeRequest<GoogleCloudApigeeV1ListAppsResponse>

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>
- Nested classes/interfaces inherited from interface java.util.Map
  Map.Entry<K,V>

Field Summary
- Fields inherited from class com.google.api.client.googleapis.services.AbstractGoogleClientRequest
  API_VERSION_HEADER, USER_AGENT_SUFFIX

Constructor Summary

Constructors
Modifier	Constructor and Description
`protected`	`List(String parent)` Lists IDs of apps within an organization that have the specified app status (approved or revoked) or are of the specified app type (developer or company).

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`	`getApiProduct()` API product.
`String`	`getApptype()` Optional.
`Boolean`	`getExpand()` Optional.
`String`	`getFilter()` Optional.
`String`	`getIds()` Optional.
`Boolean`	`getIncludeCred()` Optional.
`String`	`getKeyStatus()` Optional.
`Integer`	`getPageSize()` Optional.
`String`	`getPageToken()` Optional.
`String`	`getParent()` Required.
`Long`	`getRows()` Optional.
`String`	`getStartKey()` Returns the list of apps starting from the specified app ID.
`String`	`getStatus()` Optional.
`Apigee.Organizations.Apps.List`	`set(String parameterName, Object value)`
`Apigee.Organizations.Apps.List`	`set$Xgafv(String $Xgafv)` V1 error format.
`Apigee.Organizations.Apps.List`	`setAccessToken(String accessToken)` OAuth access token.
`Apigee.Organizations.Apps.List`	`setAlt(String alt)` Data format for response.
`Apigee.Organizations.Apps.List`	`setApiProduct(String apiProduct)` API product.
`Apigee.Organizations.Apps.List`	`setApptype(String apptype)` Optional.
`Apigee.Organizations.Apps.List`	`setCallback(String callback)` JSONP
`Apigee.Organizations.Apps.List`	`setExpand(Boolean expand)` Optional.
`Apigee.Organizations.Apps.List`	`setFields(String fields)` Selector specifying which fields to include in a partial response.
`Apigee.Organizations.Apps.List`	`setFilter(String filter)` Optional.
`Apigee.Organizations.Apps.List`	`setIds(String ids)` Optional.
`Apigee.Organizations.Apps.List`	`setIncludeCred(Boolean includeCred)` Optional.
`Apigee.Organizations.Apps.List`	`setKey(String key)` API key.
`Apigee.Organizations.Apps.List`	`setKeyStatus(String keyStatus)` Optional.
`Apigee.Organizations.Apps.List`	`setOauthToken(String oauthToken)` OAuth 2.0 token for the current user.
`Apigee.Organizations.Apps.List`	`setPageSize(Integer pageSize)` Optional.
`Apigee.Organizations.Apps.List`	`setPageToken(String pageToken)` Optional.
`Apigee.Organizations.Apps.List`	`setParent(String parent)` Required.
`Apigee.Organizations.Apps.List`	`setPrettyPrint(Boolean prettyPrint)` Returns response with indentations and line breaks.
`Apigee.Organizations.Apps.List`	`setQuotaUser(String quotaUser)` Available to use for quota purposes for server-side applications.
`Apigee.Organizations.Apps.List`	`setRows(Long rows)` Optional.
`Apigee.Organizations.Apps.List`	`setStartKey(String startKey)` Returns the list of apps starting from the specified app ID.
`Apigee.Organizations.Apps.List`	`setStatus(String status)` Optional.
`Apigee.Organizations.Apps.List`	`setUploadProtocol(String uploadProtocol)` Upload protocol for media (e.g.
`Apigee.Organizations.Apps.List`	`setUploadType(String uploadType)` Legacy upload protocol for media (e.g.

Methods inherited from class com.google.api.services.apigee.v1.ApigeeRequest
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
  - List
```
protected List(String parent)
```
    Lists IDs of apps within an organization that have the specified app status (approved or revoked) or are of the specified app type (developer or company). Create a request for the method "apps.list". This request holds the parameters needed by the the apigee server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.
    Apigee.initialize(com.google.api.client.googleapis.services.AbstractGoogleClientRequest) must be called to initialize this instance immediately after invoking the constructor.
    
    Parameters:
    
    parent - Required. Resource path of the parent in the following format: `organizations/{org}`
    
    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<GoogleCloudApigeeV1ListAppsResponse>
    
    Throws:
    
    IOException
  - buildHttpRequestUsingHead
```
public com.google.api.client.http.HttpRequest buildHttpRequestUsingHead()
                                                                 throws IOException
```
    Overrides:
    
    buildHttpRequestUsingHead in class com.google.api.client.googleapis.services.AbstractGoogleClientRequest<GoogleCloudApigeeV1ListAppsResponse>
    
    Throws:
    
    IOException
  - set$Xgafv
```
public Apigee.Organizations.Apps.List set$Xgafv(String $Xgafv)
```
    Description copied from class: ApigeeRequest
    
    V1 error format.
    
    Overrides:
    
    set$Xgafv in class ApigeeRequest<GoogleCloudApigeeV1ListAppsResponse>
  - setAccessToken
```
public Apigee.Organizations.Apps.List setAccessToken(String accessToken)
```
    Description copied from class: ApigeeRequest
    
    OAuth access token.
    
    Overrides:
    
    setAccessToken in class ApigeeRequest<GoogleCloudApigeeV1ListAppsResponse>
  - setAlt
```
public Apigee.Organizations.Apps.List setAlt(String alt)
```
    Description copied from class: ApigeeRequest
    
    Data format for response.
    
    Overrides:
    
    setAlt in class ApigeeRequest<GoogleCloudApigeeV1ListAppsResponse>
  - setCallback
```
public Apigee.Organizations.Apps.List setCallback(String callback)
```
    Description copied from class: ApigeeRequest
    
    JSONP
    
    Overrides:
    
    setCallback in class ApigeeRequest<GoogleCloudApigeeV1ListAppsResponse>
  - setFields
```
public Apigee.Organizations.Apps.List setFields(String fields)
```
    Description copied from class: ApigeeRequest
    
    Selector specifying which fields to include in a partial response.
    
    Overrides:
    
    setFields in class ApigeeRequest<GoogleCloudApigeeV1ListAppsResponse>
  - setKey
```
public Apigee.Organizations.Apps.List setKey(String key)
```
    Description copied from class: ApigeeRequest
    
    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 ApigeeRequest<GoogleCloudApigeeV1ListAppsResponse>
  - setOauthToken
```
public Apigee.Organizations.Apps.List setOauthToken(String oauthToken)
```
    Description copied from class: ApigeeRequest
    
    OAuth 2.0 token for the current user.
    
    Overrides:
    
    setOauthToken in class ApigeeRequest<GoogleCloudApigeeV1ListAppsResponse>
  - setPrettyPrint
```
public Apigee.Organizations.Apps.List setPrettyPrint(Boolean prettyPrint)
```
    Description copied from class: ApigeeRequest
    
    Returns response with indentations and line breaks.
    
    Overrides:
    
    setPrettyPrint in class ApigeeRequest<GoogleCloudApigeeV1ListAppsResponse>
  - setQuotaUser
```
public Apigee.Organizations.Apps.List setQuotaUser(String quotaUser)
```
    Description copied from class: ApigeeRequest
    
    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 ApigeeRequest<GoogleCloudApigeeV1ListAppsResponse>
  - setUploadType
```
public Apigee.Organizations.Apps.List setUploadType(String uploadType)
```
    Description copied from class: ApigeeRequest
    
    Legacy upload protocol for media (e.g. "media", "multipart").
    
    Overrides:
    
    setUploadType in class ApigeeRequest<GoogleCloudApigeeV1ListAppsResponse>
  - setUploadProtocol
```
public Apigee.Organizations.Apps.List setUploadProtocol(String uploadProtocol)
```
    Description copied from class: ApigeeRequest
    
    Upload protocol for media (e.g. "raw", "multipart").
    
    Overrides:
    
    setUploadProtocol in class ApigeeRequest<GoogleCloudApigeeV1ListAppsResponse>
  - getParent
```
public String getParent()
```
    Required. Resource path of the parent in the following format: `organizations/{org}`
  - setParent
```
public Apigee.Organizations.Apps.List setParent(String parent)
```
    Required. Resource path of the parent in the following format: `organizations/{org}`
  - getApiProduct
```
public String getApiProduct()
```
    API product.
  - setApiProduct
```
public Apigee.Organizations.Apps.List setApiProduct(String apiProduct)
```
    API product.
  - getApptype
```
public String getApptype()
```
    Optional. 'apptype' is no longer available. Use a 'filter' instead.
  - setApptype
```
public Apigee.Organizations.Apps.List setApptype(String apptype)
```
    Optional. 'apptype' is no longer available. Use a 'filter' instead.
  - getExpand
```
public Boolean getExpand()
```
    Optional. Flag that specifies whether to return an expanded list of apps for the organization. Defaults to `false`.
  - setExpand
```
public Apigee.Organizations.Apps.List setExpand(Boolean expand)
```
    Optional. Flag that specifies whether to return an expanded list of apps for the organization. Defaults to `false`.
  - getFilter
```
public String getFilter()
```
    Optional. The filter expression to be used to get the list of apps, where filtering can be done on developerEmail, apiProduct, consumerKey, status, appId, appName, appType and appGroup. Examples: "developerEmail=foo@bar.com", "appType=AppGroup", or "appType=Developer" "filter" is supported from ver 1.10.0 and above.
  - setFilter
```
public Apigee.Organizations.Apps.List setFilter(String filter)
```
    Optional. The filter expression to be used to get the list of apps, where filtering can be done on developerEmail, apiProduct, consumerKey, status, appId, appName, appType and appGroup. Examples: "developerEmail=foo@bar.com", "appType=AppGroup", or "appType=Developer" "filter" is supported from ver 1.10.0 and above.
  - getIds
```
public String getIds()
```
    Optional. Comma-separated list of app IDs on which to filter.
  - setIds
```
public Apigee.Organizations.Apps.List setIds(String ids)
```
    Optional. Comma-separated list of app IDs on which to filter.
  - getIncludeCred
```
public Boolean getIncludeCred()
```
    Optional. Flag that specifies whether to include credentials in the response.
  - setIncludeCred
```
public Apigee.Organizations.Apps.List setIncludeCred(Boolean includeCred)
```
    Optional. Flag that specifies whether to include credentials in the response.
  - getKeyStatus
```
public String getKeyStatus()
```
    Optional. Key status of the app. Valid values include `approved` or `revoked`. Defaults to `approved`.
  - setKeyStatus
```
public Apigee.Organizations.Apps.List setKeyStatus(String keyStatus)
```
    Optional. Key status of the app. Valid values include `approved` or `revoked`. Defaults to `approved`.
  - getPageSize
```
public Integer getPageSize()
```
    Optional. Count of apps a single page can have in the response. If unspecified, at most 1000 apps will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. "page_size" is supported from ver 1.10.0 and above.
  - setPageSize
```
public Apigee.Organizations.Apps.List setPageSize(Integer pageSize)
```
    Optional. Count of apps a single page can have in the response. If unspecified, at most 1000 apps will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. "page_size" is supported from ver 1.10.0 and above.
  - getPageToken
```
public String getPageToken()
```
    Optional. The starting index record for listing the developers. "page_token" is supported from ver 1.10.0 and above.
  - setPageToken
```
public Apigee.Organizations.Apps.List setPageToken(String pageToken)
```
    Optional. The starting index record for listing the developers. "page_token" is supported from ver 1.10.0 and above.
  - getRows
```
public Long getRows()
```
    Optional. Maximum number of app IDs to return. Defaults to 1000, which is also the upper limit. To get more than 1000, use pagination with 'pageSize' and 'pageToken' parameters.
  - setRows
```
public Apigee.Organizations.Apps.List setRows(Long rows)
```
    Optional. Maximum number of app IDs to return. Defaults to 1000, which is also the upper limit. To get more than 1000, use pagination with 'pageSize' and 'pageToken' parameters.
  - getStartKey
```
public String getStartKey()
```
    Returns the list of apps starting from the specified app ID.
  - setStartKey
```
public Apigee.Organizations.Apps.List setStartKey(String startKey)
```
    Returns the list of apps starting from the specified app ID.
  - getStatus
```
public String getStatus()
```
    Optional. Filter by the status of the app. Valid values are `approved` or `revoked`. Defaults to `approved`.
  - setStatus
```
public Apigee.Organizations.Apps.List setStatus(String status)
```
    Optional. Filter by the status of the app. Valid values are `approved` or `revoked`. Defaults to `approved`.
  - set
```
public Apigee.Organizations.Apps.List set(String parameterName,
                                          Object value)
```
    Overrides:
    
    set in class ApigeeRequest<GoogleCloudApigeeV1ListAppsResponse>

Class Apigee.Organizations.Apps.List

Nested Class Summary

Nested classes/interfaces inherited from class com.google.api.client.util.GenericData

Nested classes/interfaces inherited from class java.util.AbstractMap

Nested classes/interfaces inherited from interface java.util.Map

Field Summary

Fields inherited from class com.google.api.client.googleapis.services.AbstractGoogleClientRequest

Constructor Summary

Method Summary

Methods inherited from class com.google.api.services.apigee.v1.ApigeeRequest

Methods inherited from class com.google.api.client.googleapis.services.json.AbstractGoogleJsonClientRequest

Methods inherited from class com.google.api.client.googleapis.services.AbstractGoogleClientRequest

Methods inherited from class com.google.api.client.util.GenericData

Methods inherited from class java.util.AbstractMap

Methods inherited from class java.lang.Object

Methods inherited from interface java.util.Map

Constructor Detail

List

Method Detail

executeUsingHead

buildHttpRequestUsingHead

set$Xgafv

setAccessToken

setAlt

setCallback

setFields

setKey

setOauthToken

setPrettyPrint

setQuotaUser

setUploadType

setUploadProtocol

getParent

setParent

getApiProduct

setApiProduct

getApptype

setApptype

getExpand

setExpand

getFilter

setFilter

getIds

setIds

getIncludeCred

setIncludeCred

getKeyStatus

setKeyStatus

getPageSize

setPageSize

getPageToken

setPageToken

getRows

setRows

getStartKey

setStartKey

getStatus

setStatus

set