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>
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interfaceListServiceDeploymentsRequest.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static ListServiceDeploymentsRequest.Builderbuilder()Stringcluster()The cluster that hosts the service.CreatedAtcreatedAt()An optional filter you can use to narrow the results by the service creation date.booleanequals(Object obj)booleanequalsBySdkFields(Object obj)<T> Optional<T>getValueForField(String fieldName, Class<T> clazz)inthashCode()booleanhasStatus()For responses, this returns true if the service returned a value for the Status property.IntegermaxResults()The maximum number of service deployment results thatListServiceDeploymentsreturned in paginated output.StringnextToken()ThenextTokenvalue returned from aListServiceDeploymentsrequest indicating that more results are available to fulfill the request and further calls are needed.Map<String,SdkField<?>>sdkFieldNameToField()List<SdkField<?>>sdkFields()static Class<? extends ListServiceDeploymentsRequest.Builder>serializableBuilderClass()Stringservice()The ARN or name of the serviceList<ServiceDeploymentStatus>status()An optional filter you can use to narrow the results.List<String>statusAsStrings()An optional filter you can use to narrow the results.ListServiceDeploymentsRequest.BuildertoBuilder()StringtoString()Returns a string representation of this object.-
Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration
-
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
-
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,
defaultis 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,
defaultis 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 theisEmpty()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
nextTokenvalue returned from aListServiceDeploymentsrequest indicating that more results are available to fulfill the request and further calls are needed. If you providedmaxResults, it's possible the number of results is fewer thanmaxResults.- Returns:
- The
nextTokenvalue returned from aListServiceDeploymentsrequest indicating that more results are available to fulfill the request and further calls are needed. If you providedmaxResults, it's possible the number of results is fewer thanmaxResults.
-
maxResults
public final Integer maxResults()
The maximum number of service deployment results that
ListServiceDeploymentsreturned in paginated output. When this parameter is used,ListServiceDeploymentsonly returnsmaxResultsresults in a single page along with anextTokenresponse element. The remaining results of the initial request can be seen by sending anotherListServiceDeploymentsrequest with the returnednextTokenvalue. This value can be between 1 and 100. If this parameter isn't used, thenListServiceDeploymentsreturns up to 20 results and anextTokenvalue if applicable.- Returns:
- The maximum number of service deployment results that
ListServiceDeploymentsreturned in paginated output. When this parameter is used,ListServiceDeploymentsonly returnsmaxResultsresults in a single page along with anextTokenresponse element. The remaining results of the initial request can be seen by sending anotherListServiceDeploymentsrequest with the returnednextTokenvalue. This value can be between 1 and 100. If this parameter isn't used, thenListServiceDeploymentsreturns up to 20 results and anextTokenvalue if applicable.
-
toBuilder
public ListServiceDeploymentsRequest.Builder toBuilder()
- Specified by:
toBuilderin interfaceToCopyableBuilder<ListServiceDeploymentsRequest.Builder,ListServiceDeploymentsRequest>- Specified by:
toBuilderin classEcsRequest
-
builder
public static ListServiceDeploymentsRequest.Builder builder()
-
serializableBuilderClass
public static Class<? extends ListServiceDeploymentsRequest.Builder> serializableBuilderClass()
-
hashCode
public final int hashCode()
- Overrides:
hashCodein classAwsRequest
-
equals
public final boolean equals(Object obj)
- Overrides:
equalsin classAwsRequest
-
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.
-
getValueForField
public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
- Overrides:
getValueForFieldin classSdkRequest
-
sdkFieldNameToField
public final Map<String,SdkField<?>> sdkFieldNameToField()
- Specified by:
sdkFieldNameToFieldin interfaceSdkPojo
-
-