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.BuilderImplements
ListMetricDescriptorsRequestOrBuilderStatic 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 |
|
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 |
|
clearField(Descriptors.FieldDescriptor field)
public ListMetricDescriptorsRequest.Builder clearField(Descriptors.FieldDescriptor field)| Parameter | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
| Returns | |
|---|---|
| Type | Description |
ListMetricDescriptorsRequest.Builder |
|
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 | |
|---|---|
| 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 |
|
clearPageSize()
public ListMetricDescriptorsRequest.Builder clearPageSize()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;
| Returns | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Type | Description |
ListMetricDescriptorsRequest.Builder |
This builder for chaining. |
clone()
public ListMetricDescriptorsRequest.Builder clone()| Returns | |
|---|---|
| Type | Description |
ListMetricDescriptorsRequest.Builder |
|
getDefaultInstanceForType()
public ListMetricDescriptorsRequest getDefaultInstanceForType()| Returns | |
|---|---|
| Type | Description |
ListMetricDescriptorsRequest |
|
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
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 | |
|---|---|
| Type | Description |
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 | |
|---|---|
| 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()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;
| Returns | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Type | Description |
ByteString |
The bytes for pageToken. |
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()| Returns | |
|---|---|
| Type | Description |
FieldAccessorTable |
|
isInitialized()
public final boolean isInitialized()| Returns | |
|---|---|
| Type | Description |
boolean |
|
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 |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
mergeFrom(Message other)
public ListMetricDescriptorsRequest.Builder mergeFrom(Message other)| Parameter | |
|---|---|
| Name | Description |
other |
Message |
| Returns | |
|---|---|
| Type | Description |
ListMetricDescriptorsRequest.Builder |
|
mergeUnknownFields(UnknownFieldSet unknownFields)
public final ListMetricDescriptorsRequest.Builder mergeUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields |
UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
ListMetricDescriptorsRequest.Builder |
|
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 |
|
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 | |
|---|---|
| Name | Description |
value |
StringThe filter to set. |
| Returns | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Name | Description |
value |
ByteStringThe 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 |
StringThe 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 |
ByteStringThe bytes for name to set. |
| Returns | |
|---|---|
| Type | Description |
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. 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;
| Parameter | |
|---|---|
| Name | Description |
value |
intThe pageSize to set. |
| Returns | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Name | Description |
value |
StringThe pageToken to set. |
| Returns | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Name | Description |
value |
ByteStringThe 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 |
|
setUnknownFields(UnknownFieldSet unknownFields)
public final ListMetricDescriptorsRequest.Builder setUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields |
UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
ListMetricDescriptorsRequest.Builder |
|