Apigee.Organizations.Environments.Stats.Get (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<GoogleCloudApigeeV1Stats>
        
        com.google.api.services.apigee.v1.Apigee.Organizations.Environments.Stats.Get

All Implemented Interfaces:

Cloneable, Map<String,Object>

Enclosing class:

Apigee.Organizations.Environments.Stats
```
public class Apigee.Organizations.Environments.Stats.Get
extends ApigeeRequest<GoogleCloudApigeeV1Stats>
```

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 Get(String name)
Retrieve metrics grouped by dimensions.

Constructors
Modifier	Constructor and Description
`protected`	`Get(String name)` Retrieve metrics grouped by dimensions.

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`	`getAccuracy()` No longer used by Apigee.
`String`	`getAggTable()` Table name used to query custom aggregate tables.
`String`	`getFilter()` Filter that enables you to drill down on specific dimension values.
`String`	`getLimit()` Maximum number of result items to return.
`String`	`getName()` Required.
`String`	`getOffset()` Offset value.
`Boolean`	`getRealtime()` No longer used by Apigee.
`String`	`getSelect()` Comma-separated list of metrics.
`Boolean`	`getSonar()` Routes the query to API Monitoring for the last hour.
`String`	`getSort()` Flag that specifies whether the sort order should be ascending or descending.
`String`	`getSortby()` Comma-separated list of metrics to sort the final result.
`String`	`getTimeRange()` Time interval for the interactive query.
`String`	`getTimeUnit()` Granularity of metrics returned.
`String`	`getTopk()` Top number of results to return.
`Boolean`	`getTsAscending()` Flag that specifies whether to list timestamps in ascending (`true`) or descending (`false`) order.
`String`	`getTzo()` Timezone offset value.
`Apigee.Organizations.Environments.Stats.Get`	`set(String parameterName, Object value)`
`Apigee.Organizations.Environments.Stats.Get`	`set$Xgafv(String $Xgafv)` V1 error format.
`Apigee.Organizations.Environments.Stats.Get`	`setAccessToken(String accessToken)` OAuth access token.
`Apigee.Organizations.Environments.Stats.Get`	`setAccuracy(String accuracy)` No longer used by Apigee.
`Apigee.Organizations.Environments.Stats.Get`	`setAggTable(String aggTable)` Table name used to query custom aggregate tables.
`Apigee.Organizations.Environments.Stats.Get`	`setAlt(String alt)` Data format for response.
`Apigee.Organizations.Environments.Stats.Get`	`setCallback(String callback)` JSONP
`Apigee.Organizations.Environments.Stats.Get`	`setFields(String fields)` Selector specifying which fields to include in a partial response.
`Apigee.Organizations.Environments.Stats.Get`	`setFilter(String filter)` Filter that enables you to drill down on specific dimension values.
`Apigee.Organizations.Environments.Stats.Get`	`setKey(String key)` API key.
`Apigee.Organizations.Environments.Stats.Get`	`setLimit(String limit)` Maximum number of result items to return.
`Apigee.Organizations.Environments.Stats.Get`	`setName(String name)` Required.
`Apigee.Organizations.Environments.Stats.Get`	`setOauthToken(String oauthToken)` OAuth 2.0 token for the current user.
`Apigee.Organizations.Environments.Stats.Get`	`setOffset(String offset)` Offset value.
`Apigee.Organizations.Environments.Stats.Get`	`setPrettyPrint(Boolean prettyPrint)` Returns response with indentations and line breaks.
`Apigee.Organizations.Environments.Stats.Get`	`setQuotaUser(String quotaUser)` Available to use for quota purposes for server-side applications.
`Apigee.Organizations.Environments.Stats.Get`	`setRealtime(Boolean realtime)` No longer used by Apigee.
`Apigee.Organizations.Environments.Stats.Get`	`setSelect(String select)` Comma-separated list of metrics.
`Apigee.Organizations.Environments.Stats.Get`	`setSonar(Boolean sonar)` Routes the query to API Monitoring for the last hour.
`Apigee.Organizations.Environments.Stats.Get`	`setSort(String sort)` Flag that specifies whether the sort order should be ascending or descending.
`Apigee.Organizations.Environments.Stats.Get`	`setSortby(String sortby)` Comma-separated list of metrics to sort the final result.
`Apigee.Organizations.Environments.Stats.Get`	`setTimeRange(String timeRange)` Time interval for the interactive query.
`Apigee.Organizations.Environments.Stats.Get`	`setTimeUnit(String timeUnit)` Granularity of metrics returned.
`Apigee.Organizations.Environments.Stats.Get`	`setTopk(String topk)` Top number of results to return.
`Apigee.Organizations.Environments.Stats.Get`	`setTsAscending(Boolean tsAscending)` Flag that specifies whether to list timestamps in ascending (`true`) or descending (`false`) order.
`Apigee.Organizations.Environments.Stats.Get`	`setTzo(String tzo)` Timezone offset value.
`Apigee.Organizations.Environments.Stats.Get`	`setUploadProtocol(String uploadProtocol)` Upload protocol for media (e.g.
`Apigee.Organizations.Environments.Stats.Get`	`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
  - Get
```
protected Get(String name)
```
    Retrieve metrics grouped by dimensions. The types of metrics you can retrieve include traffic, message counts, API call latency, response size, and cache hits and counts. Dimensions let you view metrics in meaningful groups. You can optionally pass dimensions as path parameters to the `stats` API. If dimensions are not specified, the metrics are computed on the entire set of data for the given time range. Create a request for the method "stats.get". 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. Resource name for which the interactive query will be executed. Use the following format in your request: `organizations/{org}/environments/{env}/stats/{dimensions}` Dimensions let you view metrics in meaningful groupings, such as `apiproxy` or `target_host`. The value of dimensions should be a comma-separated list, as shown below: `organizations/{org}/environments/{env}/stats/apiproxy,request_verb`
    
    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<GoogleCloudApigeeV1Stats>
    
    Throws:
    
    IOException
  - buildHttpRequestUsingHead
```
public com.google.api.client.http.HttpRequest buildHttpRequestUsingHead()
                                                                 throws IOException
```
    Overrides:
    
    buildHttpRequestUsingHead in class com.google.api.client.googleapis.services.AbstractGoogleClientRequest<GoogleCloudApigeeV1Stats>
    
    Throws:
    
    IOException
  - set$Xgafv
```
public Apigee.Organizations.Environments.Stats.Get set$Xgafv(String $Xgafv)
```
    Description copied from class: ApigeeRequest
    
    V1 error format.
    
    Overrides:
    
    set$Xgafv in class ApigeeRequest<GoogleCloudApigeeV1Stats>
  - setAccessToken
```
public Apigee.Organizations.Environments.Stats.Get setAccessToken(String accessToken)
```
    Description copied from class: ApigeeRequest
    
    OAuth access token.
    
    Overrides:
    
    setAccessToken in class ApigeeRequest<GoogleCloudApigeeV1Stats>
  - setAlt
```
public Apigee.Organizations.Environments.Stats.Get setAlt(String alt)
```
    Description copied from class: ApigeeRequest
    
    Data format for response.
    
    Overrides:
    
    setAlt in class ApigeeRequest<GoogleCloudApigeeV1Stats>
  - setCallback
```
public Apigee.Organizations.Environments.Stats.Get setCallback(String callback)
```
    Description copied from class: ApigeeRequest
    
    JSONP
    
    Overrides:
    
    setCallback in class ApigeeRequest<GoogleCloudApigeeV1Stats>
  - setFields
```
public Apigee.Organizations.Environments.Stats.Get setFields(String fields)
```
    Description copied from class: ApigeeRequest
    
    Selector specifying which fields to include in a partial response.
    
    Overrides:
    
    setFields in class ApigeeRequest<GoogleCloudApigeeV1Stats>
  - setKey
```
public Apigee.Organizations.Environments.Stats.Get 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<GoogleCloudApigeeV1Stats>
  - setOauthToken
```
public Apigee.Organizations.Environments.Stats.Get setOauthToken(String oauthToken)
```
    Description copied from class: ApigeeRequest
    
    OAuth 2.0 token for the current user.
    
    Overrides:
    
    setOauthToken in class ApigeeRequest<GoogleCloudApigeeV1Stats>
  - setPrettyPrint
```
public Apigee.Organizations.Environments.Stats.Get setPrettyPrint(Boolean prettyPrint)
```
    Description copied from class: ApigeeRequest
    
    Returns response with indentations and line breaks.
    
    Overrides:
    
    setPrettyPrint in class ApigeeRequest<GoogleCloudApigeeV1Stats>
  - setQuotaUser
```
public Apigee.Organizations.Environments.Stats.Get 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<GoogleCloudApigeeV1Stats>
  - setUploadType
```
public Apigee.Organizations.Environments.Stats.Get setUploadType(String uploadType)
```
    Description copied from class: ApigeeRequest
    
    Legacy upload protocol for media (e.g. "media", "multipart").
    
    Overrides:
    
    setUploadType in class ApigeeRequest<GoogleCloudApigeeV1Stats>
  - setUploadProtocol
```
public Apigee.Organizations.Environments.Stats.Get setUploadProtocol(String uploadProtocol)
```
    Description copied from class: ApigeeRequest
    
    Upload protocol for media (e.g. "raw", "multipart").
    
    Overrides:
    
    setUploadProtocol in class ApigeeRequest<GoogleCloudApigeeV1Stats>
  - getName
```
public String getName()
```
    Required. Resource name for which the interactive query will be executed. Use the following format in your request: `organizations/{org}/environments/{env}/stats/{dimensions}` Dimensions let you view metrics in meaningful groupings, such as `apiproxy` or `target_host`. The value of dimensions should be a comma-separated list, as shown below: `organizations/{org}/environments/{env}/stats/apiproxy,request_verb`
  - setName
```
public Apigee.Organizations.Environments.Stats.Get setName(String name)
```
    Required. Resource name for which the interactive query will be executed. Use the following format in your request: `organizations/{org}/environments/{env}/stats/{dimensions}` Dimensions let you view metrics in meaningful groupings, such as `apiproxy` or `target_host`. The value of dimensions should be a comma-separated list, as shown below: `organizations/{org}/environments/{env}/stats/apiproxy,request_verb`
  - getAccuracy
```
public String getAccuracy()
```
    No longer used by Apigee. Supported for backwards compatibility.
  - setAccuracy
```
public Apigee.Organizations.Environments.Stats.Get setAccuracy(String accuracy)
```
    No longer used by Apigee. Supported for backwards compatibility.
  - getAggTable
```
public String getAggTable()
```
    Table name used to query custom aggregate tables. If this parameter is skipped, then Apigee will try to retrieve the data from fact tables which will be expensive.
  - setAggTable
```
public Apigee.Organizations.Environments.Stats.Get setAggTable(String aggTable)
```
    Table name used to query custom aggregate tables. If this parameter is skipped, then Apigee will try to retrieve the data from fact tables which will be expensive.
  - getFilter
```
public String getFilter()
```
    Filter that enables you to drill down on specific dimension values.
  - setFilter
```
public Apigee.Organizations.Environments.Stats.Get setFilter(String filter)
```
    Filter that enables you to drill down on specific dimension values.
  - getLimit
```
public String getLimit()
```
    Maximum number of result items to return.
  - setLimit
```
public Apigee.Organizations.Environments.Stats.Get setLimit(String limit)
```
    Maximum number of result items to return.
  - getOffset
```
public String getOffset()
```
    Offset value. Use `offset` with `limit` to enable pagination of results. For example, to display results 11-20, set limit to `10` and offset to `10`.
  - setOffset
```
public Apigee.Organizations.Environments.Stats.Get setOffset(String offset)
```
    Offset value. Use `offset` with `limit` to enable pagination of results. For example, to display results 11-20, set limit to `10` and offset to `10`.
  - getRealtime
```
public Boolean getRealtime()
```
    No longer used by Apigee. Supported for backwards compatibility.
  - setRealtime
```
public Apigee.Organizations.Environments.Stats.Get setRealtime(Boolean realtime)
```
    No longer used by Apigee. Supported for backwards compatibility.
  - getSelect
```
public String getSelect()
```
    Comma-separated list of metrics. For example: `sum(message_count),sum(error_count)`
  - setSelect
```
public Apigee.Organizations.Environments.Stats.Get setSelect(String select)
```
    Comma-separated list of metrics. For example: `sum(message_count),sum(error_count)`
  - getSonar
```
public Boolean getSonar()
```
    Routes the query to API Monitoring for the last hour.
  - setSonar
```
public Apigee.Organizations.Environments.Stats.Get setSonar(Boolean sonar)
```
    Routes the query to API Monitoring for the last hour.
  - getSort
```
public String getSort()
```
    Flag that specifies whether the sort order should be ascending or descending. Valid values include: `DESC` and `ASC`.
  - setSort
```
public Apigee.Organizations.Environments.Stats.Get setSort(String sort)
```
    Flag that specifies whether the sort order should be ascending or descending. Valid values include: `DESC` and `ASC`.
  - getSortby
```
public String getSortby()
```
    Comma-separated list of metrics to sort the final result.
  - setSortby
```
public Apigee.Organizations.Environments.Stats.Get setSortby(String sortby)
```
    Comma-separated list of metrics to sort the final result.
  - getTimeRange
```
public String getTimeRange()
```
    Time interval for the interactive query. Time range is specified in GMT as `start~end`. For example: `04/15/2017 00:00~05/15/2017 23:59`
  - setTimeRange
```
public Apigee.Organizations.Environments.Stats.Get setTimeRange(String timeRange)
```
    Time interval for the interactive query. Time range is specified in GMT as `start~end`. For example: `04/15/2017 00:00~05/15/2017 23:59`
  - getTimeUnit
```
public String getTimeUnit()
```
    Granularity of metrics returned. Valid values include: `second`, `minute`, `hour`, `day`, `week`, or` month`.
  - setTimeUnit
```
public Apigee.Organizations.Environments.Stats.Get setTimeUnit(String timeUnit)
```
    Granularity of metrics returned. Valid values include: `second`, `minute`, `hour`, `day`, `week`, or` month`.
  - getTopk
```
public String getTopk()
```
    Top number of results to return. For example, to return the top 5 results, set `topk=5`.
  - setTopk
```
public Apigee.Organizations.Environments.Stats.Get setTopk(String topk)
```
    Top number of results to return. For example, to return the top 5 results, set `topk=5`.
  - getTsAscending
```
public Boolean getTsAscending()
```
    Flag that specifies whether to list timestamps in ascending (`true`) or descending (`false`) order. Apigee recommends that you set this value to `true` if you are using `sortby` with `sort=DESC`.
  - setTsAscending
```
public Apigee.Organizations.Environments.Stats.Get setTsAscending(Boolean tsAscending)
```
    Flag that specifies whether to list timestamps in ascending (`true`) or descending (`false`) order. Apigee recommends that you set this value to `true` if you are using `sortby` with `sort=DESC`.
  - getTzo
```
public String getTzo()
```
    Timezone offset value.
  - setTzo
```
public Apigee.Organizations.Environments.Stats.Get setTzo(String tzo)
```
    Timezone offset value.
  - set
```
public Apigee.Organizations.Environments.Stats.Get set(String parameterName,
                                                       Object value)
```
    Overrides:
    
    set in class ApigeeRequest<GoogleCloudApigeeV1Stats>

Class Apigee.Organizations.Environments.Stats.Get

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

Get

Method Detail

executeUsingHead

buildHttpRequestUsingHead

set$Xgafv

setAccessToken

setAlt

setCallback

setFields

setKey

setOauthToken

setPrettyPrint

setQuotaUser

setUploadType

setUploadProtocol

getName

setName

getAccuracy

setAccuracy

getAggTable

setAggTable

getFilter

setFilter

getLimit

setLimit

getOffset

setOffset

getRealtime

setRealtime

getSelect

setSelect

getSonar

setSonar

getSort

setSort

getSortby

setSortby

getTimeRange

setTimeRange

getTimeUnit

setTimeUnit

getTopk

setTopk

getTsAscending

setTsAscending

getTzo

setTzo

set