Package software.amazon.awssdk.services.chimesdkidentity.model

Interface AppInstanceUserEndpoint.Builder

    • Method Detail

      • appInstanceUserArn

        AppInstanceUserEndpoint.Builder appInstanceUserArn​(String appInstanceUserArn)

        The ARN of the AppInstanceUser.

        Parameters:
        appInstanceUserArn - The ARN of the AppInstanceUser.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • endpointId

        AppInstanceUserEndpoint.Builder endpointId​(String endpointId)

        The unique identifier of the AppInstanceUserEndpoint.

        Parameters:
        endpointId - The unique identifier of the AppInstanceUserEndpoint.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • name

        AppInstanceUserEndpoint.Builder name​(String name)

        The name of the AppInstanceUserEndpoint.

        Parameters:
        name - The name of the AppInstanceUserEndpoint.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • resourceArn

        AppInstanceUserEndpoint.Builder resourceArn​(String resourceArn)

        The ARN of the resource to which the endpoint belongs.

        Parameters:
        resourceArn - The ARN of the resource to which the endpoint belongs.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • endpointAttributes

        AppInstanceUserEndpoint.Builder endpointAttributes​(EndpointAttributes endpointAttributes)

        The attributes of an Endpoint.

        Parameters:
        endpointAttributes - The attributes of an Endpoint.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • createdTimestamp

        AppInstanceUserEndpoint.Builder createdTimestamp​(Instant createdTimestamp)

        The time at which an AppInstanceUserEndpoint was created.

        Parameters:
        createdTimestamp - The time at which an AppInstanceUserEndpoint was created.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • lastUpdatedTimestamp

        AppInstanceUserEndpoint.Builder lastUpdatedTimestamp​(Instant lastUpdatedTimestamp)

        The time at which an AppInstanceUserEndpoint was last updated.

        Parameters:
        lastUpdatedTimestamp - The time at which an AppInstanceUserEndpoint was last updated.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • allowMessages

        AppInstanceUserEndpoint.Builder allowMessages​(String allowMessages)

        Boolean that controls whether the AppInstanceUserEndpoint is opted in to receive messages. ALL indicates the endpoint will receive all messages. NONE indicates the endpoint will receive no messages.

        Parameters:
        allowMessages - Boolean that controls whether the AppInstanceUserEndpoint is opted in to receive messages. ALL indicates the endpoint will receive all messages. NONE indicates the endpoint will receive no messages.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        AllowMessages, AllowMessages

      • allowMessages

        AppInstanceUserEndpoint.Builder allowMessages​(AllowMessages allowMessages)

        Boolean that controls whether the AppInstanceUserEndpoint is opted in to receive messages. ALL indicates the endpoint will receive all messages. NONE indicates the endpoint will receive no messages.

        Parameters:
        allowMessages - Boolean that controls whether the AppInstanceUserEndpoint is opted in to receive messages. ALL indicates the endpoint will receive all messages. NONE indicates the endpoint will receive no messages.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        AllowMessages, AllowMessages

      • endpointState

        AppInstanceUserEndpoint.Builder endpointState​(EndpointState endpointState)

        A read-only field that represents the state of an AppInstanceUserEndpoint. Supported values:

        • ACTIVE: The AppInstanceUserEndpoint is active and able to receive messages. When ACTIVE, the EndpointStatusReason remains empty.

        • INACTIVE: The AppInstanceUserEndpoint is inactive and can't receive message. When INACTIVE, the corresponding reason will be conveyed through EndpointStatusReason.

        • INVALID_DEVICE_TOKEN indicates that an AppInstanceUserEndpoint is INACTIVE due to invalid device token

        • INVALID_PINPOINT_ARN indicates that an AppInstanceUserEndpoint is INACTIVE due to an invalid pinpoint ARN that was input through the ResourceArn field.

        Parameters:
        endpointState - A read-only field that represents the state of an AppInstanceUserEndpoint. Supported values:

        • ACTIVE: The AppInstanceUserEndpoint is active and able to receive messages. When ACTIVE, the EndpointStatusReason remains empty.

        • INACTIVE: The AppInstanceUserEndpoint is inactive and can't receive message. When INACTIVE, the corresponding reason will be conveyed through EndpointStatusReason.

        • INVALID_DEVICE_TOKEN indicates that an AppInstanceUserEndpoint is INACTIVE due to invalid device token

        • INVALID_PINPOINT_ARN indicates that an AppInstanceUserEndpoint is INACTIVE due to an invalid pinpoint ARN that was input through the ResourceArn field.

        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • endpointState

        default AppInstanceUserEndpoint.Builder endpointState​(Consumer<EndpointState.Builder> endpointState)

        A read-only field that represents the state of an AppInstanceUserEndpoint. Supported values:

        • ACTIVE: The AppInstanceUserEndpoint is active and able to receive messages. When ACTIVE, the EndpointStatusReason remains empty.

        • INACTIVE: The AppInstanceUserEndpoint is inactive and can't receive message. When INACTIVE, the corresponding reason will be conveyed through EndpointStatusReason.

        • INVALID_DEVICE_TOKEN indicates that an AppInstanceUserEndpoint is INACTIVE due to invalid device token

        • INVALID_PINPOINT_ARN indicates that an AppInstanceUserEndpoint is INACTIVE due to an invalid pinpoint ARN that was input through the ResourceArn field.

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

        When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to endpointState(EndpointState).

        Parameters:
        endpointState - a consumer that will call methods on EndpointState.Builder
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        endpointState(EndpointState)