Google Cloud Monitoring v3 API - Class ListMetricDescriptorsRequest (3.14.0) 

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

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

The ListMetricDescriptors request.

Inheritance

object > ListMetricDescriptorsRequest

Namespace

Google.Cloud.Monitoring.V3

Assembly

Google.Cloud.Monitoring.V3.dll

Constructors

ListMetricDescriptorsRequest()

public ListMetricDescriptorsRequest()

ListMetricDescriptorsRequest(ListMetricDescriptorsRequest)

public ListMetricDescriptorsRequest(ListMetricDescriptorsRequest other)
Parameter
Name Description
other ListMetricDescriptorsRequest

Properties

ActiveOnly

public bool ActiveOnly { get; set; }

Optional. If true, only metrics and monitored resource types that have recent data (within roughly 25 hours) will be included in the response.

  • If a metric descriptor enumerates monitored resource types, only the monitored resource types for which the metric type has recent data will be included in the returned metric descriptor, and if none of them have recent data, the metric descriptor will not be returned.
  • If a metric descriptor does not enumerate the compatible monitored resource types, it will be returned only if the metric type has recent data for some monitored resource type. The returned descriptor will not enumerate any monitored resource types.
Property Value
Type Description
bool

Filter

public string Filter { get; set; }

Optional. If this field is empty, all custom and system-defined metric descriptors are returned. Otherwise, the filter specifies which metric descriptors are to be returned. For example, the following filter matches all custom metrics:

metric.type = starts_with("custom.googleapis.com/")
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

Name

public string Name { get; set; }

Required. The project on which to execute the request. The format is:

projects/[PROJECT_ID_OR_NUMBER]
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; }

Optional. A positive number that is the maximum number of results to return. The default and maximum value is 10,000. If a page_size <= 0 or > 10,000 is submitted, will instead return a maximum of 10,000 results.

Property Value
Type Description
int

PageToken

public string PageToken { get; set; }

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