You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::S3::Types::GetObjectRequest

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing GetObjectRequest as input to an Aws::Client method, you can use a vanilla Hash:

{
  bucket: "BucketName", # required
  if_match: "IfMatch",
  if_modified_since: Time.now,
  if_none_match: "IfNoneMatch",
  if_unmodified_since: Time.now,
  key: "ObjectKey", # required
  range: "Range",
  response_cache_control: "ResponseCacheControl",
  response_content_disposition: "ResponseContentDisposition",
  response_content_encoding: "ResponseContentEncoding",
  response_content_language: "ResponseContentLanguage",
  response_content_type: "ResponseContentType",
  response_expires: Time.now,
  version_id: "ObjectVersionId",
  sse_customer_algorithm: "SSECustomerAlgorithm",
  sse_customer_key: "SSECustomerKey",
  sse_customer_key_md5: "SSECustomerKeyMD5",
  request_payer: "requester", # accepts requester
  part_number: 1,
  use_accelerate_endpoint: false,
}

Instance Attribute Summary collapse

Instance Attribute Details

#bucketString

Returns:

  • (String)

#if_matchString

Return the object only if its entity tag (ETag) is the same as the one specified, otherwise return a 412 (precondition failed).

Returns:

  • (String)

    Return the object only if its entity tag (ETag) is the same as the one specified, otherwise return a 412 (precondition failed).

#if_modified_sinceTime

Return the object only if it has been modified since the specified time, otherwise return a 304 (not modified).

Returns:

  • (Time)

    Return the object only if it has been modified since the specified time, otherwise return a 304 (not modified).

#if_none_matchString

Return the object only if its entity tag (ETag) is different from the one specified, otherwise return a 304 (not modified).

Returns:

  • (String)

    Return the object only if its entity tag (ETag) is different from the one specified, otherwise return a 304 (not modified).

#if_unmodified_sinceTime

Return the object only if it has not been modified since the specified time, otherwise return a 412 (precondition failed).

Returns:

  • (Time)

    Return the object only if it has not been modified since the specified time, otherwise return a 412 (precondition failed).

#keyString

Returns:

  • (String)

#part_numberInteger

Part number of the object being read. This is a positive integer between 1 and 10,000. Effectively performs a \'ranged\' GET request for the part specified. Useful for downloading just a part of an object.

Returns:

  • (Integer)

    Part number of the object being read.

#rangeString

Downloads the specified range bytes of an object. For more information about the HTTP Range header, go to http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.35.

Returns:

  • (String)

    Downloads the specified range bytes of an object.

#request_payerString

Confirms that the requester knows that she or he will be charged for the request. Bucket owners need not specify this parameter in their requests. Documentation on downloading objects from requester pays buckets can be found at http://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html

Possible values:

  • requester

Returns:

  • (String)

    Confirms that the requester knows that she or he will be charged for the request.

#response_cache_controlString

Sets the Cache-Control header of the response.

Returns:

  • (String)

    Sets the Cache-Control header of the response.

#response_content_dispositionString

Sets the Content-Disposition header of the response

Returns:

  • (String)

    Sets the Content-Disposition header of the response.

#response_content_encodingString

Sets the Content-Encoding header of the response.

Returns:

  • (String)

    Sets the Content-Encoding header of the response.

#response_content_languageString

Sets the Content-Language header of the response.

Returns:

  • (String)

    Sets the Content-Language header of the response.

#response_content_typeString

Sets the Content-Type header of the response.

Returns:

  • (String)

    Sets the Content-Type header of the response.

#response_expiresTime

Sets the Expires header of the response.

Returns:

  • (Time)

    Sets the Expires header of the response.

#sse_customer_algorithmString

Specifies the algorithm to use to when encrypting the object (e.g., AES256).

Returns:

  • (String)

    Specifies the algorithm to use to when encrypting the object (e.g., AES256).

#sse_customer_keyString

Specifies the customer-provided encryption key for Amazon S3 to use in encrypting data. This value is used to store the object and then it is discarded; Amazon does not store the encryption key. The key must be appropriate for use with the algorithm specified in the x-amz-server-side​-encryption​-customer-algorithm header.

Returns:

  • (String)

    Specifies the customer-provided encryption key for Amazon S3 to use in encrypting data.

#sse_customer_key_md5String

Specifies the 128-bit MD5 digest of the encryption key according to RFC 1321. Amazon S3 uses this header for a message integrity check to ensure the encryption key was transmitted without error.

Returns:

  • (String)

    Specifies the 128-bit MD5 digest of the encryption key according to RFC 1321.

#use_accelerate_endpointBoolean

When true, the "https://BUCKETNAME.s3-accelerate.amazonaws.com" endpoint will be used.

Returns:

#version_idString

VersionId used to reference a specific version of the object.

Returns:

  • (String)

    VersionId used to reference a specific version of the object.