Package software.amazon.awssdk.services.appsync.model

Interface ChannelNamespace.Builder

    • Method Detail

      • apiId

        ChannelNamespace.Builder apiId​(String apiId)

        The Api ID.

        Parameters:
        apiId - The Api ID.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • name

        ChannelNamespace.Builder name​(String name)

        The name of the channel namespace. This name must be unique within the Api.

        Parameters:
        name - The name of the channel namespace. This name must be unique within the Api.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • subscribeAuthModes

        ChannelNamespace.Builder subscribeAuthModes​(Collection<AuthMode> subscribeAuthModes)

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

        Parameters:
        subscribeAuthModes - The authorization mode to use for subscribing to messages on the channel namespace. This configuration overrides the default Apiauthorization configuration.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • subscribeAuthModes

        ChannelNamespace.Builder subscribeAuthModes​(AuthMode... subscribeAuthModes)

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

        Parameters:
        subscribeAuthModes - The authorization mode to use for subscribing to messages on the channel namespace. This configuration overrides the default Apiauthorization configuration.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • subscribeAuthModes

        ChannelNamespace.Builder subscribeAuthModes​(Consumer<AuthMode.Builder>... subscribeAuthModes)

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

        This is a convenience method that creates an instance of the AuthMode.Builder avoiding the need to create one manually via AuthMode.builder().

        When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to #subscribeAuthModes(List).

        Parameters:
        subscribeAuthModes - a consumer that will call methods on AuthMode.Builder
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        #subscribeAuthModes(java.util.Collection)

      • publishAuthModes

        ChannelNamespace.Builder publishAuthModes​(Collection<AuthMode> publishAuthModes)

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

        Parameters:
        publishAuthModes - The authorization mode to use for publishing messages on the channel namespace. This configuration overrides the default Apiauthorization configuration.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • publishAuthModes

        ChannelNamespace.Builder publishAuthModes​(AuthMode... publishAuthModes)

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

        Parameters:
        publishAuthModes - The authorization mode to use for publishing messages on the channel namespace. This configuration overrides the default Apiauthorization configuration.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • publishAuthModes

        ChannelNamespace.Builder publishAuthModes​(Consumer<AuthMode.Builder>... publishAuthModes)

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

        This is a convenience method that creates an instance of the AuthMode.Builder avoiding the need to create one manually via AuthMode.builder().

        When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to #publishAuthModes(List).

        Parameters:
        publishAuthModes - a consumer that will call methods on AuthMode.Builder
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        #publishAuthModes(java.util.Collection)

      • codeHandlers

        ChannelNamespace.Builder codeHandlers​(String codeHandlers)

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

        Parameters:
        codeHandlers - The event handler functions that run custom business logic to process published events and subscribe requests.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • tags

        ChannelNamespace.Builder tags​(Map<String,​String> tags)
        Sets the value of the Tags property for this object.
        Parameters:
        tags - The new value for the Tags property for this object.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • channelNamespaceArn

        ChannelNamespace.Builder channelNamespaceArn​(String channelNamespaceArn)

        The Amazon Resource Name (ARN) for the ChannelNamespace.

        Parameters:
        channelNamespaceArn - The Amazon Resource Name (ARN) for the ChannelNamespace.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • created

        ChannelNamespace.Builder created​(Instant created)

        The date and time that the ChannelNamespace was created.

        Parameters:
        created - The date and time that the ChannelNamespace was created.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • lastModified

        ChannelNamespace.Builder lastModified​(Instant lastModified)

        The date and time that the ChannelNamespace was last changed.

        Parameters:
        lastModified - The date and time that the ChannelNamespace was last changed.
        Returns:
        Returns a reference to this object so that method calls can be chained together.