Package software.amazon.awssdk.services.pinpoint.model

Interface WriteSegmentRequest.Builder

All Superinterfaces:
Buildable, CopyableBuilder<WriteSegmentRequest.Builder,WriteSegmentRequest>, SdkBuilder<WriteSegmentRequest.Builder,WriteSegmentRequest>, SdkPojo
Enclosing class:
WriteSegmentRequest
public static interface WriteSegmentRequest.Builder extends SdkPojo, CopyableBuilder<WriteSegmentRequest.Builder,WriteSegmentRequest>

  • Method Details

    • dimensions

      WriteSegmentRequest.Builder dimensions(SegmentDimensions dimensions)

      The criteria that define the dimensions for the segment.

      Parameters:
      dimensions - The criteria that define the dimensions for the segment.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • dimensions

      default WriteSegmentRequest.Builder dimensions(Consumer<SegmentDimensions.Builder> dimensions)

      The criteria that define the dimensions for the segment.

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

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

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

    • name

      WriteSegmentRequest.Builder name(String name)

      The name of the segment.

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

    • segmentGroups

      WriteSegmentRequest.Builder segmentGroups(SegmentGroupList segmentGroups)

      The segment group to use and the dimensions to apply to the group's base segments in order to build the segment. A segment group can consist of zero or more base segments. Your request can include only one segment group.

      Parameters:
      segmentGroups - The segment group to use and the dimensions to apply to the group's base segments in order to build the segment. A segment group can consist of zero or more base segments. Your request can include only one segment group.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • segmentGroups

      default WriteSegmentRequest.Builder segmentGroups(Consumer<SegmentGroupList.Builder> segmentGroups)

      The segment group to use and the dimensions to apply to the group's base segments in order to build the segment. A segment group can consist of zero or more base segments. Your request can include only one segment group.

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

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

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

    • tags

      WriteSegmentRequest.Builder tags(Map<String,String> tags)

      As of 22-05-2023 tags has been deprecated for update operations. After this date any value in tags is not processed and an error code is not returned. To manage tags we recommend using either Tags in the API Reference for Amazon Pinpoint, resourcegroupstaggingapi commands in the AWS Command Line Interface Documentation or resourcegroupstaggingapi in the AWS SDK.

      (Deprecated) A string-to-string map of key-value pairs that defines the tags to associate with the segment. Each tag consists of a required tag key and an associated tag value.

      Parameters:
      tags - As of 22-05-2023 tags has been deprecated for update operations. After this date any value in tags is not processed and an error code is not returned. To manage tags we recommend using either Tags in the API Reference for Amazon Pinpoint, resourcegroupstaggingapi commands in the AWS Command Line Interface Documentation or resourcegroupstaggingapi in the AWS SDK.

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