Interface ListTimeSeriesRequestOrBuilder (3.55.0) 

public interface ListTimeSeriesRequestOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getAggregation()

public abstract 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
Type Description
Aggregation

The aggregation.

getAggregationOrBuilder()

public abstract 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;

Returns
Type Description
AggregationOrBuilder

getFilter()

public abstract String getFilter()

Required. A monitoring filter 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
Type Description
String

The filter.

getFilterBytes()

public abstract ByteString getFilterBytes()

Required. A monitoring filter 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
Type Description
ByteString

The bytes for filter.

getInterval()

public abstract 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
Type Description
TimeInterval

The interval.

getIntervalOrBuilder()

public abstract 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];

Returns
Type Description
TimeIntervalOrBuilder

getName()

public abstract String getName()

Required. The project, 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
Type Description
String

The name.

getNameBytes()

public abstract ByteString getNameBytes()

Required. The project, 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
Type Description
ByteString

The bytes for name.

getOrderBy()

public abstract 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
Type Description
String

The orderBy.

getOrderByBytes()

public abstract 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
Type Description
ByteString

The bytes for orderBy.

getPageSize()

public abstract 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
Type Description
int

The pageSize.

getPageToken()

public abstract 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
Type Description
String

The pageToken.

getPageTokenBytes()

public abstract 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
Type Description
ByteString

The bytes for pageToken.

getSecondaryAggregation()

public abstract 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
Type Description
Aggregation

The secondaryAggregation.

getSecondaryAggregationOrBuilder()

public abstract 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;

Returns
Type Description
AggregationOrBuilder

getView()

public abstract 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
Type Description
ListTimeSeriesRequest.TimeSeriesView

The view.

getViewValue()

public abstract 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
Type Description
int

The enum numeric value on the wire for view.

hasAggregation()

public abstract 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
Type Description
boolean

Whether the aggregation field is set.

hasInterval()

public abstract 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
Type Description
boolean

Whether the interval field is set.

hasSecondaryAggregation()

public abstract 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
Type Description
boolean

Whether the secondaryAggregation field is set.