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
FILTER_FIELD_NUMBER
public static final int FILTER_FIELD_NUMBER
Field Value
INTERVAL_FIELD_NUMBER
public static final int INTERVAL_FIELD_NUMBER
Field Value
NAME_FIELD_NUMBER
public static final int NAME_FIELD_NUMBER
Field Value
ORDER_BY_FIELD_NUMBER
public static final int ORDER_BY_FIELD_NUMBER
Field Value
PAGE_SIZE_FIELD_NUMBER
public static final int PAGE_SIZE_FIELD_NUMBER
Field Value
PAGE_TOKEN_FIELD_NUMBER
public static final int PAGE_TOKEN_FIELD_NUMBER
Field Value
SECONDARY_AGGREGATION_FIELD_NUMBER
public static final int SECONDARY_AGGREGATION_FIELD_NUMBER
Field Value
VIEW_FIELD_NUMBER
public static final int VIEW_FIELD_NUMBER
Field Value
Static Methods
getDefaultInstance()
public static ListTimeSeriesRequest getDefaultInstance()
Returns
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Returns
newBuilder()
public static ListTimeSeriesRequest.Builder newBuilder()
Returns
newBuilder(ListTimeSeriesRequest prototype)
public static ListTimeSeriesRequest.Builder newBuilder(ListTimeSeriesRequest prototype)
Parameter
Returns
public static ListTimeSeriesRequest parseDelimitedFrom(InputStream input)
Parameter
Returns
Exceptions
public static ListTimeSeriesRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(byte[] data)
public static ListTimeSeriesRequest parseFrom(byte[] data)
Parameter
| Name | Description |
| data | byte[]
|
Returns
Exceptions
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static ListTimeSeriesRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteString data)
public static ListTimeSeriesRequest parseFrom(ByteString data)
Parameter
Returns
Exceptions
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static ListTimeSeriesRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static ListTimeSeriesRequest parseFrom(CodedInputStream input)
Parameter
Returns
Exceptions
public static ListTimeSeriesRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static ListTimeSeriesRequest parseFrom(InputStream input)
Parameter
Returns
Exceptions
public static ListTimeSeriesRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteBuffer data)
public static ListTimeSeriesRequest parseFrom(ByteBuffer data)
Parameter
Returns
Exceptions
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static ListTimeSeriesRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parser()
public static Parser<ListTimeSeriesRequest> parser()
Returns
Methods
equals(Object obj)
public boolean equals(Object obj)
Parameter
Returns
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;
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;
getDefaultInstanceForType()
public ListTimeSeriesRequest getDefaultInstanceForType()
Returns
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];
| 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];
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];
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];
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) = { ... }
| 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) = { ... }
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;
| 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;
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;
| 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;
| 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;
getParserForType()
public Parser<ListTimeSeriesRequest> getParserForType()
Returns
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;
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;
getSerializedSize()
public int getSerializedSize()
Returns
Overrides
getUnknownFields()
public final UnknownFieldSet getUnknownFields()
Returns
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];
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];
| 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;
| 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];
| 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;
| Type | Description |
| boolean | Whether the secondaryAggregation field is set.
|
hashCode()
Returns
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Overrides
isInitialized()
public final boolean isInitialized()
Returns
Overrides
newBuilderForType()
public ListTimeSeriesRequest.Builder newBuilderForType()
Returns
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected ListTimeSeriesRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Returns
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Returns
Overrides
toBuilder()
public ListTimeSeriesRequest.Builder toBuilder()
Returns
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Parameter
Overrides
Exceptions
