/* * Copyright 2018-2023 Amazon.com, Inc. or its affiliates. All Rights Reserved. * * Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with * the License. A copy of the License is located at * * http://aws.amazon.com/apache2.0 * * or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR * CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions * and limitations under the License. */ package com.amazonaws.services.amplifyuibuilder.model; import java.io.Serializable; import javax.annotation.Generated; import com.amazonaws.protocol.StructuredPojo; import com.amazonaws.protocol.ProtocolMarshaller; /** *
* Contains the configuration settings for a user interface (UI) element for an Amplify app. A component is configured
* as a primary, stand-alone UI element. Use ComponentChild
to configure an instance of a
* Component
. A ComponentChild
instance inherits the configuration of the main
* Component
.
*
* The unique ID of the Amplify app associated with the component. *
*/ private String appId; /** ** The name of the backend environment that is a part of the Amplify app. *
*/ private String environmentName; /** ** The unique ID of the component in its original source system, such as Figma. *
*/ private String sourceId; /** ** The unique ID of the component. *
*/ private String id; /** ** The name of the component. *
*/ private String name; /** ** The type of the component. This can be an Amplify custom UI component or another custom component. *
*/ private String componentType; /** *
* Describes the component's properties. You can't specify tags
as a valid property for
* properties
.
*
* A list of the component's ComponentChild
instances.
*
* A list of the component's variants. A variant is a unique style configuration of a main component. *
*/ private java.util.List
* Describes the component's properties that can be overriden in a customized instance of the component. You can't
* specify tags
as a valid property for overrides
.
*
* The information to connect a component's properties to data at runtime. You can't specify tags
as a
* valid property for bindingProperties
.
*
* The data binding configuration for the component's properties. Use this for a collection component. You can't
* specify tags
as a valid property for collectionProperties
.
*
* The time that the component was created. *
*/ private java.util.Date createdAt; /** ** The time that the component was modified. *
*/ private java.util.Date modifiedAt; /** ** One or more key-value pairs to use when tagging the component. *
*/ private java.util.Map* Describes the events that can be raised on the component. Use for the workflow feature in Amplify Studio that * allows you to bind events and actions to components. *
*/ private java.util.Map* The schema version of the component when it was imported. *
*/ private String schemaVersion; /** ** The unique ID of the Amplify app associated with the component. *
* * @param appId * The unique ID of the Amplify app associated with the component. */ public void setAppId(String appId) { this.appId = appId; } /** ** The unique ID of the Amplify app associated with the component. *
* * @return The unique ID of the Amplify app associated with the component. */ public String getAppId() { return this.appId; } /** ** The unique ID of the Amplify app associated with the component. *
* * @param appId * The unique ID of the Amplify app associated with the component. * @return Returns a reference to this object so that method calls can be chained together. */ public Component withAppId(String appId) { setAppId(appId); return this; } /** ** The name of the backend environment that is a part of the Amplify app. *
* * @param environmentName * The name of the backend environment that is a part of the Amplify app. */ public void setEnvironmentName(String environmentName) { this.environmentName = environmentName; } /** ** The name of the backend environment that is a part of the Amplify app. *
* * @return The name of the backend environment that is a part of the Amplify app. */ public String getEnvironmentName() { return this.environmentName; } /** ** The name of the backend environment that is a part of the Amplify app. *
* * @param environmentName * The name of the backend environment that is a part of the Amplify app. * @return Returns a reference to this object so that method calls can be chained together. */ public Component withEnvironmentName(String environmentName) { setEnvironmentName(environmentName); return this; } /** ** The unique ID of the component in its original source system, such as Figma. *
* * @param sourceId * The unique ID of the component in its original source system, such as Figma. */ public void setSourceId(String sourceId) { this.sourceId = sourceId; } /** ** The unique ID of the component in its original source system, such as Figma. *
* * @return The unique ID of the component in its original source system, such as Figma. */ public String getSourceId() { return this.sourceId; } /** ** The unique ID of the component in its original source system, such as Figma. *
* * @param sourceId * The unique ID of the component in its original source system, such as Figma. * @return Returns a reference to this object so that method calls can be chained together. */ public Component withSourceId(String sourceId) { setSourceId(sourceId); return this; } /** ** The unique ID of the component. *
* * @param id * The unique ID of the component. */ public void setId(String id) { this.id = id; } /** ** The unique ID of the component. *
* * @return The unique ID of the component. */ public String getId() { return this.id; } /** ** The unique ID of the component. *
* * @param id * The unique ID of the component. * @return Returns a reference to this object so that method calls can be chained together. */ public Component withId(String id) { setId(id); return this; } /** ** The name of the component. *
* * @param name * The name of the component. */ public void setName(String name) { this.name = name; } /** ** The name of the component. *
* * @return The name of the component. */ public String getName() { return this.name; } /** ** The name of the component. *
* * @param name * The name of the component. * @return Returns a reference to this object so that method calls can be chained together. */ public Component withName(String name) { setName(name); return this; } /** ** The type of the component. This can be an Amplify custom UI component or another custom component. *
* * @param componentType * The type of the component. This can be an Amplify custom UI component or another custom component. */ public void setComponentType(String componentType) { this.componentType = componentType; } /** ** The type of the component. This can be an Amplify custom UI component or another custom component. *
* * @return The type of the component. This can be an Amplify custom UI component or another custom component. */ public String getComponentType() { return this.componentType; } /** ** The type of the component. This can be an Amplify custom UI component or another custom component. *
* * @param componentType * The type of the component. This can be an Amplify custom UI component or another custom component. * @return Returns a reference to this object so that method calls can be chained together. */ public Component withComponentType(String componentType) { setComponentType(componentType); return this; } /** *
* Describes the component's properties. You can't specify tags
as a valid property for
* properties
.
*
tags
as a valid property for
* properties
.
*/
public java.util.Map
* Describes the component's properties. You can't specify tags
as a valid property for
* properties
.
*
tags
as a valid property for
* properties
.
*/
public void setProperties(java.util.Map
* Describes the component's properties. You can't specify tags
as a valid property for
* properties
.
*
tags
as a valid property for
* properties
.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public Component withProperties(java.util.Map
* A list of the component's ComponentChild
instances.
*
ComponentChild
instances.
*/
public java.util.List
* A list of the component's ComponentChild
instances.
*
ComponentChild
instances.
*/
public void setChildren(java.util.Collection
* A list of the component's ComponentChild
instances.
*
* NOTE: This method appends the values to the existing list (if any). Use * {@link #setChildren(java.util.Collection)} or {@link #withChildren(java.util.Collection)} if you want to override * the existing values. *
* * @param children * A list of the component'sComponentChild
instances.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public Component withChildren(ComponentChild... children) {
if (this.children == null) {
setChildren(new java.util.ArrayList
* A list of the component's ComponentChild
instances.
*
ComponentChild
instances.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public Component withChildren(java.util.Collection* A list of the component's variants. A variant is a unique style configuration of a main component. *
* * @return A list of the component's variants. A variant is a unique style configuration of a main component. */ public java.util.List* A list of the component's variants. A variant is a unique style configuration of a main component. *
* * @param variants * A list of the component's variants. A variant is a unique style configuration of a main component. */ public void setVariants(java.util.Collection* A list of the component's variants. A variant is a unique style configuration of a main component. *
** NOTE: This method appends the values to the existing list (if any). Use * {@link #setVariants(java.util.Collection)} or {@link #withVariants(java.util.Collection)} if you want to override * the existing values. *
* * @param variants * A list of the component's variants. A variant is a unique style configuration of a main component. * @return Returns a reference to this object so that method calls can be chained together. */ public Component withVariants(ComponentVariant... variants) { if (this.variants == null) { setVariants(new java.util.ArrayList* A list of the component's variants. A variant is a unique style configuration of a main component. *
* * @param variants * A list of the component's variants. A variant is a unique style configuration of a main component. * @return Returns a reference to this object so that method calls can be chained together. */ public Component withVariants(java.util.Collection
* Describes the component's properties that can be overriden in a customized instance of the component. You can't
* specify tags
as a valid property for overrides
.
*
tags
as a valid property for overrides
.
*/
public java.util.Map
* Describes the component's properties that can be overriden in a customized instance of the component. You can't
* specify tags
as a valid property for overrides
.
*
tags
as a valid property for overrides
.
*/
public void setOverrides(java.util.Map
* Describes the component's properties that can be overriden in a customized instance of the component. You can't
* specify tags
as a valid property for overrides
.
*
tags
as a valid property for overrides
.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public Component withOverrides(java.util.Map
* The information to connect a component's properties to data at runtime. You can't specify tags
as a
* valid property for bindingProperties
.
*
tags
as a valid property for bindingProperties
.
*
*/
public java.util.Map
* The information to connect a component's properties to data at runtime. You can't specify tags
as a
* valid property for bindingProperties
.
*
tags
as a valid property for bindingProperties
.
*
*/
public void setBindingProperties(java.util.Map
* The information to connect a component's properties to data at runtime. You can't specify tags
as a
* valid property for bindingProperties
.
*
tags
as a valid property for bindingProperties
.
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
public Component withBindingProperties(java.util.Map
* The data binding configuration for the component's properties. Use this for a collection component. You can't
* specify tags
as a valid property for collectionProperties
.
*
tags
as a valid property for collectionProperties
.
*/
public java.util.Map
* The data binding configuration for the component's properties. Use this for a collection component. You can't
* specify tags
as a valid property for collectionProperties
.
*
tags
as a valid property for collectionProperties
.
*/
public void setCollectionProperties(java.util.Map
* The data binding configuration for the component's properties. Use this for a collection component. You can't
* specify tags
as a valid property for collectionProperties
.
*
tags
as a valid property for collectionProperties
.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public Component withCollectionProperties(java.util.Map* The time that the component was created. *
* * @param createdAt * The time that the component was created. */ public void setCreatedAt(java.util.Date createdAt) { this.createdAt = createdAt; } /** ** The time that the component was created. *
* * @return The time that the component was created. */ public java.util.Date getCreatedAt() { return this.createdAt; } /** ** The time that the component was created. *
* * @param createdAt * The time that the component was created. * @return Returns a reference to this object so that method calls can be chained together. */ public Component withCreatedAt(java.util.Date createdAt) { setCreatedAt(createdAt); return this; } /** ** The time that the component was modified. *
* * @param modifiedAt * The time that the component was modified. */ public void setModifiedAt(java.util.Date modifiedAt) { this.modifiedAt = modifiedAt; } /** ** The time that the component was modified. *
* * @return The time that the component was modified. */ public java.util.Date getModifiedAt() { return this.modifiedAt; } /** ** The time that the component was modified. *
* * @param modifiedAt * The time that the component was modified. * @return Returns a reference to this object so that method calls can be chained together. */ public Component withModifiedAt(java.util.Date modifiedAt) { setModifiedAt(modifiedAt); return this; } /** ** One or more key-value pairs to use when tagging the component. *
* * @return One or more key-value pairs to use when tagging the component. */ public java.util.Map* One or more key-value pairs to use when tagging the component. *
* * @param tags * One or more key-value pairs to use when tagging the component. */ public void setTags(java.util.Map* One or more key-value pairs to use when tagging the component. *
* * @param tags * One or more key-value pairs to use when tagging the component. * @return Returns a reference to this object so that method calls can be chained together. */ public Component withTags(java.util.Map* Describes the events that can be raised on the component. Use for the workflow feature in Amplify Studio that * allows you to bind events and actions to components. *
* * @return Describes the events that can be raised on the component. Use for the workflow feature in Amplify Studio * that allows you to bind events and actions to components. */ public java.util.Map* Describes the events that can be raised on the component. Use for the workflow feature in Amplify Studio that * allows you to bind events and actions to components. *
* * @param events * Describes the events that can be raised on the component. Use for the workflow feature in Amplify Studio * that allows you to bind events and actions to components. */ public void setEvents(java.util.Map* Describes the events that can be raised on the component. Use for the workflow feature in Amplify Studio that * allows you to bind events and actions to components. *
* * @param events * Describes the events that can be raised on the component. Use for the workflow feature in Amplify Studio * that allows you to bind events and actions to components. * @return Returns a reference to this object so that method calls can be chained together. */ public Component withEvents(java.util.Map* The schema version of the component when it was imported. *
* * @param schemaVersion * The schema version of the component when it was imported. */ public void setSchemaVersion(String schemaVersion) { this.schemaVersion = schemaVersion; } /** ** The schema version of the component when it was imported. *
* * @return The schema version of the component when it was imported. */ public String getSchemaVersion() { return this.schemaVersion; } /** ** The schema version of the component when it was imported. *
* * @param schemaVersion * The schema version of the component when it was imported. * @return Returns a reference to this object so that method calls can be chained together. */ public Component withSchemaVersion(String schemaVersion) { setSchemaVersion(schemaVersion); return this; } /** * Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be * redacted from this string using a placeholder value. * * @return A string representation of this object. * * @see java.lang.Object#toString() */ @Override public String toString() { StringBuilder sb = new StringBuilder(); sb.append("{"); if (getAppId() != null) sb.append("AppId: ").append(getAppId()).append(","); if (getEnvironmentName() != null) sb.append("EnvironmentName: ").append(getEnvironmentName()).append(","); if (getSourceId() != null) sb.append("SourceId: ").append(getSourceId()).append(","); if (getId() != null) sb.append("Id: ").append(getId()).append(","); if (getName() != null) sb.append("Name: ").append(getName()).append(","); if (getComponentType() != null) sb.append("ComponentType: ").append(getComponentType()).append(","); if (getProperties() != null) sb.append("Properties: ").append(getProperties()).append(","); if (getChildren() != null) sb.append("Children: ").append(getChildren()).append(","); if (getVariants() != null) sb.append("Variants: ").append(getVariants()).append(","); if (getOverrides() != null) sb.append("Overrides: ").append(getOverrides()).append(","); if (getBindingProperties() != null) sb.append("BindingProperties: ").append(getBindingProperties()).append(","); if (getCollectionProperties() != null) sb.append("CollectionProperties: ").append(getCollectionProperties()).append(","); if (getCreatedAt() != null) sb.append("CreatedAt: ").append(getCreatedAt()).append(","); if (getModifiedAt() != null) sb.append("ModifiedAt: ").append(getModifiedAt()).append(","); if (getTags() != null) sb.append("Tags: ").append(getTags()).append(","); if (getEvents() != null) sb.append("Events: ").append(getEvents()).append(","); if (getSchemaVersion() != null) sb.append("SchemaVersion: ").append(getSchemaVersion()); sb.append("}"); return sb.toString(); } @Override public boolean equals(Object obj) { if (this == obj) return true; if (obj == null) return false; if (obj instanceof Component == false) return false; Component other = (Component) obj; if (other.getAppId() == null ^ this.getAppId() == null) return false; if (other.getAppId() != null && other.getAppId().equals(this.getAppId()) == false) return false; if (other.getEnvironmentName() == null ^ this.getEnvironmentName() == null) return false; if (other.getEnvironmentName() != null && other.getEnvironmentName().equals(this.getEnvironmentName()) == false) return false; if (other.getSourceId() == null ^ this.getSourceId() == null) return false; if (other.getSourceId() != null && other.getSourceId().equals(this.getSourceId()) == false) return false; if (other.getId() == null ^ this.getId() == null) return false; if (other.getId() != null && other.getId().equals(this.getId()) == false) return false; if (other.getName() == null ^ this.getName() == null) return false; if (other.getName() != null && other.getName().equals(this.getName()) == false) return false; if (other.getComponentType() == null ^ this.getComponentType() == null) return false; if (other.getComponentType() != null && other.getComponentType().equals(this.getComponentType()) == false) return false; if (other.getProperties() == null ^ this.getProperties() == null) return false; if (other.getProperties() != null && other.getProperties().equals(this.getProperties()) == false) return false; if (other.getChildren() == null ^ this.getChildren() == null) return false; if (other.getChildren() != null && other.getChildren().equals(this.getChildren()) == false) return false; if (other.getVariants() == null ^ this.getVariants() == null) return false; if (other.getVariants() != null && other.getVariants().equals(this.getVariants()) == false) return false; if (other.getOverrides() == null ^ this.getOverrides() == null) return false; if (other.getOverrides() != null && other.getOverrides().equals(this.getOverrides()) == false) return false; if (other.getBindingProperties() == null ^ this.getBindingProperties() == null) return false; if (other.getBindingProperties() != null && other.getBindingProperties().equals(this.getBindingProperties()) == false) return false; if (other.getCollectionProperties() == null ^ this.getCollectionProperties() == null) return false; if (other.getCollectionProperties() != null && other.getCollectionProperties().equals(this.getCollectionProperties()) == false) return false; if (other.getCreatedAt() == null ^ this.getCreatedAt() == null) return false; if (other.getCreatedAt() != null && other.getCreatedAt().equals(this.getCreatedAt()) == false) return false; if (other.getModifiedAt() == null ^ this.getModifiedAt() == null) return false; if (other.getModifiedAt() != null && other.getModifiedAt().equals(this.getModifiedAt()) == false) return false; if (other.getTags() == null ^ this.getTags() == null) return false; if (other.getTags() != null && other.getTags().equals(this.getTags()) == false) return false; if (other.getEvents() == null ^ this.getEvents() == null) return false; if (other.getEvents() != null && other.getEvents().equals(this.getEvents()) == false) return false; if (other.getSchemaVersion() == null ^ this.getSchemaVersion() == null) return false; if (other.getSchemaVersion() != null && other.getSchemaVersion().equals(this.getSchemaVersion()) == false) return false; return true; } @Override public int hashCode() { final int prime = 31; int hashCode = 1; hashCode = prime * hashCode + ((getAppId() == null) ? 0 : getAppId().hashCode()); hashCode = prime * hashCode + ((getEnvironmentName() == null) ? 0 : getEnvironmentName().hashCode()); hashCode = prime * hashCode + ((getSourceId() == null) ? 0 : getSourceId().hashCode()); hashCode = prime * hashCode + ((getId() == null) ? 0 : getId().hashCode()); hashCode = prime * hashCode + ((getName() == null) ? 0 : getName().hashCode()); hashCode = prime * hashCode + ((getComponentType() == null) ? 0 : getComponentType().hashCode()); hashCode = prime * hashCode + ((getProperties() == null) ? 0 : getProperties().hashCode()); hashCode = prime * hashCode + ((getChildren() == null) ? 0 : getChildren().hashCode()); hashCode = prime * hashCode + ((getVariants() == null) ? 0 : getVariants().hashCode()); hashCode = prime * hashCode + ((getOverrides() == null) ? 0 : getOverrides().hashCode()); hashCode = prime * hashCode + ((getBindingProperties() == null) ? 0 : getBindingProperties().hashCode()); hashCode = prime * hashCode + ((getCollectionProperties() == null) ? 0 : getCollectionProperties().hashCode()); hashCode = prime * hashCode + ((getCreatedAt() == null) ? 0 : getCreatedAt().hashCode()); hashCode = prime * hashCode + ((getModifiedAt() == null) ? 0 : getModifiedAt().hashCode()); hashCode = prime * hashCode + ((getTags() == null) ? 0 : getTags().hashCode()); hashCode = prime * hashCode + ((getEvents() == null) ? 0 : getEvents().hashCode()); hashCode = prime * hashCode + ((getSchemaVersion() == null) ? 0 : getSchemaVersion().hashCode()); return hashCode; } @Override public Component clone() { try { return (Component) super.clone(); } catch (CloneNotSupportedException e) { throw new IllegalStateException("Got a CloneNotSupportedException from Object.clone() " + "even though we're Cloneable!", e); } } @com.amazonaws.annotation.SdkInternalApi @Override public void marshall(ProtocolMarshaller protocolMarshaller) { com.amazonaws.services.amplifyuibuilder.model.transform.ComponentMarshaller.getInstance().marshall(this, protocolMarshaller); } }