com.amazonaws.services.quicksight.model.AssetBundleImportSource Maven / Gradle / Ivy
/*
* 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.quicksight.model;
import java.io.Serializable;
import javax.annotation.Generated;
import com.amazonaws.protocol.StructuredPojo;
import com.amazonaws.protocol.ProtocolMarshaller;
/**
*
* The source of the asset bundle zip file that contains the data that you want to import. The file must be in
* QUICKSIGHT_JSON
format.
*
*
* @see AWS
* API Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class AssetBundleImportSource implements Serializable, Cloneable, StructuredPojo {
/**
*
* The bytes of the base64 encoded asset bundle import zip file. This file can't exceed 20 MB.
*
*
* If you are calling the API operations from the Amazon Web Services SDK for Java, JavaScript, Python, or PHP, the
* SDK encodes base64 automatically to allow the direct setting of the zip file's bytes. If you are using an SDK for
* a different language or receiving related errors, try to base64 encode your data.
*
*/
private java.nio.ByteBuffer body;
/**
*
* The Amazon S3 URI for an asset bundle import file that exists in an Amazon S3 bucket that the caller has read
* access to. The file must be a zip format file and can't exceed 20 MB.
*
*/
private String s3Uri;
/**
*
* The bytes of the base64 encoded asset bundle import zip file. This file can't exceed 20 MB.
*
*
* If you are calling the API operations from the Amazon Web Services SDK for Java, JavaScript, Python, or PHP, the
* SDK encodes base64 automatically to allow the direct setting of the zip file's bytes. If you are using an SDK for
* a different language or receiving related errors, try to base64 encode your data.
*
*
* 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 body
* The bytes of the base64 encoded asset bundle import zip file. This file can't exceed 20 MB.
*
* If you are calling the API operations from the Amazon Web Services SDK for Java, JavaScript, Python, or
* PHP, the SDK encodes base64 automatically to allow the direct setting of the zip file's bytes. If you are
* using an SDK for a different language or receiving related errors, try to base64 encode your data.
*/
public void setBody(java.nio.ByteBuffer body) {
this.body = body;
}
/**
*
* The bytes of the base64 encoded asset bundle import zip file. This file can't exceed 20 MB.
*
*
* If you are calling the API operations from the Amazon Web Services SDK for Java, JavaScript, Python, or PHP, the
* SDK encodes base64 automatically to allow the direct setting of the zip file's bytes. If you are using an SDK for
* a different language or receiving related errors, try to base64 encode your data.
*
*
* {@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 bytes of the base64 encoded asset bundle import zip file. This file can't exceed 20 MB.
*
* If you are calling the API operations from the Amazon Web Services SDK for Java, JavaScript, Python, or
* PHP, the SDK encodes base64 automatically to allow the direct setting of the zip file's bytes. If you are
* using an SDK for a different language or receiving related errors, try to base64 encode your data.
*/
public java.nio.ByteBuffer getBody() {
return this.body;
}
/**
*
* The bytes of the base64 encoded asset bundle import zip file. This file can't exceed 20 MB.
*
*
* If you are calling the API operations from the Amazon Web Services SDK for Java, JavaScript, Python, or PHP, the
* SDK encodes base64 automatically to allow the direct setting of the zip file's bytes. If you are using an SDK for
* a different language or receiving related errors, try to base64 encode your data.
*
*
* 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 body
* The bytes of the base64 encoded asset bundle import zip file. This file can't exceed 20 MB.
*
* If you are calling the API operations from the Amazon Web Services SDK for Java, JavaScript, Python, or
* PHP, the SDK encodes base64 automatically to allow the direct setting of the zip file's bytes. If you are
* using an SDK for a different language or receiving related errors, try to base64 encode your data.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public AssetBundleImportSource withBody(java.nio.ByteBuffer body) {
setBody(body);
return this;
}
/**
*
* The Amazon S3 URI for an asset bundle import file that exists in an Amazon S3 bucket that the caller has read
* access to. The file must be a zip format file and can't exceed 20 MB.
*
*
* @param s3Uri
* The Amazon S3 URI for an asset bundle import file that exists in an Amazon S3 bucket that the caller has
* read access to. The file must be a zip format file and can't exceed 20 MB.
*/
public void setS3Uri(String s3Uri) {
this.s3Uri = s3Uri;
}
/**
*
* The Amazon S3 URI for an asset bundle import file that exists in an Amazon S3 bucket that the caller has read
* access to. The file must be a zip format file and can't exceed 20 MB.
*
*
* @return The Amazon S3 URI for an asset bundle import file that exists in an Amazon S3 bucket that the caller has
* read access to. The file must be a zip format file and can't exceed 20 MB.
*/
public String getS3Uri() {
return this.s3Uri;
}
/**
*
* The Amazon S3 URI for an asset bundle import file that exists in an Amazon S3 bucket that the caller has read
* access to. The file must be a zip format file and can't exceed 20 MB.
*
*
* @param s3Uri
* The Amazon S3 URI for an asset bundle import file that exists in an Amazon S3 bucket that the caller has
* read access to. The file must be a zip format file and can't exceed 20 MB.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public AssetBundleImportSource withS3Uri(String s3Uri) {
setS3Uri(s3Uri);
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 (getBody() != null)
sb.append("Body: ").append("***Sensitive Data Redacted***").append(",");
if (getS3Uri() != null)
sb.append("S3Uri: ").append(getS3Uri());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof AssetBundleImportSource == false)
return false;
AssetBundleImportSource other = (AssetBundleImportSource) obj;
if (other.getBody() == null ^ this.getBody() == null)
return false;
if (other.getBody() != null && other.getBody().equals(this.getBody()) == false)
return false;
if (other.getS3Uri() == null ^ this.getS3Uri() == null)
return false;
if (other.getS3Uri() != null && other.getS3Uri().equals(this.getS3Uri()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getBody() == null) ? 0 : getBody().hashCode());
hashCode = prime * hashCode + ((getS3Uri() == null) ? 0 : getS3Uri().hashCode());
return hashCode;
}
@Override
public AssetBundleImportSource clone() {
try {
return (AssetBundleImportSource) 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.quicksight.model.transform.AssetBundleImportSourceMarshaller.getInstance().marshall(this, protocolMarshaller);
}
}