com.google.api.services.apigee.v1

Class Apigee.Organizations.Apis.List

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<GoogleCloudApigeeV1ListApiProxiesResponse>

com.google.api.services.apigee.v1.Apigee.Organizations.Apis.List

All Implemented Interfaces:

Cloneable, Map<String,Object>

Enclosing class:

Apigee.Organizations.Apis

public class Apigee.Organizations.Apis.List
extends ApigeeRequest<GoogleCloudApigeeV1ListApiProxiesResponse>

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 the names of all API proxies in an organization.

Method Summary

Modifier and Type	Method and Description
com.google.api.client.http.HttpRequest	buildHttpRequestUsingHead()
com.google.api.client.http.HttpResponse	executeUsingHead()
Boolean	getIncludeMetaData() Flag that specifies whether to include API proxy metadata in the response.
Boolean	getIncludeRevisions() Flag that specifies whether to include a list of revisions in the response.
String	getParent() Required.
String	getSpace() Optional.
Apigee.Organizations.Apis.List	set(String parameterName, Object value)
Apigee.Organizations.Apis.List	set$Xgafv(String $Xgafv) V1 error format.
Apigee.Organizations.Apis.List	setAccessToken(String accessToken) OAuth access token.
Apigee.Organizations.Apis.List	setAlt(String alt) Data format for response.
Apigee.Organizations.Apis.List	setCallback(String callback) JSONP
Apigee.Organizations.Apis.List	setFields(String fields) Selector specifying which fields to include in a partial response.
Apigee.Organizations.Apis.List	setIncludeMetaData(Boolean includeMetaData) Flag that specifies whether to include API proxy metadata in the response.
Apigee.Organizations.Apis.List	setIncludeRevisions(Boolean includeRevisions) Flag that specifies whether to include a list of revisions in the response.
Apigee.Organizations.Apis.List	setKey(String key) API key.
Apigee.Organizations.Apis.List	setOauthToken(String oauthToken) OAuth 2.0 token for the current user.
Apigee.Organizations.Apis.List	setParent(String parent) Required.
Apigee.Organizations.Apis.List	setPrettyPrint(Boolean prettyPrint) Returns response with indentations and line breaks.
Apigee.Organizations.Apis.List	setQuotaUser(String quotaUser) Available to use for quota purposes for server-side applications.
Apigee.Organizations.Apis.List	setSpace(String space) Optional.
Apigee.Organizations.Apis.List	setUploadProtocol(String uploadProtocol) Upload protocol for media (e.g.
Apigee.Organizations.Apis.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 the names of all API proxies in an organization. The names returned correspond to the names defined in the configuration files for each API proxy. If the resource has the `space` attribute set, the response may not return all resources. To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system- administration/spaces/apigee-spaces-overview). Create a request for the method "apis.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. Name of the organization in the following format: `organizations/{org}` If the resource has the `space` attribute set, IAM permissions are checked against the Space resource path. To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system- administration/spaces/apigee-spaces-overview).

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<GoogleCloudApigeeV1ListApiProxiesResponse>

Throws:

IOException

buildHttpRequestUsingHead

public com.google.api.client.http.HttpRequest buildHttpRequestUsingHead()
                                                                 throws IOException

Overrides:

buildHttpRequestUsingHead in class com.google.api.client.googleapis.services.AbstractGoogleClientRequest<GoogleCloudApigeeV1ListApiProxiesResponse>

Throws:

IOException

set$Xgafv

public Apigee.Organizations.Apis.List set$Xgafv(String $Xgafv)

Description copied from class: ApigeeRequest

V1 error format.

Overrides:

set$Xgafv in class ApigeeRequest<GoogleCloudApigeeV1ListApiProxiesResponse>

setAccessToken

public Apigee.Organizations.Apis.List setAccessToken(String accessToken)

Description copied from class: ApigeeRequest

OAuth access token.

Overrides:

setAccessToken in class ApigeeRequest<GoogleCloudApigeeV1ListApiProxiesResponse>

setAlt

public Apigee.Organizations.Apis.List setAlt(String alt)

Description copied from class: ApigeeRequest

Data format for response.

Overrides:

setAlt in class ApigeeRequest<GoogleCloudApigeeV1ListApiProxiesResponse>

setCallback

public Apigee.Organizations.Apis.List setCallback(String callback)

Description copied from class: ApigeeRequest

JSONP

Overrides:

setCallback in class ApigeeRequest<GoogleCloudApigeeV1ListApiProxiesResponse>

setFields

public Apigee.Organizations.Apis.List setFields(String fields)

Description copied from class: ApigeeRequest

Selector specifying which fields to include in a partial response.

Overrides:

setFields in class ApigeeRequest<GoogleCloudApigeeV1ListApiProxiesResponse>

setKey

public Apigee.Organizations.Apis.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<GoogleCloudApigeeV1ListApiProxiesResponse>

setOauthToken

public Apigee.Organizations.Apis.List setOauthToken(String oauthToken)

Description copied from class: ApigeeRequest

OAuth 2.0 token for the current user.

Overrides:

setOauthToken in class ApigeeRequest<GoogleCloudApigeeV1ListApiProxiesResponse>

setPrettyPrint

public Apigee.Organizations.Apis.List setPrettyPrint(Boolean prettyPrint)

Description copied from class: ApigeeRequest

Returns response with indentations and line breaks.

Overrides:

setPrettyPrint in class ApigeeRequest<GoogleCloudApigeeV1ListApiProxiesResponse>

setQuotaUser

public Apigee.Organizations.Apis.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<GoogleCloudApigeeV1ListApiProxiesResponse>

setUploadType

public Apigee.Organizations.Apis.List setUploadType(String uploadType)

Description copied from class: ApigeeRequest

Legacy upload protocol for media (e.g. "media", "multipart").

Overrides:

setUploadType in class ApigeeRequest<GoogleCloudApigeeV1ListApiProxiesResponse>

setUploadProtocol

public Apigee.Organizations.Apis.List setUploadProtocol(String uploadProtocol)

Description copied from class: ApigeeRequest

Upload protocol for media (e.g. "raw", "multipart").

Overrides:

setUploadProtocol in class ApigeeRequest<GoogleCloudApigeeV1ListApiProxiesResponse>

getParent

public String getParent()

Required. Name of the organization in the following format: `organizations/{org}` If the resource has the `space` attribute set, IAM permissions are checked against the Space resource path. To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api- platform/system-administration/spaces/apigee-spaces-overview).

setParent

public Apigee.Organizations.Apis.List setParent(String parent)

Required. Name of the organization in the following format: `organizations/{org}` If the resource has the `space` attribute set, IAM permissions are checked against the Space resource path. To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system- administration/spaces/apigee-spaces-overview).

getIncludeMetaData

public Boolean getIncludeMetaData()

Flag that specifies whether to include API proxy metadata in the response.

setIncludeMetaData

public Apigee.Organizations.Apis.List setIncludeMetaData(Boolean includeMetaData)

Flag that specifies whether to include API proxy metadata in the response.

getIncludeRevisions

public Boolean getIncludeRevisions()

Flag that specifies whether to include a list of revisions in the response.

setIncludeRevisions

public Apigee.Organizations.Apis.List setIncludeRevisions(Boolean includeRevisions)

Flag that specifies whether to include a list of revisions in the response.

getSpace

public String getSpace()

Optional. The space ID to filter the list of proxies (optional). If unspecified, all proxies in the organization will be listed.

setSpace

public Apigee.Organizations.Apis.List setSpace(String space)

Optional. The space ID to filter the list of proxies (optional). If unspecified, all proxies in the organization will be listed.

set

public Apigee.Organizations.Apis.List set(String parameterName,
                                          Object value)

Overrides:

set in class ApigeeRequest<GoogleCloudApigeeV1ListApiProxiesResponse>