Class NotificationChannelDescriptor (3.44.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
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

SUPPORTED_TIERS_FIELD_NUMBER

public static final int SUPPORTED_TIERS_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 NotificationChannelDescriptor getDefaultInstance()
Returns
Type Description
NotificationChannelDescriptor

getDescriptor()

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

newBuilder()

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

newBuilder(NotificationChannelDescriptor prototype)

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

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

equals(Object obj)

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

getDefaultInstanceForType()

public NotificationChannelDescriptor getDefaultInstanceForType()
Returns
Type Description
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
Type Description
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
Type Description
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
Type Description
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
Type Description
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
Name Description
index int
Returns
Type Description
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
Type Description
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
Type Description
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
Name Description
index int
Returns
Type Description
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
Type Description
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
Type Description
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
Type Description
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
Type Description
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
Type Description
ByteString

The bytes for name.

getParserForType()

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

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
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
Name Description
index int

The index of the element to return.

Returns
Type Description
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
Type Description
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
Type Description
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
Name Description
index int

The index of the value to return.

Returns
Type Description
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
Type Description
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
Type Description
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
Type Description
ByteString

The bytes for type.

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

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

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

writeTo(CodedOutputStream output)

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