Package com.streamlayer.sdkSettings.organization.webhooks

Class SendWebhookEventRequest.EventData.Builder

    • Method Detail

      • getEventValue

        public int getEventValue()
         [sets by SDK client] (AD event context)
        .streamlayer.sdkSettings.organization.webhooks.WebhookEvent event = 1 [json_name = "event"];
        Specified by:
        getEventValue in interface SendWebhookEventRequest.EventDataOrBuilder
        Returns:
        The enum numeric value on the wire for event.

      • setEventValue

        public SendWebhookEventRequest.EventData.Builder setEventValue​(int value)
         [sets by SDK client] (AD event context)
        .streamlayer.sdkSettings.organization.webhooks.WebhookEvent event = 1 [json_name = "event"];
        Parameters:
        value - The event to set.
        Returns:
        This builder for chaining.

      • setEvent

        public SendWebhookEventRequest.EventData.Builder setEvent​(WebhookEvent value)
         [sets by SDK client] (AD event context)
        .streamlayer.sdkSettings.organization.webhooks.WebhookEvent event = 1 [json_name = "event"];
        Parameters:
        value - The enum numeric value on the wire for event to set.
        Returns:
        This builder for chaining.

      • clearEvent

        public SendWebhookEventRequest.EventData.Builder clearEvent()
         [sets by SDK client] (AD event context)
        .streamlayer.sdkSettings.organization.webhooks.WebhookEvent event = 1 [json_name = "event"];
        Returns:
        This builder for chaining.

      • getNotificationTypeValue

        public int getNotificationTypeValue()
         [sets by SDK client]
        .streamlayer.sdkSettings.organization.webhooks.WebhookNotificationType notification_type = 2 [json_name = "notificationType"];
        Specified by:
        getNotificationTypeValue in interface SendWebhookEventRequest.EventDataOrBuilder
        Returns:
        The enum numeric value on the wire for notificationType.

      • setNotificationTypeValue

        public SendWebhookEventRequest.EventData.Builder setNotificationTypeValue​(int value)
         [sets by SDK client]
        .streamlayer.sdkSettings.organization.webhooks.WebhookNotificationType notification_type = 2 [json_name = "notificationType"];
        Parameters:
        value - The notificationType to set.
        Returns:
        This builder for chaining.

      • setNotificationType

        public SendWebhookEventRequest.EventData.Builder setNotificationType​(WebhookNotificationType value)
         [sets by SDK client]
        .streamlayer.sdkSettings.organization.webhooks.WebhookNotificationType notification_type = 2 [json_name = "notificationType"];
        Parameters:
        value - The enum numeric value on the wire for notificationType to set.
        Returns:
        This builder for chaining.

      • clearNotificationType

        public SendWebhookEventRequest.EventData.Builder clearNotificationType()
         [sets by SDK client]
        .streamlayer.sdkSettings.organization.webhooks.WebhookNotificationType notification_type = 2 [json_name = "notificationType"];
        Returns:
        This builder for chaining.

      • hasUserId

        public boolean hasUserId()
         [sets by grpc-proxy] from JWT. External client user ID. SL bypass flow should be used: https://github.com/makeomatic/ms-users/blob/master/rfcs/streamlayer-bypass-provider.md#streamlayer-internal-bypass-provider
        optional string user_id = 3 [json_name = "userId"];
        Specified by:
        hasUserId in interface SendWebhookEventRequest.EventDataOrBuilder
        Returns:
        Whether the userId field is set.

      • getUserId

        public java.lang.String getUserId()
         [sets by grpc-proxy] from JWT. External client user ID. SL bypass flow should be used: https://github.com/makeomatic/ms-users/blob/master/rfcs/streamlayer-bypass-provider.md#streamlayer-internal-bypass-provider
        optional string user_id = 3 [json_name = "userId"];
        Specified by:
        getUserId in interface SendWebhookEventRequest.EventDataOrBuilder
        Returns:
        The userId.

      • getUserIdBytes

        public com.google.protobuf.ByteString getUserIdBytes()
         [sets by grpc-proxy] from JWT. External client user ID. SL bypass flow should be used: https://github.com/makeomatic/ms-users/blob/master/rfcs/streamlayer-bypass-provider.md#streamlayer-internal-bypass-provider
        optional string user_id = 3 [json_name = "userId"];
        Specified by:
        getUserIdBytes in interface SendWebhookEventRequest.EventDataOrBuilder
        Returns:
        The bytes for userId.

      • setUserId

        public SendWebhookEventRequest.EventData.Builder setUserId​(java.lang.String value)
         [sets by grpc-proxy] from JWT. External client user ID. SL bypass flow should be used: https://github.com/makeomatic/ms-users/blob/master/rfcs/streamlayer-bypass-provider.md#streamlayer-internal-bypass-provider
        optional string user_id = 3 [json_name = "userId"];
        Parameters:
        value - The userId to set.
        Returns:
        This builder for chaining.

      • clearUserId

        public SendWebhookEventRequest.EventData.Builder clearUserId()
         [sets by grpc-proxy] from JWT. External client user ID. SL bypass flow should be used: https://github.com/makeomatic/ms-users/blob/master/rfcs/streamlayer-bypass-provider.md#streamlayer-internal-bypass-provider
        optional string user_id = 3 [json_name = "userId"];
        Returns:
        This builder for chaining.

      • setUserIdBytes

        public SendWebhookEventRequest.EventData.Builder setUserIdBytes​(com.google.protobuf.ByteString value)
         [sets by grpc-proxy] from JWT. External client user ID. SL bypass flow should be used: https://github.com/makeomatic/ms-users/blob/master/rfcs/streamlayer-bypass-provider.md#streamlayer-internal-bypass-provider
        optional string user_id = 3 [json_name = "userId"];
        Parameters:
        value - The bytes for userId to set.
        Returns:
        This builder for chaining.

      • hasAction

        public boolean hasAction()
         [sets by SDK client]. Action, e.g., CLICK_SECONDARY_BUTTON
        optional string action = 4 [json_name = "action"];
        Specified by:
        hasAction in interface SendWebhookEventRequest.EventDataOrBuilder
        Returns:
        Whether the action field is set.

      • getAction

        public java.lang.String getAction()
         [sets by SDK client]. Action, e.g., CLICK_SECONDARY_BUTTON
        optional string action = 4 [json_name = "action"];
        Specified by:
        getAction in interface SendWebhookEventRequest.EventDataOrBuilder
        Returns:
        The action.

      • getActionBytes

        public com.google.protobuf.ByteString getActionBytes()
         [sets by SDK client]. Action, e.g., CLICK_SECONDARY_BUTTON
        optional string action = 4 [json_name = "action"];
        Specified by:
        getActionBytes in interface SendWebhookEventRequest.EventDataOrBuilder
        Returns:
        The bytes for action.

      • setAction

        public SendWebhookEventRequest.EventData.Builder setAction​(java.lang.String value)
         [sets by SDK client]. Action, e.g., CLICK_SECONDARY_BUTTON
        optional string action = 4 [json_name = "action"];
        Parameters:
        value - The action to set.
        Returns:
        This builder for chaining.

      • clearAction

        public SendWebhookEventRequest.EventData.Builder clearAction()
         [sets by SDK client]. Action, e.g., CLICK_SECONDARY_BUTTON
        optional string action = 4 [json_name = "action"];
        Returns:
        This builder for chaining.

      • setActionBytes

        public SendWebhookEventRequest.EventData.Builder setActionBytes​(com.google.protobuf.ByteString value)
         [sets by SDK client]. Action, e.g., CLICK_SECONDARY_BUTTON
        optional string action = 4 [json_name = "action"];
        Parameters:
        value - The bytes for action to set.
        Returns:
        This builder for chaining.

      • getDescription

        public java.lang.String getDescription()
         [sets by SDK client]. Event description, e.g. "User clicked on a secondary button"
        string description = 5 [json_name = "description"];
        Specified by:
        getDescription in interface SendWebhookEventRequest.EventDataOrBuilder
        Returns:
        The description.

      • getDescriptionBytes

        public com.google.protobuf.ByteString getDescriptionBytes()
         [sets by SDK client]. Event description, e.g. "User clicked on a secondary button"
        string description = 5 [json_name = "description"];
        Specified by:
        getDescriptionBytes in interface SendWebhookEventRequest.EventDataOrBuilder
        Returns:
        The bytes for description.

      • setDescription

        public SendWebhookEventRequest.EventData.Builder setDescription​(java.lang.String value)
         [sets by SDK client]. Event description, e.g. "User clicked on a secondary button"
        string description = 5 [json_name = "description"];
        Parameters:
        value - The description to set.
        Returns:
        This builder for chaining.

      • clearDescription

        public SendWebhookEventRequest.EventData.Builder clearDescription()
         [sets by SDK client]. Event description, e.g. "User clicked on a secondary button"
        string description = 5 [json_name = "description"];
        Returns:
        This builder for chaining.

      • setDescriptionBytes

        public SendWebhookEventRequest.EventData.Builder setDescriptionBytes​(com.google.protobuf.ByteString value)
         [sets by SDK client]. Event description, e.g. "User clicked on a secondary button"
        string description = 5 [json_name = "description"];
        Parameters:
        value - The bytes for description to set.
        Returns:
        This builder for chaining.

      • removeMetadata

        public SendWebhookEventRequest.EventData.Builder removeMetadata​(java.lang.String key)
         [sets by grpc-proxy] Metadata for the event
        map<string, string> metadata = 6 [json_name = "metadata"];

      • getMetadataMap

        public java.util.Map<java.lang.String,​java.lang.String> getMetadataMap()
         [sets by grpc-proxy] Metadata for the event
        map<string, string> metadata = 6 [json_name = "metadata"];
        Specified by:
        getMetadataMap in interface SendWebhookEventRequest.EventDataOrBuilder

      • getMetadataOrDefault

        public java.lang.String getMetadataOrDefault​(java.lang.String key,
                                             java.lang.String defaultValue)
         [sets by grpc-proxy] Metadata for the event
        map<string, string> metadata = 6 [json_name = "metadata"];
        Specified by:
        getMetadataOrDefault in interface SendWebhookEventRequest.EventDataOrBuilder

      • putMetadata

        public SendWebhookEventRequest.EventData.Builder putMetadata​(java.lang.String key,
                                                             java.lang.String value)
         [sets by grpc-proxy] Metadata for the event
        map<string, string> metadata = 6 [json_name = "metadata"];

      • putAllMetadata

        public SendWebhookEventRequest.EventData.Builder putAllMetadata​(java.util.Map<java.lang.String,​java.lang.String> values)
         [sets by grpc-proxy] Metadata for the event
        map<string, string> metadata = 6 [json_name = "metadata"];

      • containsCustomFields

        public boolean containsCustomFields​(java.lang.String key)
         [sets by SDK client]. Clients custom fields for the AD event, e.g. { "promo_code": "SUMMER2024", "campaign": "BeachSale" }
        map<string, string> custom_fields = 7 [json_name = "customFields"];
        Specified by:
        containsCustomFields in interface SendWebhookEventRequest.EventDataOrBuilder

      • removeCustomFields

        public SendWebhookEventRequest.EventData.Builder removeCustomFields​(java.lang.String key)
         [sets by SDK client]. Clients custom fields for the AD event, e.g. { "promo_code": "SUMMER2024", "campaign": "BeachSale" }
        map<string, string> custom_fields = 7 [json_name = "customFields"];

      • getCustomFieldsMap

        public java.util.Map<java.lang.String,​java.lang.String> getCustomFieldsMap()
         [sets by SDK client]. Clients custom fields for the AD event, e.g. { "promo_code": "SUMMER2024", "campaign": "BeachSale" }
        map<string, string> custom_fields = 7 [json_name = "customFields"];
        Specified by:
        getCustomFieldsMap in interface SendWebhookEventRequest.EventDataOrBuilder

      • getCustomFieldsOrDefault

        public java.lang.String getCustomFieldsOrDefault​(java.lang.String key,
                                                 java.lang.String defaultValue)
         [sets by SDK client]. Clients custom fields for the AD event, e.g. { "promo_code": "SUMMER2024", "campaign": "BeachSale" }
        map<string, string> custom_fields = 7 [json_name = "customFields"];
        Specified by:
        getCustomFieldsOrDefault in interface SendWebhookEventRequest.EventDataOrBuilder

      • getCustomFieldsOrThrow

        public java.lang.String getCustomFieldsOrThrow​(java.lang.String key)
         [sets by SDK client]. Clients custom fields for the AD event, e.g. { "promo_code": "SUMMER2024", "campaign": "BeachSale" }
        map<string, string> custom_fields = 7 [json_name = "customFields"];
        Specified by:
        getCustomFieldsOrThrow in interface SendWebhookEventRequest.EventDataOrBuilder

      • putCustomFields

        public SendWebhookEventRequest.EventData.Builder putCustomFields​(java.lang.String key,
                                                                 java.lang.String value)
         [sets by SDK client]. Clients custom fields for the AD event, e.g. { "promo_code": "SUMMER2024", "campaign": "BeachSale" }
        map<string, string> custom_fields = 7 [json_name = "customFields"];

      • putAllCustomFields

        public SendWebhookEventRequest.EventData.Builder putAllCustomFields​(java.util.Map<java.lang.String,​java.lang.String> values)
         [sets by SDK client]. Clients custom fields for the AD event, e.g. { "promo_code": "SUMMER2024", "campaign": "BeachSale" }
        map<string, string> custom_fields = 7 [json_name = "customFields"];