@Generated(value="software.amazon.awssdk:codegen") public final class Instance extends Object implements StructuredPojo, ToCopyableBuilder<Instance.Builder,Instance>
Properties that describe an instance of a virtual computing resource that hosts one or more game servers. A fleet may contain zero or more instances.
Modifier and Type | Class and Description |
---|---|
static interface |
Instance.Builder |
Modifier and Type | Method and Description |
---|---|
static Instance.Builder |
builder() |
Instant |
creationTime()
Time stamp indicating when this data object was created.
|
boolean |
equals(Object obj) |
String |
fleetId()
Unique identifier for a fleet that the instance is in.
|
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz) |
int |
hashCode() |
String |
instanceId()
Unique identifier for an instance.
|
String |
ipAddress()
IP address assigned to the instance.
|
void |
marshall(ProtocolMarshaller protocolMarshaller)
Marshalls this structured data using the given
ProtocolMarshaller . |
OperatingSystem |
operatingSystem()
Operating system that is running on this instance.
|
String |
operatingSystemAsString()
Operating system that is running on this instance.
|
static Class<? extends Instance.Builder> |
serializableBuilderClass() |
InstanceStatus |
status()
Current status of the instance.
|
String |
statusAsString()
Current status of the instance.
|
Instance.Builder |
toBuilder()
Take this object and create a builder that contains all of the current property values of this object.
|
String |
toString() |
EC2InstanceType |
type()
EC2 instance type that defines the computing resources of this instance.
|
String |
typeAsString()
EC2 instance type that defines the computing resources of this instance.
|
copy
public String fleetId()
Unique identifier for a fleet that the instance is in.
public String instanceId()
Unique identifier for an instance.
public String ipAddress()
IP address assigned to the instance.
public OperatingSystem operatingSystem()
Operating system that is running on this instance.
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()
.
OperatingSystem
public String operatingSystemAsString()
Operating system that is running on this instance.
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()
.
OperatingSystem
public EC2InstanceType type()
EC2 instance type that defines the computing resources of this instance.
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()
.
EC2InstanceType
public String typeAsString()
EC2 instance type that defines the computing resources of this instance.
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()
.
EC2InstanceType
public InstanceStatus status()
Current status of the instance. Possible statuses include the following:
PENDING -- The instance is in the process of being created and launching server processes as defined in the fleet's run-time configuration.
ACTIVE -- The instance has been successfully created and at least one server process has successfully launched and reported back to Amazon GameLift that it is ready to host a game session. The instance is now considered ready to host game sessions.
TERMINATING -- The instance is in the process of shutting down. This may happen to reduce capacity during a scaling down event or to recycle resources in the event of a problem.
If the service returns an enum value that is not available in the current SDK version, status
will
return InstanceStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available from
statusAsString()
.
PENDING -- The instance is in the process of being created and launching server processes as defined in the fleet's run-time configuration.
ACTIVE -- The instance has been successfully created and at least one server process has successfully launched and reported back to Amazon GameLift that it is ready to host a game session. The instance is now considered ready to host game sessions.
TERMINATING -- The instance is in the process of shutting down. This may happen to reduce capacity during a scaling down event or to recycle resources in the event of a problem.
InstanceStatus
public String statusAsString()
Current status of the instance. Possible statuses include the following:
PENDING -- The instance is in the process of being created and launching server processes as defined in the fleet's run-time configuration.
ACTIVE -- The instance has been successfully created and at least one server process has successfully launched and reported back to Amazon GameLift that it is ready to host a game session. The instance is now considered ready to host game sessions.
TERMINATING -- The instance is in the process of shutting down. This may happen to reduce capacity during a scaling down event or to recycle resources in the event of a problem.
If the service returns an enum value that is not available in the current SDK version, status
will
return InstanceStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available from
statusAsString()
.
PENDING -- The instance is in the process of being created and launching server processes as defined in the fleet's run-time configuration.
ACTIVE -- The instance has been successfully created and at least one server process has successfully launched and reported back to Amazon GameLift that it is ready to host a game session. The instance is now considered ready to host game sessions.
TERMINATING -- The instance is in the process of shutting down. This may happen to reduce capacity during a scaling down event or to recycle resources in the event of a problem.
InstanceStatus
public Instant creationTime()
Time stamp indicating when this data object was created. Format is a number expressed in Unix time as milliseconds (for example "1469498468.057").
public Instance.Builder toBuilder()
ToCopyableBuilder
toBuilder
in interface ToCopyableBuilder<Instance.Builder,Instance>
public static Instance.Builder builder()
public static Class<? extends Instance.Builder> serializableBuilderClass()
public void marshall(ProtocolMarshaller protocolMarshaller)
StructuredPojo
ProtocolMarshaller
.marshall
in interface StructuredPojo
protocolMarshaller
- Implementation of ProtocolMarshaller
used to marshall this object's data.Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.