Class ListTimeSeriesRequest.Builder (3.56.0) 

public static final class ListTimeSeriesRequest.Builder extends GeneratedMessageV3.Builder<ListTimeSeriesRequest.Builder> implements ListTimeSeriesRequestOrBuilder

The ListTimeSeries request.

Protobuf type google.monitoring.v3.ListTimeSeriesRequest

Inheritance

Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > ListTimeSeriesRequest.Builder

Static Methods

getDescriptor()

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

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public ListTimeSeriesRequest.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
ListTimeSeriesRequest.Builder
Overrides

build()

public ListTimeSeriesRequest build()
Returns
Type Description
ListTimeSeriesRequest

buildPartial()

public ListTimeSeriesRequest buildPartial()
Returns
Type Description
ListTimeSeriesRequest

clear()

public ListTimeSeriesRequest.Builder clear()
Returns
Type Description
ListTimeSeriesRequest.Builder
Overrides

clearAggregation()

public ListTimeSeriesRequest.Builder clearAggregation()

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
ListTimeSeriesRequest.Builder

clearField(Descriptors.FieldDescriptor field)

public ListTimeSeriesRequest.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
ListTimeSeriesRequest.Builder
Overrides

clearFilter()

public ListTimeSeriesRequest.Builder clearFilter()

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
ListTimeSeriesRequest.Builder

This builder for chaining.

clearInterval()

public ListTimeSeriesRequest.Builder clearInterval()

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
ListTimeSeriesRequest.Builder

clearName()

public ListTimeSeriesRequest.Builder clearName()

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
ListTimeSeriesRequest.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public ListTimeSeriesRequest.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
ListTimeSeriesRequest.Builder
Overrides

clearOrderBy()

public ListTimeSeriesRequest.Builder clearOrderBy()

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
ListTimeSeriesRequest.Builder

This builder for chaining.

clearPageSize()

public ListTimeSeriesRequest.Builder clearPageSize()

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
ListTimeSeriesRequest.Builder

This builder for chaining.

clearPageToken()

public ListTimeSeriesRequest.Builder clearPageToken()

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
ListTimeSeriesRequest.Builder

This builder for chaining.

clearSecondaryAggregation()

public ListTimeSeriesRequest.Builder clearSecondaryAggregation()

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
ListTimeSeriesRequest.Builder

clearView()

public ListTimeSeriesRequest.Builder clearView()

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

This builder for chaining.

clone()

public ListTimeSeriesRequest.Builder clone()
Returns
Type Description
ListTimeSeriesRequest.Builder
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.

getAggregationBuilder()

public Aggregation.Builder getAggregationBuilder()

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

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

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

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.

getIntervalBuilder()

public TimeInterval.Builder getIntervalBuilder()

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

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.

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.

getSecondaryAggregationBuilder()

public Aggregation.Builder getSecondaryAggregationBuilder()

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

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

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.

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeAggregation(Aggregation value)

public ListTimeSeriesRequest.Builder mergeAggregation(Aggregation value)

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;

Parameter
Name Description
value Aggregation
Returns
Type Description
ListTimeSeriesRequest.Builder

mergeFrom(ListTimeSeriesRequest other)

public ListTimeSeriesRequest.Builder mergeFrom(ListTimeSeriesRequest other)
Parameter
Name Description
other ListTimeSeriesRequest
Returns
Type Description
ListTimeSeriesRequest.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public ListTimeSeriesRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ListTimeSeriesRequest.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public ListTimeSeriesRequest.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
ListTimeSeriesRequest.Builder
Overrides

mergeInterval(TimeInterval value)

public ListTimeSeriesRequest.Builder mergeInterval(TimeInterval value)

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

Parameter
Name Description
value TimeInterval
Returns
Type Description
ListTimeSeriesRequest.Builder

mergeSecondaryAggregation(Aggregation value)

public ListTimeSeriesRequest.Builder mergeSecondaryAggregation(Aggregation value)

Apply a second aggregation after aggregation is applied. May only be specified if aggregation is specified.

.google.monitoring.v3.Aggregation secondary_aggregation = 11;

Parameter
Name Description
value Aggregation
Returns
Type Description
ListTimeSeriesRequest.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final ListTimeSeriesRequest.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
ListTimeSeriesRequest.Builder
Overrides

setAggregation(Aggregation value)

public ListTimeSeriesRequest.Builder setAggregation(Aggregation value)

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;

Parameter
Name Description
value Aggregation
Returns
Type Description
ListTimeSeriesRequest.Builder

setAggregation(Aggregation.Builder builderForValue)

public ListTimeSeriesRequest.Builder setAggregation(Aggregation.Builder builderForValue)

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;

Parameter
Name Description
builderForValue Aggregation.Builder
Returns
Type Description
ListTimeSeriesRequest.Builder

setField(Descriptors.FieldDescriptor field, Object value)

public ListTimeSeriesRequest.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
ListTimeSeriesRequest.Builder
Overrides

setFilter(String value)

public ListTimeSeriesRequest.Builder setFilter(String value)

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

Parameter
Name Description
value String

The filter to set.
Returns
Type Description
ListTimeSeriesRequest.Builder

This builder for chaining.

setFilterBytes(ByteString value)

public ListTimeSeriesRequest.Builder setFilterBytes(ByteString value)

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

Parameter
Name Description
value ByteString

The bytes for filter to set.
Returns
Type Description
ListTimeSeriesRequest.Builder

This builder for chaining.

setInterval(TimeInterval value)

public ListTimeSeriesRequest.Builder setInterval(TimeInterval value)

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

Parameter
Name Description
value TimeInterval
Returns
Type Description
ListTimeSeriesRequest.Builder

setInterval(TimeInterval.Builder builderForValue)

public ListTimeSeriesRequest.Builder setInterval(TimeInterval.Builder builderForValue)

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

Parameter
Name Description
builderForValue TimeInterval.Builder
Returns
Type Description
ListTimeSeriesRequest.Builder

setName(String value)

public ListTimeSeriesRequest.Builder setName(String value)

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

Parameter
Name Description
value String

The name to set.
Returns
Type Description
ListTimeSeriesRequest.Builder

This builder for chaining.

setNameBytes(ByteString value)

public ListTimeSeriesRequest.Builder setNameBytes(ByteString value)

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

Parameter
Name Description
value ByteString

The bytes for name to set.
Returns
Type Description
ListTimeSeriesRequest.Builder

This builder for chaining.

setOrderBy(String value)

public ListTimeSeriesRequest.Builder setOrderBy(String value)

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;

Parameter
Name Description
value String

The orderBy to set.
Returns
Type Description
ListTimeSeriesRequest.Builder

This builder for chaining.

setOrderByBytes(ByteString value)

public ListTimeSeriesRequest.Builder setOrderByBytes(ByteString value)

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;

Parameter
Name Description
value ByteString

The bytes for orderBy to set.
Returns
Type Description
ListTimeSeriesRequest.Builder

This builder for chaining.

setPageSize(int value)

public ListTimeSeriesRequest.Builder setPageSize(int value)

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;

Parameter
Name Description
value int

The pageSize to set.
Returns
Type Description
ListTimeSeriesRequest.Builder

This builder for chaining.

setPageToken(String value)

public ListTimeSeriesRequest.Builder setPageToken(String value)

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;

Parameter
Name Description
value String

The pageToken to set.
Returns
Type Description
ListTimeSeriesRequest.Builder

This builder for chaining.

setPageTokenBytes(ByteString value)

public ListTimeSeriesRequest.Builder setPageTokenBytes(ByteString value)

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;

Parameter
Name Description
value ByteString

The bytes for pageToken to set.
Returns
Type Description
ListTimeSeriesRequest.Builder

This builder for chaining.

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public ListTimeSeriesRequest.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
ListTimeSeriesRequest.Builder
Overrides

setSecondaryAggregation(Aggregation value)

public ListTimeSeriesRequest.Builder setSecondaryAggregation(Aggregation value)

Apply a second aggregation after aggregation is applied. May only be specified if aggregation is specified.

.google.monitoring.v3.Aggregation secondary_aggregation = 11;

Parameter
Name Description
value Aggregation
Returns
Type Description
ListTimeSeriesRequest.Builder

setSecondaryAggregation(Aggregation.Builder builderForValue)

public ListTimeSeriesRequest.Builder setSecondaryAggregation(Aggregation.Builder builderForValue)

Apply a second aggregation after aggregation is applied. May only be specified if aggregation is specified.

.google.monitoring.v3.Aggregation secondary_aggregation = 11;

Parameter
Name Description
builderForValue Aggregation.Builder
Returns
Type Description
ListTimeSeriesRequest.Builder

setUnknownFields(UnknownFieldSet unknownFields)

public final ListTimeSeriesRequest.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
ListTimeSeriesRequest.Builder
Overrides

setView(ListTimeSeriesRequest.TimeSeriesView value)

public ListTimeSeriesRequest.Builder setView(ListTimeSeriesRequest.TimeSeriesView value)

Required. Specifies which information is returned about the time series.

.google.monitoring.v3.ListTimeSeriesRequest.TimeSeriesView view = 7 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
value ListTimeSeriesRequest.TimeSeriesView

The view to set.
Returns
Type Description
ListTimeSeriesRequest.Builder

This builder for chaining.

setViewValue(int value)

public ListTimeSeriesRequest.Builder setViewValue(int value)

Required. Specifies which information is returned about the time series.

.google.monitoring.v3.ListTimeSeriesRequest.TimeSeriesView view = 7 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
value int

The enum numeric value on the wire for view to set.
Returns
Type Description
ListTimeSeriesRequest.Builder

This builder for chaining.