All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class UpdateScriptRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable 

See Also:

AWS API Documentation, Serialized Form

• Field Summary

  • Fields inherited from class com.amazonaws.AmazonWebServiceRequest

    NOOP

• Constructor Summary

  Constructors

  Constructor and Description
  UpdateScriptRequest ()

• Method Summary

  All Methods

  Modifier and Type	Method and Description
  UpdateScriptRequest	clone () Creates a shallow clone of this object for all fields except the handler context.
  boolean	equals (Object obj)
  String	getName () A descriptive label that is associated with a script.
  String	getScriptId () A unique identifier for the Realtime script to update.
  S3Location	getStorageLocation () The location of the Amazon S3 bucket where a zipped file containing your Realtime scripts is stored.
  String	getVersion () Version information associated with a build or script.
  ByteBuffer	getZipFile () A data object containing your Realtime scripts and dependencies as a zip file.
  int	hashCode ()
  void	setName (String name) A descriptive label that is associated with a script.
  void	setScriptId (String scriptId) A unique identifier for the Realtime script to update.
  void	setStorageLocation (S3Location storageLocation) The location of the Amazon S3 bucket where a zipped file containing your Realtime scripts is stored.
  void	setVersion (String version) Version information associated with a build or script.
  void	setZipFile (ByteBuffer zipFile) A data object containing your Realtime scripts and dependencies as a zip file.
  String	toString () Returns a string representation of this object.
  UpdateScriptRequest	withName (String name) A descriptive label that is associated with a script.
  UpdateScriptRequest	withScriptId (String scriptId) A unique identifier for the Realtime script to update.
  UpdateScriptRequest	withStorageLocation (S3Location storageLocation) The location of the Amazon S3 bucket where a zipped file containing your Realtime scripts is stored.
  UpdateScriptRequest	withVersion (String version) Version information associated with a build or script.
  UpdateScriptRequest	withZipFile (ByteBuffer zipFile) A data object containing your Realtime scripts and dependencies as a zip file.

  • Methods inherited from class com.amazonaws.AmazonWebServiceRequest

    addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

  • Methods inherited from class java.lang.Object

    getClass, notify, notifyAll, wait, wait, wait

• Constructor Detail

  • UpdateScriptRequest

    public UpdateScriptRequest()

• Method Detail

  • setScriptId

    public void setScriptId(String scriptId)

    A unique identifier for the Realtime script to update. You can use either the script ID or ARN value.

    Parameters:

    scriptId - A unique identifier for the Realtime script to update. You can use either the script ID or ARN value.

  • getScriptId

    public String getScriptId()

    A unique identifier for the Realtime script to update. You can use either the script ID or ARN value.

    Returns:

    A unique identifier for the Realtime script to update. You can use either the script ID or ARN value.

  • withScriptId

    public UpdateScriptRequest withScriptId(String scriptId)

    A unique identifier for the Realtime script to update. You can use either the script ID or ARN value.

    Parameters:

    scriptId - A unique identifier for the Realtime script to update. You can use either the script ID or ARN value.

    Returns:

    Returns a reference to this object so that method calls can be chained together.

  • setName

    public void setName(String name)

    A descriptive label that is associated with a script. Script names don't need to be unique.

    Parameters:

    name - A descriptive label that is associated with a script. Script names don't need to be unique.

  • getName

    public String getName()

    A descriptive label that is associated with a script. Script names don't need to be unique.

    Returns:

    A descriptive label that is associated with a script. Script names don't need to be unique.

  • withName

    public UpdateScriptRequest withName(String name)

    A descriptive label that is associated with a script. Script names don't need to be unique.

    Parameters:

    name - A descriptive label that is associated with a script. Script names don't need to be unique.

    Returns:

    Returns a reference to this object so that method calls can be chained together.

  • setVersion

    public void setVersion(String version)

    Version information associated with a build or script. Version strings don't need to be unique.

    Parameters:

    version - Version information associated with a build or script. Version strings don't need to be unique.

  • getVersion

    public String getVersion()

    Version information associated with a build or script. Version strings don't need to be unique.

    Returns:

    Version information associated with a build or script. Version strings don't need to be unique.

  • withVersion

    public UpdateScriptRequest withVersion(String version)

    Version information associated with a build or script. Version strings don't need to be unique.

    Parameters:

    version - Version information associated with a build or script. Version strings don't need to be unique.

    Returns:

    Returns a reference to this object so that method calls can be chained together.

  • setStorageLocation

    public void setStorageLocation(S3Location 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.

    Parameters:

    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.

  • getStorageLocation

    public S3Location getStorageLocation()

    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.

    Returns:

    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.

  • withStorageLocation

    public UpdateScriptRequest withStorageLocation(S3Location 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.

    Parameters:

    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.

    Returns:

    Returns a reference to this object so that method calls can be chained together.

  • setZipFile

    public void setZipFile(ByteBuffer 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.

    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.

    Parameters:

    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.

  • getZipFile

    public ByteBuffer getZipFile()

    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.

    ByteBuffers are stateful. Calling their get methods changes their position. We recommend using ByteBuffer.asReadOnlyBuffer() to create a read-only view of the buffer with an independent position, and calling get methods on this rather than directly on the returned ByteBuffer. Doing so will ensure that anyone else using the ByteBuffer will not be affected by changes to the position.

    Returns:

    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.

  • withZipFile

    public UpdateScriptRequest withZipFile(ByteBuffer 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.

    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.

    Parameters:

    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.

    Returns:

    Returns a reference to this object so that method calls can be chained together.

  • toString

    public String toString()

    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.

    Overrides:

    toString in class Object

    Returns:

    A string representation of this object.

    See Also:

    Object.toString()

  • equals

    public boolean equals(Object obj)

    Overrides:

    equals in class Object

  • hashCode

    public int hashCode()

    Overrides:

    hashCode in class Object

  • clone

    public UpdateScriptRequest clone()

    Description copied from class: AmazonWebServiceRequest
    Creates a shallow clone of this object for all fields except the handler context. Explicitly does not clone the deep structure of the other fields in the message.

    Overrides:

    clone in class AmazonWebServiceRequest

    See Also:

    Object.clone()