Class ListMetricDescriptorsRequest (3.29.0)

public final class ListMetricDescriptorsRequest extends GeneratedMessageV3 implements ListMetricDescriptorsRequestOrBuilder

The ListMetricDescriptors request.

Protobuf type google.monitoring.v3.ListMetricDescriptorsRequest

Static Fields

FILTER_FIELD_NUMBER

public static final int FILTER_FIELD_NUMBER
Field Value
TypeDescription
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
TypeDescription
int

PAGE_SIZE_FIELD_NUMBER

public static final int PAGE_SIZE_FIELD_NUMBER
Field Value
TypeDescription
int

PAGE_TOKEN_FIELD_NUMBER

public static final int PAGE_TOKEN_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static ListMetricDescriptorsRequest getDefaultInstance()
Returns
TypeDescription
ListMetricDescriptorsRequest

getDescriptor()

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

newBuilder()

public static ListMetricDescriptorsRequest.Builder newBuilder()
Returns
TypeDescription
ListMetricDescriptorsRequest.Builder

newBuilder(ListMetricDescriptorsRequest prototype)

public static ListMetricDescriptorsRequest.Builder newBuilder(ListMetricDescriptorsRequest prototype)
Parameter
NameDescription
prototypeListMetricDescriptorsRequest
Returns
TypeDescription
ListMetricDescriptorsRequest.Builder

parseDelimitedFrom(InputStream input)

public static ListMetricDescriptorsRequest parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
ListMetricDescriptorsRequest
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static ListMetricDescriptorsRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ListMetricDescriptorsRequest
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static ListMetricDescriptorsRequest parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
ListMetricDescriptorsRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static ListMetricDescriptorsRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ListMetricDescriptorsRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static ListMetricDescriptorsRequest parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
ListMetricDescriptorsRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static ListMetricDescriptorsRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ListMetricDescriptorsRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static ListMetricDescriptorsRequest parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
ListMetricDescriptorsRequest
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static ListMetricDescriptorsRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ListMetricDescriptorsRequest
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static ListMetricDescriptorsRequest parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
ListMetricDescriptorsRequest
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static ListMetricDescriptorsRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ListMetricDescriptorsRequest
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static ListMetricDescriptorsRequest parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
ListMetricDescriptorsRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static ListMetricDescriptorsRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ListMetricDescriptorsRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<ListMetricDescriptorsRequest> parser()
Returns
TypeDescription
Parser<ListMetricDescriptorsRequest>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
Overrides

getDefaultInstanceForType()

public ListMetricDescriptorsRequest getDefaultInstanceForType()
Returns
TypeDescription
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
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.

getParserForType()

public Parser<ListMetricDescriptorsRequest> getParserForType()
Returns
TypeDescription
Parser<ListMetricDescriptorsRequest>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

public ListMetricDescriptorsRequest.Builder newBuilderForType()
Returns
TypeDescription
ListMetricDescriptorsRequest.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected ListMetricDescriptorsRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
ListMetricDescriptorsRequest.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

public ListMetricDescriptorsRequest.Builder toBuilder()
Returns
TypeDescription
ListMetricDescriptorsRequest.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides
Exceptions
TypeDescription
IOException