public final class MonitoredResourceDescriptor extends GeneratedMessageV3 implements MonitoredResourceDescriptorOrBuilder
An object that describes the schema of a
MonitoredResource object using a type name
and a set of labels. For example, the monitored resource descriptor for
Google Compute Engine VM instances has a type of
"gce_instance" and specifies the use of the labels "instance_id" and
"zone" to identify particular VM instances.
Different APIs can support different monitored resource types. APIs generally
provide a list method that returns the monitored resource descriptors used
by the API.
Protobuf type google.api.MonitoredResourceDescriptor
Static Fields
DESCRIPTION_FIELD_NUMBER
public static final int DESCRIPTION_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
DISPLAY_NAME_FIELD_NUMBER
public static final int DISPLAY_NAME_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
LABELS_FIELD_NUMBER
public static final int LABELS_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
LAUNCH_STAGE_FIELD_NUMBER
public static final int LAUNCH_STAGE_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
NAME_FIELD_NUMBER
public static final int NAME_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
TYPE_FIELD_NUMBER
public static final int TYPE_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
Static Methods
getDefaultInstance()
public static MonitoredResourceDescriptor getDefaultInstance()
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
newBuilder()
public static MonitoredResourceDescriptor.Builder newBuilder()
newBuilder(MonitoredResourceDescriptor prototype)
public static MonitoredResourceDescriptor.Builder newBuilder(MonitoredResourceDescriptor prototype)
public static MonitoredResourceDescriptor parseDelimitedFrom(InputStream input)
public static MonitoredResourceDescriptor parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(byte[] data)
public static MonitoredResourceDescriptor parseFrom(byte[] data)
| Parameter |
|---|
| Name | Description |
data | byte[]
|
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static MonitoredResourceDescriptor parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteString data)
public static MonitoredResourceDescriptor parseFrom(ByteString data)
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static MonitoredResourceDescriptor parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static MonitoredResourceDescriptor parseFrom(CodedInputStream input)
public static MonitoredResourceDescriptor parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static MonitoredResourceDescriptor parseFrom(InputStream input)
public static MonitoredResourceDescriptor parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteBuffer data)
public static MonitoredResourceDescriptor parseFrom(ByteBuffer data)
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static MonitoredResourceDescriptor parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
parser()
public static Parser<MonitoredResourceDescriptor> parser()
Methods
equals(Object obj)
public boolean equals(Object obj)
| Parameter |
|---|
| Name | Description |
obj | Object
|
Overrides
getDefaultInstanceForType()
public MonitoredResourceDescriptor getDefaultInstanceForType()
getDescription()
public String getDescription()
Optional. A detailed description of the monitored resource type that might
be used in documentation.
string description = 3;
| Returns |
|---|
| Type | Description |
String | The description.
|
getDescriptionBytes()
public ByteString getDescriptionBytes()
Optional. A detailed description of the monitored resource type that might
be used in documentation.
string description = 3;
| Returns |
|---|
| Type | Description |
ByteString | The bytes for description.
|
getDisplayName()
public String getDisplayName()
Optional. A concise name for the monitored resource type that might be
displayed in user interfaces. It should be a Title Cased Noun Phrase,
without any article or other determiners. For example,
"Google Cloud SQL Database".
string display_name = 2;
| Returns |
|---|
| Type | Description |
String | The displayName.
|
getDisplayNameBytes()
public ByteString getDisplayNameBytes()
Optional. A concise name for the monitored resource type that might be
displayed in user interfaces. It should be a Title Cased Noun Phrase,
without any article or other determiners. For example,
"Google Cloud SQL Database".
string display_name = 2;
| Returns |
|---|
| Type | Description |
ByteString | The bytes for displayName.
|
getLabels(int index)
public LabelDescriptor getLabels(int index)
Required. A set of labels used to describe instances of this monitored
resource type. For example, an individual Google Cloud SQL database is
identified by values for the labels "database_id" and "zone".
repeated .google.api.LabelDescriptor labels = 4;
| Parameter |
|---|
| Name | Description |
index | int
|
getLabelsCount()
public int getLabelsCount()
Required. A set of labels used to describe instances of this monitored
resource type. For example, an individual Google Cloud SQL database is
identified by values for the labels "database_id" and "zone".
repeated .google.api.LabelDescriptor labels = 4;
| Returns |
|---|
| Type | Description |
int | |
getLabelsList()
public List<LabelDescriptor> getLabelsList()
Required. A set of labels used to describe instances of this monitored
resource type. For example, an individual Google Cloud SQL database is
identified by values for the labels "database_id" and "zone".
repeated .google.api.LabelDescriptor labels = 4;
getLabelsOrBuilder(int index)
public LabelDescriptorOrBuilder getLabelsOrBuilder(int index)
Required. A set of labels used to describe instances of this monitored
resource type. For example, an individual Google Cloud SQL database is
identified by values for the labels "database_id" and "zone".
repeated .google.api.LabelDescriptor labels = 4;
| Parameter |
|---|
| Name | Description |
index | int
|
getLabelsOrBuilderList()
public List<? extends LabelDescriptorOrBuilder> getLabelsOrBuilderList()
Required. A set of labels used to describe instances of this monitored
resource type. For example, an individual Google Cloud SQL database is
identified by values for the labels "database_id" and "zone".
repeated .google.api.LabelDescriptor labels = 4;
| Returns |
|---|
| Type | Description |
List<? extends com.google.api.LabelDescriptorOrBuilder> | |
getLaunchStage()
public LaunchStage getLaunchStage()
Optional. The launch stage of the monitored resource definition.
.google.api.LaunchStage launch_stage = 7;
getLaunchStageValue()
public int getLaunchStageValue()
Optional. The launch stage of the monitored resource definition.
.google.api.LaunchStage launch_stage = 7;
| Returns |
|---|
| Type | Description |
int | The enum numeric value on the wire for launchStage.
|
getName()
Optional. The resource name of the monitored resource descriptor:
"projects/{project_id}/monitoredResourceDescriptors/{type}" where
{type} is the value of the type field in this object and
{project_id} is a project ID that provides API-specific context for
accessing the type. APIs that do not use project information can use the
resource name format "monitoredResourceDescriptors/{type}".
string name = 5;
| Returns |
|---|
| Type | Description |
String | The name.
|
getNameBytes()
public ByteString getNameBytes()
Optional. The resource name of the monitored resource descriptor:
"projects/{project_id}/monitoredResourceDescriptors/{type}" where
{type} is the value of the type field in this object and
{project_id} is a project ID that provides API-specific context for
accessing the type. APIs that do not use project information can use the
resource name format "monitoredResourceDescriptors/{type}".
string name = 5;
| Returns |
|---|
| Type | Description |
ByteString | The bytes for name.
|
getParserForType()
public Parser<MonitoredResourceDescriptor> getParserForType()
Overrides
getSerializedSize()
public int getSerializedSize()
| Returns |
|---|
| Type | Description |
int | |
Overrides
getType()
| Returns |
|---|
| Type | Description |
String | The type.
|
getTypeBytes()
public ByteString getTypeBytes()
| Returns |
|---|
| Type | Description |
ByteString | The bytes for type.
|
getUnknownFields()
public final UnknownFieldSet getUnknownFields()
Overrides
hashCode()
| Returns |
|---|
| Type | Description |
int | |
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
isInitialized()
public final boolean isInitialized()
Overrides
newBuilderForType()
public MonitoredResourceDescriptor.Builder newBuilderForType()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected MonitoredResourceDescriptor.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Overrides
toBuilder()
public MonitoredResourceDescriptor.Builder toBuilder()
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Overrides
