Google Cloud Monitoring v3 API - Class ListTimeSeriesRequest (3.3.0)

public sealed class ListTimeSeriesRequest : IMessage<ListTimeSeriesRequest>, IEquatable<ListTimeSeriesRequest>, IDeepCloneable<ListTimeSeriesRequest>, IBufferMessage, IMessage, IPageRequest

Reference documentation and code samples for the Google Cloud Monitoring v3 API class ListTimeSeriesRequest.

The ListTimeSeries request.

Inheritance

object > ListTimeSeriesRequest

Implements

IMessage ListTimeSeriesRequest, IEquatable ListTimeSeriesRequest, IDeepCloneable ListTimeSeriesRequest, IBufferMessage, IMessage, IPageRequest

Inherited Members

object.GetHashCode()

object.GetType()

object.ToString()

Namespace

Google.Cloud.Monitoring.V3

Assembly

Google.Cloud.Monitoring.V3.dll

Constructors

ListTimeSeriesRequest()

public ListTimeSeriesRequest()

ListTimeSeriesRequest(ListTimeSeriesRequest)

public ListTimeSeriesRequest(ListTimeSeriesRequest other)

Parameter
Name	Description
`other`	`ListTimeSeriesRequest`

Properties

Aggregation

public Aggregation Aggregation { get; set; }

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.

Property Value
Type	Description
`Aggregation`

Filter

public string Filter { get; set; }

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"

Property Value
Type	Description
`string`

FolderName

public FolderName FolderName { get; set; }

FolderName-typed view over the Name resource name property.

Property Value
Type	Description
`FolderName`

Interval

public TimeInterval Interval { get; set; }

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.

Property Value
Type	Description
`TimeInterval`

Name

public string Name { get; set; }

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]

Property Value
Type	Description
`string`

OrderBy

public string OrderBy { get; set; }

Unsupported: must be left blank. The points in each time series are currently returned in reverse time order (most recent to oldest).

Property Value
Type	Description
`string`

OrganizationName

public OrganizationName OrganizationName { get; set; }

OrganizationName-typed view over the Name resource name property.

Property Value
Type	Description
`OrganizationName`

PageSize

public int PageSize { get; set; }

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.

Property Value
Type	Description
`int`

PageToken

public string PageToken { get; set; }

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.

Property Value
Type	Description
`string`

ProjectName

public ProjectName ProjectName { get; set; }

ProjectName-typed view over the Name resource name property.

Property Value
Type	Description
`ProjectName`

ResourceName

public IResourceName ResourceName { get; set; }

IResourceName-typed view over the Name resource name property.

Property Value
Type	Description
`IResourceName`

SecondaryAggregation

public Aggregation SecondaryAggregation { get; set; }

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

Property Value
Type	Description
`Aggregation`

View

public ListTimeSeriesRequest.Types.TimeSeriesView View { get; set; }

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

Property Value
Type	Description
`ListTimeSeriesRequestTypesTimeSeriesView`