com.amazonaws.services.lambda.model.FunctionCode Maven / Gradle / Ivy
Show all versions of aws-java-sdk-lambda Show documentation
/*
* Copyright 2017-2022 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.protocol.StructuredPojo;
import com.amazonaws.protocol.ProtocolMarshaller;
/**
*
* The code for the Lambda function. You can specify either an object in Amazon S3, upload a .zip file archive
* deployment package directly, or specify the URI of a container image.
*
*
* @see AWS API
* Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class FunctionCode implements Serializable, Cloneable, StructuredPojo {
/**
*
* The base64-encoded contents of the deployment package. Amazon Web Services SDK and Amazon Web Services CLI
* clients handle the encoding for you.
*
*/
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.
*
*/
private String s3Bucket;
/**
*
* The Amazon S3 key of the 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.
*
*/
private String imageUri;
/**
*
* The base64-encoded contents of the deployment package. Amazon Web Services SDK and Amazon Web Services CLI
* clients handle the encoding for you.
*
*
* 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 Amazon Web Services CLI
* clients handle the encoding for you.
*/
public void setZipFile(java.nio.ByteBuffer zipFile) {
this.zipFile = zipFile;
}
/**
*
* The base64-encoded contents of the deployment package. Amazon Web Services SDK and Amazon Web Services CLI
* clients handle the encoding for you.
*
*
* {@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 Amazon Web Services
* CLI clients handle the encoding for you.
*/
public java.nio.ByteBuffer getZipFile() {
return this.zipFile;
}
/**
*
* The base64-encoded contents of the deployment package. Amazon Web Services SDK and Amazon Web Services CLI
* clients handle the encoding for you.
*
*
* 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 Amazon Web Services CLI
* clients handle the encoding for you.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public FunctionCode 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.
*
*
* @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.
*/
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.
*
*
* @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.
*/
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.
*
*
* @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.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public FunctionCode withS3Bucket(String s3Bucket) {
setS3Bucket(s3Bucket);
return this;
}
/**
*
* The Amazon S3 key of the deployment package.
*
*
* @param s3Key
* The Amazon S3 key of the deployment package.
*/
public void setS3Key(String s3Key) {
this.s3Key = s3Key;
}
/**
*
* The Amazon S3 key of the deployment package.
*
*
* @return The Amazon S3 key of the deployment package.
*/
public String getS3Key() {
return this.s3Key;
}
/**
*
* The Amazon S3 key of the deployment package.
*
*
* @param s3Key
* The Amazon S3 key of the deployment package.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public FunctionCode 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 FunctionCode withS3ObjectVersion(String s3ObjectVersion) {
setS3ObjectVersion(s3ObjectVersion);
return this;
}
/**
*
* URI of a container image in the
* Amazon ECR registry.
*
*
* @param imageUri
* URI of a container image in
* the Amazon ECR registry.
*/
public void setImageUri(String imageUri) {
this.imageUri = imageUri;
}
/**
*
* URI of a container image in the
* Amazon ECR registry.
*
*
* @return URI of a container image in
* the Amazon ECR registry.
*/
public String getImageUri() {
return this.imageUri;
}
/**
*
* URI of a container image in the
* Amazon ECR registry.
*
*
* @param imageUri
* URI of a container image in
* the Amazon ECR registry.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public FunctionCode withImageUri(String imageUri) {
setImageUri(imageUri);
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 (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());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof FunctionCode == false)
return false;
FunctionCode other = (FunctionCode) obj;
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;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
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());
return hashCode;
}
@Override
public FunctionCode clone() {
try {
return (FunctionCode) 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.lambda.model.transform.FunctionCodeMarshaller.getInstance().marshall(this, protocolMarshaller);
}
}