com.amazonaws.services.greengrassv2.model.CreateComponentVersionRequest Maven / Gradle / Ivy
Show all versions of aws-java-sdk-greengrassv2 Show documentation
/*
* Copyright 2019-2024 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.greengrassv2.model;
import java.io.Serializable;
import javax.annotation.Generated;
import com.amazonaws.AmazonWebServiceRequest;
/**
*
* @see AWS API Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class CreateComponentVersionRequest extends com.amazonaws.AmazonWebServiceRequest implements Serializable, Cloneable {
/**
*
* The recipe to use to create the component. The recipe defines the component's metadata, parameters, dependencies,
* lifecycle, artifacts, and platform compatibility.
*
*
* You must specify either inlineRecipe or lambdaFunction.
*
*/
private java.nio.ByteBuffer inlineRecipe;
/**
*
* The parameters to create a component from a Lambda function.
*
*
* You must specify either inlineRecipe or lambdaFunction.
*
*/
private LambdaFunctionRecipeSource lambdaFunction;
/**
*
* A list of key-value pairs that contain metadata for the resource. For more information, see Tag your resources in the
* IoT Greengrass V2 Developer Guide.
*
*/
private java.util.Map tags;
/**
*
* A unique, case-sensitive identifier that you can provide to ensure that the request is idempotent. Idempotency
* means that the request is successfully processed only once, even if you send the request multiple times. When a
* request succeeds, and you specify the same client token for subsequent successful requests, the IoT Greengrass V2
* service returns the successful response that it caches from the previous request. IoT Greengrass V2 caches
* successful responses for idempotent requests for up to 8 hours.
*
*/
private String clientToken;
/**
*
* The recipe to use to create the component. The recipe defines the component's metadata, parameters, dependencies,
* lifecycle, artifacts, and platform compatibility.
*
*
* You must specify either inlineRecipe or lambdaFunction.
*
*
* The AWS SDK for Java performs a Base64 encoding on this field before sending this request to the AWS service.
* Users of the SDK should not perform Base64 encoding on this field.
*
*
* Warning: ByteBuffers returned by the SDK are mutable. Changes to the content or position of the byte buffer will
* be seen by all objects that have a reference to this object. It is recommended to call ByteBuffer.duplicate() or
* ByteBuffer.asReadOnlyBuffer() before using or reading from the buffer. This behavior will be changed in a future
* major version of the SDK.
*
*
* @param inlineRecipe
* The recipe to use to create the component. The recipe defines the component's metadata, parameters,
* dependencies, lifecycle, artifacts, and platform compatibility.
*
* You must specify either inlineRecipe or lambdaFunction.
*/
public void setInlineRecipe(java.nio.ByteBuffer inlineRecipe) {
this.inlineRecipe = inlineRecipe;
}
/**
*
* The recipe to use to create the component. The recipe defines the component's metadata, parameters, dependencies,
* lifecycle, artifacts, and platform compatibility.
*
*
* You must specify either inlineRecipe or lambdaFunction.
*
*
* {@code ByteBuffer}s are stateful. Calling their {@code get} methods changes their {@code position}. We recommend
* using {@link java.nio.ByteBuffer#asReadOnlyBuffer()} to create a read-only view of the buffer with an independent
* {@code position}, and calling {@code get} methods on this rather than directly on the returned {@code ByteBuffer}.
* Doing so will ensure that anyone else using the {@code ByteBuffer} will not be affected by changes to the
* {@code position}.
*
*
* @return The recipe to use to create the component. The recipe defines the component's metadata, parameters,
* dependencies, lifecycle, artifacts, and platform compatibility.
*
* You must specify either inlineRecipe or lambdaFunction.
*/
public java.nio.ByteBuffer getInlineRecipe() {
return this.inlineRecipe;
}
/**
*
* The recipe to use to create the component. The recipe defines the component's metadata, parameters, dependencies,
* lifecycle, artifacts, and platform compatibility.
*
*
* You must specify either inlineRecipe or lambdaFunction.
*
*
* The AWS SDK for Java performs a Base64 encoding on this field before sending this request to the AWS service.
* Users of the SDK should not perform Base64 encoding on this field.
*
*
* Warning: ByteBuffers returned by the SDK are mutable. Changes to the content or position of the byte buffer will
* be seen by all objects that have a reference to this object. It is recommended to call ByteBuffer.duplicate() or
* ByteBuffer.asReadOnlyBuffer() before using or reading from the buffer. This behavior will be changed in a future
* major version of the SDK.
*
*
* @param inlineRecipe
* The recipe to use to create the component. The recipe defines the component's metadata, parameters,
* dependencies, lifecycle, artifacts, and platform compatibility.
*
* You must specify either inlineRecipe or lambdaFunction.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateComponentVersionRequest withInlineRecipe(java.nio.ByteBuffer inlineRecipe) {
setInlineRecipe(inlineRecipe);
return this;
}
/**
*
* The parameters to create a component from a Lambda function.
*
*
* You must specify either inlineRecipe or lambdaFunction.
*
*
* @param lambdaFunction
* The parameters to create a component from a Lambda function.
*
* You must specify either inlineRecipe or lambdaFunction.
*/
public void setLambdaFunction(LambdaFunctionRecipeSource lambdaFunction) {
this.lambdaFunction = lambdaFunction;
}
/**
*
* The parameters to create a component from a Lambda function.
*
*
* You must specify either inlineRecipe or lambdaFunction.
*
*
* @return The parameters to create a component from a Lambda function.
*
* You must specify either inlineRecipe or lambdaFunction.
*/
public LambdaFunctionRecipeSource getLambdaFunction() {
return this.lambdaFunction;
}
/**
*
* The parameters to create a component from a Lambda function.
*
*
* You must specify either inlineRecipe or lambdaFunction.
*
*
* @param lambdaFunction
* The parameters to create a component from a Lambda function.
*
* You must specify either inlineRecipe or lambdaFunction.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateComponentVersionRequest withLambdaFunction(LambdaFunctionRecipeSource lambdaFunction) {
setLambdaFunction(lambdaFunction);
return this;
}
/**
*
* A list of key-value pairs that contain metadata for the resource. For more information, see Tag your resources in the
* IoT Greengrass V2 Developer Guide.
*
*
* @return A list of key-value pairs that contain metadata for the resource. For more information, see Tag your resources
* in the IoT Greengrass V2 Developer Guide.
*/
public java.util.Map getTags() {
return tags;
}
/**
*
* A list of key-value pairs that contain metadata for the resource. For more information, see Tag your resources in the
* IoT Greengrass V2 Developer Guide.
*
*
* @param tags
* A list of key-value pairs that contain metadata for the resource. For more information, see Tag your resources
* in the IoT Greengrass V2 Developer Guide.
*/
public void setTags(java.util.Map tags) {
this.tags = tags;
}
/**
*
* A list of key-value pairs that contain metadata for the resource. For more information, see Tag your resources in the
* IoT Greengrass V2 Developer Guide.
*
*
* @param tags
* A list of key-value pairs that contain metadata for the resource. For more information, see Tag your resources
* in the IoT Greengrass V2 Developer Guide.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateComponentVersionRequest withTags(java.util.Map tags) {
setTags(tags);
return this;
}
/**
* Add a single Tags entry
*
* @see CreateComponentVersionRequest#withTags
* @returns a reference to this object so that method calls can be chained together.
*/
public CreateComponentVersionRequest addTagsEntry(String key, String value) {
if (null == this.tags) {
this.tags = new java.util.HashMap();
}
if (this.tags.containsKey(key))
throw new IllegalArgumentException("Duplicated keys (" + key.toString() + ") are provided.");
this.tags.put(key, value);
return this;
}
/**
* Removes all the entries added into Tags.
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateComponentVersionRequest clearTagsEntries() {
this.tags = null;
return this;
}
/**
*
* A unique, case-sensitive identifier that you can provide to ensure that the request is idempotent. Idempotency
* means that the request is successfully processed only once, even if you send the request multiple times. When a
* request succeeds, and you specify the same client token for subsequent successful requests, the IoT Greengrass V2
* service returns the successful response that it caches from the previous request. IoT Greengrass V2 caches
* successful responses for idempotent requests for up to 8 hours.
*
*
* @param clientToken
* A unique, case-sensitive identifier that you can provide to ensure that the request is idempotent.
* Idempotency means that the request is successfully processed only once, even if you send the request
* multiple times. When a request succeeds, and you specify the same client token for subsequent successful
* requests, the IoT Greengrass V2 service returns the successful response that it caches from the previous
* request. IoT Greengrass V2 caches successful responses for idempotent requests for up to 8 hours.
*/
public void setClientToken(String clientToken) {
this.clientToken = clientToken;
}
/**
*
* A unique, case-sensitive identifier that you can provide to ensure that the request is idempotent. Idempotency
* means that the request is successfully processed only once, even if you send the request multiple times. When a
* request succeeds, and you specify the same client token for subsequent successful requests, the IoT Greengrass V2
* service returns the successful response that it caches from the previous request. IoT Greengrass V2 caches
* successful responses for idempotent requests for up to 8 hours.
*
*
* @return A unique, case-sensitive identifier that you can provide to ensure that the request is idempotent.
* Idempotency means that the request is successfully processed only once, even if you send the request
* multiple times. When a request succeeds, and you specify the same client token for subsequent successful
* requests, the IoT Greengrass V2 service returns the successful response that it caches from the previous
* request. IoT Greengrass V2 caches successful responses for idempotent requests for up to 8 hours.
*/
public String getClientToken() {
return this.clientToken;
}
/**
*
* A unique, case-sensitive identifier that you can provide to ensure that the request is idempotent. Idempotency
* means that the request is successfully processed only once, even if you send the request multiple times. When a
* request succeeds, and you specify the same client token for subsequent successful requests, the IoT Greengrass V2
* service returns the successful response that it caches from the previous request. IoT Greengrass V2 caches
* successful responses for idempotent requests for up to 8 hours.
*
*
* @param clientToken
* A unique, case-sensitive identifier that you can provide to ensure that the request is idempotent.
* Idempotency means that the request is successfully processed only once, even if you send the request
* multiple times. When a request succeeds, and you specify the same client token for subsequent successful
* requests, the IoT Greengrass V2 service returns the successful response that it caches from the previous
* request. IoT Greengrass V2 caches successful responses for idempotent requests for up to 8 hours.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateComponentVersionRequest withClientToken(String clientToken) {
setClientToken(clientToken);
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 (getInlineRecipe() != null)
sb.append("InlineRecipe: ").append(getInlineRecipe()).append(",");
if (getLambdaFunction() != null)
sb.append("LambdaFunction: ").append(getLambdaFunction()).append(",");
if (getTags() != null)
sb.append("Tags: ").append(getTags()).append(",");
if (getClientToken() != null)
sb.append("ClientToken: ").append(getClientToken());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof CreateComponentVersionRequest == false)
return false;
CreateComponentVersionRequest other = (CreateComponentVersionRequest) obj;
if (other.getInlineRecipe() == null ^ this.getInlineRecipe() == null)
return false;
if (other.getInlineRecipe() != null && other.getInlineRecipe().equals(this.getInlineRecipe()) == false)
return false;
if (other.getLambdaFunction() == null ^ this.getLambdaFunction() == null)
return false;
if (other.getLambdaFunction() != null && other.getLambdaFunction().equals(this.getLambdaFunction()) == 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.getClientToken() == null ^ this.getClientToken() == null)
return false;
if (other.getClientToken() != null && other.getClientToken().equals(this.getClientToken()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getInlineRecipe() == null) ? 0 : getInlineRecipe().hashCode());
hashCode = prime * hashCode + ((getLambdaFunction() == null) ? 0 : getLambdaFunction().hashCode());
hashCode = prime * hashCode + ((getTags() == null) ? 0 : getTags().hashCode());
hashCode = prime * hashCode + ((getClientToken() == null) ? 0 : getClientToken().hashCode());
return hashCode;
}
@Override
public CreateComponentVersionRequest clone() {
return (CreateComponentVersionRequest) super.clone();
}
}