Package software.amazon.awssdk.services.mediastoredata.model

Interface GetObjectRequest.Builder

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

  • Method Details

    • path

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

    • range

      GetObjectRequest.Builder range(String range)

      The range bytes of an object to retrieve. For more information about the Range header, see http://www.w3.org/Protocols/rfc2616/ rfc2616-sec14.html#sec14.35. AWS Elemental MediaStore ignores this header for partially uploaded objects that have streaming upload availability.

      Parameters:
      range - The range bytes of an object to retrieve. For more information about the Range header, see http://www.w3.org/Protocols /rfc2616/rfc2616-sec14.html#sec14.35. AWS Elemental MediaStore ignores this header for partially uploaded objects that have streaming upload availability.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • overrideConfiguration

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

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