Package org.mlflow.api.proto
Interface Webhooks.CreateWebhookOrBuilder
- All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder,com.google.protobuf.MessageOrBuilder
- All Known Implementing Classes:
Webhooks.CreateWebhook,Webhooks.CreateWebhook.Builder
- Enclosing class:
- Webhooks
public static interface Webhooks.CreateWebhookOrBuilder
extends com.google.protobuf.MessageOrBuilder
-
Method Summary
Modifier and TypeMethodDescriptionOptional description for the webhookcom.google.protobuf.ByteStringOptional description for the webhookgetEvents(int index) List of events to subscribe tointList of events to subscribe toList of events to subscribe togetEventsOrBuilder(int index) List of events to subscribe toList<? extends Webhooks.WebhookEventOrBuilder>List of events to subscribe togetName()Name of the webhookcom.google.protobuf.ByteStringName of the webhookSecret key for HMAC signature verificationcom.google.protobuf.ByteStringSecret key for HMAC signature verificationInitial status (defaults to ACTIVE if not specified)getUrl()URL to send webhook events tocom.google.protobuf.ByteStringURL to send webhook events tobooleanOptional description for the webhookbooleanhasName()Name of the webhookbooleanSecret key for HMAC signature verificationbooleanInitial status (defaults to ACTIVE if not specified)booleanhasUrl()URL to send webhook events toMethods inherited from interface com.google.protobuf.MessageLiteOrBuilder
isInitializedMethods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof
-
Method Details
-
hasName
boolean hasName()Name of the webhook
optional string name = 1 [(.mlflow.validate_required) = true];- Returns:
- Whether the name field is set.
-
getName
String getName()Name of the webhook
optional string name = 1 [(.mlflow.validate_required) = true];- Returns:
- The name.
-
getNameBytes
com.google.protobuf.ByteString getNameBytes()Name of the webhook
optional string name = 1 [(.mlflow.validate_required) = true];- Returns:
- The bytes for name.
-
hasDescription
boolean hasDescription()Optional description for the webhook
optional string description = 2;- Returns:
- Whether the description field is set.
-
getDescription
String getDescription()Optional description for the webhook
optional string description = 2;- Returns:
- The description.
-
getDescriptionBytes
com.google.protobuf.ByteString getDescriptionBytes()Optional description for the webhook
optional string description = 2;- Returns:
- The bytes for description.
-
hasUrl
boolean hasUrl()URL to send webhook events to
optional string url = 3 [(.mlflow.validate_required) = true];- Returns:
- Whether the url field is set.
-
getUrl
String getUrl()URL to send webhook events to
optional string url = 3 [(.mlflow.validate_required) = true];- Returns:
- The url.
-
getUrlBytes
com.google.protobuf.ByteString getUrlBytes()URL to send webhook events to
optional string url = 3 [(.mlflow.validate_required) = true];- Returns:
- The bytes for url.
-
getEventsList
List<Webhooks.WebhookEvent> getEventsList()List of events to subscribe to
repeated .mlflow.WebhookEvent events = 4 [(.mlflow.validate_required) = true]; -
getEvents
List of events to subscribe to
repeated .mlflow.WebhookEvent events = 4 [(.mlflow.validate_required) = true]; -
getEventsCount
int getEventsCount()List of events to subscribe to
repeated .mlflow.WebhookEvent events = 4 [(.mlflow.validate_required) = true]; -
getEventsOrBuilderList
List<? extends Webhooks.WebhookEventOrBuilder> getEventsOrBuilderList()List of events to subscribe to
repeated .mlflow.WebhookEvent events = 4 [(.mlflow.validate_required) = true]; -
getEventsOrBuilder
List of events to subscribe to
repeated .mlflow.WebhookEvent events = 4 [(.mlflow.validate_required) = true]; -
hasSecret
boolean hasSecret()Secret key for HMAC signature verification
optional string secret = 5;- Returns:
- Whether the secret field is set.
-
getSecret
String getSecret()Secret key for HMAC signature verification
optional string secret = 5;- Returns:
- The secret.
-
getSecretBytes
com.google.protobuf.ByteString getSecretBytes()Secret key for HMAC signature verification
optional string secret = 5;- Returns:
- The bytes for secret.
-
hasStatus
boolean hasStatus()Initial status (defaults to ACTIVE if not specified)
optional .mlflow.WebhookStatus status = 6;- Returns:
- Whether the status field is set.
-
getStatus
Webhooks.WebhookStatus getStatus()Initial status (defaults to ACTIVE if not specified)
optional .mlflow.WebhookStatus status = 6;- Returns:
- The status.
-