ListTimeSeriesRequest.Builder (proto-google-cloud-monitoring-v3 3.46.0 API)

java.lang.Object
- com.google.protobuf.AbstractMessageLite.Builder
- - com.google.protobuf.AbstractMessage.Builder<BuilderT>
  - - com.google.protobuf.GeneratedMessageV3.Builder<ListTimeSeriesRequest.Builder>
    - - com.google.monitoring.v3.ListTimeSeriesRequest.Builder

All Implemented Interfaces:

ListTimeSeriesRequestOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable

Enclosing class:

ListTimeSeriesRequest
```
public static final class ListTimeSeriesRequest.Builder
extends com.google.protobuf.GeneratedMessageV3.Builder<ListTimeSeriesRequest.Builder>
implements ListTimeSeriesRequestOrBuilder
```
```
 The `ListTimeSeries` request.
 
```
Protobuf type google.monitoring.v3.ListTimeSeriesRequest

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`ListTimeSeriesRequest.Builder`	`addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)`
`ListTimeSeriesRequest`	`build()`
`ListTimeSeriesRequest`	`buildPartial()`
`ListTimeSeriesRequest.Builder`	`clear()`
`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.
`ListTimeSeriesRequest.Builder`	`clearField(com.google.protobuf.Descriptors.FieldDescriptor field)`
`ListTimeSeriesRequest.Builder`	`clearFilter()` Required.
`ListTimeSeriesRequest.Builder`	`clearInterval()` Required.
`ListTimeSeriesRequest.Builder`	`clearName()` Required.
`ListTimeSeriesRequest.Builder`	`clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)`
`ListTimeSeriesRequest.Builder`	`clearOrderBy()` Unsupported: must be left blank.
`ListTimeSeriesRequest.Builder`	`clearPageSize()` A positive number that is the maximum number of results to return.
`ListTimeSeriesRequest.Builder`	`clearPageToken()` If this field is not empty then it must contain the `nextPageToken` value returned by a previous call to this method.
`ListTimeSeriesRequest.Builder`	`clearSecondaryAggregation()` Apply a second aggregation after `aggregation` is applied.
`ListTimeSeriesRequest.Builder`	`clearView()` Required.
`ListTimeSeriesRequest.Builder`	`clone()`
`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.
`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.
`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.
`ListTimeSeriesRequest`	`getDefaultInstanceForType()`
`static com.google.protobuf.Descriptors.Descriptor`	`getDescriptor()`
`com.google.protobuf.Descriptors.Descriptor`	`getDescriptorForType()`
`String`	`getFilter()` Required.
`com.google.protobuf.ByteString`	`getFilterBytes()` Required.
`TimeInterval`	`getInterval()` Required.
`TimeInterval.Builder`	`getIntervalBuilder()` 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.
`Aggregation`	`getSecondaryAggregation()` Apply a second aggregation after `aggregation` is applied.
`Aggregation.Builder`	`getSecondaryAggregationBuilder()` Apply a second aggregation after `aggregation` is applied.
`AggregationOrBuilder`	`getSecondaryAggregationOrBuilder()` Apply a second aggregation after `aggregation` is applied.
`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.
`boolean`	`hasInterval()` Required.
`boolean`	`hasSecondaryAggregation()` Apply a second aggregation after `aggregation` is applied.
`protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable`	`internalGetFieldAccessorTable()`
`boolean`	`isInitialized()`
`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.
`ListTimeSeriesRequest.Builder`	`mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`ListTimeSeriesRequest.Builder`	`mergeFrom(ListTimeSeriesRequest other)`
`ListTimeSeriesRequest.Builder`	`mergeFrom(com.google.protobuf.Message other)`
`ListTimeSeriesRequest.Builder`	`mergeInterval(TimeInterval value)` Required.
`ListTimeSeriesRequest.Builder`	`mergeSecondaryAggregation(Aggregation value)` Apply a second aggregation after `aggregation` is applied.
`ListTimeSeriesRequest.Builder`	`mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)`
`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.
`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.
`ListTimeSeriesRequest.Builder`	`setField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)`
`ListTimeSeriesRequest.Builder`	`setFilter(String value)` Required.
`ListTimeSeriesRequest.Builder`	`setFilterBytes(com.google.protobuf.ByteString value)` Required.
`ListTimeSeriesRequest.Builder`	`setInterval(TimeInterval.Builder builderForValue)` Required.
`ListTimeSeriesRequest.Builder`	`setInterval(TimeInterval value)` Required.
`ListTimeSeriesRequest.Builder`	`setName(String value)` Required.
`ListTimeSeriesRequest.Builder`	`setNameBytes(com.google.protobuf.ByteString value)` Required.
`ListTimeSeriesRequest.Builder`	`setOrderBy(String value)` Unsupported: must be left blank.
`ListTimeSeriesRequest.Builder`	`setOrderByBytes(com.google.protobuf.ByteString value)` Unsupported: must be left blank.
`ListTimeSeriesRequest.Builder`	`setPageSize(int value)` A positive number that is the maximum number of results to return.
`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.
`ListTimeSeriesRequest.Builder`	`setPageTokenBytes(com.google.protobuf.ByteString value)` If this field is not empty then it must contain the `nextPageToken` value returned by a previous call to this method.
`ListTimeSeriesRequest.Builder`	`setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value)`
`ListTimeSeriesRequest.Builder`	`setSecondaryAggregation(Aggregation.Builder builderForValue)` Apply a second aggregation after `aggregation` is applied.
`ListTimeSeriesRequest.Builder`	`setSecondaryAggregation(Aggregation value)` Apply a second aggregation after `aggregation` is applied.
`ListTimeSeriesRequest.Builder`	`setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)`
`ListTimeSeriesRequest.Builder`	`setView(ListTimeSeriesRequest.TimeSeriesView value)` Required.
`ListTimeSeriesRequest.Builder`	`setViewValue(int value)` Required.

Methods inherited from class com.google.protobuf.GeneratedMessageV3.Builder
getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, getUnknownFieldSetBuilder, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, internalGetMutableMapField, internalGetMutableMapFieldReflection, isClean, markClean, mergeUnknownLengthDelimitedField, mergeUnknownVarintField, newBuilderForField, onBuilt, onChanged, parseUnknownField, setUnknownFieldSetBuilder, setUnknownFieldsProto3

Methods inherited from class com.google.protobuf.AbstractMessage.Builder
findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite.Builder
addAll, addAll, mergeDelimitedFrom, mergeDelimitedFrom, newUninitializedMessageException

Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.Message.Builder
mergeDelimitedFrom, mergeDelimitedFrom

Method Detail

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

clear
```
public ListTimeSeriesRequest.Builder clear()
```
Specified by:

clear in interface com.google.protobuf.Message.Builder

Specified by:

clear in interface com.google.protobuf.MessageLite.Builder

Overrides:

clear in class com.google.protobuf.GeneratedMessageV3.Builder<ListTimeSeriesRequest.Builder>

getDescriptorForType
```
public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
```
Specified by:

getDescriptorForType in interface com.google.protobuf.Message.Builder

Specified by:

getDescriptorForType in interface com.google.protobuf.MessageOrBuilder

Overrides:

getDescriptorForType in class com.google.protobuf.GeneratedMessageV3.Builder<ListTimeSeriesRequest.Builder>

getDefaultInstanceForType
```
public ListTimeSeriesRequest getDefaultInstanceForType()
```
Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder

build
```
public ListTimeSeriesRequest build()
```
Specified by:

build in interface com.google.protobuf.Message.Builder

Specified by:

build in interface com.google.protobuf.MessageLite.Builder

buildPartial
```
public ListTimeSeriesRequest buildPartial()
```
Specified by:

buildPartial in interface com.google.protobuf.Message.Builder

Specified by:

buildPartial in interface com.google.protobuf.MessageLite.Builder

clone
```
public ListTimeSeriesRequest.Builder clone()
```
Specified by:

clone in interface com.google.protobuf.Message.Builder

Specified by:

clone in interface com.google.protobuf.MessageLite.Builder

Overrides:

clone in class com.google.protobuf.GeneratedMessageV3.Builder<ListTimeSeriesRequest.Builder>

setField

public ListTimeSeriesRequest.Builder setField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                              Object value)

Specified by:: setField in interface com.google.protobuf.Message.Builder
Overrides:: setField in class com.google.protobuf.GeneratedMessageV3.Builder<ListTimeSeriesRequest.Builder>

clearField
```
public ListTimeSeriesRequest.Builder clearField(com.google.protobuf.Descriptors.FieldDescriptor field)
```
Specified by:

clearField in interface com.google.protobuf.Message.Builder

Overrides:

clearField in class com.google.protobuf.GeneratedMessageV3.Builder<ListTimeSeriesRequest.Builder>

clearOneof
```
public ListTimeSeriesRequest.Builder clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)
```
Specified by:

clearOneof in interface com.google.protobuf.Message.Builder

Overrides:

clearOneof in class com.google.protobuf.GeneratedMessageV3.Builder<ListTimeSeriesRequest.Builder>

setRepeatedField

public ListTimeSeriesRequest.Builder setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                                      int index,
                                                      Object value)

Specified by:: setRepeatedField in interface com.google.protobuf.Message.Builder
Overrides:: setRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<ListTimeSeriesRequest.Builder>

addRepeatedField

public ListTimeSeriesRequest.Builder addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                                      Object value)

Specified by:: addRepeatedField in interface com.google.protobuf.Message.Builder
Overrides:: addRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<ListTimeSeriesRequest.Builder>

mergeFrom
```
public ListTimeSeriesRequest.Builder mergeFrom(com.google.protobuf.Message other)
```
Specified by:

mergeFrom in interface com.google.protobuf.Message.Builder

Overrides:

mergeFrom in class com.google.protobuf.AbstractMessage.Builder<ListTimeSeriesRequest.Builder>

mergeFrom

public ListTimeSeriesRequest.Builder mergeFrom(ListTimeSeriesRequest other)

isInitialized
```
public final boolean isInitialized()
```
Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessageV3.Builder<ListTimeSeriesRequest.Builder>

mergeFrom
```
public ListTimeSeriesRequest.Builder mergeFrom(com.google.protobuf.CodedInputStream input,
                                               com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                        throws IOException
```
Specified by:

mergeFrom in interface com.google.protobuf.Message.Builder

Specified by:

mergeFrom in interface com.google.protobuf.MessageLite.Builder

Overrides:

mergeFrom in class com.google.protobuf.AbstractMessage.Builder<ListTimeSeriesRequest.Builder>

Throws:

IOException

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.

setName

public ListTimeSeriesRequest.Builder setName(String value)

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

Parameters:: value - The name to set.
Returns:: This builder for chaining.

clearName

public ListTimeSeriesRequest.Builder clearName()

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

Returns:: This builder for chaining.

setNameBytes

public ListTimeSeriesRequest.Builder setNameBytes(com.google.protobuf.ByteString value)

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

Parameters:: value - The bytes for name to set.
Returns:: This builder for chaining.

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.

setFilter

public ListTimeSeriesRequest.Builder setFilter(String value)

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

Parameters:: value - The filter to set.
Returns:: This builder for chaining.

clearFilter

public ListTimeSeriesRequest.Builder clearFilter()

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

Returns:: This builder for chaining.

setFilterBytes

public ListTimeSeriesRequest.Builder setFilterBytes(com.google.protobuf.ByteString value)

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

Parameters:: value - The bytes for filter to set.
Returns:: This builder for chaining.

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.

setInterval

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

setInterval

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

mergeInterval

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

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

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

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