Class ListTimeSeriesRequest (3.49.0)

public final class ListTimeSeriesRequest extends GeneratedMessageV3 implements ListTimeSeriesRequestOrBuilder

The ListTimeSeries request.

Protobuf type google.monitoring.v3.ListTimeSeriesRequest

Static Fields

AGGREGATION_FIELD_NUMBER

public static final int AGGREGATION_FIELD_NUMBER
Field Value
Type Description
int

FILTER_FIELD_NUMBER

public static final int FILTER_FIELD_NUMBER
Field Value
Type Description
int

INTERVAL_FIELD_NUMBER

public static final int INTERVAL_FIELD_NUMBER
Field Value
Type Description
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
Type Description
int

ORDER_BY_FIELD_NUMBER

public static final int ORDER_BY_FIELD_NUMBER
Field Value
Type Description
int

PAGE_SIZE_FIELD_NUMBER

public static final int PAGE_SIZE_FIELD_NUMBER
Field Value
Type Description
int

PAGE_TOKEN_FIELD_NUMBER

public static final int PAGE_TOKEN_FIELD_NUMBER
Field Value
Type Description
int

SECONDARY_AGGREGATION_FIELD_NUMBER

public static final int SECONDARY_AGGREGATION_FIELD_NUMBER
Field Value
Type Description
int

VIEW_FIELD_NUMBER

public static final int VIEW_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static ListTimeSeriesRequest getDefaultInstance()
Returns
Type Description
ListTimeSeriesRequest

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static ListTimeSeriesRequest.Builder newBuilder()
Returns
Type Description
ListTimeSeriesRequest.Builder

newBuilder(ListTimeSeriesRequest prototype)

public static ListTimeSeriesRequest.Builder newBuilder(ListTimeSeriesRequest prototype)
Parameter
Name Description
prototype ListTimeSeriesRequest
Returns
Type Description
ListTimeSeriesRequest.Builder

parseDelimitedFrom(InputStream input)

public static ListTimeSeriesRequest parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
ListTimeSeriesRequest
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static ListTimeSeriesRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ListTimeSeriesRequest
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static ListTimeSeriesRequest parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
ListTimeSeriesRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static ListTimeSeriesRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ListTimeSeriesRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static ListTimeSeriesRequest parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
ListTimeSeriesRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static ListTimeSeriesRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ListTimeSeriesRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static ListTimeSeriesRequest parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
ListTimeSeriesRequest
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static ListTimeSeriesRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ListTimeSeriesRequest
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static ListTimeSeriesRequest parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
ListTimeSeriesRequest
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static ListTimeSeriesRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ListTimeSeriesRequest
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static ListTimeSeriesRequest parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
ListTimeSeriesRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static ListTimeSeriesRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ListTimeSeriesRequest
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<ListTimeSeriesRequest> parser()
Returns
Type Description
Parser<ListTimeSeriesRequest>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getAggregation()

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

getDefaultInstanceForType()

public ListTimeSeriesRequest getDefaultInstanceForType()
Returns
Type Description
ListTimeSeriesRequest

getFilter()

public 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 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 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 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 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 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 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 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 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 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 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.

getParserForType()

public Parser<ListTimeSeriesRequest> getParserForType()
Returns
Type Description
Parser<ListTimeSeriesRequest>
Overrides

getSecondaryAggregation()

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

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getView()

public 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 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 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 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 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.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public ListTimeSeriesRequest.Builder newBuilderForType()
Returns
Type Description
ListTimeSeriesRequest.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected ListTimeSeriesRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
ListTimeSeriesRequest.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public ListTimeSeriesRequest.Builder toBuilder()
Returns
Type Description
ListTimeSeriesRequest.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException