Package software.amazon.awssdk.services.gamelift.model

Class DescribeFleetPortSettingsResponse

java.lang.Object

software.amazon.awssdk.core.SdkResponse

software.amazon.awssdk.awscore.AwsResponse

software.amazon.awssdk.services.gamelift.model.GameLiftResponse

software.amazon.awssdk.services.gamelift.model.DescribeFleetPortSettingsResponse

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<DescribeFleetPortSettingsResponse.Builder,DescribeFleetPortSettingsResponse>

@Generated("software.amazon.awssdk:codegen")
public final class DescribeFleetPortSettingsResponse
extends GameLiftResponse
implements ToCopyableBuilder<DescribeFleetPortSettingsResponse.Builder,DescribeFleetPortSettingsResponse>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	DescribeFleetPortSettingsResponse.Builder

Method Summary

Modifier and Type	Method	Description
static DescribeFleetPortSettingsResponse.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
String	fleetArn()	The Amazon Resource Name (ARN) that is assigned to a Amazon GameLift fleet resource and uniquely identifies it.
String	fleetId()	A unique identifier for the fleet that was requested.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasInboundPermissions()	For responses, this returns true if the service returned a value for the InboundPermissions property.
List<IpPermission>	inboundPermissions()	The port settings for the requested fleet ID.
String	location()	The requested fleet location, expressed as an Amazon Web Services Region code, such as us-west-2.
List<SdkField<?>>	sdkFields()
static Class<? extends DescribeFleetPortSettingsResponse.Builder>	serializableBuilderClass()
DescribeFleetPortSettingsResponse.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
LocationUpdateStatus	updateStatus()	The current status of updates to the fleet's port settings in the requested fleet location.
String	updateStatusAsString()	The current status of updates to the fleet's port settings in the requested fleet location.

Methods inherited from class software.amazon.awssdk.services.gamelift.model.GameLiftResponse

responseMetadata

Methods inherited from class software.amazon.awssdk.core.SdkResponse

sdkHttpResponse

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 was requested.

Returns:

A unique identifier for the fleet that was requested.

fleetArn

public final String fleetArn()

The Amazon Resource Name (ARN) that is assigned to a Amazon GameLift fleet resource and uniquely identifies it. ARNs are unique across all Regions. Format is arn:aws:gamelift:<region>::fleet/fleet-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912 .

Returns:

The Amazon Resource Name (ARN) that is assigned to a Amazon GameLift fleet resource and uniquely identifies it. ARNs are unique across all Regions. Format is arn:aws:gamelift:<region>::fleet/fleet-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912.

hasInboundPermissions

public final boolean hasInboundPermissions()

For responses, this returns true if the service returned a value for the InboundPermissions property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

inboundPermissions

public final List<IpPermission> inboundPermissions()

The port settings for the requested fleet ID.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasInboundPermissions() method.

Returns:

The port settings for the requested fleet ID.

updateStatus

public final LocationUpdateStatus updateStatus()

The current status of updates to the fleet's port settings in the requested fleet location. A status of PENDING_UPDATE indicates that an update was requested for the fleet but has not yet been completed for the location.

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

Returns:

The current status of updates to the fleet's port settings in the requested fleet location. A status of PENDING_UPDATE indicates that an update was requested for the fleet but has not yet been completed for the location.

See Also:

LocationUpdateStatus

updateStatusAsString

public final String updateStatusAsString()

The current status of updates to the fleet's port settings in the requested fleet location. A status of PENDING_UPDATE indicates that an update was requested for the fleet but has not yet been completed for the location.

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

Returns:

The current status of updates to the fleet's port settings in the requested fleet location. A status of PENDING_UPDATE indicates that an update was requested for the fleet but has not yet been completed for the location.

See Also:

LocationUpdateStatus

location

public final String location()

The requested fleet location, expressed as an Amazon Web Services Region code, such as us-west-2.

Returns:

The requested fleet location, expressed as an Amazon Web Services Region code, such as us-west-2.

toBuilder

public DescribeFleetPortSettingsResponse.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<DescribeFleetPortSettingsResponse.Builder,DescribeFleetPortSettingsResponse>

Specified by:

toBuilder in class AwsResponse

builder

public static DescribeFleetPortSettingsResponse.Builder builder()

serializableBuilderClass

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

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsResponse

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsResponse

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)

Overrides:

getValueForField in class SdkResponse

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo