Class ListMetricDescriptorsRequest (3.49.0) 

public final class ListMetricDescriptorsRequest extends GeneratedMessageV3 implements ListMetricDescriptorsRequestOrBuilder

The ListMetricDescriptors request.

Protobuf type google.monitoring.v3.ListMetricDescriptorsRequest

Inheritance

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

Static Fields

FILTER_FIELD_NUMBER

public static final int FILTER_FIELD_NUMBER
Field Value
Type Description
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
Type Description
int

PAGE_SIZE_FIELD_NUMBER

public static final int PAGE_SIZE_FIELD_NUMBER
Field Value
Type Description
int

PAGE_TOKEN_FIELD_NUMBER

public static final int PAGE_TOKEN_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static ListMetricDescriptorsRequest getDefaultInstance()
Returns
Type Description
ListMetricDescriptorsRequest

getDescriptor()

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

newBuilder()

public static ListMetricDescriptorsRequest.Builder newBuilder()
Returns
Type Description
ListMetricDescriptorsRequest.Builder

newBuilder(ListMetricDescriptorsRequest prototype)

public static ListMetricDescriptorsRequest.Builder newBuilder(ListMetricDescriptorsRequest prototype)
Parameter
Name Description
prototype ListMetricDescriptorsRequest
Returns
Type Description
ListMetricDescriptorsRequest.Builder

parseDelimitedFrom(InputStream input)

public static ListMetricDescriptorsRequest parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
ListMetricDescriptorsRequest
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static ListMetricDescriptorsRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ListMetricDescriptorsRequest
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static ListMetricDescriptorsRequest parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
ListMetricDescriptorsRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static ListMetricDescriptorsRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ListMetricDescriptorsRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static ListMetricDescriptorsRequest parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
ListMetricDescriptorsRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static ListMetricDescriptorsRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ListMetricDescriptorsRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static ListMetricDescriptorsRequest parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
ListMetricDescriptorsRequest
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static ListMetricDescriptorsRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ListMetricDescriptorsRequest
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static ListMetricDescriptorsRequest parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
ListMetricDescriptorsRequest
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static ListMetricDescriptorsRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ListMetricDescriptorsRequest
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static ListMetricDescriptorsRequest parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
ListMetricDescriptorsRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static ListMetricDescriptorsRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ListMetricDescriptorsRequest
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<ListMetricDescriptorsRequest> parser()
Returns
Type Description
Parser<ListMetricDescriptorsRequest>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getDefaultInstanceForType()

public ListMetricDescriptorsRequest getDefaultInstanceForType()
Returns
Type Description
ListMetricDescriptorsRequest

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.

getParserForType()

public Parser<ListMetricDescriptorsRequest> getParserForType()
Returns
Type Description
Parser<ListMetricDescriptorsRequest>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public ListMetricDescriptorsRequest.Builder newBuilderForType()
Returns
Type Description
ListMetricDescriptorsRequest.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected ListMetricDescriptorsRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
ListMetricDescriptorsRequest.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public ListMetricDescriptorsRequest.Builder toBuilder()
Returns
Type Description
ListMetricDescriptorsRequest.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException