Interface S3Object.Builder

All Superinterfaces:
Buildable, CopyableBuilder<S3Object.Builder,S3Object>, SdkBuilder<S3Object.Builder,S3Object>, SdkPojo
Enclosing class:
S3Object
@Mutable @NotThreadSafe public static interface S3Object.Builder extends SdkPojo, CopyableBuilder<S3Object.Builder,S3Object>

  • Method Details

    • bucketArn

      S3Object.Builder bucketArn(String bucketArn)

      The Amazon Resource Name (ARN) of the bucket that contains the object.

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

    • eTag

      S3Object.Builder eTag(String eTag)

      The entity tag (ETag) that identifies the affected version of the object. If the object was overwritten or changed after Amazon Macie produced the finding, this value might be different from the current ETag for the object.

      Parameters:
      eTag - The entity tag (ETag) that identifies the affected version of the object. If the object was overwritten or changed after Amazon Macie produced the finding, this value might be different from the current ETag for the object.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • extension

      S3Object.Builder extension(String extension)

      The file name extension of the object. If the object doesn't have a file name extension, this value is "".

      Parameters:
      extension - The file name extension of the object. If the object doesn't have a file name extension, this value is "".
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • key

      S3Object.Builder key(String key)

      The full name (key) of the object, including the object's prefix if applicable.

      Parameters:
      key - The full name (key) of the object, including the object's prefix if applicable.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • lastModified

      S3Object.Builder lastModified(Instant lastModified)

      The date and time, in UTC and extended ISO 8601 format, when the object was last modified.

      Parameters:
      lastModified - The date and time, in UTC and extended ISO 8601 format, when the object was last modified.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • path

      S3Object.Builder path(String path)

      The full path to the affected object, including the name of the affected bucket and the object's name (key).

      Parameters:
      path - The full path to the affected object, including the name of the affected bucket and the object's name (key).
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • publicAccess

      S3Object.Builder publicAccess(Boolean publicAccess)

      Specifies whether the object is publicly accessible due to the combination of permissions settings that apply to the object.

      Parameters:
      publicAccess - Specifies whether the object is publicly accessible due to the combination of permissions settings that apply to the object.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • serverSideEncryption

      S3Object.Builder serverSideEncryption(ServerSideEncryption serverSideEncryption)

      The type of server-side encryption that was used to encrypt the object.

      Parameters:
      serverSideEncryption - The type of server-side encryption that was used to encrypt the object.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • serverSideEncryption

      default S3Object.Builder serverSideEncryption(Consumer<ServerSideEncryption.Builder> serverSideEncryption)

      The type of server-side encryption that was used to encrypt the object.

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

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

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

    • size

      S3Object.Builder size(Long size)

      The total storage size, in bytes, of the object.

      Parameters:
      size - The total storage size, in bytes, of the object.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • storageClass

      S3Object.Builder storageClass(String storageClass)

      The storage class of the object.

      Parameters:
      storageClass - The storage class of the object.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • storageClass

      S3Object.Builder storageClass(StorageClass storageClass)

      The storage class of the object.

      Parameters:
      storageClass - The storage class of the object.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • tags

      S3Object.Builder tags(Collection<KeyValuePair> tags)

      The tags that are associated with the object.

      Parameters:
      tags - The tags that are associated with the object.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • tags

      S3Object.Builder tags(KeyValuePair... tags)

      The tags that are associated with the object.

      Parameters:
      tags - The tags that are associated with the object.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • tags

      S3Object.Builder tags(Consumer<KeyValuePair.Builder>... tags)

      The tags that are associated with the object.

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

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

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

    • versionId

      S3Object.Builder versionId(String versionId)

      The identifier for the affected version of the object.

      Parameters:
      versionId - The identifier for the affected version of the object.
      Returns:
      Returns a reference to this object so that method calls can be chained together.