com.amazonaws.services.lambda.model.UpdateFunctionCodeRequest Maven / Gradle / Ivy
Show all versions of aws-java-sdk-lambda 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.lambda.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 UpdateFunctionCodeRequest extends com.amazonaws.AmazonWebServiceRequest implements Serializable, Cloneable {
/**
*
* The name or ARN of the Lambda function.
*
*
* Name formats
*
*
* -
*
* Function name – my-function.
*
*
* -
*
* Function ARN – arn:aws:lambda:us-west-2:123456789012:function:my-function.
*
*
* -
*
* Partial ARN – 123456789012:function:my-function.
*
*
*
*
* The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64
* characters in length.
*
*/
private String functionName;
/**
*
* The base64-encoded contents of the deployment package. Amazon Web Services SDK and CLI clients handle the
* encoding for you. Use only with a function defined with a .zip file archive deployment package.
*
*/
private java.nio.ByteBuffer zipFile;
/**
*
* An Amazon S3 bucket in the same Amazon Web Services Region as your function. The bucket can be in a different
* Amazon Web Services account. Use only with a function defined with a .zip file archive deployment package.
*
*/
private String s3Bucket;
/**
*
* The Amazon S3 key of the deployment package. Use only with a function defined with a .zip file archive deployment
* package.
*
*/
private String s3Key;
/**
*
* For versioned objects, the version of the deployment package object to use.
*
*/
private String s3ObjectVersion;
/**
*
* URI of a container image in the Amazon ECR registry. Do not use for a function defined with a .zip file archive.
*
*/
private String imageUri;
/**
*
* Set to true to publish a new version of the function after updating the code. This has the same effect as calling
* PublishVersion separately.
*
*/
private Boolean publish;
/**
*
* Set to true to validate the request parameters and access permissions without modifying the function code.
*
*/
private Boolean dryRun;
/**
*
* Update the function only if the revision ID matches the ID that's specified. Use this option to avoid modifying a
* function that has changed since you last read it.
*
*/
private String revisionId;
/**
*
* The instruction set architecture that the function supports. Enter a string array with one of the valid values
* (arm64 or x86_64). The default value is x86_64.
*
*/
private com.amazonaws.internal.SdkInternalList architectures;
/**
*
* The name or ARN of the Lambda function.
*
*
* Name formats
*
*
* -
*
* Function name – my-function.
*
*
* -
*
* Function ARN – arn:aws:lambda:us-west-2:123456789012:function:my-function.
*
*
* -
*
* Partial ARN – 123456789012:function:my-function.
*
*
*
*
* The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64
* characters in length.
*
*
* @param functionName
* The name or ARN of the Lambda function.
*
* Name formats
*
*
* -
*
* Function name – my-function.
*
*
* -
*
* Function ARN – arn:aws:lambda:us-west-2:123456789012:function:my-function.
*
*
* -
*
* Partial ARN – 123456789012:function:my-function.
*
*
*
*
* The length constraint applies only to the full ARN. If you specify only the function name, it is limited
* to 64 characters in length.
*/
public void setFunctionName(String functionName) {
this.functionName = functionName;
}
/**
*
* The name or ARN of the Lambda function.
*
*
* Name formats
*
*
* -
*
* Function name – my-function.
*
*
* -
*
* Function ARN – arn:aws:lambda:us-west-2:123456789012:function:my-function.
*
*
* -
*
* Partial ARN – 123456789012:function:my-function.
*
*
*
*
* The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64
* characters in length.
*
*
* @return The name or ARN of the Lambda function.
*
* Name formats
*
*
* -
*
* Function name – my-function.
*
*
* -
*
* Function ARN – arn:aws:lambda:us-west-2:123456789012:function:my-function.
*
*
* -
*
* Partial ARN – 123456789012:function:my-function.
*
*
*
*
* The length constraint applies only to the full ARN. If you specify only the function name, it is limited
* to 64 characters in length.
*/
public String getFunctionName() {
return this.functionName;
}
/**
*
* The name or ARN of the Lambda function.
*
*
* Name formats
*
*
* -
*
* Function name – my-function.
*
*
* -
*
* Function ARN – arn:aws:lambda:us-west-2:123456789012:function:my-function.
*
*
* -
*
* Partial ARN – 123456789012:function:my-function.
*
*
*
*
* The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64
* characters in length.
*
*
* @param functionName
* The name or ARN of the Lambda function.
*
* Name formats
*
*
* -
*
* Function name – my-function.
*
*
* -
*
* Function ARN – arn:aws:lambda:us-west-2:123456789012:function:my-function.
*
*
* -
*
* Partial ARN – 123456789012:function:my-function.
*
*
*
*
* The length constraint applies only to the full ARN. If you specify only the function name, it is limited
* to 64 characters in length.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public UpdateFunctionCodeRequest withFunctionName(String functionName) {
setFunctionName(functionName);
return this;
}
/**
*
* The base64-encoded contents of the deployment package. Amazon Web Services SDK and CLI clients handle the
* encoding for you. Use only with a function defined with a .zip file archive deployment package.
*
*
* 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 zipFile
* The base64-encoded contents of the deployment package. Amazon Web Services SDK and CLI clients handle the
* encoding for you. Use only with a function defined with a .zip file archive deployment package.
*/
public void setZipFile(java.nio.ByteBuffer zipFile) {
this.zipFile = zipFile;
}
/**
*
* The base64-encoded contents of the deployment package. Amazon Web Services SDK and CLI clients handle the
* encoding for you. Use only with a function defined with a .zip file archive deployment package.
*
*
* {@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 base64-encoded contents of the deployment package. Amazon Web Services SDK and CLI clients handle the
* encoding for you. Use only with a function defined with a .zip file archive deployment package.
*/
public java.nio.ByteBuffer getZipFile() {
return this.zipFile;
}
/**
*
* The base64-encoded contents of the deployment package. Amazon Web Services SDK and CLI clients handle the
* encoding for you. Use only with a function defined with a .zip file archive deployment package.
*
*
* 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 zipFile
* The base64-encoded contents of the deployment package. Amazon Web Services SDK and CLI clients handle the
* encoding for you. Use only with a function defined with a .zip file archive deployment package.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public UpdateFunctionCodeRequest withZipFile(java.nio.ByteBuffer zipFile) {
setZipFile(zipFile);
return this;
}
/**
*
* An Amazon S3 bucket in the same Amazon Web Services Region as your function. The bucket can be in a different
* Amazon Web Services account. Use only with a function defined with a .zip file archive deployment package.
*
*
* @param s3Bucket
* An Amazon S3 bucket in the same Amazon Web Services Region as your function. The bucket can be in a
* different Amazon Web Services account. Use only with a function defined with a .zip file archive
* deployment package.
*/
public void setS3Bucket(String s3Bucket) {
this.s3Bucket = s3Bucket;
}
/**
*
* An Amazon S3 bucket in the same Amazon Web Services Region as your function. The bucket can be in a different
* Amazon Web Services account. Use only with a function defined with a .zip file archive deployment package.
*
*
* @return An Amazon S3 bucket in the same Amazon Web Services Region as your function. The bucket can be in a
* different Amazon Web Services account. Use only with a function defined with a .zip file archive
* deployment package.
*/
public String getS3Bucket() {
return this.s3Bucket;
}
/**
*
* An Amazon S3 bucket in the same Amazon Web Services Region as your function. The bucket can be in a different
* Amazon Web Services account. Use only with a function defined with a .zip file archive deployment package.
*
*
* @param s3Bucket
* An Amazon S3 bucket in the same Amazon Web Services Region as your function. The bucket can be in a
* different Amazon Web Services account. Use only with a function defined with a .zip file archive
* deployment package.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public UpdateFunctionCodeRequest withS3Bucket(String s3Bucket) {
setS3Bucket(s3Bucket);
return this;
}
/**
*
* The Amazon S3 key of the deployment package. Use only with a function defined with a .zip file archive deployment
* package.
*
*
* @param s3Key
* The Amazon S3 key of the deployment package. Use only with a function defined with a .zip file archive
* deployment package.
*/
public void setS3Key(String s3Key) {
this.s3Key = s3Key;
}
/**
*
* The Amazon S3 key of the deployment package. Use only with a function defined with a .zip file archive deployment
* package.
*
*
* @return The Amazon S3 key of the deployment package. Use only with a function defined with a .zip file archive
* deployment package.
*/
public String getS3Key() {
return this.s3Key;
}
/**
*
* The Amazon S3 key of the deployment package. Use only with a function defined with a .zip file archive deployment
* package.
*
*
* @param s3Key
* The Amazon S3 key of the deployment package. Use only with a function defined with a .zip file archive
* deployment package.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public UpdateFunctionCodeRequest withS3Key(String s3Key) {
setS3Key(s3Key);
return this;
}
/**
*
* For versioned objects, the version of the deployment package object to use.
*
*
* @param s3ObjectVersion
* For versioned objects, the version of the deployment package object to use.
*/
public void setS3ObjectVersion(String s3ObjectVersion) {
this.s3ObjectVersion = s3ObjectVersion;
}
/**
*
* For versioned objects, the version of the deployment package object to use.
*
*
* @return For versioned objects, the version of the deployment package object to use.
*/
public String getS3ObjectVersion() {
return this.s3ObjectVersion;
}
/**
*
* For versioned objects, the version of the deployment package object to use.
*
*
* @param s3ObjectVersion
* For versioned objects, the version of the deployment package object to use.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public UpdateFunctionCodeRequest withS3ObjectVersion(String s3ObjectVersion) {
setS3ObjectVersion(s3ObjectVersion);
return this;
}
/**
*
* URI of a container image in the Amazon ECR registry. Do not use for a function defined with a .zip file archive.
*
*
* @param imageUri
* URI of a container image in the Amazon ECR registry. Do not use for a function defined with a .zip file
* archive.
*/
public void setImageUri(String imageUri) {
this.imageUri = imageUri;
}
/**
*
* URI of a container image in the Amazon ECR registry. Do not use for a function defined with a .zip file archive.
*
*
* @return URI of a container image in the Amazon ECR registry. Do not use for a function defined with a .zip file
* archive.
*/
public String getImageUri() {
return this.imageUri;
}
/**
*
* URI of a container image in the Amazon ECR registry. Do not use for a function defined with a .zip file archive.
*
*
* @param imageUri
* URI of a container image in the Amazon ECR registry. Do not use for a function defined with a .zip file
* archive.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public UpdateFunctionCodeRequest withImageUri(String imageUri) {
setImageUri(imageUri);
return this;
}
/**
*
* Set to true to publish a new version of the function after updating the code. This has the same effect as calling
* PublishVersion separately.
*
*
* @param publish
* Set to true to publish a new version of the function after updating the code. This has the same effect as
* calling PublishVersion separately.
*/
public void setPublish(Boolean publish) {
this.publish = publish;
}
/**
*
* Set to true to publish a new version of the function after updating the code. This has the same effect as calling
* PublishVersion separately.
*
*
* @return Set to true to publish a new version of the function after updating the code. This has the same effect as
* calling PublishVersion separately.
*/
public Boolean getPublish() {
return this.publish;
}
/**
*
* Set to true to publish a new version of the function after updating the code. This has the same effect as calling
* PublishVersion separately.
*
*
* @param publish
* Set to true to publish a new version of the function after updating the code. This has the same effect as
* calling PublishVersion separately.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public UpdateFunctionCodeRequest withPublish(Boolean publish) {
setPublish(publish);
return this;
}
/**
*
* Set to true to publish a new version of the function after updating the code. This has the same effect as calling
* PublishVersion separately.
*
*
* @return Set to true to publish a new version of the function after updating the code. This has the same effect as
* calling PublishVersion separately.
*/
public Boolean isPublish() {
return this.publish;
}
/**
*
* Set to true to validate the request parameters and access permissions without modifying the function code.
*
*
* @param dryRun
* Set to true to validate the request parameters and access permissions without modifying the function code.
*/
public void setDryRun(Boolean dryRun) {
this.dryRun = dryRun;
}
/**
*
* Set to true to validate the request parameters and access permissions without modifying the function code.
*
*
* @return Set to true to validate the request parameters and access permissions without modifying the function
* code.
*/
public Boolean getDryRun() {
return this.dryRun;
}
/**
*
* Set to true to validate the request parameters and access permissions without modifying the function code.
*
*
* @param dryRun
* Set to true to validate the request parameters and access permissions without modifying the function code.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public UpdateFunctionCodeRequest withDryRun(Boolean dryRun) {
setDryRun(dryRun);
return this;
}
/**
*
* Set to true to validate the request parameters and access permissions without modifying the function code.
*
*
* @return Set to true to validate the request parameters and access permissions without modifying the function
* code.
*/
public Boolean isDryRun() {
return this.dryRun;
}
/**
*
* Update the function only if the revision ID matches the ID that's specified. Use this option to avoid modifying a
* function that has changed since you last read it.
*
*
* @param revisionId
* Update the function only if the revision ID matches the ID that's specified. Use this option to avoid
* modifying a function that has changed since you last read it.
*/
public void setRevisionId(String revisionId) {
this.revisionId = revisionId;
}
/**
*
* Update the function only if the revision ID matches the ID that's specified. Use this option to avoid modifying a
* function that has changed since you last read it.
*
*
* @return Update the function only if the revision ID matches the ID that's specified. Use this option to avoid
* modifying a function that has changed since you last read it.
*/
public String getRevisionId() {
return this.revisionId;
}
/**
*
* Update the function only if the revision ID matches the ID that's specified. Use this option to avoid modifying a
* function that has changed since you last read it.
*
*
* @param revisionId
* Update the function only if the revision ID matches the ID that's specified. Use this option to avoid
* modifying a function that has changed since you last read it.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public UpdateFunctionCodeRequest withRevisionId(String revisionId) {
setRevisionId(revisionId);
return this;
}
/**
*
* The instruction set architecture that the function supports. Enter a string array with one of the valid values
* (arm64 or x86_64). The default value is x86_64.
*
*
* @return The instruction set architecture that the function supports. Enter a string array with one of the valid
* values (arm64 or x86_64). The default value is x86_64.
* @see Architecture
*/
public java.util.List getArchitectures() {
if (architectures == null) {
architectures = new com.amazonaws.internal.SdkInternalList();
}
return architectures;
}
/**
*
* The instruction set architecture that the function supports. Enter a string array with one of the valid values
* (arm64 or x86_64). The default value is x86_64.
*
*
* @param architectures
* The instruction set architecture that the function supports. Enter a string array with one of the valid
* values (arm64 or x86_64). The default value is x86_64.
* @see Architecture
*/
public void setArchitectures(java.util.Collection architectures) {
if (architectures == null) {
this.architectures = null;
return;
}
this.architectures = new com.amazonaws.internal.SdkInternalList(architectures);
}
/**
*
* The instruction set architecture that the function supports. Enter a string array with one of the valid values
* (arm64 or x86_64). The default value is x86_64.
*
*
* NOTE: This method appends the values to the existing list (if any). Use
* {@link #setArchitectures(java.util.Collection)} or {@link #withArchitectures(java.util.Collection)} if you want
* to override the existing values.
*
*
* @param architectures
* The instruction set architecture that the function supports. Enter a string array with one of the valid
* values (arm64 or x86_64). The default value is x86_64.
* @return Returns a reference to this object so that method calls can be chained together.
* @see Architecture
*/
public UpdateFunctionCodeRequest withArchitectures(String... architectures) {
if (this.architectures == null) {
setArchitectures(new com.amazonaws.internal.SdkInternalList(architectures.length));
}
for (String ele : architectures) {
this.architectures.add(ele);
}
return this;
}
/**
*
* The instruction set architecture that the function supports. Enter a string array with one of the valid values
* (arm64 or x86_64). The default value is x86_64.
*
*
* @param architectures
* The instruction set architecture that the function supports. Enter a string array with one of the valid
* values (arm64 or x86_64). The default value is x86_64.
* @return Returns a reference to this object so that method calls can be chained together.
* @see Architecture
*/
public UpdateFunctionCodeRequest withArchitectures(java.util.Collection architectures) {
setArchitectures(architectures);
return this;
}
/**
*
* The instruction set architecture that the function supports. Enter a string array with one of the valid values
* (arm64 or x86_64). The default value is x86_64.
*
*
* @param architectures
* The instruction set architecture that the function supports. Enter a string array with one of the valid
* values (arm64 or x86_64). The default value is x86_64.
* @return Returns a reference to this object so that method calls can be chained together.
* @see Architecture
*/
public UpdateFunctionCodeRequest withArchitectures(Architecture... architectures) {
com.amazonaws.internal.SdkInternalList architecturesCopy = new com.amazonaws.internal.SdkInternalList(architectures.length);
for (Architecture value : architectures) {
architecturesCopy.add(value.toString());
}
if (getArchitectures() == null) {
setArchitectures(architecturesCopy);
} else {
getArchitectures().addAll(architecturesCopy);
}
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 (getFunctionName() != null)
sb.append("FunctionName: ").append(getFunctionName()).append(",");
if (getZipFile() != null)
sb.append("ZipFile: ").append("***Sensitive Data Redacted***").append(",");
if (getS3Bucket() != null)
sb.append("S3Bucket: ").append(getS3Bucket()).append(",");
if (getS3Key() != null)
sb.append("S3Key: ").append(getS3Key()).append(",");
if (getS3ObjectVersion() != null)
sb.append("S3ObjectVersion: ").append(getS3ObjectVersion()).append(",");
if (getImageUri() != null)
sb.append("ImageUri: ").append(getImageUri()).append(",");
if (getPublish() != null)
sb.append("Publish: ").append(getPublish()).append(",");
if (getDryRun() != null)
sb.append("DryRun: ").append(getDryRun()).append(",");
if (getRevisionId() != null)
sb.append("RevisionId: ").append(getRevisionId()).append(",");
if (getArchitectures() != null)
sb.append("Architectures: ").append(getArchitectures());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof UpdateFunctionCodeRequest == false)
return false;
UpdateFunctionCodeRequest other = (UpdateFunctionCodeRequest) obj;
if (other.getFunctionName() == null ^ this.getFunctionName() == null)
return false;
if (other.getFunctionName() != null && other.getFunctionName().equals(this.getFunctionName()) == false)
return false;
if (other.getZipFile() == null ^ this.getZipFile() == null)
return false;
if (other.getZipFile() != null && other.getZipFile().equals(this.getZipFile()) == false)
return false;
if (other.getS3Bucket() == null ^ this.getS3Bucket() == null)
return false;
if (other.getS3Bucket() != null && other.getS3Bucket().equals(this.getS3Bucket()) == false)
return false;
if (other.getS3Key() == null ^ this.getS3Key() == null)
return false;
if (other.getS3Key() != null && other.getS3Key().equals(this.getS3Key()) == false)
return false;
if (other.getS3ObjectVersion() == null ^ this.getS3ObjectVersion() == null)
return false;
if (other.getS3ObjectVersion() != null && other.getS3ObjectVersion().equals(this.getS3ObjectVersion()) == false)
return false;
if (other.getImageUri() == null ^ this.getImageUri() == null)
return false;
if (other.getImageUri() != null && other.getImageUri().equals(this.getImageUri()) == false)
return false;
if (other.getPublish() == null ^ this.getPublish() == null)
return false;
if (other.getPublish() != null && other.getPublish().equals(this.getPublish()) == false)
return false;
if (other.getDryRun() == null ^ this.getDryRun() == null)
return false;
if (other.getDryRun() != null && other.getDryRun().equals(this.getDryRun()) == false)
return false;
if (other.getRevisionId() == null ^ this.getRevisionId() == null)
return false;
if (other.getRevisionId() != null && other.getRevisionId().equals(this.getRevisionId()) == false)
return false;
if (other.getArchitectures() == null ^ this.getArchitectures() == null)
return false;
if (other.getArchitectures() != null && other.getArchitectures().equals(this.getArchitectures()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getFunctionName() == null) ? 0 : getFunctionName().hashCode());
hashCode = prime * hashCode + ((getZipFile() == null) ? 0 : getZipFile().hashCode());
hashCode = prime * hashCode + ((getS3Bucket() == null) ? 0 : getS3Bucket().hashCode());
hashCode = prime * hashCode + ((getS3Key() == null) ? 0 : getS3Key().hashCode());
hashCode = prime * hashCode + ((getS3ObjectVersion() == null) ? 0 : getS3ObjectVersion().hashCode());
hashCode = prime * hashCode + ((getImageUri() == null) ? 0 : getImageUri().hashCode());
hashCode = prime * hashCode + ((getPublish() == null) ? 0 : getPublish().hashCode());
hashCode = prime * hashCode + ((getDryRun() == null) ? 0 : getDryRun().hashCode());
hashCode = prime * hashCode + ((getRevisionId() == null) ? 0 : getRevisionId().hashCode());
hashCode = prime * hashCode + ((getArchitectures() == null) ? 0 : getArchitectures().hashCode());
return hashCode;
}
@Override
public UpdateFunctionCodeRequest clone() {
return (UpdateFunctionCodeRequest) super.clone();
}
}