Package com.streamlayer.sdkSettings.organization.webhooks

Interface WebhookOrBuilder

  • All Superinterfaces:
    com.google.protobuf.MessageLiteOrBuilder
    All Known Implementing Classes:
    Webhook, Webhook.Builder
    public interface WebhookOrBuilder
extends com.google.protobuf.MessageLiteOrBuilder

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      ApiKey getApiKey()
      Target URL authentication
      java.lang.String getDescription()
      Webhook description
      com.google.protobuf.ByteString getDescriptionBytes()
      Webhook description
      long getEventId()
      optional uint64 event_id = 12 [json_name = "eventId"];
      int getHttpTimeout()
      uint32 http_timeout = 7 [json_name = "httpTimeout"];
      java.lang.String getId()
      endpoint_id of the created webhook
      com.google.protobuf.ByteString getIdBytes()
      endpoint_id of the created webhook
      java.lang.String getOrganizationId()
      owner_id
      com.google.protobuf.ByteString getOrganizationIdBytes()
      owner_id
      java.lang.String getProjectId()
      Convoy project_id
      com.google.protobuf.ByteString getProjectIdBytes()
      Convoy project_id
      java.lang.String getQuestionId()
      optional string question_id = 13 [json_name = "questionId"];
      com.google.protobuf.ByteString getQuestionIdBytes()
      optional string question_id = 13 [json_name = "questionId"];
      int getRateLimit()
      uint32 rate_limit = 8 [json_name = "rateLimit"];
      int getRateLimitDuration()
      uint32 rate_limit_duration = 9 [json_name = "rateLimitDuration"];
      WebhookStatus getStatus()
      .streamlayer.sdkSettings.organization.webhooks.WebhookStatus status = 10 [json_name = "status"];
      int getStatusValue()
      .streamlayer.sdkSettings.organization.webhooks.WebhookStatus status = 10 [json_name = "status"];
      java.lang.String getTargetUrl()
      webhook target EP
      com.google.protobuf.ByteString getTargetUrlBytes()
      webhook target EP
      java.lang.String getTitle()
      Webhook name
      com.google.protobuf.ByteString getTitleBytes()
      Webhook name
      boolean hasApiKey()
      Target URL authentication
      boolean hasEventId()
      optional uint64 event_id = 12 [json_name = "eventId"];
      boolean hasQuestionId()
      optional string question_id = 13 [json_name = "questionId"];

      • Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

        getDefaultInstanceForType, isInitialized

    • Method Detail

      • getId

        java.lang.String getId()
         endpoint_id of the created webhook
        string id = 1 [json_name = "id"];
        Returns:
        The id.

      • getIdBytes

        com.google.protobuf.ByteString getIdBytes()
         endpoint_id of the created webhook
        string id = 1 [json_name = "id"];
        Returns:
        The bytes for id.

      • getProjectId

        java.lang.String getProjectId()
         Convoy project_id
        string project_id = 2 [json_name = "projectId"];
        Returns:
        The projectId.

      • getProjectIdBytes

        com.google.protobuf.ByteString getProjectIdBytes()
         Convoy project_id
        string project_id = 2 [json_name = "projectId"];
        Returns:
        The bytes for projectId.

      • getTitle

        java.lang.String getTitle()
         Webhook name
        string title = 3 [json_name = "title"];
        Returns:
        The title.

      • getTitleBytes

        com.google.protobuf.ByteString getTitleBytes()
         Webhook name
        string title = 3 [json_name = "title"];
        Returns:
        The bytes for title.

      • getDescription

        java.lang.String getDescription()
         Webhook description
        string description = 4 [json_name = "description"];
        Returns:
        The description.

      • getDescriptionBytes

        com.google.protobuf.ByteString getDescriptionBytes()
         Webhook description
        string description = 4 [json_name = "description"];
        Returns:
        The bytes for description.

      • getOrganizationId

        java.lang.String getOrganizationId()
         owner_id
        string organization_id = 5 [json_name = "organizationId"];
        Returns:
        The organizationId.

      • getOrganizationIdBytes

        com.google.protobuf.ByteString getOrganizationIdBytes()
         owner_id
        string organization_id = 5 [json_name = "organizationId"];
        Returns:
        The bytes for organizationId.

      • getTargetUrl

        java.lang.String getTargetUrl()
         webhook target EP
        string target_url = 6 [json_name = "targetUrl"];
        Returns:
        The targetUrl.

      • getTargetUrlBytes

        com.google.protobuf.ByteString getTargetUrlBytes()
         webhook target EP
        string target_url = 6 [json_name = "targetUrl"];
        Returns:
        The bytes for targetUrl.

      • getHttpTimeout

        int getHttpTimeout()
        uint32 http_timeout = 7 [json_name = "httpTimeout"];
        Returns:
        The httpTimeout.

      • getRateLimit

        int getRateLimit()
        uint32 rate_limit = 8 [json_name = "rateLimit"];
        Returns:
        The rateLimit.

      • getRateLimitDuration

        int getRateLimitDuration()
        uint32 rate_limit_duration = 9 [json_name = "rateLimitDuration"];
        Returns:
        The rateLimitDuration.

      • getStatusValue

        int getStatusValue()
        .streamlayer.sdkSettings.organization.webhooks.WebhookStatus status = 10 [json_name = "status"];
        Returns:
        The enum numeric value on the wire for status.

      • getStatus

        WebhookStatus getStatus()
        .streamlayer.sdkSettings.organization.webhooks.WebhookStatus status = 10 [json_name = "status"];
        Returns:
        The status.

      • hasApiKey

        boolean hasApiKey()
         Target URL authentication
        .streamlayer.sdkSettings.organization.webhooks.ApiKey api_key = 11 [json_name = "apiKey"];
        Returns:
        Whether the apiKey field is set.

      • getApiKey

        ApiKey getApiKey()
         Target URL authentication
        .streamlayer.sdkSettings.organization.webhooks.ApiKey api_key = 11 [json_name = "apiKey"];
        Returns:
        The apiKey.

      • hasEventId

        boolean hasEventId()
        optional uint64 event_id = 12 [json_name = "eventId"];
        Returns:
        Whether the eventId field is set.

      • getEventId

        long getEventId()
        optional uint64 event_id = 12 [json_name = "eventId"];
        Returns:
        The eventId.

      • hasQuestionId

        boolean hasQuestionId()
        optional string question_id = 13 [json_name = "questionId"];
        Returns:
        Whether the questionId field is set.

      • getQuestionId

        java.lang.String getQuestionId()
        optional string question_id = 13 [json_name = "questionId"];
        Returns:
        The questionId.

      • getQuestionIdBytes

        com.google.protobuf.ByteString getQuestionIdBytes()
        optional string question_id = 13 [json_name = "questionId"];
        Returns:
        The bytes for questionId.