Class UpdatePropertiesError
- java.lang.Object
-
- com.dropbox.core.v2.fileproperties.UpdatePropertiesError
-
public final class UpdatePropertiesError extends java.lang.Object
This class is a tagged union. Tagged unions instances are always associated to a specific tag. This means only one of theisAbc()
methods will returntrue
. You can usetag()
to determine the tag associated with this instance.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
UpdatePropertiesError.Serializer
For internal use only.static class
UpdatePropertiesError.Tag
Discriminating tag type forUpdatePropertiesError
.
-
Field Summary
Fields Modifier and Type Field Description static UpdatePropertiesError
DOES_NOT_FIT_TEMPLATE
One or more of the supplied property fields does not conform to the template specifications.static UpdatePropertiesError
DUPLICATE_PROPERTY_GROUPS
There are 2 or more property groups referring to the same templates in the input.static UpdatePropertiesError
OTHER
Catch-all used for unknown tag values returned by the Dropbox servers.static UpdatePropertiesError
PROPERTY_FIELD_TOO_LARGE
One or more of the supplied property field values is too large.static UpdatePropertiesError
RESTRICTED_CONTENT
You do not have permission to modify this template.static UpdatePropertiesError
UNSUPPORTED_FOLDER
This folder cannot be tagged.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description boolean
equals(java.lang.Object obj)
LookupError
getPathValue()
This instance must be tagged asUpdatePropertiesError.Tag.PATH
.LookUpPropertiesError
getPropertyGroupLookupValue()
This instance must be tagged asUpdatePropertiesError.Tag.PROPERTY_GROUP_LOOKUP
.java.lang.String
getTemplateNotFoundValue()
Template does not exist for the given identifier.int
hashCode()
boolean
isDoesNotFitTemplate()
Returnstrue
if this instance has the tagUpdatePropertiesError.Tag.DOES_NOT_FIT_TEMPLATE
,false
otherwise.boolean
isDuplicatePropertyGroups()
Returnstrue
if this instance has the tagUpdatePropertiesError.Tag.DUPLICATE_PROPERTY_GROUPS
,false
otherwise.boolean
isOther()
boolean
isPath()
boolean
isPropertyFieldTooLarge()
Returnstrue
if this instance has the tagUpdatePropertiesError.Tag.PROPERTY_FIELD_TOO_LARGE
,false
otherwise.boolean
isPropertyGroupLookup()
Returnstrue
if this instance has the tagUpdatePropertiesError.Tag.PROPERTY_GROUP_LOOKUP
,false
otherwise.boolean
isRestrictedContent()
Returnstrue
if this instance has the tagUpdatePropertiesError.Tag.RESTRICTED_CONTENT
,false
otherwise.boolean
isTemplateNotFound()
Returnstrue
if this instance has the tagUpdatePropertiesError.Tag.TEMPLATE_NOT_FOUND
,false
otherwise.boolean
isUnsupportedFolder()
Returnstrue
if this instance has the tagUpdatePropertiesError.Tag.UNSUPPORTED_FOLDER
,false
otherwise.static UpdatePropertiesError
path(LookupError value)
Returns an instance ofUpdatePropertiesError
that has its tag set toUpdatePropertiesError.Tag.PATH
.static UpdatePropertiesError
propertyGroupLookup(LookUpPropertiesError value)
Returns an instance ofUpdatePropertiesError
that has its tag set toUpdatePropertiesError.Tag.PROPERTY_GROUP_LOOKUP
.UpdatePropertiesError.Tag
tag()
Returns the tag for this instance.static UpdatePropertiesError
templateNotFound(java.lang.String value)
Returns an instance ofUpdatePropertiesError
that has its tag set toUpdatePropertiesError.Tag.TEMPLATE_NOT_FOUND
.java.lang.String
toString()
java.lang.String
toStringMultiline()
Returns a String representation of this object formatted for easier readability.
-
-
-
Field Detail
-
RESTRICTED_CONTENT
public static final UpdatePropertiesError RESTRICTED_CONTENT
You do not have permission to modify this template.
-
OTHER
public static final UpdatePropertiesError OTHER
Catch-all used for unknown tag values returned by the Dropbox servers.Receiving a catch-all value typically indicates this SDK version is not up to date. Consider updating your SDK version to handle the new tags.
-
UNSUPPORTED_FOLDER
public static final UpdatePropertiesError UNSUPPORTED_FOLDER
This folder cannot be tagged. Tagging folders is not supported for team-owned templates.
-
PROPERTY_FIELD_TOO_LARGE
public static final UpdatePropertiesError PROPERTY_FIELD_TOO_LARGE
One or more of the supplied property field values is too large.
-
DOES_NOT_FIT_TEMPLATE
public static final UpdatePropertiesError DOES_NOT_FIT_TEMPLATE
One or more of the supplied property fields does not conform to the template specifications.
-
DUPLICATE_PROPERTY_GROUPS
public static final UpdatePropertiesError DUPLICATE_PROPERTY_GROUPS
There are 2 or more property groups referring to the same templates in the input.
-
-
Method Detail
-
tag
public UpdatePropertiesError.Tag tag()
Returns the tag for this instance.This class is a tagged union. Tagged unions instances are always associated to a specific tag. This means only one of the
isXyz()
methods will returntrue
. Callers are recommended to use the tag value in aswitch
statement to properly handle the different values for thisUpdatePropertiesError
.- Returns:
- the tag for this instance.
-
isTemplateNotFound
public boolean isTemplateNotFound()
Returnstrue
if this instance has the tagUpdatePropertiesError.Tag.TEMPLATE_NOT_FOUND
,false
otherwise.- Returns:
true
if this instance is tagged asUpdatePropertiesError.Tag.TEMPLATE_NOT_FOUND
,false
otherwise.
-
templateNotFound
public static UpdatePropertiesError templateNotFound(java.lang.String value)
Returns an instance ofUpdatePropertiesError
that has its tag set toUpdatePropertiesError.Tag.TEMPLATE_NOT_FOUND
.Template does not exist for the given identifier.
- Parameters:
value
- value to assign to this instance.- Returns:
- Instance of
UpdatePropertiesError
with its tag set toUpdatePropertiesError.Tag.TEMPLATE_NOT_FOUND
. - Throws:
java.lang.IllegalArgumentException
- ifvalue
is shorter than 1, does not match pattern "(/|ptid:).*
", or isnull
.
-
getTemplateNotFoundValue
public java.lang.String getTemplateNotFoundValue()
Template does not exist for the given identifier.This instance must be tagged as
UpdatePropertiesError.Tag.TEMPLATE_NOT_FOUND
.- Returns:
- The
String
value associated with this instance ifisTemplateNotFound()
istrue
. - Throws:
java.lang.IllegalStateException
- IfisTemplateNotFound()
isfalse
.
-
isRestrictedContent
public boolean isRestrictedContent()
Returnstrue
if this instance has the tagUpdatePropertiesError.Tag.RESTRICTED_CONTENT
,false
otherwise.- Returns:
true
if this instance is tagged asUpdatePropertiesError.Tag.RESTRICTED_CONTENT
,false
otherwise.
-
isOther
public boolean isOther()
- Returns:
true
if this instance is tagged asUpdatePropertiesError.Tag.OTHER
,false
otherwise.
-
isPath
public boolean isPath()
- Returns:
true
if this instance is tagged asUpdatePropertiesError.Tag.PATH
,false
otherwise.
-
path
public static UpdatePropertiesError path(LookupError value)
Returns an instance ofUpdatePropertiesError
that has its tag set toUpdatePropertiesError.Tag.PATH
.None
- Parameters:
value
- value to assign to this instance.- Returns:
- Instance of
UpdatePropertiesError
with its tag set toUpdatePropertiesError.Tag.PATH
. - Throws:
java.lang.IllegalArgumentException
- ifvalue
isnull
.
-
getPathValue
public LookupError getPathValue()
This instance must be tagged asUpdatePropertiesError.Tag.PATH
.- Returns:
- The
LookupError
value associated with this instance ifisPath()
istrue
. - Throws:
java.lang.IllegalStateException
- IfisPath()
isfalse
.
-
isUnsupportedFolder
public boolean isUnsupportedFolder()
Returnstrue
if this instance has the tagUpdatePropertiesError.Tag.UNSUPPORTED_FOLDER
,false
otherwise.- Returns:
true
if this instance is tagged asUpdatePropertiesError.Tag.UNSUPPORTED_FOLDER
,false
otherwise.
-
isPropertyFieldTooLarge
public boolean isPropertyFieldTooLarge()
Returnstrue
if this instance has the tagUpdatePropertiesError.Tag.PROPERTY_FIELD_TOO_LARGE
,false
otherwise.- Returns:
true
if this instance is tagged asUpdatePropertiesError.Tag.PROPERTY_FIELD_TOO_LARGE
,false
otherwise.
-
isDoesNotFitTemplate
public boolean isDoesNotFitTemplate()
Returnstrue
if this instance has the tagUpdatePropertiesError.Tag.DOES_NOT_FIT_TEMPLATE
,false
otherwise.- Returns:
true
if this instance is tagged asUpdatePropertiesError.Tag.DOES_NOT_FIT_TEMPLATE
,false
otherwise.
-
isDuplicatePropertyGroups
public boolean isDuplicatePropertyGroups()
Returnstrue
if this instance has the tagUpdatePropertiesError.Tag.DUPLICATE_PROPERTY_GROUPS
,false
otherwise.- Returns:
true
if this instance is tagged asUpdatePropertiesError.Tag.DUPLICATE_PROPERTY_GROUPS
,false
otherwise.
-
isPropertyGroupLookup
public boolean isPropertyGroupLookup()
Returnstrue
if this instance has the tagUpdatePropertiesError.Tag.PROPERTY_GROUP_LOOKUP
,false
otherwise.- Returns:
true
if this instance is tagged asUpdatePropertiesError.Tag.PROPERTY_GROUP_LOOKUP
,false
otherwise.
-
propertyGroupLookup
public static UpdatePropertiesError propertyGroupLookup(LookUpPropertiesError value)
Returns an instance ofUpdatePropertiesError
that has its tag set toUpdatePropertiesError.Tag.PROPERTY_GROUP_LOOKUP
.None
- Parameters:
value
- value to assign to this instance.- Returns:
- Instance of
UpdatePropertiesError
with its tag set toUpdatePropertiesError.Tag.PROPERTY_GROUP_LOOKUP
. - Throws:
java.lang.IllegalArgumentException
- ifvalue
isnull
.
-
getPropertyGroupLookupValue
public LookUpPropertiesError getPropertyGroupLookupValue()
This instance must be tagged asUpdatePropertiesError.Tag.PROPERTY_GROUP_LOOKUP
.- Returns:
- The
LookUpPropertiesError
value associated with this instance ifisPropertyGroupLookup()
istrue
. - Throws:
java.lang.IllegalStateException
- IfisPropertyGroupLookup()
isfalse
.
-
hashCode
public int hashCode()
- Overrides:
hashCode
in classjava.lang.Object
-
equals
public boolean equals(java.lang.Object obj)
- Overrides:
equals
in classjava.lang.Object
-
toString
public java.lang.String toString()
- Overrides:
toString
in classjava.lang.Object
-
toStringMultiline
public java.lang.String toStringMultiline()
Returns a String representation of this object formatted for easier readability.The returned String may contain newlines.
- Returns:
- Formatted, multiline String representation of this object
-
-