com.google.api.services.apigee.v1

Class Apigee.Organizations.Environments.Analytics.Admin.GetSchemav2

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

com.google.api.services.apigee.v1.Apigee.Organizations.Environments.Analytics.Admin.GetSchemav2

All Implemented Interfaces:

Cloneable, Map<String,Object>

Enclosing class:

Apigee.Organizations.Environments.Analytics.Admin

public class Apigee.Organizations.Environments.Analytics.Admin.GetSchemav2
extends ApigeeRequest<GoogleCloudApigeeV1Schema>

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	GetSchemav2(String name) Gets a list of metrics and dimensions that can be used to create analytics queries and reports.

Method Summary

Modifier and Type	Method and Description
com.google.api.client.http.HttpRequest	buildHttpRequestUsingHead()
com.google.api.client.http.HttpResponse	executeUsingHead()
Boolean	getDisableCache() Flag that specifies whether the schema is be read from the database or cache.
String	getName() Required.
String	getType() Required.
Apigee.Organizations.Environments.Analytics.Admin.GetSchemav2	set(String parameterName, Object value)
Apigee.Organizations.Environments.Analytics.Admin.GetSchemav2	set$Xgafv(String $Xgafv) V1 error format.
Apigee.Organizations.Environments.Analytics.Admin.GetSchemav2	setAccessToken(String accessToken) OAuth access token.
Apigee.Organizations.Environments.Analytics.Admin.GetSchemav2	setAlt(String alt) Data format for response.
Apigee.Organizations.Environments.Analytics.Admin.GetSchemav2	setCallback(String callback) JSONP
Apigee.Organizations.Environments.Analytics.Admin.GetSchemav2	setDisableCache(Boolean disableCache) Flag that specifies whether the schema is be read from the database or cache.
Apigee.Organizations.Environments.Analytics.Admin.GetSchemav2	setFields(String fields) Selector specifying which fields to include in a partial response.
Apigee.Organizations.Environments.Analytics.Admin.GetSchemav2	setKey(String key) API key.
Apigee.Organizations.Environments.Analytics.Admin.GetSchemav2	setName(String name) Required.
Apigee.Organizations.Environments.Analytics.Admin.GetSchemav2	setOauthToken(String oauthToken) OAuth 2.0 token for the current user.
Apigee.Organizations.Environments.Analytics.Admin.GetSchemav2	setPrettyPrint(Boolean prettyPrint) Returns response with indentations and line breaks.
Apigee.Organizations.Environments.Analytics.Admin.GetSchemav2	setQuotaUser(String quotaUser) Available to use for quota purposes for server-side applications.
Apigee.Organizations.Environments.Analytics.Admin.GetSchemav2	setType(String type) Required.
Apigee.Organizations.Environments.Analytics.Admin.GetSchemav2	setUploadProtocol(String uploadProtocol) Upload protocol for media (e.g.
Apigee.Organizations.Environments.Analytics.Admin.GetSchemav2	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

GetSchemav2

protected GetSchemav2(String name)

Gets a list of metrics and dimensions that can be used to create analytics queries and reports. Each schema element contains the name of the field, its associated type, and a flag indicating whether it is a standard or custom field. Create a request for the method "admin.getSchemav2". 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:

name - Required. Path to the schema. Use the following structure in your request: `organizations/{org}/environments/{env}/analytics/admin/schemav2`.

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

Throws:

IOException

buildHttpRequestUsingHead

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

Overrides:

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

Throws:

IOException

set$Xgafv

public Apigee.Organizations.Environments.Analytics.Admin.GetSchemav2 set$Xgafv(String $Xgafv)

Description copied from class: ApigeeRequest

V1 error format.

Overrides:

set$Xgafv in class ApigeeRequest<GoogleCloudApigeeV1Schema>

setAccessToken

public Apigee.Organizations.Environments.Analytics.Admin.GetSchemav2 setAccessToken(String accessToken)

Description copied from class: ApigeeRequest

OAuth access token.

Overrides:

setAccessToken in class ApigeeRequest<GoogleCloudApigeeV1Schema>

setAlt

public Apigee.Organizations.Environments.Analytics.Admin.GetSchemav2 setAlt(String alt)

Description copied from class: ApigeeRequest

Data format for response.

Overrides:

setAlt in class ApigeeRequest<GoogleCloudApigeeV1Schema>

setCallback

public Apigee.Organizations.Environments.Analytics.Admin.GetSchemav2 setCallback(String callback)

Description copied from class: ApigeeRequest

JSONP

Overrides:

setCallback in class ApigeeRequest<GoogleCloudApigeeV1Schema>

setFields

public Apigee.Organizations.Environments.Analytics.Admin.GetSchemav2 setFields(String fields)

Description copied from class: ApigeeRequest

Selector specifying which fields to include in a partial response.

Overrides:

setFields in class ApigeeRequest<GoogleCloudApigeeV1Schema>

setKey

public Apigee.Organizations.Environments.Analytics.Admin.GetSchemav2 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<GoogleCloudApigeeV1Schema>

setOauthToken

public Apigee.Organizations.Environments.Analytics.Admin.GetSchemav2 setOauthToken(String oauthToken)

Description copied from class: ApigeeRequest

OAuth 2.0 token for the current user.

Overrides:

setOauthToken in class ApigeeRequest<GoogleCloudApigeeV1Schema>

setPrettyPrint

public Apigee.Organizations.Environments.Analytics.Admin.GetSchemav2 setPrettyPrint(Boolean prettyPrint)

Description copied from class: ApigeeRequest

Returns response with indentations and line breaks.

Overrides:

setPrettyPrint in class ApigeeRequest<GoogleCloudApigeeV1Schema>

setQuotaUser

public Apigee.Organizations.Environments.Analytics.Admin.GetSchemav2 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<GoogleCloudApigeeV1Schema>

setUploadType

public Apigee.Organizations.Environments.Analytics.Admin.GetSchemav2 setUploadType(String uploadType)

Description copied from class: ApigeeRequest

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

Overrides:

setUploadType in class ApigeeRequest<GoogleCloudApigeeV1Schema>

setUploadProtocol

public Apigee.Organizations.Environments.Analytics.Admin.GetSchemav2 setUploadProtocol(String uploadProtocol)

Description copied from class: ApigeeRequest

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

Overrides:

setUploadProtocol in class ApigeeRequest<GoogleCloudApigeeV1Schema>

getName

public String getName()

Required. Path to the schema. Use the following structure in your request: `organizations/{org}/environments/{env}/analytics/admin/schemav2`.

setName

public Apigee.Organizations.Environments.Analytics.Admin.GetSchemav2 setName(String name)

Required. Path to the schema. Use the following structure in your request: `organizations/{org}/environments/{env}/analytics/admin/schemav2`.

getDisableCache

public Boolean getDisableCache()

Flag that specifies whether the schema is be read from the database or cache. Set to `true` to read the schema from the database. Defaults to cache.

setDisableCache

public Apigee.Organizations.Environments.Analytics.Admin.GetSchemav2 setDisableCache(Boolean disableCache)

Flag that specifies whether the schema is be read from the database or cache. Set to `true` to read the schema from the database. Defaults to cache.

getType

public String getType()

Required. Name of the dataset for which you want to retrieve the schema. For example: `fact` or `agg_cus1`

setType

public Apigee.Organizations.Environments.Analytics.Admin.GetSchemav2 setType(String type)

Required. Name of the dataset for which you want to retrieve the schema. For example: `fact` or `agg_cus1`

set

public Apigee.Organizations.Environments.Analytics.Admin.GetSchemav2 set(String parameterName,
                                                                         Object value)

Overrides:

set in class ApigeeRequest<GoogleCloudApigeeV1Schema>