com.google.api.services.apigee.v1.model

Class GoogleCloudApigeeV1QueryTimeSeriesStatsRequest

java.lang.Object

java.util.AbstractMap<String,Object>

com.google.api.client.util.GenericData

com.google.api.client.json.GenericJson

com.google.api.services.apigee.v1.model.GoogleCloudApigeeV1QueryTimeSeriesStatsRequest

All Implemented Interfaces:

Cloneable, Map<String,Object>

public final class GoogleCloudApigeeV1QueryTimeSeriesStatsRequest
extends com.google.api.client.json.GenericJson

QueryTimeSeriesStatsRequest represents a query that returns a collection of time series sequences grouped by their values.

This is the Java data model class that specifies how to parse/serialize into the JSON that is transmitted over HTTP when working with the Apigee API. For a detailed explanation see: https://developers.google.com/api-client-library/java/google-http-java-client/json

Author:

Google, Inc.

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>

Constructor Summary

Constructors

Constructor and Description
GoogleCloudApigeeV1QueryTimeSeriesStatsRequest()

Method Summary

Modifier and Type	Method and Description
GoogleCloudApigeeV1QueryTimeSeriesStatsRequest	clone()
List<String>	getDimensions() List of dimension names to group the aggregations by.
String	getFilter() Filter further on specific dimension values.
List<GoogleCloudApigeeV1MetricAggregation>	getMetrics() Required.
Integer	getPageSize() Page size represents the number of time series sequences, one per unique set of dimensions and their values.
String	getPageToken() Page token stands for a specific collection of time series sequences.
GoogleTypeInterval	getTimeRange() Required.
String	getTimestampOrder() Order the sequences in increasing or decreasing order of timestamps.
String	getWindowSize() Time buckets to group the stats by.
GoogleCloudApigeeV1QueryTimeSeriesStatsRequest	set(String fieldName, Object value)
GoogleCloudApigeeV1QueryTimeSeriesStatsRequest	setDimensions(List<String> dimensions) List of dimension names to group the aggregations by.
GoogleCloudApigeeV1QueryTimeSeriesStatsRequest	setFilter(String filter) Filter further on specific dimension values.
GoogleCloudApigeeV1QueryTimeSeriesStatsRequest	setMetrics(List<GoogleCloudApigeeV1MetricAggregation> metrics) Required.
GoogleCloudApigeeV1QueryTimeSeriesStatsRequest	setPageSize(Integer pageSize) Page size represents the number of time series sequences, one per unique set of dimensions and their values.
GoogleCloudApigeeV1QueryTimeSeriesStatsRequest	setPageToken(String pageToken) Page token stands for a specific collection of time series sequences.
GoogleCloudApigeeV1QueryTimeSeriesStatsRequest	setTimeRange(GoogleTypeInterval timeRange) Required.
GoogleCloudApigeeV1QueryTimeSeriesStatsRequest	setTimestampOrder(String timestampOrder) Order the sequences in increasing or decreasing order of timestamps.
GoogleCloudApigeeV1QueryTimeSeriesStatsRequest	setWindowSize(String windowSize) Time buckets to group the stats by.

Methods inherited from class com.google.api.client.json.GenericJson

getFactory, setFactory, toPrettyString, toString

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

entrySet, equals, get, getClassInfo, getUnknownKeys, hashCode, put, putAll, remove, setUnknownKeys

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

GoogleCloudApigeeV1QueryTimeSeriesStatsRequest

public GoogleCloudApigeeV1QueryTimeSeriesStatsRequest()

Method Detail

getDimensions

public List<String> getDimensions()

List of dimension names to group the aggregations by. If no dimensions are passed, a single trend line representing the requested metric aggregations grouped by environment is returned.

Returns:

value or null for none

setDimensions

public GoogleCloudApigeeV1QueryTimeSeriesStatsRequest setDimensions(List<String> dimensions)

List of dimension names to group the aggregations by. If no dimensions are passed, a single trend line representing the requested metric aggregations grouped by environment is returned.

Parameters:

dimensions - dimensions or null for none

getFilter

public String getFilter()

Filter further on specific dimension values. Follows the same grammar as custom report's filter expressions. Example, apiproxy eq 'foobar'. https://cloud.google.com/apigee/docs/api- platform/analytics/analytics-reference#filters

Returns:

value or null for none

setFilter

public GoogleCloudApigeeV1QueryTimeSeriesStatsRequest setFilter(String filter)

Filter further on specific dimension values. Follows the same grammar as custom report's filter expressions. Example, apiproxy eq 'foobar'. https://cloud.google.com/apigee/docs/api- platform/analytics/analytics-reference#filters

Parameters:

filter - filter or null for none

getMetrics

public List<GoogleCloudApigeeV1MetricAggregation> getMetrics()

Required. List of metrics and their aggregations.

Returns:

value or null for none

setMetrics

public GoogleCloudApigeeV1QueryTimeSeriesStatsRequest setMetrics(List<GoogleCloudApigeeV1MetricAggregation> metrics)

Required. List of metrics and their aggregations.

Parameters:

metrics - metrics or null for none

getPageSize

public Integer getPageSize()

Page size represents the number of time series sequences, one per unique set of dimensions and their values.

Returns:

value or null for none

setPageSize

public GoogleCloudApigeeV1QueryTimeSeriesStatsRequest setPageSize(Integer pageSize)

Page size represents the number of time series sequences, one per unique set of dimensions and their values.

Parameters:

pageSize - pageSize or null for none

getPageToken

public String getPageToken()

Page token stands for a specific collection of time series sequences.

Returns:

value or null for none

setPageToken

public GoogleCloudApigeeV1QueryTimeSeriesStatsRequest setPageToken(String pageToken)

Page token stands for a specific collection of time series sequences.

Parameters:

pageToken - pageToken or null for none

getTimeRange

public GoogleTypeInterval getTimeRange()

Required. Time range for the stats.

Returns:

value or null for none

setTimeRange

public GoogleCloudApigeeV1QueryTimeSeriesStatsRequest setTimeRange(GoogleTypeInterval timeRange)

Required. Time range for the stats.

Parameters:

timeRange - timeRange or null for none

getTimestampOrder

public String getTimestampOrder()

Order the sequences in increasing or decreasing order of timestamps. Default is descending order of timestamps (latest first).

Returns:

value or null for none

setTimestampOrder

public GoogleCloudApigeeV1QueryTimeSeriesStatsRequest setTimestampOrder(String timestampOrder)

Order the sequences in increasing or decreasing order of timestamps. Default is descending order of timestamps (latest first).

Parameters:

timestampOrder - timestampOrder or null for none

getWindowSize

public String getWindowSize()

Time buckets to group the stats by.

Returns:

value or null for none

setWindowSize

public GoogleCloudApigeeV1QueryTimeSeriesStatsRequest setWindowSize(String windowSize)

Time buckets to group the stats by.

Parameters:

windowSize - windowSize or null for none

set

public GoogleCloudApigeeV1QueryTimeSeriesStatsRequest set(String fieldName,
                                                          Object value)

Overrides:

set in class com.google.api.client.json.GenericJson

clone

public GoogleCloudApigeeV1QueryTimeSeriesStatsRequest clone()

Overrides:

clone in class com.google.api.client.json.GenericJson