Class NotificationChannelDescriptor (3.29.0)

public final class NotificationChannelDescriptor extends GeneratedMessageV3 implements NotificationChannelDescriptorOrBuilder

A description of a notification channel. The descriptor includes the properties of the channel and the set of labels or fields that must be specified to configure channels of a given type.

Protobuf type google.monitoring.v3.NotificationChannelDescriptor

Static Fields

DESCRIPTION_FIELD_NUMBER

public static final int DESCRIPTION_FIELD_NUMBER
Field Value
TypeDescription
int

DISPLAY_NAME_FIELD_NUMBER

public static final int DISPLAY_NAME_FIELD_NUMBER
Field Value
TypeDescription
int

LABELS_FIELD_NUMBER

public static final int LABELS_FIELD_NUMBER
Field Value
TypeDescription
int

LAUNCH_STAGE_FIELD_NUMBER

public static final int LAUNCH_STAGE_FIELD_NUMBER
Field Value
TypeDescription
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
TypeDescription
int

SUPPORTED_TIERS_FIELD_NUMBER

public static final int SUPPORTED_TIERS_FIELD_NUMBER
Field Value
TypeDescription
int

TYPE_FIELD_NUMBER

public static final int TYPE_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static NotificationChannelDescriptor getDefaultInstance()
Returns
TypeDescription
NotificationChannelDescriptor

getDescriptor()

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

newBuilder()

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

newBuilder(NotificationChannelDescriptor prototype)

public static NotificationChannelDescriptor.Builder newBuilder(NotificationChannelDescriptor prototype)
Parameter
NameDescription
prototypeNotificationChannelDescriptor
Returns
TypeDescription
NotificationChannelDescriptor.Builder

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

equals(Object obj)

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

getDefaultInstanceForType()

public NotificationChannelDescriptor getDefaultInstanceForType()
Returns
TypeDescription
NotificationChannelDescriptor

getDescription()

public String getDescription()

A human-readable description of the notification channel type. The description may include a description of the properties of the channel and pointers to external documentation.

string description = 3;

Returns
TypeDescription
String

The description.

getDescriptionBytes()

public ByteString getDescriptionBytes()

A human-readable description of the notification channel type. The description may include a description of the properties of the channel and pointers to external documentation.

string description = 3;

Returns
TypeDescription
ByteString

The bytes for description.

getDisplayName()

public String getDisplayName()

A human-readable name for the notification channel type. This form of the name is suitable for a user interface.

string display_name = 2;

Returns
TypeDescription
String

The displayName.

getDisplayNameBytes()

public ByteString getDisplayNameBytes()

A human-readable name for the notification channel type. This form of the name is suitable for a user interface.

string display_name = 2;

Returns
TypeDescription
ByteString

The bytes for displayName.

getLabels(int index)

public LabelDescriptor getLabels(int index)

The set of labels that must be defined to identify a particular channel of the corresponding type. Each label includes a description for how that field should be populated.

repeated .google.api.LabelDescriptor labels = 4;

Parameter
NameDescription
indexint
Returns
TypeDescription
com.google.api.LabelDescriptor

getLabelsCount()

public int getLabelsCount()

The set of labels that must be defined to identify a particular channel of the corresponding type. Each label includes a description for how that field should be populated.

repeated .google.api.LabelDescriptor labels = 4;

Returns
TypeDescription
int

getLabelsList()

public List<LabelDescriptor> getLabelsList()

The set of labels that must be defined to identify a particular channel of the corresponding type. Each label includes a description for how that field should be populated.

repeated .google.api.LabelDescriptor labels = 4;

Returns
TypeDescription
List<com.google.api.LabelDescriptor>

getLabelsOrBuilder(int index)

public LabelDescriptorOrBuilder getLabelsOrBuilder(int index)

The set of labels that must be defined to identify a particular channel of the corresponding type. Each label includes a description for how that field should be populated.

repeated .google.api.LabelDescriptor labels = 4;

Parameter
NameDescription
indexint
Returns
TypeDescription
com.google.api.LabelDescriptorOrBuilder

getLabelsOrBuilderList()

public List<? extends LabelDescriptorOrBuilder> getLabelsOrBuilderList()

The set of labels that must be defined to identify a particular channel of the corresponding type. Each label includes a description for how that field should be populated.

repeated .google.api.LabelDescriptor labels = 4;

Returns
TypeDescription
List<? extends com.google.api.LabelDescriptorOrBuilder>

getLaunchStage()

public LaunchStage getLaunchStage()

The product launch stage for channels of this type.

.google.api.LaunchStage launch_stage = 7;

Returns
TypeDescription
com.google.api.LaunchStage

The launchStage.

getLaunchStageValue()

public int getLaunchStageValue()

The product launch stage for channels of this type.

.google.api.LaunchStage launch_stage = 7;

Returns
TypeDescription
int

The enum numeric value on the wire for launchStage.

getName()

public String getName()

The full REST resource name for this descriptor. The format is:

 projects/[PROJECT_ID_OR_NUMBER]/notificationChannelDescriptors/[TYPE]

In the above, [TYPE] is the value of the type field.

string name = 6;

Returns
TypeDescription
String

The name.

getNameBytes()

public ByteString getNameBytes()

The full REST resource name for this descriptor. The format is:

 projects/[PROJECT_ID_OR_NUMBER]/notificationChannelDescriptors/[TYPE]

In the above, [TYPE] is the value of the type field.

string name = 6;

Returns
TypeDescription
ByteString

The bytes for name.

getParserForType()

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

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

getSupportedTiers(int index) (deprecated)

public ServiceTier getSupportedTiers(int index)

Deprecated. google.monitoring.v3.NotificationChannelDescriptor.supported_tiers is deprecated. See google/monitoring/v3/notification.proto;l=75

The tiers that support this notification channel; the project service tier must be one of the supported_tiers.

repeated .google.monitoring.v3.ServiceTier supported_tiers = 5 [deprecated = true];

Parameter
NameDescription
indexint

The index of the element to return.

Returns
TypeDescription
ServiceTier

The supportedTiers at the given index.

getSupportedTiersCount() (deprecated)

public int getSupportedTiersCount()

Deprecated. google.monitoring.v3.NotificationChannelDescriptor.supported_tiers is deprecated. See google/monitoring/v3/notification.proto;l=75

The tiers that support this notification channel; the project service tier must be one of the supported_tiers.

repeated .google.monitoring.v3.ServiceTier supported_tiers = 5 [deprecated = true];

Returns
TypeDescription
int

The count of supportedTiers.

getSupportedTiersList() (deprecated)

public List<ServiceTier> getSupportedTiersList()

Deprecated. google.monitoring.v3.NotificationChannelDescriptor.supported_tiers is deprecated. See google/monitoring/v3/notification.proto;l=75

The tiers that support this notification channel; the project service tier must be one of the supported_tiers.

repeated .google.monitoring.v3.ServiceTier supported_tiers = 5 [deprecated = true];

Returns
TypeDescription
List<ServiceTier>

A list containing the supportedTiers.

getSupportedTiersValue(int index) (deprecated)

public int getSupportedTiersValue(int index)

Deprecated. google.monitoring.v3.NotificationChannelDescriptor.supported_tiers is deprecated. See google/monitoring/v3/notification.proto;l=75

The tiers that support this notification channel; the project service tier must be one of the supported_tiers.

repeated .google.monitoring.v3.ServiceTier supported_tiers = 5 [deprecated = true];

Parameter
NameDescription
indexint

The index of the value to return.

Returns
TypeDescription
int

The enum numeric value on the wire of supportedTiers at the given index.

getSupportedTiersValueList() (deprecated)

public List<Integer> getSupportedTiersValueList()

Deprecated. google.monitoring.v3.NotificationChannelDescriptor.supported_tiers is deprecated. See google/monitoring/v3/notification.proto;l=75

The tiers that support this notification channel; the project service tier must be one of the supported_tiers.

repeated .google.monitoring.v3.ServiceTier supported_tiers = 5 [deprecated = true];

Returns
TypeDescription
List<Integer>

A list containing the enum numeric values on the wire for supportedTiers.

getType()

public String getType()

The type of notification channel, such as "email" and "sms". To view the full list of channels, see Channel descriptors. Notification channel types are globally unique.

string type = 1;

Returns
TypeDescription
String

The type.

getTypeBytes()

public ByteString getTypeBytes()

The type of notification channel, such as "email" and "sms". To view the full list of channels, see Channel descriptors. Notification channel types are globally unique.

string type = 1;

Returns
TypeDescription
ByteString

The bytes for type.

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 NotificationChannelDescriptor.Builder newBuilderForType()
Returns
TypeDescription
NotificationChannelDescriptor.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

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

writeTo(CodedOutputStream output)

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