Interface PutRumEventsRequest.Builder

  • Method Details

    • id

      The ID of the app monitor that is sending this data.

      Parameters:
      id - The ID of the app monitor that is sending this data.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • batchId

      A unique identifier for this batch of RUM event data.

      Parameters:
      batchId - A unique identifier for this batch of RUM event data.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • appMonitorDetails

      PutRumEventsRequest.Builder appMonitorDetails(AppMonitorDetails appMonitorDetails)

      A structure that contains information about the app monitor that collected this telemetry information.

      Parameters:
      appMonitorDetails - A structure that contains information about the app monitor that collected this telemetry information.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • appMonitorDetails

      default PutRumEventsRequest.Builder appMonitorDetails(Consumer<AppMonitorDetails.Builder> appMonitorDetails)

      A structure that contains information about the app monitor that collected this telemetry information.

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

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

      Parameters:
      appMonitorDetails - a consumer that will call methods on AppMonitorDetails.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • userDetails

      PutRumEventsRequest.Builder userDetails(UserDetails userDetails)

      A structure that contains information about the user session that this batch of events was collected from.

      Parameters:
      userDetails - A structure that contains information about the user session that this batch of events was collected from.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • userDetails

      default PutRumEventsRequest.Builder userDetails(Consumer<UserDetails.Builder> userDetails)

      A structure that contains information about the user session that this batch of events was collected from.

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

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

      Parameters:
      userDetails - a consumer that will call methods on UserDetails.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • rumEvents

      An array of structures that contain the telemetry event data.

      Parameters:
      rumEvents - An array of structures that contain the telemetry event data.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • rumEvents

      PutRumEventsRequest.Builder rumEvents(RumEvent... rumEvents)

      An array of structures that contain the telemetry event data.

      Parameters:
      rumEvents - An array of structures that contain the telemetry event data.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • rumEvents

      An array of structures that contain the telemetry event data.

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

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to rumEvents(List<RumEvent>).

      Parameters:
      rumEvents - a consumer that will call methods on RumEvent.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • alias

      If the app monitor uses a resource-based policy that requires PutRumEvents requests to specify a certain alias, specify that alias here. This alias will be compared to the rum:alias context key in the resource-based policy. For more information, see Using resource-based policies with CloudWatch RUM.

      Parameters:
      alias - If the app monitor uses a resource-based policy that requires PutRumEvents requests to specify a certain alias, specify that alias here. This alias will be compared to the rum:alias context key in the resource-based policy. For more information, see Using resource-based policies with CloudWatch RUM.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • sessionMetadata

      PutRumEventsRequest.Builder sessionMetadata(String sessionMetadata)

      A JSON serialization of attributes that apply to every event in this batch, such as the browser, device, and operating system of the end user. CloudWatch RUM merges these attributes into each event in the batch, so you send them once for the batch instead of once for each event. If an attribute appears both here and in an individual event's metadata, CloudWatch RUM uses the value in the event's metadata.

      Parameters:
      sessionMetadata - A JSON serialization of attributes that apply to every event in this batch, such as the browser, device, and operating system of the end user. CloudWatch RUM merges these attributes into each event in the batch, so you send them once for the batch instead of once for each event. If an attribute appears both here and in an individual event's metadata, CloudWatch RUM uses the value in the event's metadata.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • overrideConfiguration

      PutRumEventsRequest.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

      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.