software.amazon.awssdk.services.gamelift.model

Class UpdateScriptRequest

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

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<UpdateScriptRequest.Builder,UpdateScriptRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	UpdateScriptRequest.Builder

Method Summary

Modifier and Type	Method and Description
static UpdateScriptRequest.Builder	builder()
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	scriptId() A unique identifier for a Realtime script to update.
List<SdkField<?>>	sdkFields()
static Class<? extends UpdateScriptRequest.Builder>	serializableBuilderClass()
S3Location	storageLocation() The Amazon S3 location of your Realtime scripts.
UpdateScriptRequest.Builder	toBuilder()
String	toString() Returns a string representation of this object.
String	version() The version that is associated with a build or script.
SdkBytes	zipFile() A 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

scriptId

public String scriptId()

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

Returns:

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

name

public String name()

A descriptive label that is associated with a script. Script names do not need to be unique.

Returns:

A descriptive label that is associated with a script. Script names do not need to be unique.

version

public String version()

The version that is associated with a build or script. Version strings do not need to be unique.

Returns:

The version that is associated with a build or script. Version strings do not need to be unique.

storageLocation

public S3Location storageLocation()

The Amazon S3 location of your Realtime scripts. The storage location must specify the S3 bucket name, the zip file name (the "key"), and an IAM role ARN that allows Amazon GameLift to access the S3 storage location. The S3 bucket must be in the same Region as the script you're updating. 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. To call this operation with a storage location, you must have IAM PassRole permission. For more details on IAM roles and PassRole permissions, see Set up a role for GameLift access.

Returns:

The Amazon S3 location of your Realtime scripts. The storage location must specify the S3 bucket name, the zip file name (the "key"), and an IAM role ARN that allows Amazon GameLift to access the S3 storage location. The S3 bucket must be in the same Region as the script you're updating. 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. To call this operation with a storage location, you must have IAM PassRole permission. For more details on IAM roles and PassRole permissions, see Set up a role for GameLift access.

zipFile

public SdkBytes 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 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:

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 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 UpdateScriptRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<UpdateScriptRequest.Builder,UpdateScriptRequest>

Specified by:

toBuilder in class GameLiftRequest

builder

public static UpdateScriptRequest.Builder builder()

serializableBuilderClass

public static Class<? extends UpdateScriptRequest.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