getObject method

Future<GetObjectResponse> getObject({ required String path, String? range, })

Downloads the object at the specified path. If the object’s upload availability is set to streaming, AWS Elemental MediaStore downloads the object even if it’s still uploading the object.

May throw ContainerNotFoundException. May throw ObjectNotFoundException. May throw RequestedRangeNotSatisfiableException. May throw InternalServerError.

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

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

Implementation

Future<GetObjectResponse> getObject({
  required String path,
  String? range,
}) async {
  ArgumentError.checkNotNull(path, 'path');
  _s.validateStringLength(
    'path',
    path,
    1,
    900,
    isRequired: true,
  );
  final headers = <String, String>{
    if (range != null) 'Range': range.toString(),
  };
  final response = await _protocol.sendRaw(
    payload: null,
    method: 'GET',
    requestUri: '/${path.split('/').map(Uri.encodeComponent).join('/')}',
    headers: headers,
    exceptionFnMap: _exceptionFns,
  );
  return GetObjectResponse(
    body: await response.stream.toBytes(),
    cacheControl:
        _s.extractHeaderStringValue(response.headers, 'Cache-Control'),
    contentLength:
        _s.extractHeaderIntValue(response.headers, 'Content-Length'),
    contentRange:
        _s.extractHeaderStringValue(response.headers, 'Content-Range'),
    contentType:
        _s.extractHeaderStringValue(response.headers, 'Content-Type'),
    eTag: _s.extractHeaderStringValue(response.headers, 'ETag'),
    lastModified:
        _s.extractHeaderDateTimeValue(response.headers, 'Last-Modified'),
    statusCode: response.statusCode,
  );
}