com.google.monitoring.v3

Interface ListTimeSeriesRequestOrBuilder

All Superinterfaces:

com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder

All Known Implementing Classes:

ListTimeSeriesRequest, ListTimeSeriesRequest.Builder

public interface ListTimeSeriesRequestOrBuilder
extends com.google.protobuf.MessageOrBuilder

Method Summary

Modifier and Type	Method and Description
Aggregation	getAggregation() Specifies the alignment of data points in individual time series as well as how to combine the retrieved time series across specified labels.
AggregationOrBuilder	getAggregationOrBuilder() Specifies the alignment of data points in individual time series as well as how to combine the retrieved time series across specified labels.
String	getFilter() Required.
com.google.protobuf.ByteString	getFilterBytes() Required.
TimeInterval	getInterval() Required.
TimeIntervalOrBuilder	getIntervalOrBuilder() Required.
String	getName() Required.
com.google.protobuf.ByteString	getNameBytes() Required.
String	getOrderBy() Unsupported: must be left blank.
com.google.protobuf.ByteString	getOrderByBytes() Unsupported: must be left blank.
int	getPageSize() A positive number that is the maximum number of results to return.
String	getPageToken() If this field is not empty then it must contain the `nextPageToken` value returned by a previous call to this method.
com.google.protobuf.ByteString	getPageTokenBytes() If this field is not empty then it must contain the `nextPageToken` value returned by a previous call to this method.
Aggregation	getSecondaryAggregation() Apply a second aggregation after `aggregation` is applied.
AggregationOrBuilder	getSecondaryAggregationOrBuilder() Apply a second aggregation after `aggregation` is applied.
ListTimeSeriesRequest.TimeSeriesView	getView() Required.
int	getViewValue() Required.
boolean	hasAggregation() Specifies the alignment of data points in individual time series as well as how to combine the retrieved time series across specified labels.
boolean	hasInterval() Required.
boolean	hasSecondaryAggregation() Apply a second aggregation after `aggregation` is applied.

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

isInitialized

Method Detail

getName

String getName()

 Required. The
 [project](https://cloud.google.com/monitoring/api/v3#project_name),
 organization or folder on which to execute the request. The format is:

     projects/[PROJECT_ID_OR_NUMBER]
     organizations/[ORGANIZATION_ID]
     folders/[FOLDER_ID]
 

string name = 10 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns:

The name.

getNameBytes

com.google.protobuf.ByteString getNameBytes()

 Required. The
 [project](https://cloud.google.com/monitoring/api/v3#project_name),
 organization or folder on which to execute the request. The format is:

     projects/[PROJECT_ID_OR_NUMBER]
     organizations/[ORGANIZATION_ID]
     folders/[FOLDER_ID]
 

string name = 10 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns:

The bytes for name.

getFilter

String getFilter()

 Required. A [monitoring
 filter](https://cloud.google.com/monitoring/api/v3/filters) that specifies
 which time series should be returned.  The filter must specify a single
 metric type, and can additionally specify metric labels and other
 information. For example:

     metric.type = "compute.googleapis.com/instance/cpu/usage_time" AND
         metric.labels.instance_name = "my-instance-name"
 

string filter = 2 [(.google.api.field_behavior) = REQUIRED];

Returns:

The filter.

getFilterBytes

com.google.protobuf.ByteString getFilterBytes()

 Required. A [monitoring
 filter](https://cloud.google.com/monitoring/api/v3/filters) that specifies
 which time series should be returned.  The filter must specify a single
 metric type, and can additionally specify metric labels and other
 information. For example:

     metric.type = "compute.googleapis.com/instance/cpu/usage_time" AND
         metric.labels.instance_name = "my-instance-name"
 

string filter = 2 [(.google.api.field_behavior) = REQUIRED];

Returns:

The bytes for filter.

hasInterval

boolean hasInterval()

 Required. The time interval for which results should be returned. Only time
 series that contain data points in the specified interval are included in
 the response.
 

.google.monitoring.v3.TimeInterval interval = 4 [(.google.api.field_behavior) = REQUIRED];

Returns:

Whether the interval field is set.

getInterval

TimeInterval getInterval()

 Required. The time interval for which results should be returned. Only time
 series that contain data points in the specified interval are included in
 the response.
 

.google.monitoring.v3.TimeInterval interval = 4 [(.google.api.field_behavior) = REQUIRED];

Returns:

The interval.

getIntervalOrBuilder

TimeIntervalOrBuilder getIntervalOrBuilder()

 Required. The time interval for which results should be returned. Only time
 series that contain data points in the specified interval are included in
 the response.
 

.google.monitoring.v3.TimeInterval interval = 4 [(.google.api.field_behavior) = REQUIRED];

hasAggregation

boolean hasAggregation()

 Specifies the alignment of data points in individual time series as
 well as how to combine the retrieved time series across specified labels.

 By default (if no `aggregation` is explicitly specified), the raw time
 series data is returned.
 

.google.monitoring.v3.Aggregation aggregation = 5;

Returns:

Whether the aggregation field is set.

getAggregation

Aggregation getAggregation()

 Specifies the alignment of data points in individual time series as
 well as how to combine the retrieved time series across specified labels.

 By default (if no `aggregation` is explicitly specified), the raw time
 series data is returned.
 

.google.monitoring.v3.Aggregation aggregation = 5;

Returns:

The aggregation.

getAggregationOrBuilder

AggregationOrBuilder getAggregationOrBuilder()

 Specifies the alignment of data points in individual time series as
 well as how to combine the retrieved time series across specified labels.

 By default (if no `aggregation` is explicitly specified), the raw time
 series data is returned.
 

.google.monitoring.v3.Aggregation aggregation = 5;

hasSecondaryAggregation

boolean hasSecondaryAggregation()

 Apply a second aggregation after `aggregation` is applied. May only be
 specified if `aggregation` is specified.
 

.google.monitoring.v3.Aggregation secondary_aggregation = 11;

Returns:

Whether the secondaryAggregation field is set.

getSecondaryAggregation

Aggregation getSecondaryAggregation()

 Apply a second aggregation after `aggregation` is applied. May only be
 specified if `aggregation` is specified.
 

.google.monitoring.v3.Aggregation secondary_aggregation = 11;

Returns:

The secondaryAggregation.

getSecondaryAggregationOrBuilder

AggregationOrBuilder getSecondaryAggregationOrBuilder()

 Apply a second aggregation after `aggregation` is applied. May only be
 specified if `aggregation` is specified.
 

.google.monitoring.v3.Aggregation secondary_aggregation = 11;

getOrderBy

String getOrderBy()

 Unsupported: must be left blank. The points in each time series are
 currently returned in reverse time order (most recent to oldest).
 

string order_by = 6;

Returns:

The orderBy.

getOrderByBytes

com.google.protobuf.ByteString getOrderByBytes()

 Unsupported: must be left blank. The points in each time series are
 currently returned in reverse time order (most recent to oldest).
 

string order_by = 6;

Returns:

The bytes for orderBy.

getViewValue

int getViewValue()

 Required. Specifies which information is returned about the time series.
 

.google.monitoring.v3.ListTimeSeriesRequest.TimeSeriesView view = 7 [(.google.api.field_behavior) = REQUIRED];

Returns:

The enum numeric value on the wire for view.

getView

ListTimeSeriesRequest.TimeSeriesView getView()

 Required. Specifies which information is returned about the time series.
 

.google.monitoring.v3.ListTimeSeriesRequest.TimeSeriesView view = 7 [(.google.api.field_behavior) = REQUIRED];

Returns:

The view.

getPageSize

int getPageSize()

 A positive number that is the maximum number of results to return. If
 `page_size` is empty or more than 100,000 results, the effective
 `page_size` is 100,000 results. If `view` is set to `FULL`, this is the
 maximum number of `Points` returned. If `view` is set to `HEADERS`, this is
 the maximum number of `TimeSeries` returned.
 

int32 page_size = 8;

Returns:

The pageSize.

getPageToken

String getPageToken()

 If this field is not empty then it must contain the `nextPageToken` value
 returned by a previous call to this method.  Using this field causes the
 method to return additional results from the previous method call.
 

string page_token = 9;

Returns:

The pageToken.

getPageTokenBytes

com.google.protobuf.ByteString getPageTokenBytes()

 If this field is not empty then it must contain the `nextPageToken` value
 returned by a previous call to this method.  Using this field causes the
 method to return additional results from the previous method call.
 

string page_token = 9;

Returns:

The bytes for pageToken.