com.google.monitoring.v3

Class ListTimeSeriesRequest

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessageV3

com.google.monitoring.v3.ListTimeSeriesRequest

All Implemented Interfaces:

ListTimeSeriesRequestOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable

public final class ListTimeSeriesRequest
extends com.google.protobuf.GeneratedMessageV3
implements ListTimeSeriesRequestOrBuilder

 The `ListTimeSeries` request.
 

Protobuf type google.monitoring.v3.ListTimeSeriesRequest

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ListTimeSeriesRequest.Builder The `ListTimeSeries` request.
static class	ListTimeSeriesRequest.TimeSeriesView Controls which fields are returned by `ListTimeSeries`.

Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

Field Summary

Fields

Modifier and Type	Field and Description
static int	AGGREGATION_FIELD_NUMBER
static int	FILTER_FIELD_NUMBER
static int	INTERVAL_FIELD_NUMBER
static int	NAME_FIELD_NUMBER
static int	ORDER_BY_FIELD_NUMBER
static int	PAGE_SIZE_FIELD_NUMBER
static int	PAGE_TOKEN_FIELD_NUMBER
static int	SECONDARY_AGGREGATION_FIELD_NUMBER
static int	VIEW_FIELD_NUMBER

Fields inherited from class com.google.protobuf.GeneratedMessageV3

alwaysUseFieldBuilders, unknownFields

Fields inherited from class com.google.protobuf.AbstractMessage

memoizedSize

Fields inherited from class com.google.protobuf.AbstractMessageLite

memoizedHashCode

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
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.
static ListTimeSeriesRequest	getDefaultInstance()
ListTimeSeriesRequest	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
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.
com.google.protobuf.Parser<ListTimeSeriesRequest>	getParserForType()
Aggregation	getSecondaryAggregation() Apply a second aggregation after `aggregation` is applied.
AggregationOrBuilder	getSecondaryAggregationOrBuilder() Apply a second aggregation after `aggregation` is applied.
int	getSerializedSize()
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.
int	hashCode()
boolean	hasInterval() Required.
boolean	hasSecondaryAggregation() Apply a second aggregation after `aggregation` is applied.
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
static ListTimeSeriesRequest.Builder	newBuilder()
static ListTimeSeriesRequest.Builder	newBuilder(ListTimeSeriesRequest prototype)
ListTimeSeriesRequest.Builder	newBuilderForType()
protected ListTimeSeriesRequest.Builder	newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
protected Object	newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
static ListTimeSeriesRequest	parseDelimitedFrom(InputStream input)
static ListTimeSeriesRequest	parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static ListTimeSeriesRequest	parseFrom(byte[] data)
static ListTimeSeriesRequest	parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static ListTimeSeriesRequest	parseFrom(ByteBuffer data)
static ListTimeSeriesRequest	parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static ListTimeSeriesRequest	parseFrom(com.google.protobuf.ByteString data)
static ListTimeSeriesRequest	parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static ListTimeSeriesRequest	parseFrom(com.google.protobuf.CodedInputStream input)
static ListTimeSeriesRequest	parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static ListTimeSeriesRequest	parseFrom(InputStream input)
static ListTimeSeriesRequest	parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<ListTimeSeriesRequest>	parser()
ListTimeSeriesRequest.Builder	toBuilder()
void	writeTo(com.google.protobuf.CodedOutputStream output)

Methods inherited from class com.google.protobuf.GeneratedMessageV3

canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

Methods inherited from class com.google.protobuf.AbstractMessage

findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite

addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

Methods inherited from interface com.google.protobuf.MessageLite

toByteArray, toByteString, writeDelimitedTo, writeTo

Field Detail

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER

See Also:

Constant Field Values

FILTER_FIELD_NUMBER

public static final int FILTER_FIELD_NUMBER

See Also:

Constant Field Values

INTERVAL_FIELD_NUMBER

public static final int INTERVAL_FIELD_NUMBER

See Also:

Constant Field Values

AGGREGATION_FIELD_NUMBER

public static final int AGGREGATION_FIELD_NUMBER

See Also:

Constant Field Values

SECONDARY_AGGREGATION_FIELD_NUMBER

public static final int SECONDARY_AGGREGATION_FIELD_NUMBER

See Also:

Constant Field Values

ORDER_BY_FIELD_NUMBER

public static final int ORDER_BY_FIELD_NUMBER

See Also:

Constant Field Values

VIEW_FIELD_NUMBER

public static final int VIEW_FIELD_NUMBER

See Also:

Constant Field Values

PAGE_SIZE_FIELD_NUMBER

public static final int PAGE_SIZE_FIELD_NUMBER

See Also:

Constant Field Values

PAGE_TOKEN_FIELD_NUMBER

public static final int PAGE_TOKEN_FIELD_NUMBER

See Also:

Constant Field Values

Method Detail

newInstance

protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)

Overrides:

newInstance in class com.google.protobuf.GeneratedMessageV3

getDescriptor

public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

internalGetFieldAccessorTable

protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Specified by:

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

getName

public 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) = { ... }

Specified by:

getName in interface ListTimeSeriesRequestOrBuilder

Returns:

The name.

getNameBytes

public 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) = { ... }

Specified by:

getNameBytes in interface ListTimeSeriesRequestOrBuilder

Returns:

The bytes for name.

getFilter

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

Specified by:

getFilter in interface ListTimeSeriesRequestOrBuilder

Returns:

The filter.

getFilterBytes

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

Specified by:

getFilterBytes in interface ListTimeSeriesRequestOrBuilder

Returns:

The bytes for filter.

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

Specified by:

hasInterval in interface ListTimeSeriesRequestOrBuilder

Returns:

Whether the interval field is set.

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

Specified by:

getInterval in interface ListTimeSeriesRequestOrBuilder

Returns:

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

Specified by:

getIntervalOrBuilder in interface ListTimeSeriesRequestOrBuilder

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;

Specified by:

hasAggregation in interface ListTimeSeriesRequestOrBuilder

Returns:

Whether the aggregation field is set.

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;

Specified by:

getAggregation in interface ListTimeSeriesRequestOrBuilder

Returns:

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;

Specified by:

getAggregationOrBuilder in interface ListTimeSeriesRequestOrBuilder

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;

Specified by:

hasSecondaryAggregation in interface ListTimeSeriesRequestOrBuilder

Returns:

Whether the secondaryAggregation field is set.

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;

Specified by:

getSecondaryAggregation in interface ListTimeSeriesRequestOrBuilder

Returns:

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;

Specified by:

getSecondaryAggregationOrBuilder in interface ListTimeSeriesRequestOrBuilder

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;

Specified by:

getOrderBy in interface ListTimeSeriesRequestOrBuilder

Returns:

The orderBy.

getOrderByBytes

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

Specified by:

getOrderByBytes in interface ListTimeSeriesRequestOrBuilder

Returns:

The bytes for orderBy.

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

Specified by:

getViewValue in interface ListTimeSeriesRequestOrBuilder

Returns:

The enum numeric value on the wire for view.

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

Specified by:

getView in interface ListTimeSeriesRequestOrBuilder

Returns:

The view.

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;

Specified by:

getPageSize in interface ListTimeSeriesRequestOrBuilder

Returns:

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;

Specified by:

getPageToken in interface ListTimeSeriesRequestOrBuilder

Returns:

The pageToken.

getPageTokenBytes

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

Specified by:

getPageTokenBytes in interface ListTimeSeriesRequestOrBuilder

Returns:

The bytes for pageToken.

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessageV3

writeTo

public void writeTo(com.google.protobuf.CodedOutputStream output)
             throws IOException

Specified by:

writeTo in interface com.google.protobuf.MessageLite

Overrides:

writeTo in class com.google.protobuf.GeneratedMessageV3

Throws:

IOException

getSerializedSize

public int getSerializedSize()

Specified by:

getSerializedSize in interface com.google.protobuf.MessageLite

Overrides:

getSerializedSize in class com.google.protobuf.GeneratedMessageV3

equals

public boolean equals(Object obj)

Specified by:

equals in interface com.google.protobuf.Message

Overrides:

equals in class com.google.protobuf.AbstractMessage

hashCode

public int hashCode()

Specified by:

hashCode in interface com.google.protobuf.Message

Overrides:

hashCode in class com.google.protobuf.AbstractMessage

parseFrom

public static ListTimeSeriesRequest parseFrom(ByteBuffer data)
                                       throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static ListTimeSeriesRequest parseFrom(ByteBuffer data,
                                              com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                       throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static ListTimeSeriesRequest parseFrom(com.google.protobuf.ByteString data)
                                       throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static ListTimeSeriesRequest parseFrom(com.google.protobuf.ByteString data,
                                              com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                       throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static ListTimeSeriesRequest parseFrom(byte[] data)
                                       throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static ListTimeSeriesRequest parseFrom(byte[] data,
                                              com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                       throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static ListTimeSeriesRequest parseFrom(InputStream input)
                                       throws IOException

Throws:

IOException

parseFrom

public static ListTimeSeriesRequest parseFrom(InputStream input,
                                              com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                       throws IOException

Throws:

IOException

parseDelimitedFrom

public static ListTimeSeriesRequest parseDelimitedFrom(InputStream input)
                                                throws IOException

Throws:

IOException

parseDelimitedFrom

public static ListTimeSeriesRequest parseDelimitedFrom(InputStream input,
                                                       com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                throws IOException

Throws:

IOException

parseFrom

public static ListTimeSeriesRequest parseFrom(com.google.protobuf.CodedInputStream input)
                                       throws IOException

Throws:

IOException

parseFrom

public static ListTimeSeriesRequest parseFrom(com.google.protobuf.CodedInputStream input,
                                              com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                       throws IOException

Throws:

IOException

newBuilderForType

public ListTimeSeriesRequest.Builder newBuilderForType()

Specified by:

newBuilderForType in interface com.google.protobuf.Message

Specified by:

newBuilderForType in interface com.google.protobuf.MessageLite

newBuilder

public static ListTimeSeriesRequest.Builder newBuilder()

newBuilder

public static ListTimeSeriesRequest.Builder newBuilder(ListTimeSeriesRequest prototype)

toBuilder

public ListTimeSeriesRequest.Builder toBuilder()

Specified by:

toBuilder in interface com.google.protobuf.Message

Specified by:

toBuilder in interface com.google.protobuf.MessageLite

newBuilderForType

protected ListTimeSeriesRequest.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)

Specified by:

newBuilderForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstance

public static ListTimeSeriesRequest getDefaultInstance()

parser

public static com.google.protobuf.Parser<ListTimeSeriesRequest> parser()

getParserForType

public com.google.protobuf.Parser<ListTimeSeriesRequest> getParserForType()

Specified by:

getParserForType in interface com.google.protobuf.Message

Specified by:

getParserForType in interface com.google.protobuf.MessageLite

Overrides:

getParserForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstanceForType

public ListTimeSeriesRequest getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder