com.amazonaws.services.gamelift.model.S3Location 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.gamelift.model;
import java.io.Serializable;
import javax.annotation.Generated;
import com.amazonaws.protocol.StructuredPojo;
import com.amazonaws.protocol.ProtocolMarshaller;
/**
*
* The location in Amazon S3 where build or script files are stored for access by Amazon GameLift.
*
*
* @see AWS API
* Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class S3Location implements Serializable, Cloneable, StructuredPojo {
/**
*
* An Amazon S3 bucket identifier. Thename of the S3 bucket.
*
*
*
* Amazon GameLift doesn't support uploading from Amazon S3 buckets with names that contain a dot (.).
*
*
*/
private String bucket;
/**
*
* The name of the zip file that contains the build files or script files.
*
*/
private String key;
/**
*
* The Amazon Resource Name (ARN)
* for an IAM role that allows Amazon GameLift to access the S3 bucket.
*
*/
private String roleArn;
/**
*
* The version of the file, if object versioning is turned on for the bucket. Amazon GameLift uses this information
* when retrieving files from an S3 bucket that you own. Use this parameter to specify a specific version of the
* file. If not set, the latest version of the file is retrieved.
*
*/
private String objectVersion;
/**
*
* An Amazon S3 bucket identifier. Thename of the S3 bucket.
*
*
*
* Amazon GameLift doesn't support uploading from Amazon S3 buckets with names that contain a dot (.).
*
*
*
* @param bucket
* An Amazon S3 bucket identifier. Thename of the S3 bucket.
*
* Amazon GameLift doesn't support uploading from Amazon S3 buckets with names that contain a dot (.).
*
*/
public void setBucket(String bucket) {
this.bucket = bucket;
}
/**
*
* An Amazon S3 bucket identifier. Thename of the S3 bucket.
*
*
*
* Amazon GameLift doesn't support uploading from Amazon S3 buckets with names that contain a dot (.).
*
*
*
* @return An Amazon S3 bucket identifier. Thename of the S3 bucket.
*
* Amazon GameLift doesn't support uploading from Amazon S3 buckets with names that contain a dot (.).
*
*/
public String getBucket() {
return this.bucket;
}
/**
*
* An Amazon S3 bucket identifier. Thename of the S3 bucket.
*
*
*
* Amazon GameLift doesn't support uploading from Amazon S3 buckets with names that contain a dot (.).
*
*
*
* @param bucket
* An Amazon S3 bucket identifier. Thename of the S3 bucket.
*
* Amazon GameLift doesn't support uploading from Amazon S3 buckets with names that contain a dot (.).
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
public S3Location withBucket(String bucket) {
setBucket(bucket);
return this;
}
/**
*
* The name of the zip file that contains the build files or script files.
*
*
* @param key
* The name of the zip file that contains the build files or script files.
*/
public void setKey(String key) {
this.key = key;
}
/**
*
* The name of the zip file that contains the build files or script files.
*
*
* @return The name of the zip file that contains the build files or script files.
*/
public String getKey() {
return this.key;
}
/**
*
* The name of the zip file that contains the build files or script files.
*
*
* @param key
* The name of the zip file that contains the build files or script files.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public S3Location withKey(String key) {
setKey(key);
return this;
}
/**
*
* The Amazon Resource Name (ARN)
* for an IAM role that allows Amazon GameLift to access the S3 bucket.
*
*
* @param roleArn
* The Amazon Resource Name (ARN) for an IAM role that
* allows Amazon GameLift to access the S3 bucket.
*/
public void setRoleArn(String roleArn) {
this.roleArn = roleArn;
}
/**
*
* The Amazon Resource Name (ARN)
* for an IAM role that allows Amazon GameLift to access the S3 bucket.
*
*
* @return The Amazon Resource Name (ARN) for an IAM role that
* allows Amazon GameLift to access the S3 bucket.
*/
public String getRoleArn() {
return this.roleArn;
}
/**
*
* The Amazon Resource Name (ARN)
* for an IAM role that allows Amazon GameLift to access the S3 bucket.
*
*
* @param roleArn
* The Amazon Resource Name (ARN) for an IAM role that
* allows Amazon GameLift to access the S3 bucket.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public S3Location withRoleArn(String roleArn) {
setRoleArn(roleArn);
return this;
}
/**
*
* The version of the file, if object versioning is turned on for the bucket. Amazon GameLift uses this information
* when retrieving files from an S3 bucket that you own. Use this parameter to specify a specific version of the
* file. If not set, the latest version of the file is retrieved.
*
*
* @param objectVersion
* The version of the file, if object versioning is turned on for the bucket. Amazon GameLift uses this
* information when retrieving files from an S3 bucket that you own. Use this parameter to specify a specific
* version of the file. If not set, the latest version of the file is retrieved.
*/
public void setObjectVersion(String objectVersion) {
this.objectVersion = objectVersion;
}
/**
*
* The version of the file, if object versioning is turned on for the bucket. Amazon GameLift uses this information
* when retrieving files from an S3 bucket that you own. Use this parameter to specify a specific version of the
* file. If not set, the latest version of the file is retrieved.
*
*
* @return The version of the file, if object versioning is turned on for the bucket. Amazon GameLift uses this
* information when retrieving files from an S3 bucket that you own. Use this parameter to specify a
* specific version of the file. If not set, the latest version of the file is retrieved.
*/
public String getObjectVersion() {
return this.objectVersion;
}
/**
*
* The version of the file, if object versioning is turned on for the bucket. Amazon GameLift uses this information
* when retrieving files from an S3 bucket that you own. Use this parameter to specify a specific version of the
* file. If not set, the latest version of the file is retrieved.
*
*
* @param objectVersion
* The version of the file, if object versioning is turned on for the bucket. Amazon GameLift uses this
* information when retrieving files from an S3 bucket that you own. Use this parameter to specify a specific
* version of the file. If not set, the latest version of the file is retrieved.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public S3Location withObjectVersion(String objectVersion) {
setObjectVersion(objectVersion);
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 (getBucket() != null)
sb.append("Bucket: ").append(getBucket()).append(",");
if (getKey() != null)
sb.append("Key: ").append(getKey()).append(",");
if (getRoleArn() != null)
sb.append("RoleArn: ").append(getRoleArn()).append(",");
if (getObjectVersion() != null)
sb.append("ObjectVersion: ").append(getObjectVersion());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof S3Location == false)
return false;
S3Location other = (S3Location) obj;
if (other.getBucket() == null ^ this.getBucket() == null)
return false;
if (other.getBucket() != null && other.getBucket().equals(this.getBucket()) == false)
return false;
if (other.getKey() == null ^ this.getKey() == null)
return false;
if (other.getKey() != null && other.getKey().equals(this.getKey()) == false)
return false;
if (other.getRoleArn() == null ^ this.getRoleArn() == null)
return false;
if (other.getRoleArn() != null && other.getRoleArn().equals(this.getRoleArn()) == false)
return false;
if (other.getObjectVersion() == null ^ this.getObjectVersion() == null)
return false;
if (other.getObjectVersion() != null && other.getObjectVersion().equals(this.getObjectVersion()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getBucket() == null) ? 0 : getBucket().hashCode());
hashCode = prime * hashCode + ((getKey() == null) ? 0 : getKey().hashCode());
hashCode = prime * hashCode + ((getRoleArn() == null) ? 0 : getRoleArn().hashCode());
hashCode = prime * hashCode + ((getObjectVersion() == null) ? 0 : getObjectVersion().hashCode());
return hashCode;
}
@Override
public S3Location clone() {
try {
return (S3Location) 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.gamelift.model.transform.S3LocationMarshaller.getInstance().marshall(this, protocolMarshaller);
}
}