software.amazon.awssdk.services.gamelift.model

Class Compute

java.lang.Object

software.amazon.awssdk.services.gamelift.model.Compute

All Implemented Interfaces:

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

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

An Amazon GameLift compute resource for hosting your game servers. A compute can be an EC2instance in a managed EC2 fleet or a registered compute in an Anywhere fleet.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	Compute.Builder

Method Summary

Modifier and Type	Method and Description
static Compute.Builder	builder()
String	computeArn() The ARN that is assigned to a compute resource and uniquely identifies it.
String	computeName() A descriptive label for the compute resource.
ComputeStatus	computeStatus() Current status of the compute.
String	computeStatusAsString() Current status of the compute.
Instant	creationTime() A time stamp indicating when this data object was created.
String	dnsName() The DNS name of a compute resource.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
String	fleetArn() The Amazon Resource Name (ARN) of the fleet that the compute belongs to.
String	fleetId() A unique identifier for the fleet that the compute belongs to.
String	gameLiftServiceSdkEndpoint() The Amazon GameLift SDK endpoint connection for a registered compute resource in an Anywhere fleet.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	ipAddress() The IP address of a compute resource.
String	location() The name of the custom location you added to the fleet that this compute resource resides in.
OperatingSystem	operatingSystem() The type of operating system on the compute resource.
String	operatingSystemAsString() The type of operating system on the compute resource.
List<SdkField<?>>	sdkFields()
static Class<? extends Compute.Builder>	serializableBuilderClass()
Compute.Builder	toBuilder()
String	toString() Returns a string representation of this object.
EC2InstanceType	type() The Amazon EC2 instance type that the fleet uses.
String	typeAsString() The Amazon EC2 instance type that the fleet uses.

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

fleetId

public final String fleetId()

A unique identifier for the fleet that the compute belongs to.

Returns:

A unique identifier for the fleet that the compute belongs to.

fleetArn

public final String fleetArn()

The Amazon Resource Name (ARN) of the fleet that the compute belongs to.

Returns:

The Amazon Resource Name (ARN) of the fleet that the compute belongs to.

computeName

public final String computeName()

A descriptive label for the compute resource. For instances in a managed EC2 fleet, the compute name is an instance ID.

Returns:

A descriptive label for the compute resource. For instances in a managed EC2 fleet, the compute name is an instance ID.

computeArn

public final String computeArn()

The ARN that is assigned to a compute resource and uniquely identifies it. ARNs are unique across locations. Instances in managed EC2 fleets are not assigned a ComputeARN.

Returns:

The ARN that is assigned to a compute resource and uniquely identifies it. ARNs are unique across locations. Instances in managed EC2 fleets are not assigned a ComputeARN.

ipAddress

public final String ipAddress()

The IP address of a compute resource. Amazon GameLift requires a DNS name or IP address for a compute.

Returns:

The IP address of a compute resource. Amazon GameLift requires a DNS name or IP address for a compute.

dnsName

public final String dnsName()

The DNS name of a compute resource. Amazon GameLift requires a DNS name or IP address for a compute.

Returns:

The DNS name of a compute resource. Amazon GameLift requires a DNS name or IP address for a compute.

computeStatus

public final ComputeStatus computeStatus()

Current status of the compute. A compute must have an ACTIVE status to host game sessions.

If the service returns an enum value that is not available in the current SDK version, computeStatus will return ComputeStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from computeStatusAsString().

Returns:

Current status of the compute. A compute must have an ACTIVE status to host game sessions.

See Also:

ComputeStatus

computeStatusAsString

public final String computeStatusAsString()

Current status of the compute. A compute must have an ACTIVE status to host game sessions.

If the service returns an enum value that is not available in the current SDK version, computeStatus will return ComputeStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from computeStatusAsString().

Returns:

Current status of the compute. A compute must have an ACTIVE status to host game sessions.

See Also:

ComputeStatus

location

public final String location()

The name of the custom location you added to the fleet that this compute resource resides in.

Returns:

The name of the custom location you added to the fleet that this compute resource resides in.

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

operatingSystem

public final OperatingSystem operatingSystem()

The type of operating system on the compute resource.

If the service returns an enum value that is not available in the current SDK version, operatingSystem will return OperatingSystem.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from operatingSystemAsString().

Returns:

The type of operating system on the compute resource.

See Also:

OperatingSystem

operatingSystemAsString

public final String operatingSystemAsString()

The type of operating system on the compute resource.

If the service returns an enum value that is not available in the current SDK version, operatingSystem will return OperatingSystem.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from operatingSystemAsString().

Returns:

The type of operating system on the compute resource.

See Also:

OperatingSystem

type

public final EC2InstanceType type()

The Amazon EC2 instance type that the fleet uses. For registered computes in an Amazon GameLift Anywhere fleet, this property is empty.

If the service returns an enum value that is not available in the current SDK version, type will return EC2InstanceType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from typeAsString().

Returns:

The Amazon EC2 instance type that the fleet uses. For registered computes in an Amazon GameLift Anywhere fleet, this property is empty.

See Also:

EC2InstanceType

typeAsString

public final String typeAsString()

The Amazon EC2 instance type that the fleet uses. For registered computes in an Amazon GameLift Anywhere fleet, this property is empty.

If the service returns an enum value that is not available in the current SDK version, type will return EC2InstanceType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from typeAsString().

Returns:

The Amazon EC2 instance type that the fleet uses. For registered computes in an Amazon GameLift Anywhere fleet, this property is empty.

See Also:

EC2InstanceType

gameLiftServiceSdkEndpoint

public final String gameLiftServiceSdkEndpoint()

The Amazon GameLift SDK endpoint connection for a registered compute resource in an Anywhere fleet. The game servers on the compute use this endpoint to connect to the Amazon GameLift service.

Returns:

The Amazon GameLift SDK endpoint connection for a registered compute resource in an Anywhere fleet. The game servers on the compute use this endpoint to connect to the Amazon GameLift service.

toBuilder

public Compute.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<Compute.Builder,Compute>

builder

public static Compute.Builder builder()

serializableBuilderClass

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