Class GetFleetResponse

java.lang.Object
software.amazon.awssdk.core.SdkResponse
software.amazon.awssdk.awscore.AwsResponse
software.amazon.awssdk.services.deadline.model.DeadlineResponse
software.amazon.awssdk.services.deadline.model.GetFleetResponse
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<GetFleetResponse.Builder,GetFleetResponse>
@Generated("software.amazon.awssdk:codegen") public final class GetFleetResponse extends DeadlineResponse implements ToCopyableBuilder<GetFleetResponse.Builder,GetFleetResponse>

  • Method Details

    • fleetId

      public final String fleetId()

      The fleet ID.

      Returns:
      The fleet ID.

    • farmId

      public final String farmId()

      The farm ID of the farm in the fleet.

      Returns:
      The farm ID of the farm in the fleet.

    • displayName

      public final String displayName()

      The display name of the fleet.

      This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.

      Returns:
      The display name of the fleet.

      This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.

    • description

      public final String description()

      The description of the fleet.

      This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.

      Returns:
      The description of the fleet.

      This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.

    • status

      public final FleetStatus status()

      The status of the fleet.

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

      Returns:
      The status of the fleet.
      See Also:

    • statusAsString

      public final String statusAsString()

      The status of the fleet.

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

      Returns:
      The status of the fleet.
      See Also:

    • autoScalingStatus

      public final AutoScalingStatus autoScalingStatus()

      The Auto Scaling status of the fleet. Either GROWING, STEADY, or SHRINKING .

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

      Returns:
      The Auto Scaling status of the fleet. Either GROWING, STEADY, or SHRINKING.
      See Also:

    • autoScalingStatusAsString

      public final String autoScalingStatusAsString()

      The Auto Scaling status of the fleet. Either GROWING, STEADY, or SHRINKING .

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

      Returns:
      The Auto Scaling status of the fleet. Either GROWING, STEADY, or SHRINKING.
      See Also:

    • targetWorkerCount

      public final Integer targetWorkerCount()

      The number of target workers in the fleet.

      Returns:
      The number of target workers in the fleet.

    • workerCount

      public final Integer workerCount()

      The number of workers in the fleet.

      Returns:
      The number of workers in the fleet.

    • minWorkerCount

      public final Integer minWorkerCount()

      The minimum number of workers specified in the fleet.

      Returns:
      The minimum number of workers specified in the fleet.

    • maxWorkerCount

      public final Integer maxWorkerCount()

      The maximum number of workers specified in the fleet.

      Returns:
      The maximum number of workers specified in the fleet.

    • configuration

      public final FleetConfiguration configuration()

      The configuration setting for the fleet.

      Returns:
      The configuration setting for the fleet.

    • hostConfiguration

      public final HostConfiguration hostConfiguration()

      The script that runs as a worker is starting up that you can use to provide additional configuration for workers in your fleet.

      Returns:
      The script that runs as a worker is starting up that you can use to provide additional configuration for workers in your fleet.

    • capabilities

      public final FleetCapabilities capabilities()

      Outlines what the fleet is capable of for minimums, maximums, and naming, in addition to attribute names and values.

      Returns:
      Outlines what the fleet is capable of for minimums, maximums, and naming, in addition to attribute names and values.

    • roleArn

      public final String roleArn()

      The IAM role ARN.

      Returns:
      The IAM role ARN.

    • createdAt

      public final Instant createdAt()

      The date and time the resource was created.

      Returns:
      The date and time the resource was created.

    • createdBy

      public final String createdBy()

      The user or system that created this resource.

      Returns:
      The user or system that created this resource.

    • updatedAt

      public final Instant updatedAt()

      The date and time the resource was updated.

      Returns:
      The date and time the resource was updated.

    • updatedBy

      public final String updatedBy()

      The user or system that updated this resource.

      Returns:
      The user or system that updated this resource.

    • toBuilder

      public GetFleetResponse.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<GetFleetResponse.Builder,GetFleetResponse>
      Specified by:
      toBuilder in class AwsResponse
      Returns:
      a builder for type T

    • builder

      public static GetFleetResponse.Builder builder()

    • serializableBuilderClass

      public static Class<? extends GetFleetResponse.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)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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)
      Description copied from class: SdkResponse
      Used to retrieve the value of a field from any class that extends SdkResponse. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkResponse.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkResponse
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.