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

Class ListObjectsV2Request

java.lang.Object
software.amazon.awssdk.core.SdkRequest
software.amazon.awssdk.awscore.AwsRequest
software.amazon.awssdk.services.s3.model.S3Request
software.amazon.awssdk.services.s3.model.ListObjectsV2Request
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<ListObjectsV2Request.Builder,ListObjectsV2Request>
@Generated("software.amazon.awssdk:codegen") public final class ListObjectsV2Request extends S3Request implements ToCopyableBuilder<ListObjectsV2Request.Builder,ListObjectsV2Request>

  • Method Details

    • bucket

      public final String bucket()

      Bucket name to list.

      When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide.

      When you use this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When you use this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts access point ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see What is S3 on Outposts? in the Amazon S3 User Guide.

      Returns:
      Bucket name to list.

      When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide.

      When you use this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com . When you use this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts access point ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see What is S3 on Outposts? in the Amazon S3 User Guide.

    • delimiter

      public final String delimiter()

      A delimiter is a character that you use to group keys.

      Returns:
      A delimiter is a character that you use to group keys.

    • encodingType

      public final EncodingType encodingType()

      Encoding type used by Amazon S3 to encode object keys in the response.

      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:
      Encoding type used by Amazon S3 to encode object keys in the response.
      See Also:

    • encodingTypeAsString

      public final String encodingTypeAsString()

      Encoding type used by Amazon S3 to encode object keys in the response.

      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:
      Encoding type used by Amazon S3 to encode object keys in the response.
      See Also:

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

      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.

    • prefix

      public final String prefix()

      Limits the response to keys that begin with the specified prefix.

      Returns:
      Limits the response to keys that begin with the specified prefix.

    • continuationToken

      public final String continuationToken()

      ContinuationToken indicates to Amazon S3 that the list is being continued on this bucket with a token. ContinuationToken is obfuscated and is not a real key.

      Returns:
      ContinuationToken indicates to Amazon S3 that the list is being continued on this bucket with a token. ContinuationToken is obfuscated and is not a real key.

    • fetchOwner

      public final Boolean fetchOwner()

      The owner field is not present in ListObjectsV2 by default. If you want to return the owner field with each key in the result, then set the FetchOwner field to true.

      Returns:
      The owner field is not present in ListObjectsV2 by default. If you want to return the owner field with each key in the result, then set the FetchOwner field to true.

    • startAfter

      public final String startAfter()

      StartAfter is where you want Amazon S3 to start listing from. Amazon S3 starts listing after this specified key. StartAfter can be any key in the bucket.

      Returns:
      StartAfter is where you want Amazon S3 to start listing from. Amazon S3 starts listing after this specified key. StartAfter can be any key in the bucket.

    • requestPayer

      public final RequestPayer requestPayer()

      Confirms that the requester knows that she or he will be charged for the list objects request in V2 style. Bucket owners need not specify this parameter in their requests.

      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:
      Confirms that the requester knows that she or he will be charged for the list objects request in V2 style. Bucket owners need not specify this parameter in their requests.
      See Also:

    • requestPayerAsString

      public final String requestPayerAsString()

      Confirms that the requester knows that she or he will be charged for the list objects request in V2 style. Bucket owners need not specify this parameter in their requests.

      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:
      Confirms that the requester knows that she or he will be charged for the list objects request in V2 style. Bucket owners need not specify this parameter in their requests.
      See Also:

    • expectedBucketOwner

      public final String expectedBucketOwner()

      The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).

      Returns:
      The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).

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

    • toBuilder

      public ListObjectsV2Request.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<ListObjectsV2Request.Builder,ListObjectsV2Request>
      Specified by:
      toBuilder in class S3Request
      Returns:
      a builder for type T

    • builder

      public static ListObjectsV2Request.Builder builder()

    • serializableBuilderClass

      public static Class<? extends ListObjectsV2Request.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class AwsRequest

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class AwsRequest

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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

    • getValueForField

      public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
      Description copied from class: SdkRequest
      Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkRequest
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.