Interface ListObjectVersionsResponse.Builder

All Superinterfaces:
AwsResponse.Builder, Buildable, CopyableBuilder<ListObjectVersionsResponse.Builder,ListObjectVersionsResponse>, S3Response.Builder, SdkBuilder<ListObjectVersionsResponse.Builder,ListObjectVersionsResponse>, SdkPojo, SdkResponse.Builder
Enclosing class:
ListObjectVersionsResponse
public static interface ListObjectVersionsResponse.Builder extends S3Response.Builder, SdkPojo, CopyableBuilder<ListObjectVersionsResponse.Builder,ListObjectVersionsResponse>

  • Method Details

    • isTruncated

      ListObjectVersionsResponse.Builder isTruncated(Boolean isTruncated)

      A flag that indicates whether Amazon S3 returned all of the results that satisfied the search criteria. If your results were truncated, you can make a follow-up paginated request by using the NextKeyMarker and NextVersionIdMarker response parameters as a starting place in another request to return the rest of the results.

      Parameters:
      isTruncated - A flag that indicates whether Amazon S3 returned all of the results that satisfied the search criteria. If your results were truncated, you can make a follow-up paginated request by using the NextKeyMarker and NextVersionIdMarker response parameters as a starting place in another request to return the rest of the results.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • keyMarker

      ListObjectVersionsResponse.Builder keyMarker(String keyMarker)

      Marks the last key returned in a truncated response.

      Parameters:
      keyMarker - Marks the last key returned in a truncated response.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • versionIdMarker

      ListObjectVersionsResponse.Builder versionIdMarker(String versionIdMarker)

      Marks the last version of the key returned in a truncated response.

      Parameters:
      versionIdMarker - Marks the last version of the key returned in a truncated response.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • nextKeyMarker

      ListObjectVersionsResponse.Builder nextKeyMarker(String nextKeyMarker)

      When the number of responses exceeds the value of MaxKeys, NextKeyMarker specifies the first key not returned that satisfies the search criteria. Use this value for the key-marker request parameter in a subsequent request.

      Parameters:
      nextKeyMarker - When the number of responses exceeds the value of MaxKeys, NextKeyMarker specifies the first key not returned that satisfies the search criteria. Use this value for the key-marker request parameter in a subsequent request.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • nextVersionIdMarker

      ListObjectVersionsResponse.Builder nextVersionIdMarker(String nextVersionIdMarker)

      When the number of responses exceeds the value of MaxKeys, NextVersionIdMarker specifies the first object version not returned that satisfies the search criteria. Use this value for the version-id-marker request parameter in a subsequent request.

      Parameters:
      nextVersionIdMarker - When the number of responses exceeds the value of MaxKeys, NextVersionIdMarker specifies the first object version not returned that satisfies the search criteria. Use this value for the version-id-marker request parameter in a subsequent request.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • versions

      ListObjectVersionsResponse.Builder versions(Collection<ObjectVersion> versions)

      Container for version information.

      Parameters:
      versions - Container for version information.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • versions

      ListObjectVersionsResponse.Builder versions(ObjectVersion... versions)

      Container for version information.

      Parameters:
      versions - Container for version information.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • versions

      ListObjectVersionsResponse.Builder versions(Consumer<ObjectVersion.Builder>... versions)

      Container for version information.

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

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

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

    • deleteMarkers

      ListObjectVersionsResponse.Builder deleteMarkers(Collection<DeleteMarkerEntry> deleteMarkers)

      Container for an object that is a delete marker.

      Parameters:
      deleteMarkers - Container for an object that is a delete marker.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • deleteMarkers

      ListObjectVersionsResponse.Builder deleteMarkers(DeleteMarkerEntry... deleteMarkers)

      Container for an object that is a delete marker.

      Parameters:
      deleteMarkers - Container for an object that is a delete marker.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • deleteMarkers

      ListObjectVersionsResponse.Builder deleteMarkers(Consumer<DeleteMarkerEntry.Builder>... deleteMarkers)

      Container for an object that is a delete marker.

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

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

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

    • name

      ListObjectVersionsResponse.Builder name(String name)

      The bucket name.

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

    • prefix

      ListObjectVersionsResponse.Builder prefix(String prefix)

      Selects objects that start with the value supplied by this parameter.

      Parameters:
      prefix - Selects objects that start with the value supplied by this parameter.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • delimiter

      ListObjectVersionsResponse.Builder delimiter(String delimiter)

      The delimiter grouping the included keys. A delimiter is a character that you specify to group keys. All keys that contain the same string between the prefix and the first occurrence of the delimiter are grouped under a single result element in CommonPrefixes. These groups are counted as one result against the max-keys limitation. These keys are not returned elsewhere in the response.

      Parameters:
      delimiter - The delimiter grouping the included keys. A delimiter is a character that you specify to group keys. All keys that contain the same string between the prefix and the first occurrence of the delimiter are grouped under a single result element in CommonPrefixes. These groups are counted as one result against the max-keys limitation. These keys are not returned elsewhere in the response.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • maxKeys

      ListObjectVersionsResponse.Builder maxKeys(Integer maxKeys)

      Specifies the maximum number of objects to return.

      Parameters:
      maxKeys - Specifies the maximum number of objects to return.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • commonPrefixes

      ListObjectVersionsResponse.Builder commonPrefixes(Collection<CommonPrefix> commonPrefixes)

      All of the keys rolled up into a common prefix count as a single return when calculating the number of returns.

      Parameters:
      commonPrefixes - All of the keys rolled up into a common prefix count as a single return when calculating the number of returns.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • commonPrefixes

      ListObjectVersionsResponse.Builder commonPrefixes(CommonPrefix... commonPrefixes)

      All of the keys rolled up into a common prefix count as a single return when calculating the number of returns.

      Parameters:
      commonPrefixes - All of the keys rolled up into a common prefix count as a single return when calculating the number of returns.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • commonPrefixes

      ListObjectVersionsResponse.Builder commonPrefixes(Consumer<CommonPrefix.Builder>... commonPrefixes)

      All of the keys rolled up into a common prefix count as a single return when calculating the number of returns.

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

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

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

    • encodingType

      ListObjectVersionsResponse.Builder encodingType(String encodingType)

      Encoding type used by Amazon S3 to encode object key names in the XML response.

      If you specify the encoding-type request parameter, Amazon S3 includes this element in the response, and returns encoded key name values in the following response elements:

      KeyMarker, NextKeyMarker, Prefix, Key, and Delimiter.

      Parameters:
      encodingType - Encoding type used by Amazon S3 to encode object key names in the XML response.

      If you specify the encoding-type request parameter, Amazon S3 includes this element in the response, and returns encoded key name values in the following response elements:

      KeyMarker, NextKeyMarker, Prefix, Key, and Delimiter.

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

    • encodingType

      ListObjectVersionsResponse.Builder encodingType(EncodingType encodingType)

      Encoding type used by Amazon S3 to encode object key names in the XML response.

      If you specify the encoding-type request parameter, Amazon S3 includes this element in the response, and returns encoded key name values in the following response elements:

      KeyMarker, NextKeyMarker, Prefix, Key, and Delimiter.

      Parameters:
      encodingType - Encoding type used by Amazon S3 to encode object key names in the XML response.

      If you specify the encoding-type request parameter, Amazon S3 includes this element in the response, and returns encoded key name values in the following response elements:

      KeyMarker, NextKeyMarker, Prefix, Key, and Delimiter.

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

    • requestCharged

      ListObjectVersionsResponse.Builder requestCharged(String requestCharged)
      Sets the value of the RequestCharged property for this object.
      Parameters:
      requestCharged - The new value for the RequestCharged property for this object.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • requestCharged

      ListObjectVersionsResponse.Builder requestCharged(RequestCharged requestCharged)
      Sets the value of the RequestCharged property for this object.
      Parameters:
      requestCharged - The new value for the RequestCharged property for this object.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also: