Package com.dropbox.core.v2.fileproperties

Class UpdateTemplateArg

java.lang.Object

com.dropbox.core.v2.fileproperties.UpdateTemplateArg

public class UpdateTemplateArg
extends java.lang.Object

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	UpdateTemplateArg.Builder	Builder for UpdateTemplateArg.
static class	UpdateTemplateArg.Serializer	For internal use only.

Field Summary

Fields

Modifier and Type	Field	Description
protected java.util.List<PropertyFieldTemplate>	addFields
protected java.lang.String	description
protected java.lang.String	name
protected java.lang.String	templateId

Constructor Summary

Constructors

Constructor	Description
UpdateTemplateArg(java.lang.String templateId)	None
UpdateTemplateArg(java.lang.String templateId, java.lang.String name, java.lang.String description, java.util.List<PropertyFieldTemplate> addFields)	Use newBuilder(java.lang.String) to create instances of this class without specifying values for all optional fields.

Method Summary

Modifier and Type	Method	Description
boolean	equals(java.lang.Object obj)
java.util.List<PropertyFieldTemplate>	getAddFields()	Property field templates to be added to the group template.
java.lang.String	getDescription()	Description for the new template.
java.lang.String	getName()	A display name for the template.
java.lang.String	getTemplateId()	An identifier for template added by See DbxUserFilePropertiesRequests.templatesAddForUser(String,String,List) or DbxTeamFilePropertiesRequests.templatesAddForTeam(String,String,List).
int	hashCode()
static UpdateTemplateArg.Builder	newBuilder(java.lang.String templateId)	Returns a new builder for creating an instance of this class.
java.lang.String	toString()
java.lang.String	toStringMultiline()	Returns a String representation of this object formatted for easier readability.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

templateId

@Nonnull
protected final java.lang.String templateId

name

@Nullable
protected final java.lang.String name

description

@Nullable
protected final java.lang.String description

addFields

@Nullable
protected final java.util.List<PropertyFieldTemplate> addFields

Constructor Detail

UpdateTemplateArg

public UpdateTemplateArg(@Nonnull
                         java.lang.String templateId,
                         @Nullable
                         java.lang.String name,
                         @Nullable
                         java.lang.String description,
                         @Nullable
                         java.util.List<PropertyFieldTemplate> addFields)

Use newBuilder(java.lang.String) to create instances of this class without specifying values for all optional fields.

Parameters:

templateId - An identifier for template added by See DbxUserFilePropertiesRequests.templatesAddForUser(String,String,List) or DbxTeamFilePropertiesRequests.templatesAddForTeam(String,String,List). Must have length of at least 1, match pattern "(/|ptid:).*", and not be null.

name - A display name for the template. template names can be up to 256 bytes.

description - Description for the new template. Template descriptions can be up to 1024 bytes.

addFields - Property field templates to be added to the group template. There can be up to 32 properties in a single template. Must not contain a null item.

Throws:

java.lang.IllegalArgumentException - If any argument does not meet its preconditions.

UpdateTemplateArg

public UpdateTemplateArg(@Nonnull
                         java.lang.String templateId)

None

The default values for unset fields will be used.

Parameters:

templateId - An identifier for template added by See DbxUserFilePropertiesRequests.templatesAddForUser(String,String,List) or DbxTeamFilePropertiesRequests.templatesAddForTeam(String,String,List). Must have length of at least 1, match pattern "(/|ptid:).*", and not be null.

Throws:

java.lang.IllegalArgumentException - If any argument does not meet its preconditions.

Method Detail

getTemplateId

@Nonnull
public java.lang.String getTemplateId()

An identifier for template added by See DbxUserFilePropertiesRequests.templatesAddForUser(String,String,List) or DbxTeamFilePropertiesRequests.templatesAddForTeam(String,String,List).

Returns:

value for this field, never null.

getName

@Nullable
public java.lang.String getName()

A display name for the template. template names can be up to 256 bytes.

Returns:

value for this field, or null if not present.

getDescription

@Nullable
public java.lang.String getDescription()

Description for the new template. Template descriptions can be up to 1024 bytes.

Returns:

value for this field, or null if not present.

getAddFields

@Nullable
public java.util.List<PropertyFieldTemplate> getAddFields()

Property field templates to be added to the group template. There can be up to 32 properties in a single template.

Returns:

value for this field, or null if not present.

newBuilder

public static UpdateTemplateArg.Builder newBuilder(java.lang.String templateId)

Returns a new builder for creating an instance of this class.

Parameters:

templateId - An identifier for template added by See DbxUserFilePropertiesRequests.templatesAddForUser(String,String,List) or DbxTeamFilePropertiesRequests.templatesAddForTeam(String,String,List). Must have length of at least 1, match pattern "(/|ptid:).*", and not be null.

Returns:

builder for this class.

Throws:

java.lang.IllegalArgumentException - If any argument does not meet its preconditions.

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.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