Skip to content

Commit

Permalink
Add some notes regarding direct_path_prefix_object
Browse files Browse the repository at this point in the history
  • Loading branch information
huylenq committed Jun 21, 2018
1 parent 7e97e47 commit a5e8a42
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 0 deletions.
2 changes: 2 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,8 @@

- **path_prefix** prefix of target keys (string, required)

- **direct_path_prefix_object** flag to enable treating `path_prefix` as a single object key (boolean, default to `false`). Since list-objects operation on S3 is eventually consistent, using this for a more reliable way to retrieve a single object when you know the exact object key.

- **endpoint** S3 endpoint login user name (string, optional)

- **region** S3 region. endpoint will be in effect if you specify both of endpoint and region (string, optional)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -82,6 +82,12 @@ public interface PluginTask
@ConfigDefault("false")
public boolean getSkipGlacierObjects();

/**
* When this is on, "path_prefix" config will be treated as a single object key,
*
* Since list-objects operation on S3 is eventually consistent, using this for a
* more reliable way to retrieve a single object when you know the exact object key.
*/
@Config("direct_path_prefix_object")
@ConfigDefault("false")
public boolean getDirectPathPrefixObject();
Expand Down

0 comments on commit a5e8a42

Please sign in to comment.