public class GetMetadataArg extends Object
Modifier and Type | Class and Description |
---|---|
static class |
GetMetadataArg.Builder
Builder for
GetMetadataArg . |
Modifier and Type | Field and Description |
---|---|
protected boolean |
includeDeleted |
protected boolean |
includeHasExplicitSharedMembers |
protected boolean |
includeMediaInfo |
protected String |
path |
Constructor and Description |
---|
GetMetadataArg(String path)
The default values for unset fields will be used.
|
GetMetadataArg(String path,
boolean includeMediaInfo,
boolean includeDeleted,
boolean includeHasExplicitSharedMembers)
Use
newBuilder to create instances of this class without
specifying values for all optional fields. |
Modifier and Type | Method and Description |
---|---|
boolean |
equals(Object obj) |
boolean |
getIncludeDeleted()
If true,
DeletedMetadata will be returned for deleted file or
folder, otherwise LookupError.NOT_FOUND will be returned. |
boolean |
getIncludeHasExplicitSharedMembers()
If true, the results will include a flag for each file indicating whether
or not that file has any explicit members.
|
boolean |
getIncludeMediaInfo()
If true,
FileMetadata.getMediaInfo() is set for photo and video. |
String |
getPath()
The path of a file or folder on Dropbox.
|
int |
hashCode() |
static GetMetadataArg.Builder |
newBuilder(String path)
Returns a new builder for creating an instance of this class.
|
String |
toString() |
String |
toStringMultiline()
Returns a String representation of this object formatted for easier
readability.
|
protected final String path
protected final boolean includeMediaInfo
protected final boolean includeDeleted
protected final boolean includeHasExplicitSharedMembers
public GetMetadataArg(String path, boolean includeMediaInfo, boolean includeDeleted, boolean includeHasExplicitSharedMembers)
newBuilder
to create instances of this class without
specifying values for all optional fields.path
- The path of a file or folder on Dropbox. Must match pattern
"(/(.|[\\r\\n])*|id:.*)|(rev:[0-9a-f]{9,})|(ns:[0-9]+(/.*)?)
"
and not be null
.includeMediaInfo
- If true, FileMetadata.getMediaInfo()
is
set for photo and video.includeDeleted
- If true, DeletedMetadata
will be returned
for deleted file or folder, otherwise LookupError.NOT_FOUND
will be returned.includeHasExplicitSharedMembers
- If true, the results will include
a flag for each file indicating whether or not that file has any
explicit members.IllegalArgumentException
- If any argument does not meet its
preconditions.public GetMetadataArg(String path)
path
- The path of a file or folder on Dropbox. Must match pattern
"(/(.|[\\r\\n])*|id:.*)|(rev:[0-9a-f]{9,})|(ns:[0-9]+(/.*)?)
"
and not be null
.IllegalArgumentException
- If any argument does not meet its
preconditions.public String getPath()
null
.public boolean getIncludeMediaInfo()
FileMetadata.getMediaInfo()
is set for photo and video.null
if not present. Defaults to
false.public boolean getIncludeDeleted()
DeletedMetadata
will be returned for deleted file or
folder, otherwise LookupError.NOT_FOUND
will be returned.null
if not present. Defaults to
false.public boolean getIncludeHasExplicitSharedMembers()
null
if not present. Defaults to
false.public static GetMetadataArg.Builder newBuilder(String path)
path
- The path of a file or folder on Dropbox. Must match pattern
"(/(.|[\\r\\n])*|id:.*)|(rev:[0-9a-f]{9,})|(ns:[0-9]+(/.*)?)
"
and not be null
.IllegalArgumentException
- If any argument does not meet its
preconditions.public String toStringMultiline()
The returned String may contain newlines.