Package software.amazon.awssdk.services.gamelift.model

Class Script

java.lang.Object

software.amazon.awssdk.services.gamelift.model.Script

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<Script.Builder,Script>

@Generated("software.amazon.awssdk:codegen")
public final class Script
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<Script.Builder,Script>

Properties describing a Realtime script.

Related actions

All APIs by task

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	Script.Builder

Method Summary

Modifier and Type	Method	Description
static Script.Builder	builder()
Instant	creationTime()	A time stamp indicating when this data object was created.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	name()	A descriptive label that is associated with a script.
String	scriptArn()	The Amazon Resource Name (ARN) that is assigned to a Amazon GameLift script resource and uniquely identifies it.
String	scriptId()	A unique identifier for the Realtime script
List<SdkField<?>>	sdkFields()
static Class<? extends Script.Builder>	serializableBuilderClass()
Long	sizeOnDisk()	The file size of the uploaded Realtime script, expressed in bytes.
S3Location	storageLocation()	The location of the Amazon S3 bucket where a zipped file containing your Realtime scripts is stored.
Script.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
String	version()	Version information associated with a build or script.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

scriptId

public final String scriptId()

A unique identifier for the Realtime script

Returns:

A unique identifier for the Realtime script

scriptArn

public final 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.

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.

name

public final String name()

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.

version

public final String version()

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.

sizeOnDisk

public final 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".

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

creationTime

public final Instant 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:

A time stamp indicating when this data object was created. Format is a number expressed in Unix time as milliseconds (for example "1469498468.057").

storageLocation

public final 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.

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.

toBuilder

public Script.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<Script.Builder,Script>

builder

public static Script.Builder builder()

serializableBuilderClass

public static Class<? extends Script.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final 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

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo