com.google.monitoring.v3

Interface ListMetricDescriptorsRequestOrBuilder

All Superinterfaces:

com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder

All Known Implementing Classes:

ListMetricDescriptorsRequest, ListMetricDescriptorsRequest.Builder

public interface ListMetricDescriptorsRequestOrBuilder
extends com.google.protobuf.MessageOrBuilder

Method Summary

Modifier and Type	Method and Description
boolean	getActiveOnly() Optional.
String	getFilter() Optional.
com.google.protobuf.ByteString	getFilterBytes() Optional.
String	getName() Required.
com.google.protobuf.ByteString	getNameBytes() Required.
int	getPageSize() Optional.
String	getPageToken() Optional.
com.google.protobuf.ByteString	getPageTokenBytes() Optional.

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

isInitialized

Method Detail

getName

String getName()

 Required. The
 [project](https://cloud.google.com/monitoring/api/v3#project_name) on which
 to execute the request. The format is:

     projects/[PROJECT_ID_OR_NUMBER]
 

string name = 5 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns:

The name.

getNameBytes

com.google.protobuf.ByteString getNameBytes()

 Required. The
 [project](https://cloud.google.com/monitoring/api/v3#project_name) on which
 to execute the request. The format is:

     projects/[PROJECT_ID_OR_NUMBER]
 

string name = 5 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns:

The bytes for name.

getFilter

String getFilter()

 Optional. If this field is empty, all custom and
 system-defined metric descriptors are returned.
 Otherwise, the [filter](https://cloud.google.com/monitoring/api/v3/filters)
 specifies which metric descriptors are to be
 returned. For example, the following filter matches all
 [custom metrics](https://cloud.google.com/monitoring/custom-metrics):

     metric.type = starts_with("custom.googleapis.com/")
 

string filter = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns:

The filter.

getFilterBytes

com.google.protobuf.ByteString getFilterBytes()

 Optional. If this field is empty, all custom and
 system-defined metric descriptors are returned.
 Otherwise, the [filter](https://cloud.google.com/monitoring/api/v3/filters)
 specifies which metric descriptors are to be
 returned. For example, the following filter matches all
 [custom metrics](https://cloud.google.com/monitoring/custom-metrics):

     metric.type = starts_with("custom.googleapis.com/")
 

string filter = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns:

The bytes for filter.

getPageSize

int getPageSize()

 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.
 

int32 page_size = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns:

The pageSize.

getPageToken

String getPageToken()

 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.
 

string page_token = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns:

The pageToken.

getPageTokenBytes

com.google.protobuf.ByteString getPageTokenBytes()

 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.
 

string page_token = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns:

The bytes for pageToken.

getActiveOnly

boolean getActiveOnly()

 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.
 

bool active_only = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns:

The activeOnly.