software.amazon.awssdk.services.gamelift.model

Class CreateScriptRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.gamelift.model.GameLiftRequest

software.amazon.awssdk.services.gamelift.model.CreateScriptRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<CreateScriptRequest.Builder,CreateScriptRequest>

@Generated(value="software.amazon.awssdk:codegen")
public final class CreateScriptRequest
extends GameLiftRequest
implements ToCopyableBuilder<CreateScriptRequest.Builder,CreateScriptRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	CreateScriptRequest.Builder

Method Summary

Modifier and Type	Method and Description
static CreateScriptRequest.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	name() Descriptive label that is associated with a script.
List<SdkField<?>>	sdkFields()
static Class<? extends CreateScriptRequest.Builder>	serializableBuilderClass()
S3Location	storageLocation() Location of the Amazon S3 bucket where a zipped file containing your Realtime scripts is stored.
CreateScriptRequest.Builder	toBuilder()
String	toString() Returns a string representation of this object.
String	version() Version that is associated with a build or script.
SdkBytes	zipFile() Data object containing your Realtime scripts and dependencies as a zip file.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

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

name

public String name()

Descriptive label that is associated with a script. Script names do not need to be unique. You can use UpdateScript to change this value later.

Returns:

Descriptive label that is associated with a script. Script names do not need to be unique. You can use UpdateScript to change this value later.

version

public String version()

Version that is associated with a build or script. Version strings do not need to be unique. You can use UpdateScript to change this value later.

Returns:

Version that is associated with a build or script. Version strings do not need to be unique. You can use UpdateScript to change this value later.

storageLocation

public S3Location storageLocation()

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:

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.

zipFile

public SdkBytes zipFile()

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 AWS 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:

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

toBuilder

public CreateScriptRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<CreateScriptRequest.Builder,CreateScriptRequest>

Specified by:

toBuilder in class GameLiftRequest

builder

public static CreateScriptRequest.Builder builder()

serializableBuilderClass

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

hashCode

public int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public boolean equals(Object obj)

Overrides:

equals in class AwsRequest

equalsBySdkFields

public boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

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

getValueForField

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

Overrides:

getValueForField in class SdkRequest

sdkFields

public List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo