Class ListMetricDescriptorsRequest.Builder (3.58.0) 

public static final class ListMetricDescriptorsRequest.Builder extends GeneratedMessageV3.Builder<ListMetricDescriptorsRequest.Builder> implements ListMetricDescriptorsRequestOrBuilder

The ListMetricDescriptors request.

Protobuf type google.monitoring.v3.ListMetricDescriptorsRequest

Inheritance

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

Static Methods

getDescriptor()

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

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

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

build()

public ListMetricDescriptorsRequest build()
Returns
Type Description
ListMetricDescriptorsRequest

buildPartial()

public ListMetricDescriptorsRequest buildPartial()
Returns
Type Description
ListMetricDescriptorsRequest

clear()

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

clearActiveOnly()

public ListMetricDescriptorsRequest.Builder clearActiveOnly()

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
Type Description
ListMetricDescriptorsRequest.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

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

clearFilter()

public ListMetricDescriptorsRequest.Builder clearFilter()

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/")

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

Returns
Type Description
ListMetricDescriptorsRequest.Builder

This builder for chaining.

clearName()

public ListMetricDescriptorsRequest.Builder clearName()

Required. The project 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
Type Description
ListMetricDescriptorsRequest.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

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

clearPageSize()

public ListMetricDescriptorsRequest.Builder clearPageSize()

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
Type Description
ListMetricDescriptorsRequest.Builder

This builder for chaining.

clearPageToken()

public ListMetricDescriptorsRequest.Builder clearPageToken()

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
Type Description
ListMetricDescriptorsRequest.Builder

This builder for chaining.

clone()

public ListMetricDescriptorsRequest.Builder clone()
Returns
Type Description
ListMetricDescriptorsRequest.Builder
Overrides

getActiveOnly()

public 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
Type Description
boolean

The activeOnly.

getDefaultInstanceForType()

public ListMetricDescriptorsRequest getDefaultInstanceForType()
Returns
Type Description
ListMetricDescriptorsRequest

getDescriptorForType()

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

getFilter()

public String getFilter()

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/")

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

Returns
Type Description
String

The filter.

getFilterBytes()

public ByteString getFilterBytes()

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/")

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

Returns
Type Description
ByteString

The bytes for filter.

getName()

public String getName()

Required. The project 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
Type Description
String

The name.

getNameBytes()

public ByteString getNameBytes()

Required. The project 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
Type Description
ByteString

The bytes for name.

getPageSize()

public 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
Type Description
int

The pageSize.

getPageToken()

public 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
Type Description
String

The pageToken.

getPageTokenBytes()

public 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
Type Description
ByteString

The bytes for pageToken.

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(ListMetricDescriptorsRequest other)

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

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

mergeFrom(Message other)

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

mergeUnknownFields(UnknownFieldSet unknownFields)

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

setActiveOnly(boolean value)

public ListMetricDescriptorsRequest.Builder setActiveOnly(boolean value)

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

Parameter
Name Description
value boolean

The activeOnly to set.
Returns
Type Description
ListMetricDescriptorsRequest.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

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

setFilter(String value)

public ListMetricDescriptorsRequest.Builder setFilter(String value)

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/")

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

Parameter
Name Description
value String

The filter to set.
Returns
Type Description
ListMetricDescriptorsRequest.Builder

This builder for chaining.

setFilterBytes(ByteString value)

public ListMetricDescriptorsRequest.Builder setFilterBytes(ByteString value)

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/")

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

Parameter
Name Description
value ByteString

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

This builder for chaining.

setName(String value)

public ListMetricDescriptorsRequest.Builder setName(String value)

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

Parameter
Name Description
value String

The name to set.
Returns
Type Description
ListMetricDescriptorsRequest.Builder

This builder for chaining.

setNameBytes(ByteString value)

public ListMetricDescriptorsRequest.Builder setNameBytes(ByteString value)

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

Parameter
Name Description
value ByteString

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

This builder for chaining.

setPageSize(int value)

public ListMetricDescriptorsRequest.Builder setPageSize(int value)

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

Parameter
Name Description
value int

The pageSize to set.
Returns
Type Description
ListMetricDescriptorsRequest.Builder

This builder for chaining.

setPageToken(String value)

public ListMetricDescriptorsRequest.Builder setPageToken(String value)

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

Parameter
Name Description
value String

The pageToken to set.
Returns
Type Description
ListMetricDescriptorsRequest.Builder

This builder for chaining.

setPageTokenBytes(ByteString value)

public ListMetricDescriptorsRequest.Builder setPageTokenBytes(ByteString value)

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

Parameter
Name Description
value ByteString

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

This builder for chaining.

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

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

setUnknownFields(UnknownFieldSet unknownFields)

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