Package software.amazon.awssdk.services.s3.model

Class ListObjectVersionsRequest

    • Method Detail

      • bucket

        public final String bucket()

        The bucket name that contains the objects.

        Returns:
        The bucket name that contains the objects.

      • delimiter

        public final String delimiter()

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

      • encodingTypeAsString

        public final String encodingTypeAsString()
        Returns the value of the EncodingType property for this object.

        If the service returns an enum value that is not available in the current SDK version, encodingType will return EncodingType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from encodingTypeAsString().

        Returns:
        The value of the EncodingType property for this object.
        See Also:
        EncodingType

      • keyMarker

        public final String keyMarker()

        Specifies the key to start with when listing objects in a bucket.

        Returns:
        Specifies the key to start with when listing objects in a bucket.

      • maxKeys

        public final Integer maxKeys()

        Sets the maximum number of keys returned in the response. By default, the action returns up to 1,000 key names. The response might contain fewer keys but will never contain more. If additional keys satisfy the search criteria, but were not returned because max-keys was exceeded, the response contains <isTruncated>true</isTruncated>. To return the additional keys, see key-marker and version-id-marker.

        Returns:
        Sets the maximum number of keys returned in the response. By default, the action returns up to 1,000 key names. The response might contain fewer keys but will never contain more. If additional keys satisfy the search criteria, but were not returned because max-keys was exceeded, the response contains <isTruncated>true</isTruncated>. To return the additional keys, see key-marker and version-id-marker.

      • prefix

        public final String prefix()

        Use this parameter to select only those keys that begin with the specified prefix. You can use prefixes to separate a bucket into different groupings of keys. (You can think of using prefix to make groups in the same way that you'd use a folder in a file system.) You can use prefix with delimiter to roll up numerous objects into a single result under CommonPrefixes.

        Returns:
        Use this parameter to select only those keys that begin with the specified prefix. You can use prefixes to separate a bucket into different groupings of keys. (You can think of using prefix to make groups in the same way that you'd use a folder in a file system.) You can use prefix with delimiter to roll up numerous objects into a single result under CommonPrefixes.

      • versionIdMarker

        public final String versionIdMarker()

        Specifies the object version you want to start listing from.

        Returns:
        Specifies the object version you want to start listing from.

      • expectedBucketOwner

        public final String expectedBucketOwner()

        The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).

        Returns:
        The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).

      • requestPayerAsString

        public final String requestPayerAsString()
        Returns the value of the RequestPayer property for this object.

        If the service returns an enum value that is not available in the current SDK version, requestPayer will return RequestPayer.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from requestPayerAsString().

        Returns:
        The value of the RequestPayer property for this object.
        See Also:
        RequestPayer

      • optionalObjectAttributes

        public final List<OptionalObjectAttributes> optionalObjectAttributes()

        Specifies the optional fields that you want returned in the response. Fields that you do not specify are not returned.

        Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

        This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasOptionalObjectAttributes() method.

        Returns:
        Specifies the optional fields that you want returned in the response. Fields that you do not specify are not returned.

      • hasOptionalObjectAttributes

        public final boolean hasOptionalObjectAttributes()
        For responses, this returns true if the service returned a value for the OptionalObjectAttributes property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

      • optionalObjectAttributesAsStrings

        public final List<String> optionalObjectAttributesAsStrings()

        Specifies the optional fields that you want returned in the response. Fields that you do not specify are not returned.

        Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

        This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasOptionalObjectAttributes() method.

        Returns:
        Specifies the optional fields that you want returned in the response. Fields that you do not specify are not returned.

      • toString

        public final String toString()
        Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
        Overrides:
        toString in class Object