Interface StartParticipantReplicationRequest.Builder

All Superinterfaces:
AwsRequest.Builder, Buildable, CopyableBuilder<StartParticipantReplicationRequest.Builder,StartParticipantReplicationRequest>, IvsRealTimeRequest.Builder, SdkBuilder<StartParticipantReplicationRequest.Builder,StartParticipantReplicationRequest>, SdkPojo, SdkRequest.Builder
Enclosing class:
StartParticipantReplicationRequest
@Mutable @NotThreadSafe public static interface StartParticipantReplicationRequest.Builder extends IvsRealTimeRequest.Builder, SdkPojo, CopyableBuilder<StartParticipantReplicationRequest.Builder,StartParticipantReplicationRequest>

  • Method Details

    • sourceStageArn

      StartParticipantReplicationRequest.Builder sourceStageArn(String sourceStageArn)

      ARN of the stage where the participant is publishing.

      Parameters:
      sourceStageArn - ARN of the stage where the participant is publishing.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • destinationStageArn

      StartParticipantReplicationRequest.Builder destinationStageArn(String destinationStageArn)

      ARN of the stage to which the participant will be replicated.

      Parameters:
      destinationStageArn - ARN of the stage to which the participant will be replicated.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • participantId

      StartParticipantReplicationRequest.Builder participantId(String participantId)

      Participant ID of the publisher that will be replicated. This is assigned by IVS and returned by CreateParticipantToken or the jti (JWT ID) used to create a self signed token.

      Parameters:
      participantId - Participant ID of the publisher that will be replicated. This is assigned by IVS and returned by CreateParticipantToken or the jti (JWT ID) used to create a self signed token.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • reconnectWindowSeconds

      StartParticipantReplicationRequest.Builder reconnectWindowSeconds(Integer reconnectWindowSeconds)

      If the participant disconnects and then reconnects within the specified interval, replication will continue to be ACTIVE. Default: 0.

      Parameters:
      reconnectWindowSeconds - If the participant disconnects and then reconnects within the specified interval, replication will continue to be ACTIVE. Default: 0.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • attributes

      StartParticipantReplicationRequest.Builder attributes(Map<String,String> attributes)

      Application-provided attributes to set on the replicated participant in the destination stage. Map keys and values can contain UTF-8 encoded text. The maximum length of this field is 1 KB total. This field is exposed to all stage participants and should not be used for personally identifying, confidential, or sensitive information.

      These attributes are merged with any attributes set for this participant when creating the token. If there is overlap in keys, the values in these attributes are replaced.

      Parameters:
      attributes - Application-provided attributes to set on the replicated participant in the destination stage. Map keys and values can contain UTF-8 encoded text. The maximum length of this field is 1 KB total. This field is exposed to all stage participants and should not be used for personally identifying, confidential, or sensitive information.

      These attributes are merged with any attributes set for this participant when creating the token. If there is overlap in keys, the values in these attributes are replaced.

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

    • overrideConfiguration

      StartParticipantReplicationRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      overrideConfiguration - The override configuration.
      Returns:
      This object for method chaining.

    • overrideConfiguration

      StartParticipantReplicationRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.
      Returns:
      This object for method chaining.