Package com.google.monitoring.v3

Class 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

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

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

      • 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

      • newBuilderForType

        public ListTimeSeriesRequest.Builder newBuilderForType()
        Specified by:
        newBuilderForType in interface com.google.protobuf.Message
        Specified by:
        newBuilderForType in interface com.google.protobuf.MessageLite

      • 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

      • 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