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

Class GetObjectRequest

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

  • Method Details

    • path

      public final 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.

      Returns:
      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.

    • range

      public final 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.

      Returns:
      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.

    • toBuilder

      public GetObjectRequest.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<GetObjectRequest.Builder,GetObjectRequest>
      Specified by:
      toBuilder in class MediaStoreDataRequest
      Returns:
      a builder for type T

    • builder

      public static GetObjectRequest.Builder builder()

    • serializableBuilderClass

      public static Class<? extends GetObjectRequest.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.