Package software.amazon.awssdk.services.ecs.model

Class ListServiceDeploymentsRequest

java.lang.Object
software.amazon.awssdk.core.SdkRequest
software.amazon.awssdk.awscore.AwsRequest
software.amazon.awssdk.services.ecs.model.EcsRequest
software.amazon.awssdk.services.ecs.model.ListServiceDeploymentsRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<ListServiceDeploymentsRequest.Builder,ListServiceDeploymentsRequest>
@Generated("software.amazon.awssdk:codegen") public final class ListServiceDeploymentsRequest extends EcsRequest implements ToCopyableBuilder<ListServiceDeploymentsRequest.Builder,ListServiceDeploymentsRequest>

  • Method Details

    • service

      public final String service()

      The ARN or name of the service

      Returns:
      The ARN or name of the service

    • cluster

      public final String cluster()

      The cluster that hosts the service. This can either be the cluster name or ARN. Starting April 15, 2023, Amazon Web Services will not onboard new customers to Amazon Elastic Inference (EI), and will help current customers migrate their workloads to options that offer better price and performance. If you don't specify a cluster, default is used.

      Returns:
      The cluster that hosts the service. This can either be the cluster name or ARN. Starting April 15, 2023, Amazon Web Services will not onboard new customers to Amazon Elastic Inference (EI), and will help current customers migrate their workloads to options that offer better price and performance. If you don't specify a cluster, default is used.

    • status

      public final List<ServiceDeploymentStatus> status()

      An optional filter you can use to narrow the results. If you do not specify a status, then all status values are included in the result.

      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 hasStatus() method.

      Returns:
      An optional filter you can use to narrow the results. If you do not specify a status, then all status values are included in the result.

    • hasStatus

      public final boolean hasStatus()
      For responses, this returns true if the service returned a value for the Status 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.

    • statusAsStrings

      public final List<String> statusAsStrings()

      An optional filter you can use to narrow the results. If you do not specify a status, then all status values are included in the result.

      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 hasStatus() method.

      Returns:
      An optional filter you can use to narrow the results. If you do not specify a status, then all status values are included in the result.

    • createdAt

      public final CreatedAt createdAt()

      An optional filter you can use to narrow the results by the service creation date. If you do not specify a value, the result includes all services created before the current time. The format is yyyy-MM-dd HH:mm:ss.SSSSSS.

      Returns:
      An optional filter you can use to narrow the results by the service creation date. If you do not specify a value, the result includes all services created before the current time. The format is yyyy-MM-dd HH:mm:ss.SSSSSS.

    • nextToken

      public final String nextToken()

      The nextToken value returned from a ListServiceDeployments request indicating that more results are available to fulfill the request and further calls are needed. If you provided maxResults, it's possible the number of results is fewer than maxResults.

      Returns:
      The nextToken value returned from a ListServiceDeployments request indicating that more results are available to fulfill the request and further calls are needed. If you provided maxResults, it's possible the number of results is fewer than maxResults.

    • maxResults

      public final Integer maxResults()

      The maximum number of service deployment results that ListServiceDeployments returned in paginated output. When this parameter is used, ListServiceDeployments only returns maxResults results in a single page along with a nextToken response element. The remaining results of the initial request can be seen by sending another ListServiceDeployments request with the returned nextToken value. This value can be between 1 and 100. If this parameter isn't used, then ListServiceDeployments returns up to 20 results and a nextToken value if applicable.

      Returns:
      The maximum number of service deployment results that ListServiceDeployments returned in paginated output. When this parameter is used, ListServiceDeployments only returns maxResults results in a single page along with a nextToken response element. The remaining results of the initial request can be seen by sending another ListServiceDeployments request with the returned nextToken value. This value can be between 1 and 100. If this parameter isn't used, then ListServiceDeployments returns up to 20 results and a nextToken value if applicable.

    • toBuilder

      public ListServiceDeploymentsRequest.Builder toBuilder()
      Specified by:
      toBuilder in interface ToCopyableBuilder<ListServiceDeploymentsRequest.Builder,ListServiceDeploymentsRequest>
      Specified by:
      toBuilder in class EcsRequest

    • builder

      public static ListServiceDeploymentsRequest.Builder builder()

    • serializableBuilderClass

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

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class AwsRequest

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class AwsRequest

    • 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 SdkRequest

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo