Package flyteidl.admin

Class Common.Notification

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessageV3

flyteidl.admin.Common.Notification

All Implemented Interfaces:

com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Common.NotificationOrBuilder, Serializable

Enclosing class:

Common

public static final class Common.Notification
extends com.google.protobuf.GeneratedMessageV3
implements Common.NotificationOrBuilder

 Represents a structure for notifications based on execution status.
 The notification content is configured within flyte admin but can be templatized.
 Future iterations could expose configuring notifications with custom content.
 

Protobuf type flyteidl.admin.Notification

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Common.Notification.Builder	Represents a structure for notifications based on execution status.
static class	Common.Notification.TypeCase

Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage,BuilderType extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType,BuilderType>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

Field Summary

Fields

Modifier and Type	Field	Description
private static Common.Notification	DEFAULT_INSTANCE
static int	EMAIL_FIELD_NUMBER
private byte	memoizedIsInitialized
static int	PAGER_DUTY_FIELD_NUMBER
private static com.google.protobuf.Parser<Common.Notification>	PARSER
private List<Integer>	phases_
private static com.google.protobuf.Internal.ListAdapter.Converter<Integer,Execution.WorkflowExecution.Phase>	phases_converter_
static int	PHASES_FIELD_NUMBER
private int	phasesMemoizedSerializedSize
private static long	serialVersionUID
static int	SLACK_FIELD_NUMBER
private Object	type_
private int	typeCase_

Fields inherited from class com.google.protobuf.GeneratedMessageV3

alwaysUseFieldBuilders, unknownFields

Fields inherited from class com.google.protobuf.AbstractMessage

memoizedSize

Fields inherited from class com.google.protobuf.AbstractMessageLite

memoizedHashCode

Constructor Summary

Constructors

Modifier	Constructor	Description
private	Notification()
private	Notification(com.google.protobuf.GeneratedMessageV3.Builder<?> builder)

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object obj)
static Common.Notification	getDefaultInstance()
Common.Notification	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
Common.EmailNotification	getEmail()	.flyteidl.admin.EmailNotification email = 2;
Common.EmailNotificationOrBuilder	getEmailOrBuilder()	.flyteidl.admin.EmailNotification email = 2;
Common.PagerDutyNotification	getPagerDuty()	.flyteidl.admin.PagerDutyNotification pager_duty = 3;
Common.PagerDutyNotificationOrBuilder	getPagerDutyOrBuilder()	.flyteidl.admin.PagerDutyNotification pager_duty = 3;
com.google.protobuf.Parser<Common.Notification>	getParserForType()
Execution.WorkflowExecution.Phase	getPhases(int index)	A list of phases to which users can associate the notifications to.
int	getPhasesCount()	A list of phases to which users can associate the notifications to.
List<Execution.WorkflowExecution.Phase>	getPhasesList()	A list of phases to which users can associate the notifications to.
int	getPhasesValue(int index)	A list of phases to which users can associate the notifications to.
List<Integer>	getPhasesValueList()	A list of phases to which users can associate the notifications to.
int	getSerializedSize()
Common.SlackNotification	getSlack()	.flyteidl.admin.SlackNotification slack = 4;
Common.SlackNotificationOrBuilder	getSlackOrBuilder()	.flyteidl.admin.SlackNotification slack = 4;
Common.Notification.TypeCase	getTypeCase()
com.google.protobuf.UnknownFieldSet	getUnknownFields()
boolean	hasEmail()	.flyteidl.admin.EmailNotification email = 2;
int	hashCode()
boolean	hasPagerDuty()	.flyteidl.admin.PagerDutyNotification pager_duty = 3;
boolean	hasSlack()	.flyteidl.admin.SlackNotification slack = 4;
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
static Common.Notification.Builder	newBuilder()
static Common.Notification.Builder	newBuilder(Common.Notification prototype)
Common.Notification.Builder	newBuilderForType()
protected Common.Notification.Builder	newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
protected Object	newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
static Common.Notification	parseDelimitedFrom(InputStream input)
static Common.Notification	parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Common.Notification	parseFrom(byte[] data)
static Common.Notification	parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Common.Notification	parseFrom(com.google.protobuf.ByteString data)
static Common.Notification	parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Common.Notification	parseFrom(com.google.protobuf.CodedInputStream input)
static Common.Notification	parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Common.Notification	parseFrom(InputStream input)
static Common.Notification	parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Common.Notification	parseFrom(ByteBuffer data)
static Common.Notification	parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<Common.Notification>	parser()
Common.Notification.Builder	toBuilder()
void	writeTo(com.google.protobuf.CodedOutputStream output)

Methods inherited from class com.google.protobuf.GeneratedMessageV3

canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof, internalGetMapField, isStringEmpty, makeExtensionsImmutable, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

Methods inherited from class com.google.protobuf.AbstractMessage

findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite

addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageLite

toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof

Field Detail

serialVersionUID

private static final long serialVersionUID

See Also:

Constant Field Values

typeCase_

private int typeCase_

type_

private Object type_

PHASES_FIELD_NUMBER

public static final int PHASES_FIELD_NUMBER

See Also:

Constant Field Values

phases_

private List<Integer> phases_

phases_converter_

private static final com.google.protobuf.Internal.ListAdapter.Converter<Integer,Execution.WorkflowExecution.Phase> phases_converter_

phasesMemoizedSerializedSize

private int phasesMemoizedSerializedSize

EMAIL_FIELD_NUMBER

public static final int EMAIL_FIELD_NUMBER

See Also:

Constant Field Values

PAGER_DUTY_FIELD_NUMBER

public static final int PAGER_DUTY_FIELD_NUMBER

See Also:

Constant Field Values

SLACK_FIELD_NUMBER

public static final int SLACK_FIELD_NUMBER

See Also:

Constant Field Values

memoizedIsInitialized

private byte memoizedIsInitialized

DEFAULT_INSTANCE

private static final Common.Notification DEFAULT_INSTANCE

PARSER

private static final com.google.protobuf.Parser<Common.Notification> PARSER

Constructor Detail

Notification

private Notification(com.google.protobuf.GeneratedMessageV3.Builder<?> builder)

Notification

private Notification()

Method Detail

newInstance

protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)

Overrides:

newInstance in class com.google.protobuf.GeneratedMessageV3

getUnknownFields

public final com.google.protobuf.UnknownFieldSet getUnknownFields()

Specified by:

getUnknownFields in interface com.google.protobuf.MessageOrBuilder

Overrides:

getUnknownFields in class com.google.protobuf.GeneratedMessageV3

getDescriptor

public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

internalGetFieldAccessorTable

protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Specified by:

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

getTypeCase

public Common.Notification.TypeCase getTypeCase()

Specified by:

getTypeCase in interface Common.NotificationOrBuilder

getPhasesList

public List<Execution.WorkflowExecution.Phase> getPhasesList()

 A list of phases to which users can associate the notifications to.
 +required
 

repeated .flyteidl.core.WorkflowExecution.Phase phases = 1;

Specified by:

getPhasesList in interface Common.NotificationOrBuilder

Returns:

A list containing the phases.

getPhasesCount

public int getPhasesCount()

 A list of phases to which users can associate the notifications to.
 +required
 

repeated .flyteidl.core.WorkflowExecution.Phase phases = 1;

Specified by:

getPhasesCount in interface Common.NotificationOrBuilder

Returns:

The count of phases.

getPhases

public Execution.WorkflowExecution.Phase getPhases(int index)

 A list of phases to which users can associate the notifications to.
 +required
 

repeated .flyteidl.core.WorkflowExecution.Phase phases = 1;

Specified by:

getPhases in interface Common.NotificationOrBuilder

Parameters:

index - The index of the element to return.

Returns:

The phases at the given index.

getPhasesValueList

public List<Integer> getPhasesValueList()

 A list of phases to which users can associate the notifications to.
 +required
 

repeated .flyteidl.core.WorkflowExecution.Phase phases = 1;

Specified by:

getPhasesValueList in interface Common.NotificationOrBuilder

Returns:

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

getPhasesValue

public int getPhasesValue(int index)

 A list of phases to which users can associate the notifications to.
 +required
 

repeated .flyteidl.core.WorkflowExecution.Phase phases = 1;

Specified by:

getPhasesValue in interface Common.NotificationOrBuilder

Parameters:

index - The index of the value to return.

Returns:

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

hasEmail

public boolean hasEmail()

.flyteidl.admin.EmailNotification email = 2;

Specified by:

hasEmail in interface Common.NotificationOrBuilder

Returns:

Whether the email field is set.

getEmail

public Common.EmailNotification getEmail()

.flyteidl.admin.EmailNotification email = 2;

Specified by:

getEmail in interface Common.NotificationOrBuilder

Returns:

The email.

getEmailOrBuilder

public Common.EmailNotificationOrBuilder getEmailOrBuilder()

.flyteidl.admin.EmailNotification email = 2;

Specified by:

getEmailOrBuilder in interface Common.NotificationOrBuilder

hasPagerDuty

public boolean hasPagerDuty()

.flyteidl.admin.PagerDutyNotification pager_duty = 3;

Specified by:

hasPagerDuty in interface Common.NotificationOrBuilder

Returns:

Whether the pagerDuty field is set.

getPagerDuty

public Common.PagerDutyNotification getPagerDuty()

.flyteidl.admin.PagerDutyNotification pager_duty = 3;

Specified by:

getPagerDuty in interface Common.NotificationOrBuilder

Returns:

The pagerDuty.

getPagerDutyOrBuilder

public Common.PagerDutyNotificationOrBuilder getPagerDutyOrBuilder()

.flyteidl.admin.PagerDutyNotification pager_duty = 3;

Specified by:

getPagerDutyOrBuilder in interface Common.NotificationOrBuilder

hasSlack

public boolean hasSlack()

.flyteidl.admin.SlackNotification slack = 4;

Specified by:

hasSlack in interface Common.NotificationOrBuilder

Returns:

Whether the slack field is set.

getSlack

public Common.SlackNotification getSlack()

.flyteidl.admin.SlackNotification slack = 4;

Specified by:

getSlack in interface Common.NotificationOrBuilder

Returns:

The slack.

getSlackOrBuilder

public Common.SlackNotificationOrBuilder getSlackOrBuilder()

.flyteidl.admin.SlackNotification slack = 4;

Specified by:

getSlackOrBuilder in interface Common.NotificationOrBuilder

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessageV3

writeTo

public void writeTo(com.google.protobuf.CodedOutputStream output)
             throws IOException

Specified by:

writeTo in interface com.google.protobuf.MessageLite

Overrides:

writeTo in class com.google.protobuf.GeneratedMessageV3

Throws:

IOException

getSerializedSize

public int getSerializedSize()

Specified by:

getSerializedSize in interface com.google.protobuf.MessageLite

Overrides:

getSerializedSize in class com.google.protobuf.GeneratedMessageV3

equals

public boolean equals(Object obj)

Specified by:

equals in interface com.google.protobuf.Message

Overrides:

equals in class com.google.protobuf.AbstractMessage

hashCode

public int hashCode()

Specified by:

hashCode in interface com.google.protobuf.Message

Overrides:

hashCode in class com.google.protobuf.AbstractMessage

parseFrom

public static Common.Notification parseFrom(ByteBuffer data)
                                     throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Common.Notification parseFrom(ByteBuffer data,
                                            com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                     throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Common.Notification parseFrom(com.google.protobuf.ByteString data)
                                     throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Common.Notification parseFrom(com.google.protobuf.ByteString data,
                                            com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                     throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Common.Notification parseFrom(byte[] data)
                                     throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Common.Notification parseFrom(byte[] data,
                                            com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                     throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Common.Notification parseFrom(InputStream input)
                                     throws IOException

Throws:

IOException

parseFrom

public static Common.Notification parseFrom(InputStream input,
                                            com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                     throws IOException

Throws:

IOException

parseDelimitedFrom

public static Common.Notification parseDelimitedFrom(InputStream input)
                                              throws IOException

Throws:

IOException

parseDelimitedFrom

public static Common.Notification parseDelimitedFrom(InputStream input,
                                                     com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                              throws IOException

Throws:

IOException

parseFrom

public static Common.Notification parseFrom(com.google.protobuf.CodedInputStream input)
                                     throws IOException

Throws:

IOException

parseFrom

public static Common.Notification parseFrom(com.google.protobuf.CodedInputStream input,
                                            com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                     throws IOException

Throws:

IOException

newBuilderForType

public Common.Notification.Builder newBuilderForType()

Specified by:

newBuilderForType in interface com.google.protobuf.Message

Specified by:

newBuilderForType in interface com.google.protobuf.MessageLite

newBuilder

public static Common.Notification.Builder newBuilder()

newBuilder

public static Common.Notification.Builder newBuilder(Common.Notification prototype)

toBuilder

public Common.Notification.Builder toBuilder()

Specified by:

toBuilder in interface com.google.protobuf.Message

Specified by:

toBuilder in interface com.google.protobuf.MessageLite

newBuilderForType

protected Common.Notification.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)

Specified by:

newBuilderForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstance

public static Common.Notification getDefaultInstance()

parser

public static com.google.protobuf.Parser<Common.Notification> parser()

getParserForType

public com.google.protobuf.Parser<Common.Notification> getParserForType()

Specified by:

getParserForType in interface com.google.protobuf.Message

Specified by:

getParserForType in interface com.google.protobuf.MessageLite

Overrides:

getParserForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstanceForType

public Common.Notification getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder