Script (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.gamelift.model.Script

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class Script
extends Object
implements Serializable, Cloneable, StructuredPojo
```
Properties describing a Realtime script.

Related actions

All APIs by task

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

Script()

Constructors
Constructor and Description
`Script()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Script`	`clone()`
`boolean`	`equals(Object obj)`
`Date`	`getCreationTime()` A time stamp indicating when this data object was created.
`String`	`getName()` A descriptive label that is associated with a script.
`String`	`getScriptArn()` The Amazon Resource Name (ARN) that is assigned to a Amazon GameLift script resource and uniquely identifies it.
`String`	`getScriptId()` A unique identifier for the Realtime script
`Long`	`getSizeOnDisk()` The file size of the uploaded Realtime script, expressed in bytes.
`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.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setCreationTime(Date creationTime)` A time stamp indicating when this data object was created.
`void`	`setName(String name)` A descriptive label that is associated with a script.
`void`	`setScriptArn(String scriptArn)` The Amazon Resource Name (ARN) that is assigned to a Amazon GameLift script resource and uniquely identifies it.
`void`	`setScriptId(String scriptId)` A unique identifier for the Realtime script
`void`	`setSizeOnDisk(Long sizeOnDisk)` The file size of the uploaded Realtime script, expressed in bytes.
`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.
`String`	`toString()` Returns a string representation of this object.
`Script`	`withCreationTime(Date creationTime)` A time stamp indicating when this data object was created.
`Script`	`withName(String name)` A descriptive label that is associated with a script.
`Script`	`withScriptArn(String scriptArn)` The Amazon Resource Name (ARN) that is assigned to a Amazon GameLift script resource and uniquely identifies it.
`Script`	`withScriptId(String scriptId)` A unique identifier for the Realtime script
`Script`	`withSizeOnDisk(Long sizeOnDisk)` The file size of the uploaded Realtime script, expressed in bytes.
`Script`	`withStorageLocation(S3Location storageLocation)` The location of the Amazon S3 bucket where a zipped file containing your Realtime scripts is stored.
`Script`	`withVersion(String version)` Version information associated with a build or script.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - Script
```
public Script()
```
- Method Detail
  - setScriptId
```
public void setScriptId(String scriptId)
```
    A unique identifier for the Realtime script
    
    Parameters:
    
    scriptId - A unique identifier for the Realtime script
  - getScriptId
```
public String getScriptId()
```
    A unique identifier for the Realtime script
    
    Returns:
    
    A unique identifier for the Realtime script
  - withScriptId
```
public Script withScriptId(String scriptId)
```
    A unique identifier for the Realtime script
    
    Parameters:
    
    scriptId - A unique identifier for the Realtime script
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setScriptArn
```
public void setScriptArn(String scriptArn)
```
    The Amazon Resource Name (ARN) that is assigned to a Amazon GameLift script resource and uniquely identifies it. ARNs are unique across all Regions. In a GameLift script ARN, the resource ID matches the ScriptId value.
    
    Parameters:
    
    scriptArn - The Amazon Resource Name (ARN) that is assigned to a Amazon GameLift script resource and uniquely identifies it. ARNs are unique across all Regions. In a GameLift script ARN, the resource ID matches the ScriptId value.
  - getScriptArn
```
public String getScriptArn()
```
    The Amazon Resource Name (ARN) that is assigned to a Amazon GameLift script resource and uniquely identifies it. ARNs are unique across all Regions. In a GameLift script ARN, the resource ID matches the ScriptId value.
    
    Returns:
    
    The Amazon Resource Name (ARN) that is assigned to a Amazon GameLift script resource and uniquely identifies it. ARNs are unique across all Regions. In a GameLift script ARN, the resource ID matches the ScriptId value.
  - withScriptArn
```
public Script withScriptArn(String scriptArn)
```
    The Amazon Resource Name (ARN) that is assigned to a Amazon GameLift script resource and uniquely identifies it. ARNs are unique across all Regions. In a GameLift script ARN, the resource ID matches the ScriptId value.
    
    Parameters:
    
    scriptArn - The Amazon Resource Name (ARN) that is assigned to a Amazon GameLift script resource and uniquely identifies it. ARNs are unique across all Regions. In a GameLift script ARN, the resource ID matches the ScriptId 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 Script 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 Script 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.
  - setSizeOnDisk
```
public void setSizeOnDisk(Long sizeOnDisk)
```
    The file size of the uploaded Realtime script, expressed in bytes. When files are uploaded from an S3 location, this value remains at "0".
    
    Parameters:
    
    sizeOnDisk - The file size of the uploaded Realtime script, expressed in bytes. When files are uploaded from an S3 location, this value remains at "0".
  - getSizeOnDisk
```
public Long getSizeOnDisk()
```
    The file size of the uploaded Realtime script, expressed in bytes. When files are uploaded from an S3 location, this value remains at "0".
    
    Returns:
    
    The file size of the uploaded Realtime script, expressed in bytes. When files are uploaded from an S3 location, this value remains at "0".
  - withSizeOnDisk
```
public Script withSizeOnDisk(Long sizeOnDisk)
```
    The file size of the uploaded Realtime script, expressed in bytes. When files are uploaded from an S3 location, this value remains at "0".
    
    Parameters:
    
    sizeOnDisk - The file size of the uploaded Realtime script, expressed in bytes. When files are uploaded from an S3 location, this value remains at "0".
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setCreationTime
```
public void setCreationTime(Date creationTime)
```
    A time stamp indicating when this data object was created. Format is a number expressed in Unix time as milliseconds (for example "1469498468.057").
    
    Parameters:
    
    creationTime - A time stamp indicating when this data object was created. Format is a number expressed in Unix time as milliseconds (for example "1469498468.057").
  - getCreationTime
```
public Date getCreationTime()
```
    A time stamp indicating when this data object was created. Format is a number expressed in Unix time as milliseconds (for example "1469498468.057").
    
    Returns:
    
    A time stamp indicating when this data object was created. Format is a number expressed in Unix time as milliseconds (for example "1469498468.057").
  - withCreationTime
```
public Script withCreationTime(Date creationTime)
```
    A time stamp indicating when this data object was created. Format is a number expressed in Unix time as milliseconds (for example "1469498468.057").
    
    Parameters:
    
    creationTime - A time stamp indicating when this data object was created. Format is a number expressed in Unix time as milliseconds (for example "1469498468.057").
    
    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 Script 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.
  - 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 Script clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

AWS SDK for Java 1.x API Reference - 1.12.555

Class Script

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Script

Method Detail

setScriptId

getScriptId

withScriptId

setScriptArn

getScriptArn

withScriptArn

setName

getName

withName

setVersion

getVersion

withVersion

setSizeOnDisk

getSizeOnDisk

withSizeOnDisk

setCreationTime

getCreationTime

withCreationTime

setStorageLocation

getStorageLocation

withStorageLocation

toString

equals

hashCode

clone

marshall