/* * Copyright 2010-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.iot.model; import java.io.Serializable; import com.amazonaws.AmazonWebServiceRequest; /** *

* Updates the supported fields for a specific package version. *

*

* Requires permission to access the UpdatePackageVersion and GetIndexingConfiguration actions. *

*/ public class UpdatePackageVersionRequest extends AmazonWebServiceRequest implements Serializable { /** *

* The name of the associated software package. *

*

* Constraints:
* Length: 1 - 128
* Pattern: [a-zA-Z0-9-_.]+
*/ private String packageName; /** *

* The name of the target package version. *

*

* Constraints:
* Length: 1 - 64
* Pattern: [a-zA-Z0-9-_.]+
*/ private String versionName; /** *

* The package version description. *

*

* Constraints:
* Length: 0 - 1024
* Pattern: [^\p{C}]+
*/ private String description; /** *

* Metadata that can be used to define a package version’s configuration. * For example, the S3 file location, configuration options that are being * sent to the device or fleet. *

*

* Note: Attributes can be updated only when the package version is * in a draft state. *

*

* The combined size of all the attributes on a package version is limited * to 3KB. *

*/ private java.util.Map attributes; /** *

* The status that the package version should be assigned. For more * information, see Package version lifecycle. *

*

* Constraints:
* Allowed Values: PUBLISH, DEPRECATE */ private String action; /** *

* A unique case-sensitive identifier that you can provide to ensure the * idempotency of the request. Don't reuse this client token if a new * idempotent request is required. *

*

* Constraints:
* Length: 36 - 64
* Pattern: \S{36,64}
*/ private String clientToken; /** *

* The name of the associated software package. *

*

* Constraints:
* Length: 1 - 128
* Pattern: [a-zA-Z0-9-_.]+
* * @return

* The name of the associated software package. *

*/ public String getPackageName() { return packageName; } /** *

* The name of the associated software package. *

*

* Constraints:
* Length: 1 - 128
* Pattern: [a-zA-Z0-9-_.]+
* * @param packageName

* The name of the associated software package. *

*/ public void setPackageName(String packageName) { this.packageName = packageName; } /** *

* The name of the associated software package. *

*

* Returns a reference to this object so that method calls can be chained * together. *

* Constraints:
* Length: 1 - 128
* Pattern: [a-zA-Z0-9-_.]+
* * @param packageName

* The name of the associated software package. *

* @return A reference to this updated object so that method calls can be * chained together. */ public UpdatePackageVersionRequest withPackageName(String packageName) { this.packageName = packageName; return this; } /** *

* The name of the target package version. *

*

* Constraints:
* Length: 1 - 64
* Pattern: [a-zA-Z0-9-_.]+
* * @return

* The name of the target package version. *

*/ public String getVersionName() { return versionName; } /** *

* The name of the target package version. *

*

* Constraints:
* Length: 1 - 64
* Pattern: [a-zA-Z0-9-_.]+
* * @param versionName

* The name of the target package version. *

*/ public void setVersionName(String versionName) { this.versionName = versionName; } /** *

* The name of the target package version. *

*

* Returns a reference to this object so that method calls can be chained * together. *

* Constraints:
* Length: 1 - 64
* Pattern: [a-zA-Z0-9-_.]+
* * @param versionName

* The name of the target package version. *

* @return A reference to this updated object so that method calls can be * chained together. */ public UpdatePackageVersionRequest withVersionName(String versionName) { this.versionName = versionName; return this; } /** *

* The package version description. *

*

* Constraints:
* Length: 0 - 1024
* Pattern: [^\p{C}]+
* * @return

* The package version description. *

*/ public String getDescription() { return description; } /** *

* The package version description. *

*

* Constraints:
* Length: 0 - 1024
* Pattern: [^\p{C}]+
* * @param description

* The package version description. *

*/ public void setDescription(String description) { this.description = description; } /** *

* The package version description. *

*

* Returns a reference to this object so that method calls can be chained * together. *

* Constraints:
* Length: 0 - 1024
* Pattern: [^\p{C}]+
* * @param description

* The package version description. *

* @return A reference to this updated object so that method calls can be * chained together. */ public UpdatePackageVersionRequest withDescription(String description) { this.description = description; return this; } /** *

* Metadata that can be used to define a package version’s configuration. * For example, the S3 file location, configuration options that are being * sent to the device or fleet. *

*

* Note: Attributes can be updated only when the package version is * in a draft state. *

*

* The combined size of all the attributes on a package version is limited * to 3KB. *

* * @return

* Metadata that can be used to define a package version’s * configuration. For example, the S3 file location, configuration * options that are being sent to the device or fleet. *

*

* Note: Attributes can be updated only when the package * version is in a draft state. *

*

* The combined size of all the attributes on a package version is * limited to 3KB. *

*/ public java.util.Map getAttributes() { return attributes; } /** *

* Metadata that can be used to define a package version’s configuration. * For example, the S3 file location, configuration options that are being * sent to the device or fleet. *

*

* Note: Attributes can be updated only when the package version is * in a draft state. *

*

* The combined size of all the attributes on a package version is limited * to 3KB. *

* * @param attributes

* Metadata that can be used to define a package version’s * configuration. For example, the S3 file location, * configuration options that are being sent to the device or * fleet. *

*

* Note: Attributes can be updated only when the package * version is in a draft state. *

*

* The combined size of all the attributes on a package version * is limited to 3KB. *

*/ public void setAttributes(java.util.Map attributes) { this.attributes = attributes; } /** *

* Metadata that can be used to define a package version’s configuration. * For example, the S3 file location, configuration options that are being * sent to the device or fleet. *

*

* Note: Attributes can be updated only when the package version is * in a draft state. *

*

* The combined size of all the attributes on a package version is limited * to 3KB. *

*

* Returns a reference to this object so that method calls can be chained * together. * * @param attributes

* Metadata that can be used to define a package version’s * configuration. For example, the S3 file location, * configuration options that are being sent to the device or * fleet. *

*

* Note: Attributes can be updated only when the package * version is in a draft state. *

*

* The combined size of all the attributes on a package version * is limited to 3KB. *

* @return A reference to this updated object so that method calls can be * chained together. */ public UpdatePackageVersionRequest withAttributes(java.util.Map attributes) { this.attributes = attributes; return this; } /** *

* Metadata that can be used to define a package version’s configuration. * For example, the S3 file location, configuration options that are being * sent to the device or fleet. *

*

* Note: Attributes can be updated only when the package version is * in a draft state. *

*

* The combined size of all the attributes on a package version is limited * to 3KB. *

*

* The method adds a new key-value pair into attributes parameter, and * returns a reference to this object so that method calls can be chained * together. * * @param key The key of the entry to be added into attributes. * @param value The corresponding value of the entry to be added into * attributes. * @return A reference to this updated object so that method calls can be * chained together. */ public UpdatePackageVersionRequest addattributesEntry(String key, String value) { if (null == this.attributes) { this.attributes = new java.util.HashMap(); } if (this.attributes.containsKey(key)) throw new IllegalArgumentException("Duplicated keys (" + key.toString() + ") are provided."); this.attributes.put(key, value); return this; } /** * Removes all the entries added into attributes. *

* Returns a reference to this object so that method calls can be chained * together. */ public UpdatePackageVersionRequest clearattributesEntries() { this.attributes = null; return this; } /** *

* The status that the package version should be assigned. For more * information, see Package version lifecycle. *

*

* Constraints:
* Allowed Values: PUBLISH, DEPRECATE * * @return

* The status that the package version should be assigned. For more * information, see Package version lifecycle. *

* @see PackageVersionAction */ public String getAction() { return action; } /** *

* The status that the package version should be assigned. For more * information, see Package version lifecycle. *

*

* Constraints:
* Allowed Values: PUBLISH, DEPRECATE * * @param action

* The status that the package version should be assigned. For * more information, see Package version lifecycle. *

* @see PackageVersionAction */ public void setAction(String action) { this.action = action; } /** *

* The status that the package version should be assigned. For more * information, see Package version lifecycle. *

*

* Returns a reference to this object so that method calls can be chained * together. *

* Constraints:
* Allowed Values: PUBLISH, DEPRECATE * * @param action

* The status that the package version should be assigned. For * more information, see Package version lifecycle. *

* @return A reference to this updated object so that method calls can be * chained together. * @see PackageVersionAction */ public UpdatePackageVersionRequest withAction(String action) { this.action = action; return this; } /** *

* The status that the package version should be assigned. For more * information, see Package version lifecycle. *

*

* Constraints:
* Allowed Values: PUBLISH, DEPRECATE * * @param action

* The status that the package version should be assigned. For * more information, see Package version lifecycle. *

* @see PackageVersionAction */ public void setAction(PackageVersionAction action) { this.action = action.toString(); } /** *

* The status that the package version should be assigned. For more * information, see Package version lifecycle. *

*

* Returns a reference to this object so that method calls can be chained * together. *

* Constraints:
* Allowed Values: PUBLISH, DEPRECATE * * @param action

* The status that the package version should be assigned. For * more information, see Package version lifecycle. *

* @return A reference to this updated object so that method calls can be * chained together. * @see PackageVersionAction */ public UpdatePackageVersionRequest withAction(PackageVersionAction action) { this.action = action.toString(); return this; } /** *

* A unique case-sensitive identifier that you can provide to ensure the * idempotency of the request. Don't reuse this client token if a new * idempotent request is required. *

*

* Constraints:
* Length: 36 - 64
* Pattern: \S{36,64}
* * @return

* A unique case-sensitive identifier that you can provide to ensure * the idempotency of the request. Don't reuse this client token if * a new idempotent request is required. *

*/ public String getClientToken() { return clientToken; } /** *

* A unique case-sensitive identifier that you can provide to ensure the * idempotency of the request. Don't reuse this client token if a new * idempotent request is required. *

*

* Constraints:
* Length: 36 - 64
* Pattern: \S{36,64}
* * @param clientToken

* A unique case-sensitive identifier that you can provide to * ensure the idempotency of the request. Don't reuse this client * token if a new idempotent request is required. *

*/ public void setClientToken(String clientToken) { this.clientToken = clientToken; } /** *

* A unique case-sensitive identifier that you can provide to ensure the * idempotency of the request. Don't reuse this client token if a new * idempotent request is required. *

*

* Returns a reference to this object so that method calls can be chained * together. *

* Constraints:
* Length: 36 - 64
* Pattern: \S{36,64}
* * @param clientToken

* A unique case-sensitive identifier that you can provide to * ensure the idempotency of the request. Don't reuse this client * token if a new idempotent request is required. *

* @return A reference to this updated object so that method calls can be * chained together. */ public UpdatePackageVersionRequest withClientToken(String clientToken) { this.clientToken = clientToken; return this; } /** * Returns a string representation of this object; useful for testing and * debugging. * * @return A string representation of this object. * @see java.lang.Object#toString() */ @Override public String toString() { StringBuilder sb = new StringBuilder(); sb.append("{"); if (getPackageName() != null) sb.append("packageName: " + getPackageName() + ","); if (getVersionName() != null) sb.append("versionName: " + getVersionName() + ","); if (getDescription() != null) sb.append("description: " + getDescription() + ","); if (getAttributes() != null) sb.append("attributes: " + getAttributes() + ","); if (getAction() != null) sb.append("action: " + getAction() + ","); if (getClientToken() != null) sb.append("clientToken: " + getClientToken()); sb.append("}"); return sb.toString(); } @Override public int hashCode() { final int prime = 31; int hashCode = 1; hashCode = prime * hashCode + ((getPackageName() == null) ? 0 : getPackageName().hashCode()); hashCode = prime * hashCode + ((getVersionName() == null) ? 0 : getVersionName().hashCode()); hashCode = prime * hashCode + ((getDescription() == null) ? 0 : getDescription().hashCode()); hashCode = prime * hashCode + ((getAttributes() == null) ? 0 : getAttributes().hashCode()); hashCode = prime * hashCode + ((getAction() == null) ? 0 : getAction().hashCode()); hashCode = prime * hashCode + ((getClientToken() == null) ? 0 : getClientToken().hashCode()); return hashCode; } @Override public boolean equals(Object obj) { if (this == obj) return true; if (obj == null) return false; if (obj instanceof UpdatePackageVersionRequest == false) return false; UpdatePackageVersionRequest other = (UpdatePackageVersionRequest) obj; if (other.getPackageName() == null ^ this.getPackageName() == null) return false; if (other.getPackageName() != null && other.getPackageName().equals(this.getPackageName()) == false) return false; if (other.getVersionName() == null ^ this.getVersionName() == null) return false; if (other.getVersionName() != null && other.getVersionName().equals(this.getVersionName()) == false) return false; if (other.getDescription() == null ^ this.getDescription() == null) return false; if (other.getDescription() != null && other.getDescription().equals(this.getDescription()) == false) return false; if (other.getAttributes() == null ^ this.getAttributes() == null) return false; if (other.getAttributes() != null && other.getAttributes().equals(this.getAttributes()) == false) return false; if (other.getAction() == null ^ this.getAction() == null) return false; if (other.getAction() != null && other.getAction().equals(this.getAction()) == false) return false; if (other.getClientToken() == null ^ this.getClientToken() == null) return false; if (other.getClientToken() != null && other.getClientToken().equals(this.getClientToken()) == false) return false; return true; } }