Class S3Bucket


  • public class S3Bucket
    extends java.lang.Object
    • Constructor Summary

      Constructors 
      Constructor Description
      S3Bucket​(S3Client client, com.amazonaws.services.s3.model.Bucket bucket)  
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      S3File asFile()  
      void deleteObject​(java.lang.String key)  
      S3Client getClient()  
      java.util.Date getCreationDate()  
      S3File getFile​(java.lang.String key)  
      java.lang.String getName()  
      com.amazonaws.services.s3.model.S3Object getObject​(java.lang.String key)  
      com.amazonaws.services.s3.model.S3ObjectInputStream getObjectAsStream​(java.lang.String key)
      Favor S3File.getValueAsStream() over this method.
      java.lang.String getObjectAsString​(java.lang.String key)
      Favor S3File.getValueAsString() over this method.
      com.amazonaws.services.s3.model.Owner getOwner()  
      java.util.stream.Stream<S3File> objects()  
      java.util.stream.Stream<S3File> objects​(com.amazonaws.services.s3.model.ListObjectsRequest request)  
      com.amazonaws.services.s3.model.PutObjectResult putObject​(java.lang.String key, java.io.File file)  
      com.amazonaws.services.s3.model.PutObjectResult putObject​(java.lang.String key, java.io.InputStream inputStream, com.amazonaws.services.s3.model.ObjectMetadata objectMetadata)  
      com.amazonaws.services.s3.model.PutObjectResult putObject​(java.lang.String key, java.lang.String s2)  
      void setCreationDate​(java.util.Date creationDate)  
      void setName​(java.lang.String name)  
      com.amazonaws.services.s3.model.PutObjectResult setObjectAsFile​(java.lang.String key, java.io.File value)  
      S3OutputStream setObjectAsStream​(java.lang.String key)  
      com.amazonaws.services.s3.model.PutObjectResult setObjectAsStream​(java.lang.String key, java.io.InputStream value)  
      com.amazonaws.services.s3.model.PutObjectResult setObjectAsString​(java.lang.String key, java.lang.String value)  
      void setOwner​(com.amazonaws.services.s3.model.Owner owner)  
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Constructor Detail

      • S3Bucket

        public S3Bucket​(S3Client client,
                        com.amazonaws.services.s3.model.Bucket bucket)
    • Method Detail

      • getClient

        public S3Client getClient()
      • asFile

        public S3File asFile()
      • objects

        public java.util.stream.Stream<S3File> objects()
      • objects

        public java.util.stream.Stream<S3File> objects​(com.amazonaws.services.s3.model.ListObjectsRequest request)
      • putObject

        public com.amazonaws.services.s3.model.PutObjectResult putObject​(java.lang.String key,
                                                                         java.io.File file)
                                                                  throws com.amazonaws.SdkClientException,
                                                                         com.amazonaws.AmazonServiceException
        Throws:
        com.amazonaws.SdkClientException
        com.amazonaws.AmazonServiceException
      • putObject

        public com.amazonaws.services.s3.model.PutObjectResult putObject​(java.lang.String key,
                                                                         java.io.InputStream inputStream,
                                                                         com.amazonaws.services.s3.model.ObjectMetadata objectMetadata)
                                                                  throws com.amazonaws.SdkClientException,
                                                                         com.amazonaws.AmazonServiceException
        Throws:
        com.amazonaws.SdkClientException
        com.amazonaws.AmazonServiceException
      • putObject

        public com.amazonaws.services.s3.model.PutObjectResult putObject​(java.lang.String key,
                                                                         java.lang.String s2)
                                                                  throws com.amazonaws.AmazonServiceException,
                                                                         com.amazonaws.SdkClientException
        Throws:
        com.amazonaws.AmazonServiceException
        com.amazonaws.SdkClientException
      • getObject

        public com.amazonaws.services.s3.model.S3Object getObject​(java.lang.String key)
                                                           throws com.amazonaws.SdkClientException,
                                                                  com.amazonaws.AmazonServiceException
        Throws:
        com.amazonaws.SdkClientException
        com.amazonaws.AmazonServiceException
      • getFile

        public S3File getFile​(java.lang.String key)
                       throws com.amazonaws.SdkClientException,
                              com.amazonaws.AmazonServiceException
        Throws:
        com.amazonaws.SdkClientException
        com.amazonaws.AmazonServiceException
      • getObjectAsStream

        public com.amazonaws.services.s3.model.S3ObjectInputStream getObjectAsStream​(java.lang.String key)
                                                                              throws com.amazonaws.SdkClientException,
                                                                                     com.amazonaws.AmazonServiceException
        Favor S3File.getValueAsStream() over this method. The AmazonS3.getObjectAsString method call that powers this method will issue 2 HTTP requests to fetch the content. The first request will be to get the S3Object, the second call will use S3Object to request the content itself. The S3File.getValueAsStream() will make the same 2 requests, however, the S3Object will be kept afterwards allowing for calls to get other information about the content such as lastModified or etag to be zero cost. Additionally, any subsequent calls to get the content again will now be just 1 request.
        Throws:
        com.amazonaws.SdkClientException
        com.amazonaws.AmazonServiceException
      • getObjectAsString

        public java.lang.String getObjectAsString​(java.lang.String key)
                                           throws com.amazonaws.AmazonServiceException,
                                                  com.amazonaws.SdkClientException
        Favor S3File.getValueAsString() over this method. The AmazonS3.getObjectAsString method call that powers this method will issue 2 HTTP requests to fetch the content. The first request will be to get the S3Object, the second call will use S3Object to request the content itself. The S3File.getValueAsString() will make the same 2 requests, however, the S3Object will be kept afterwards allowing for calls to get other information about the content such as lastModified or etag to be zero cost. Additionally, any subsequent calls to get the content again will now be just 1 request.
        Throws:
        com.amazonaws.AmazonServiceException
        com.amazonaws.SdkClientException
      • setObjectAsStream

        public S3OutputStream setObjectAsStream​(java.lang.String key)
      • setObjectAsString

        public com.amazonaws.services.s3.model.PutObjectResult setObjectAsString​(java.lang.String key,
                                                                                 java.lang.String value)
      • setObjectAsFile

        public com.amazonaws.services.s3.model.PutObjectResult setObjectAsFile​(java.lang.String key,
                                                                               java.io.File value)
      • setObjectAsStream

        public com.amazonaws.services.s3.model.PutObjectResult setObjectAsStream​(java.lang.String key,
                                                                                 java.io.InputStream value)
      • deleteObject

        public void deleteObject​(java.lang.String key)
      • getOwner

        public com.amazonaws.services.s3.model.Owner getOwner()
      • setOwner

        public void setOwner​(com.amazonaws.services.s3.model.Owner owner)
      • getCreationDate

        public java.util.Date getCreationDate()
      • setCreationDate

        public void setCreationDate​(java.util.Date creationDate)
      • getName

        public java.lang.String getName()
      • setName

        public void setName​(java.lang.String name)