Class ListMetricDescriptorsRequest.Builder (3.25.0)

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

The ListMetricDescriptors request.

Protobuf type google.monitoring.v3.ListMetricDescriptorsRequest

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public ListMetricDescriptorsRequest.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
ListMetricDescriptorsRequest.Builder
Overrides

build()

public ListMetricDescriptorsRequest build()
Returns
TypeDescription
ListMetricDescriptorsRequest

buildPartial()

public ListMetricDescriptorsRequest buildPartial()
Returns
TypeDescription
ListMetricDescriptorsRequest

clear()

public ListMetricDescriptorsRequest.Builder clear()
Returns
TypeDescription
ListMetricDescriptorsRequest.Builder
Overrides

clearField(Descriptors.FieldDescriptor field)

public ListMetricDescriptorsRequest.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
NameDescription
fieldFieldDescriptor
Returns
TypeDescription
ListMetricDescriptorsRequest.Builder
Overrides

clearFilter()

public ListMetricDescriptorsRequest.Builder clearFilter()

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;

Returns
TypeDescription
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
TypeDescription
ListMetricDescriptorsRequest.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public ListMetricDescriptorsRequest.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
NameDescription
oneofOneofDescriptor
Returns
TypeDescription
ListMetricDescriptorsRequest.Builder
Overrides

clearPageSize()

public ListMetricDescriptorsRequest.Builder clearPageSize()

A positive number that is the maximum number of results to return.

int32 page_size = 3;

Returns
TypeDescription
ListMetricDescriptorsRequest.Builder

This builder for chaining.

clearPageToken()

public ListMetricDescriptorsRequest.Builder clearPageToken()

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;

Returns
TypeDescription
ListMetricDescriptorsRequest.Builder

This builder for chaining.

clone()

public ListMetricDescriptorsRequest.Builder clone()
Returns
TypeDescription
ListMetricDescriptorsRequest.Builder
Overrides

getDefaultInstanceForType()

public ListMetricDescriptorsRequest getDefaultInstanceForType()
Returns
TypeDescription
ListMetricDescriptorsRequest

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
TypeDescription
Descriptor
Overrides

getFilter()

public String getFilter()

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;

Returns
TypeDescription
String

The filter.

getFilterBytes()

public ByteString getFilterBytes()

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;

Returns
TypeDescription
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
TypeDescription
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
TypeDescription
ByteString

The bytes for name.

getPageSize()

public int getPageSize()

A positive number that is the maximum number of results to return.

int32 page_size = 3;

Returns
TypeDescription
int

The pageSize.

getPageToken()

public String getPageToken()

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;

Returns
TypeDescription
String

The pageToken.

getPageTokenBytes()

public ByteString getPageTokenBytes()

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;

Returns
TypeDescription
ByteString

The bytes for pageToken.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

mergeFrom(ListMetricDescriptorsRequest other)

public ListMetricDescriptorsRequest.Builder mergeFrom(ListMetricDescriptorsRequest other)
Parameter
NameDescription
otherListMetricDescriptorsRequest
Returns
TypeDescription
ListMetricDescriptorsRequest.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public ListMetricDescriptorsRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ListMetricDescriptorsRequest.Builder
Overrides
Exceptions
TypeDescription
IOException

mergeFrom(Message other)

public ListMetricDescriptorsRequest.Builder mergeFrom(Message other)
Parameter
NameDescription
otherMessage
Returns
TypeDescription
ListMetricDescriptorsRequest.Builder
Overrides

mergeUnknownFields(UnknownFieldSet unknownFields)

public final ListMetricDescriptorsRequest.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
ListMetricDescriptorsRequest.Builder
Overrides

setField(Descriptors.FieldDescriptor field, Object value)

public ListMetricDescriptorsRequest.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
ListMetricDescriptorsRequest.Builder
Overrides

setFilter(String value)

public ListMetricDescriptorsRequest.Builder setFilter(String value)

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;

Parameter
NameDescription
valueString

The filter to set.

Returns
TypeDescription
ListMetricDescriptorsRequest.Builder

This builder for chaining.

setFilterBytes(ByteString value)

public ListMetricDescriptorsRequest.Builder setFilterBytes(ByteString value)

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;

Parameter
NameDescription
valueByteString

The bytes for filter to set.

Returns
TypeDescription
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
NameDescription
valueString

The name to set.

Returns
TypeDescription
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
NameDescription
valueByteString

The bytes for name to set.

Returns
TypeDescription
ListMetricDescriptorsRequest.Builder

This builder for chaining.

setPageSize(int value)

public ListMetricDescriptorsRequest.Builder setPageSize(int value)

A positive number that is the maximum number of results to return.

int32 page_size = 3;

Parameter
NameDescription
valueint

The pageSize to set.

Returns
TypeDescription
ListMetricDescriptorsRequest.Builder

This builder for chaining.

setPageToken(String value)

public ListMetricDescriptorsRequest.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. Using this field causes the method to return additional results from the previous method call.

string page_token = 4;

Parameter
NameDescription
valueString

The pageToken to set.

Returns
TypeDescription
ListMetricDescriptorsRequest.Builder

This builder for chaining.

setPageTokenBytes(ByteString value)

public ListMetricDescriptorsRequest.Builder setPageTokenBytes(ByteString value)

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;

Parameter
NameDescription
valueByteString

The bytes for pageToken to set.

Returns
TypeDescription
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
NameDescription
fieldFieldDescriptor
indexint
valueObject
Returns
TypeDescription
ListMetricDescriptorsRequest.Builder
Overrides

setUnknownFields(UnknownFieldSet unknownFields)

public final ListMetricDescriptorsRequest.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
ListMetricDescriptorsRequest.Builder
Overrides