Package org.mlflow.api.proto

Class Webhooks.CreateWebhook

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessageV3

org.mlflow.api.proto.Webhooks.CreateWebhook

All Implemented Interfaces:

com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable, Webhooks.CreateWebhookOrBuilder

Enclosing class:

Webhooks

public static final class Webhooks.CreateWebhook
extends com.google.protobuf.GeneratedMessageV3
implements Webhooks.CreateWebhookOrBuilder

 Create webhook request
 

Protobuf type mlflow.CreateWebhook

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	Webhooks.CreateWebhook.Builder	Create webhook request
static final class	Webhooks.CreateWebhook.Response	Protobuf type mlflow.CreateWebhook.Response
static interface	Webhooks.CreateWebhook.ResponseOrBuilder

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
static final int	DESCRIPTION_FIELD_NUMBER
static final int	EVENTS_FIELD_NUMBER
static final int	NAME_FIELD_NUMBER
static final com.google.protobuf.Parser<Webhooks.CreateWebhook>	PARSER	Deprecated.
static final int	SECRET_FIELD_NUMBER
static final int	STATUS_FIELD_NUMBER
static final int	URL_FIELD_NUMBER

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

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object obj)
static Webhooks.CreateWebhook	getDefaultInstance()
Webhooks.CreateWebhook	getDefaultInstanceForType()
String	getDescription()	Optional description for the webhook
com.google.protobuf.ByteString	getDescriptionBytes()	Optional description for the webhook
static final com.google.protobuf.Descriptors.Descriptor	getDescriptor()
Webhooks.WebhookEvent	getEvents(int index)	List of events to subscribe to
int	getEventsCount()	List of events to subscribe to
List<Webhooks.WebhookEvent>	getEventsList()	List of events to subscribe to
Webhooks.WebhookEventOrBuilder	getEventsOrBuilder(int index)	List of events to subscribe to
List<? extends Webhooks.WebhookEventOrBuilder>	getEventsOrBuilderList()	List of events to subscribe to
String	getName()	Name of the webhook
com.google.protobuf.ByteString	getNameBytes()	Name of the webhook
com.google.protobuf.Parser<Webhooks.CreateWebhook>	getParserForType()
String	getSecret()	Secret key for HMAC signature verification
com.google.protobuf.ByteString	getSecretBytes()	Secret key for HMAC signature verification
int	getSerializedSize()
Webhooks.WebhookStatus	getStatus()	Initial status (defaults to ACTIVE if not specified)
final com.google.protobuf.UnknownFieldSet	getUnknownFields()
String	getUrl()	URL to send webhook events to
com.google.protobuf.ByteString	getUrlBytes()	URL to send webhook events to
boolean	hasDescription()	Optional description for the webhook
int	hashCode()
boolean	hasName()	Name of the webhook
boolean	hasSecret()	Secret key for HMAC signature verification
boolean	hasStatus()	Initial status (defaults to ACTIVE if not specified)
boolean	hasUrl()	URL to send webhook events to
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
final boolean	isInitialized()
static Webhooks.CreateWebhook.Builder	newBuilder()
static Webhooks.CreateWebhook.Builder	newBuilder(Webhooks.CreateWebhook prototype)
Webhooks.CreateWebhook.Builder	newBuilderForType()
protected Webhooks.CreateWebhook.Builder	newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
protected Object	newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
static Webhooks.CreateWebhook	parseDelimitedFrom(InputStream input)
static Webhooks.CreateWebhook	parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Webhooks.CreateWebhook	parseFrom(byte[] data)
static Webhooks.CreateWebhook	parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Webhooks.CreateWebhook	parseFrom(com.google.protobuf.ByteString data)
static Webhooks.CreateWebhook	parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Webhooks.CreateWebhook	parseFrom(com.google.protobuf.CodedInputStream input)
static Webhooks.CreateWebhook	parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Webhooks.CreateWebhook	parseFrom(InputStream input)
static Webhooks.CreateWebhook	parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Webhooks.CreateWebhook	parseFrom(ByteBuffer data)
static Webhooks.CreateWebhook	parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<Webhooks.CreateWebhook>	parser()
Webhooks.CreateWebhook.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 Details

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER

See Also:

• Constant Field Values

DESCRIPTION_FIELD_NUMBER

public static final int DESCRIPTION_FIELD_NUMBER

See Also:

• Constant Field Values

URL_FIELD_NUMBER

public static final int URL_FIELD_NUMBER

See Also:

• Constant Field Values

EVENTS_FIELD_NUMBER

public static final int EVENTS_FIELD_NUMBER

See Also:

• Constant Field Values

SECRET_FIELD_NUMBER

public static final int SECRET_FIELD_NUMBER

See Also:

• Constant Field Values

STATUS_FIELD_NUMBER

public static final int STATUS_FIELD_NUMBER

See Also:

• Constant Field Values

PARSER

@Deprecated
public static final com.google.protobuf.Parser<Webhooks.CreateWebhook> PARSER

Deprecated.

Method Details

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

hasName

public boolean hasName()

 Name of the webhook
 

optional string name = 1 [(.mlflow.validate_required) = true];

Specified by:

hasName in interface Webhooks.CreateWebhookOrBuilder

Returns:

Whether the name field is set.

getName

public String getName()

 Name of the webhook
 

optional string name = 1 [(.mlflow.validate_required) = true];

Specified by:

getName in interface Webhooks.CreateWebhookOrBuilder

Returns:

The name.

getNameBytes

public com.google.protobuf.ByteString getNameBytes()

 Name of the webhook
 

optional string name = 1 [(.mlflow.validate_required) = true];

Specified by:

getNameBytes in interface Webhooks.CreateWebhookOrBuilder

Returns:

The bytes for name.

hasDescription

public boolean hasDescription()

 Optional description for the webhook
 

optional string description = 2;

Specified by:

hasDescription in interface Webhooks.CreateWebhookOrBuilder

Returns:

Whether the description field is set.

getDescription

public String getDescription()

 Optional description for the webhook
 

optional string description = 2;

Specified by:

getDescription in interface Webhooks.CreateWebhookOrBuilder

Returns:

The description.

getDescriptionBytes

public com.google.protobuf.ByteString getDescriptionBytes()

 Optional description for the webhook
 

optional string description = 2;

Specified by:

getDescriptionBytes in interface Webhooks.CreateWebhookOrBuilder

Returns:

The bytes for description.

hasUrl

public boolean hasUrl()

 URL to send webhook events to
 

optional string url = 3 [(.mlflow.validate_required) = true];

Specified by:

hasUrl in interface Webhooks.CreateWebhookOrBuilder

Returns:

Whether the url field is set.

getUrl

public String getUrl()

 URL to send webhook events to
 

optional string url = 3 [(.mlflow.validate_required) = true];

Specified by:

getUrl in interface Webhooks.CreateWebhookOrBuilder

Returns:

The url.

getUrlBytes

public com.google.protobuf.ByteString getUrlBytes()

 URL to send webhook events to
 

optional string url = 3 [(.mlflow.validate_required) = true];

Specified by:

getUrlBytes in interface Webhooks.CreateWebhookOrBuilder

Returns:

The bytes for url.

getEventsList

public List<Webhooks.WebhookEvent> getEventsList()

 List of events to subscribe to
 

repeated .mlflow.WebhookEvent events = 4 [(.mlflow.validate_required) = true];

Specified by:

getEventsList in interface Webhooks.CreateWebhookOrBuilder

getEventsOrBuilderList

public List<? extends Webhooks.WebhookEventOrBuilder> getEventsOrBuilderList()

 List of events to subscribe to
 

repeated .mlflow.WebhookEvent events = 4 [(.mlflow.validate_required) = true];

Specified by:

getEventsOrBuilderList in interface Webhooks.CreateWebhookOrBuilder

getEventsCount

public int getEventsCount()

 List of events to subscribe to
 

repeated .mlflow.WebhookEvent events = 4 [(.mlflow.validate_required) = true];

Specified by:

getEventsCount in interface Webhooks.CreateWebhookOrBuilder

getEvents

public Webhooks.WebhookEvent getEvents(int index)

 List of events to subscribe to
 

repeated .mlflow.WebhookEvent events = 4 [(.mlflow.validate_required) = true];

Specified by:

getEvents in interface Webhooks.CreateWebhookOrBuilder

getEventsOrBuilder

public Webhooks.WebhookEventOrBuilder getEventsOrBuilder(int index)

 List of events to subscribe to
 

repeated .mlflow.WebhookEvent events = 4 [(.mlflow.validate_required) = true];

Specified by:

getEventsOrBuilder in interface Webhooks.CreateWebhookOrBuilder

hasSecret

public boolean hasSecret()

 Secret key for HMAC signature verification
 

optional string secret = 5;

Specified by:

hasSecret in interface Webhooks.CreateWebhookOrBuilder

Returns:

Whether the secret field is set.

getSecret

public String getSecret()

 Secret key for HMAC signature verification
 

optional string secret = 5;

Specified by:

getSecret in interface Webhooks.CreateWebhookOrBuilder

Returns:

The secret.

getSecretBytes

public com.google.protobuf.ByteString getSecretBytes()

 Secret key for HMAC signature verification
 

optional string secret = 5;

Specified by:

getSecretBytes in interface Webhooks.CreateWebhookOrBuilder

Returns:

The bytes for secret.

hasStatus

public boolean hasStatus()

 Initial status (defaults to ACTIVE if not specified)
 

optional .mlflow.WebhookStatus status = 6;

Specified by:

hasStatus in interface Webhooks.CreateWebhookOrBuilder

Returns:

Whether the status field is set.

getStatus

public Webhooks.WebhookStatus getStatus()

 Initial status (defaults to ACTIVE if not specified)
 

optional .mlflow.WebhookStatus status = 6;

Specified by:

getStatus in interface Webhooks.CreateWebhookOrBuilder

Returns:

The status.

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 Webhooks.CreateWebhook parseFrom(ByteBuffer data)
                                        throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Webhooks.CreateWebhook parseFrom(com.google.protobuf.ByteString data)
                                        throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Webhooks.CreateWebhook parseFrom(byte[] data)
                                        throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Webhooks.CreateWebhook parseFrom(InputStream input)
                                        throws IOException

Throws:

IOException

parseFrom

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

Throws:

IOException

parseDelimitedFrom

public static Webhooks.CreateWebhook parseDelimitedFrom(InputStream input)
                                                 throws IOException

Throws:

IOException

parseDelimitedFrom

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

Throws:

IOException

parseFrom

public static Webhooks.CreateWebhook parseFrom(com.google.protobuf.CodedInputStream input)
                                        throws IOException

Throws:

IOException

parseFrom

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

Throws:

IOException

newBuilderForType

public Webhooks.CreateWebhook.Builder newBuilderForType()

Specified by:

newBuilderForType in interface com.google.protobuf.Message

Specified by:

newBuilderForType in interface com.google.protobuf.MessageLite

newBuilder

public static Webhooks.CreateWebhook.Builder newBuilder()

newBuilder

public static Webhooks.CreateWebhook.Builder newBuilder(Webhooks.CreateWebhook prototype)

toBuilder

public Webhooks.CreateWebhook.Builder toBuilder()

Specified by:

toBuilder in interface com.google.protobuf.Message

Specified by:

toBuilder in interface com.google.protobuf.MessageLite

newBuilderForType

protected Webhooks.CreateWebhook.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)

Specified by:

newBuilderForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstance

public static Webhooks.CreateWebhook getDefaultInstance()

parser

public static com.google.protobuf.Parser<Webhooks.CreateWebhook> parser()

getParserForType

public com.google.protobuf.Parser<Webhooks.CreateWebhook> 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 Webhooks.CreateWebhook getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder