Class Compute
- java.lang.Object
-
- software.amazon.awssdk.services.gamelift.model.Compute
-
- All Implemented Interfaces:
Serializable,SdkPojo,ToCopyableBuilder<Compute.Builder,Compute>
@Generated("software.amazon.awssdk:codegen") public final class Compute extends Object implements SdkPojo, Serializable, ToCopyableBuilder<Compute.Builder,Compute>
This data type has been expanded to use with the Amazon GameLift containers feature, which is currently in public preview.
An Amazon GameLift compute resource for hosting your game servers. Computes in an Amazon GameLift fleet differs depending on the fleet's compute type property as follows:
-
For
EC2fleets, a compute is an EC2 instance. -
For
ANYWHEREfleets, a compute is a computing resource that you provide and is registered to the fleet. -
For
CONTAINERfleets, a compute is a container that's registered to the fleet.
- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interfaceCompute.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static Compute.Builderbuilder()StringcomputeArn()The ARN that is assigned to a compute resource and uniquely identifies it.StringcomputeName()A descriptive label for the compute resource.ComputeStatuscomputeStatus()Current status of the compute.StringcomputeStatusAsString()Current status of the compute.ContainerAttributescontainerAttributes()Some attributes of a container.InstantcreationTime()A time stamp indicating when this data object was created.StringdnsName()The DNS name of a compute resource.booleanequals(Object obj)booleanequalsBySdkFields(Object obj)StringfleetArn()The Amazon Resource Name (ARN) of the fleet that the compute belongs to.StringfleetId()A unique identifier for the fleet that the compute belongs to.StringgameLiftAgentEndpoint()The endpoint of the Amazon GameLift Agent.StringgameLiftServiceSdkEndpoint()The Amazon GameLift SDK endpoint connection for a registered compute resource in an Anywhere fleet.<T> Optional<T>getValueForField(String fieldName, Class<T> clazz)inthashCode()StringinstanceId()TheInstanceIDof theInstancehosting the compute for Container and Managed EC2 fleets.StringipAddress()The IP address of a compute resource.Stringlocation()The name of the custom location you added to the fleet that this compute resource resides in.OperatingSystemoperatingSystem()The type of operating system on the compute resource.StringoperatingSystemAsString()The type of operating system on the compute resource.List<SdkField<?>>sdkFields()static Class<? extends Compute.Builder>serializableBuilderClass()Compute.BuildertoBuilder()StringtoString()Returns a string representation of this object.EC2InstanceTypetype()The Amazon EC2 instance type that the fleet uses.StringtypeAsString()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 the same value as the
InstanceIdID.- Returns:
- A descriptive label for the compute resource. For instances in a managed EC2 fleet, the compute name is
the same value as the
InstanceIdID.
-
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 Compute ARN.
- 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 Compute ARN.
-
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
ACTIVEstatus to host game sessions.If the service returns an enum value that is not available in the current SDK version,
computeStatuswill returnComputeStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromcomputeStatusAsString().- Returns:
- Current status of the compute. A compute must have an
ACTIVEstatus to host game sessions. - See Also:
ComputeStatus
-
computeStatusAsString
public final String computeStatusAsString()
Current status of the compute. A compute must have an
ACTIVEstatus to host game sessions.If the service returns an enum value that is not available in the current SDK version,
computeStatuswill returnComputeStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromcomputeStatusAsString().- Returns:
- Current status of the compute. A compute must have an
ACTIVEstatus 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,
operatingSystemwill returnOperatingSystem.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromoperatingSystemAsString().- 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,
operatingSystemwill returnOperatingSystem.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromoperatingSystemAsString().- 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,
typewill returnEC2InstanceType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromtypeAsString().- 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,
typewill returnEC2InstanceType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromtypeAsString().- 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.
-
gameLiftAgentEndpoint
public final String gameLiftAgentEndpoint()
The endpoint of the Amazon GameLift Agent.
- Returns:
- The endpoint of the Amazon GameLift Agent.
-
instanceId
public final String instanceId()
The
InstanceIDof theInstancehosting the compute for Container and Managed EC2 fleets.- Returns:
- The
InstanceIDof theInstancehosting the compute for Container and Managed EC2 fleets.
-
containerAttributes
public final ContainerAttributes containerAttributes()
Some attributes of a container.
- Returns:
- Some attributes of a container.
-
toBuilder
public Compute.Builder toBuilder()
- Specified by:
toBuilderin interfaceToCopyableBuilder<Compute.Builder,Compute>
-
builder
public static Compute.Builder builder()
-
serializableBuilderClass
public static Class<? extends Compute.Builder> serializableBuilderClass()
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFieldsin interfaceSdkPojo
-
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.
-
-