Class CreateChannelNamespaceRequest

    • Method Detail

      • apiId

        public final String apiId()

        The Api ID.

        Returns:
        The Api ID.
      • name

        public final String name()

        The name of the ChannelNamespace. This name must be unique within the Api

        Returns:
        The name of the ChannelNamespace. This name must be unique within the Api
      • hasSubscribeAuthModes

        public final boolean hasSubscribeAuthModes()
        For responses, this returns true if the service returned a value for the SubscribeAuthModes property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
      • subscribeAuthModes

        public final List<AuthMode> subscribeAuthModes()

        The authorization mode to use for subscribing to messages on the channel namespace. This configuration overrides the default Api authorization configuration.

        Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

        This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasSubscribeAuthModes() method.

        Returns:
        The authorization mode to use for subscribing to messages on the channel namespace. This configuration overrides the default Api authorization configuration.
      • hasPublishAuthModes

        public final boolean hasPublishAuthModes()
        For responses, this returns true if the service returned a value for the PublishAuthModes property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
      • publishAuthModes

        public final List<AuthMode> publishAuthModes()

        The authorization mode to use for publishing messages on the channel namespace. This configuration overrides the default Api authorization configuration.

        Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

        This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasPublishAuthModes() method.

        Returns:
        The authorization mode to use for publishing messages on the channel namespace. This configuration overrides the default Api authorization configuration.
      • codeHandlers

        public final String codeHandlers()

        The event handler functions that run custom business logic to process published events and subscribe requests.

        Returns:
        The event handler functions that run custom business logic to process published events and subscribe requests.
      • hasTags

        public final boolean hasTags()
        For responses, this returns true if the service returned a value for the Tags property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
      • tags

        public final Map<String,​String> tags()
        Returns the value of the Tags property for this object.

        Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

        This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasTags() method.

        Returns:
        The value of the Tags property for this object.
      • toString

        public final String toString()
        Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
        Overrides:
        toString in class Object