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

Interface SegmentResponse.Builder

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

  • Method Details

    • applicationId

      SegmentResponse.Builder applicationId(String applicationId)

      The unique identifier for the application that the segment is associated with.

      Parameters:
      applicationId - The unique identifier for the application that the segment is associated with.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • arn

      SegmentResponse.Builder arn(String arn)

      The Amazon Resource Name (ARN) of the segment.

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

    • creationDate

      SegmentResponse.Builder creationDate(String creationDate)

      The date and time when the segment was created.

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

    • dimensions

      SegmentResponse.Builder dimensions(SegmentDimensions dimensions)

      The dimension settings for the segment.

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

    • dimensions

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

      The dimension settings 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:

    • id

      SegmentResponse.Builder id(String id)

      The unique identifier for the segment.

      Parameters:
      id - The unique identifier for the segment.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • importDefinition

      SegmentResponse.Builder importDefinition(SegmentImportResource importDefinition)

      The settings for the import job that's associated with the segment.

      Parameters:
      importDefinition - The settings for the import job that's associated with the segment.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • importDefinition

      default SegmentResponse.Builder importDefinition(Consumer<SegmentImportResource.Builder> importDefinition)

      The settings for the import job that's associated with the segment.

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

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

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

    • lastModifiedDate

      SegmentResponse.Builder lastModifiedDate(String lastModifiedDate)

      The date and time when the segment was last modified.

      Parameters:
      lastModifiedDate - The date and time when the segment was last modified.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • name

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

      SegmentResponse.Builder segmentGroups(SegmentGroupList segmentGroups)

      A list of one or more segment groups that apply to the segment. Each segment group consists of zero or more base segments and the dimensions that are applied to those base segments.

      Parameters:
      segmentGroups - A list of one or more segment groups that apply to the segment. Each segment group consists of zero or more base segments and the dimensions that are applied to those base segments.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • segmentGroups

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

      A list of one or more segment groups that apply to the segment. Each segment group consists of zero or more base segments and the dimensions that are applied to those base segments.

      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:

    • segmentType

      SegmentResponse.Builder segmentType(String segmentType)

      The segment type. Valid values are:

      • DIMENSIONAL - A dynamic segment, which is a segment that uses selection criteria that you specify and is based on endpoint data that's reported by your app. Dynamic segments can change over time.

      • IMPORT - A static segment, which is a segment that uses selection criteria that you specify and is based on endpoint definitions that you import from a file. Imported segments are static; they don't change over time.

      Parameters:
      segmentType - The segment type. Valid values are:

      • DIMENSIONAL - A dynamic segment, which is a segment that uses selection criteria that you specify and is based on endpoint data that's reported by your app. Dynamic segments can change over time.

      • IMPORT - A static segment, which is a segment that uses selection criteria that you specify and is based on endpoint definitions that you import from a file. Imported segments are static; they don't change over time.

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

    • segmentType

      SegmentResponse.Builder segmentType(SegmentType segmentType)

      The segment type. Valid values are:

      • DIMENSIONAL - A dynamic segment, which is a segment that uses selection criteria that you specify and is based on endpoint data that's reported by your app. Dynamic segments can change over time.

      • IMPORT - A static segment, which is a segment that uses selection criteria that you specify and is based on endpoint definitions that you import from a file. Imported segments are static; they don't change over time.

      Parameters:
      segmentType - The segment type. Valid values are:

      • DIMENSIONAL - A dynamic segment, which is a segment that uses selection criteria that you specify and is based on endpoint data that's reported by your app. Dynamic segments can change over time.

      • IMPORT - A static segment, which is a segment that uses selection criteria that you specify and is based on endpoint definitions that you import from a file. Imported segments are static; they don't change over time.

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

    • tags

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

      A string-to-string map of key-value pairs that identifies the tags that are associated with the segment. Each tag consists of a required tag key and an associated tag value.

      Parameters:
      tags - A string-to-string map of key-value pairs that identifies the tags that are associated with the segment. Each tag consists of a required tag key and an associated tag value.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • version

      SegmentResponse.Builder version(Integer version)

      The version number of the segment.

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