/* * Copyright 2018-2023 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.AmazonWebServiceRequest; /** * * @see AWS API * Documentation */ @Generated("com.amazonaws:aws-java-sdk-code-generator") public class CreateScriptRequest extends com.amazonaws.AmazonWebServiceRequest implements Serializable, Cloneable { /** *

* A descriptive label that is associated with a script. Script names don't need to be unique. You can use UpdateScript to change * this value later. *

*/ private String name; /** *

* Version information associated with a build or script. Version strings don't need to be unique. You can use UpdateScript to change * this value later. *

*/ private String version; /** *

* The location of the Amazon S3 bucket where a zipped file containing your Realtime scripts is stored. The storage * location must specify the Amazon S3 bucket name, the zip file name (the "key"), and a role ARN that allows Amazon * GameLift to access the Amazon S3 storage location. The S3 bucket must be in the same Region where you want to * create a new script. By default, Amazon GameLift uploads the latest version of the zip file; if you have S3 * object versioning turned on, you can use the ObjectVersion parameter to specify an earlier version. *

*/ private S3Location storageLocation; /** *

* A data object containing your Realtime scripts and dependencies as a zip file. The zip file can have one or * multiple files. Maximum size of a zip file is 5 MB. *

* When using the Amazon Web Services CLI tool to create a script, this parameter is set to the zip file name. It * must be prepended with the string "fileb://" to indicate that the file data is a binary object. For example: * --zip-file fileb://myRealtimeScript.zip. *

*/ private java.nio.ByteBuffer zipFile; /** *

* A list of labels to assign to the new script resource. Tags are developer-defined key-value pairs. Tagging Amazon * Web Services resources are useful for resource management, access management and cost allocation. For more * information, see Tagging Amazon Web * Services Resources in the Amazon Web Services General Reference. Once the resource is created, you can * use TagResource, UntagResource, and ListTagsForResource * to add, remove, and view tags. The maximum tag limit may be lower than stated. See the Amazon Web Services * General Reference for actual tagging limits. *

*/ private java.util.List tags; /** *

* A descriptive label that is associated with a script. Script names don't need to be unique. You can use UpdateScript to change * this value later. *

* * @param name * A descriptive label that is associated with a script. Script names don't need to be unique. You can use UpdateScript to * change this value later. */ public void setName(String name) { this.name = name; } /** *

* A descriptive label that is associated with a script. Script names don't need to be unique. You can use UpdateScript to change * this value later. *

* * @return A descriptive label that is associated with a script. Script names don't need to be unique. You can use * UpdateScript * to change this value later. */ public String getName() { return this.name; } /** *

* A descriptive label that is associated with a script. Script names don't need to be unique. You can use UpdateScript to change * this value later. *

* * @param name * A descriptive label that is associated with a script. Script names don't need to be unique. You can use UpdateScript to * change this value later. * @return Returns a reference to this object so that method calls can be chained together. */ public CreateScriptRequest withName(String name) { setName(name); return this; } /** *

* Version information associated with a build or script. Version strings don't need to be unique. You can use UpdateScript to change * this value later. *

* * @param version * Version information associated with a build or script. Version strings don't need to be unique. You can * use UpdateScript to * change this value later. */ public void setVersion(String version) { this.version = version; } /** *

* Version information associated with a build or script. Version strings don't need to be unique. You can use UpdateScript to change * this value later. *

* * @return Version information associated with a build or script. Version strings don't need to be unique. You can * use UpdateScript to * change this value later. */ public String getVersion() { return this.version; } /** *

* Version information associated with a build or script. Version strings don't need to be unique. You can use UpdateScript to change * this value later. *

* * @param version * Version information associated with a build or script. Version strings don't need to be unique. You can * use UpdateScript to * change this value later. * @return Returns a reference to this object so that method calls can be chained together. */ public CreateScriptRequest withVersion(String version) { setVersion(version); return this; } /** *

* * @param storageLocation * The location of the Amazon S3 bucket where a zipped file containing your Realtime scripts is stored. The * storage location must specify the Amazon S3 bucket name, the zip file name (the "key"), and a role ARN * that allows Amazon GameLift to access the Amazon S3 storage location. The S3 bucket must be in the same * Region where you want to create a new script. By default, Amazon GameLift uploads the latest version of * the zip file; if you have S3 object versioning turned on, you can use the ObjectVersion * parameter to specify an earlier version. */ public void setStorageLocation(S3Location storageLocation) { this.storageLocation = storageLocation; } /** *

* * @return The location of the Amazon S3 bucket where a zipped file containing your Realtime scripts is stored. The * storage location must specify the Amazon S3 bucket name, the zip file name (the "key"), and a role ARN * that allows Amazon GameLift to access the Amazon S3 storage location. The S3 bucket must be in the same * Region where you want to create a new script. By default, Amazon GameLift uploads the latest version of * the zip file; if you have S3 object versioning turned on, you can use the ObjectVersion * parameter to specify an earlier version. */ public S3Location getStorageLocation() { return this.storageLocation; } /** *

* * @param storageLocation * The location of the Amazon S3 bucket where a zipped file containing your Realtime scripts is stored. The * storage location must specify the Amazon S3 bucket name, the zip file name (the "key"), and a role ARN * that allows Amazon GameLift to access the Amazon S3 storage location. The S3 bucket must be in the same * Region where you want to create a new script. By default, Amazon GameLift uploads the latest version of * the zip file; if you have S3 object versioning turned on, you can use the ObjectVersion * parameter to specify an earlier version. * @return Returns a reference to this object so that method calls can be chained together. */ public CreateScriptRequest withStorageLocation(S3Location storageLocation) { setStorageLocation(storageLocation); return this; } /** *

* A data object containing your Realtime scripts and dependencies as a zip file. The zip file can have one or * multiple files. Maximum size of a zip file is 5 MB. *

* 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 * A data object containing your Realtime scripts and dependencies as a zip file. The zip file can have one * or multiple files. Maximum size of a zip file is 5 MB.

* When using the Amazon Web Services CLI tool to create a script, this parameter is set to the zip file * name. It must be prepended with the string "fileb://" to indicate that the file data is a binary object. * For example: --zip-file fileb://myRealtimeScript.zip. */ public void setZipFile(java.nio.ByteBuffer zipFile) { this.zipFile = zipFile; } /** *

* A data object containing your Realtime scripts and dependencies as a zip file. The zip file can have one or * multiple files. Maximum size of a zip file is 5 MB. *

* {@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 A data object containing your Realtime scripts and dependencies as a zip file. The zip file can have one * or multiple files. Maximum size of a zip file is 5 MB.

* When using the Amazon Web Services CLI tool to create a script, this parameter is set to the zip file * name. It must be prepended with the string "fileb://" to indicate that the file data is a binary object. * For example: --zip-file fileb://myRealtimeScript.zip. */ public java.nio.ByteBuffer getZipFile() { return this.zipFile; } /** *

* A data object containing your Realtime scripts and dependencies as a zip file. The zip file can have one or * multiple files. Maximum size of a zip file is 5 MB. *

* 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. *

* * @param zipFile * A data object containing your Realtime scripts and dependencies as a zip file. The zip file can have one * or multiple files. Maximum size of a zip file is 5 MB.

* When using the Amazon Web Services CLI tool to create a script, this parameter is set to the zip file * name. It must be prepended with the string "fileb://" to indicate that the file data is a binary object. * For example: --zip-file fileb://myRealtimeScript.zip. * @return Returns a reference to this object so that method calls can be chained together. */ public CreateScriptRequest withZipFile(java.nio.ByteBuffer zipFile) { setZipFile(zipFile); return this; } /** *

* * @return A list of labels to assign to the new script resource. Tags are developer-defined key-value pairs. * Tagging Amazon Web Services resources are useful for resource management, access management and cost * allocation. For more information, see Tagging Amazon Web Services * Resources in the Amazon Web Services General Reference. Once the resource is created, you can * use TagResource, UntagResource, * and * ListTagsForResource to add, remove, and view tags. The maximum tag limit may be lower than stated. * See the Amazon Web Services General Reference for actual tagging limits. */ public java.util.List getTags() { return tags; } /** *

* NOTE: This method appends the values to the existing list (if any). Use * {@link #setTags(java.util.Collection)} or {@link #withTags(java.util.Collection)} if you want to override the * existing values. *

* * @param tags * A list of labels to assign to the new script resource. Tags are developer-defined key-value pairs. Tagging * Amazon Web Services resources are useful for resource management, access management and cost allocation. * For more information, see * Tagging Amazon Web Services Resources in the Amazon Web Services General Reference. Once the * resource is created, you can use TagResource, UntagResource, * and * ListTagsForResource to add, remove, and view tags. The maximum tag limit may be lower than stated. See * the Amazon Web Services General Reference for actual tagging limits. * @return Returns a reference to this object so that method calls can be chained together. */ public CreateScriptRequest withTags(java.util.Collection tags) { setTags(tags); 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 (getName() != null) sb.append("Name: ").append(getName()).append(","); if (getVersion() != null) sb.append("Version: ").append(getVersion()).append(","); if (getStorageLocation() != null) sb.append("StorageLocation: ").append(getStorageLocation()).append(","); if (getZipFile() != null) sb.append("ZipFile: ").append(getZipFile()).append(","); if (getTags() != null) sb.append("Tags: ").append(getTags()); sb.append("}"); return sb.toString(); } @Override public boolean equals(Object obj) { if (this == obj) return true; if (obj == null) return false; if (obj instanceof CreateScriptRequest == false) return false; CreateScriptRequest other = (CreateScriptRequest) obj; if (other.getName() == null ^ this.getName() == null) return false; if (other.getName() != null && other.getName().equals(this.getName()) == false) return false; if (other.getVersion() == null ^ this.getVersion() == null) return false; if (other.getVersion() != null && other.getVersion().equals(this.getVersion()) == false) return false; if (other.getStorageLocation() == null ^ this.getStorageLocation() == null) return false; if (other.getStorageLocation() != null && other.getStorageLocation().equals(this.getStorageLocation()) == 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.getTags() == null ^ this.getTags() == null) return false; if (other.getTags() != null && other.getTags().equals(this.getTags()) == false) return false; return true; } @Override public int hashCode() { final int prime = 31; int hashCode = 1; hashCode = prime * hashCode + ((getName() == null) ? 0 : getName().hashCode()); hashCode = prime * hashCode + ((getVersion() == null) ? 0 : getVersion().hashCode()); hashCode = prime * hashCode + ((getStorageLocation() == null) ? 0 : getStorageLocation().hashCode()); hashCode = prime * hashCode + ((getZipFile() == null) ? 0 : getZipFile().hashCode()); hashCode = prime * hashCode + ((getTags() == null) ? 0 : getTags().hashCode()); return hashCode; } @Override public CreateScriptRequest clone() { return (CreateScriptRequest) super.clone(); } }