Interface PutObjectRequest.Builder

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

  • Method Details

    • path

      PutObjectRequest.Builder path(String path)

      The path (including the file name) where the object is stored in the container. Format: <folder name>/<folder name>/<file name>

      For example, to upload the file mlaw.avi to the folder path premium\canada in the container movies, enter the path premium/canada/mlaw.avi.

      Do not include the container name in this path.

      If the path includes any folders that don't exist yet, the service creates them. For example, suppose you have an existing premium/usa subfolder. If you specify premium/canada, the service creates a canada subfolder in the premium folder. You then have two subfolders, usa and canada, in the premium folder.

      There is no correlation between the path to the source and the path (folders) in the container in AWS Elemental MediaStore.

      For more information about folders and how they exist in a container, see the AWS Elemental MediaStore User Guide.

      The file name is the name that is assigned to the file that you upload. The file can have the same name inside and outside of AWS Elemental MediaStore, or it can have the same name. The file name can include or omit an extension.

      Parameters:
      path - The path (including the file name) where the object is stored in the container. Format: <folder name>/<folder name>/<file name>

      For example, to upload the file mlaw.avi to the folder path premium\canada in the container movies, enter the path premium/canada/mlaw.avi.

      Do not include the container name in this path.

      If the path includes any folders that don't exist yet, the service creates them. For example, suppose you have an existing premium/usa subfolder. If you specify premium/canada, the service creates a canada subfolder in the premium folder. You then have two subfolders, usa and canada, in the premium folder.

      There is no correlation between the path to the source and the path (folders) in the container in AWS Elemental MediaStore.

      For more information about folders and how they exist in a container, see the AWS Elemental MediaStore User Guide.

      The file name is the name that is assigned to the file that you upload. The file can have the same name inside and outside of AWS Elemental MediaStore, or it can have the same name. The file name can include or omit an extension.

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

    • contentType

      PutObjectRequest.Builder contentType(String contentType)

      The content type of the object.

      Parameters:
      contentType - The content type of the object.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • cacheControl

      PutObjectRequest.Builder cacheControl(String cacheControl)

      An optional CacheControl header that allows the caller to control the object's cache behavior. Headers can be passed in as specified in the HTTP at https://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.9.

      Headers with a custom user-defined value are also accepted.

      Parameters:
      cacheControl - An optional CacheControl header that allows the caller to control the object's cache behavior. Headers can be passed in as specified in the HTTP at https://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.9.

      Headers with a custom user-defined value are also accepted.

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

    • storageClass

      PutObjectRequest.Builder storageClass(String storageClass)

      Indicates the storage class of a Put request. Defaults to high-performance temporal storage class, and objects are persisted into durable storage shortly after being received.

      Parameters:
      storageClass - Indicates the storage class of a Put request. Defaults to high-performance temporal storage class, and objects are persisted into durable storage shortly after being received.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • storageClass

      PutObjectRequest.Builder storageClass(StorageClass storageClass)

      Indicates the storage class of a Put request. Defaults to high-performance temporal storage class, and objects are persisted into durable storage shortly after being received.

      Parameters:
      storageClass - Indicates the storage class of a Put request. Defaults to high-performance temporal storage class, and objects are persisted into durable storage shortly after being received.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • uploadAvailability

      PutObjectRequest.Builder uploadAvailability(String uploadAvailability)

      Indicates the availability of an object while it is still uploading. If the value is set to streaming, the object is available for downloading after some initial buffering but before the object is uploaded completely. If the value is set to standard, the object is available for downloading only when it is uploaded completely. The default value for this header is standard.

      To use this header, you must also set the HTTP Transfer-Encoding header to chunked.

      Parameters:
      uploadAvailability - Indicates the availability of an object while it is still uploading. If the value is set to streaming, the object is available for downloading after some initial buffering but before the object is uploaded completely. If the value is set to standard, the object is available for downloading only when it is uploaded completely. The default value for this header is standard.

      To use this header, you must also set the HTTP Transfer-Encoding header to chunked.

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

    • uploadAvailability

      PutObjectRequest.Builder uploadAvailability(UploadAvailability uploadAvailability)

      Indicates the availability of an object while it is still uploading. If the value is set to streaming, the object is available for downloading after some initial buffering but before the object is uploaded completely. If the value is set to standard, the object is available for downloading only when it is uploaded completely. The default value for this header is standard.

      To use this header, you must also set the HTTP Transfer-Encoding header to chunked.

      Parameters:
      uploadAvailability - Indicates the availability of an object while it is still uploading. If the value is set to streaming, the object is available for downloading after some initial buffering but before the object is uploaded completely. If the value is set to standard, the object is available for downloading only when it is uploaded completely. The default value for this header is standard.

      To use this header, you must also set the HTTP Transfer-Encoding header to chunked.

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

    • overrideConfiguration

      PutObjectRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      overrideConfiguration - The override configuration.
      Returns:
      This object for method chaining.

    • overrideConfiguration

      PutObjectRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.
      Returns:
      This object for method chaining.