Interface ListServiceDeploymentsRequest.Builder
- All Superinterfaces:
AwsRequest.Builder,Buildable,CopyableBuilder<ListServiceDeploymentsRequest.Builder,,ListServiceDeploymentsRequest> EcsRequest.Builder,SdkBuilder<ListServiceDeploymentsRequest.Builder,,ListServiceDeploymentsRequest> SdkPojo,SdkRequest.Builder
- Enclosing class:
ListServiceDeploymentsRequest
-
Method Summary
Modifier and TypeMethodDescriptionThe cluster that hosts the service.createdAt(Consumer<CreatedAt.Builder> createdAt) An optional filter you can use to narrow the results by the service creation date.An optional filter you can use to narrow the results by the service creation date.maxResults(Integer maxResults) The maximum number of service deployment results thatListServiceDeploymentsreturned in paginated output.ThenextTokenvalue returned from aListServiceDeploymentsrequest indicating that more results are available to fulfill the request and further calls are needed.overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.The ARN or name of the servicestatus(Collection<ServiceDeploymentStatus> status) An optional filter you can use to narrow the results.status(ServiceDeploymentStatus... status) An optional filter you can use to narrow the results.statusWithStrings(String... status) An optional filter you can use to narrow the results.statusWithStrings(Collection<String> status) An optional filter you can use to narrow the results.Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder
overrideConfigurationMethods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copyMethods inherited from interface software.amazon.awssdk.services.ecs.model.EcsRequest.Builder
buildMethods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, buildMethods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFieldNameToField, sdkFields
-
Method Details
-
service
The ARN or name of the service
- Parameters:
service- The ARN or name of the service- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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.- Parameters:
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:
- Returns a reference to this object so that method calls can be chained together.
-
statusWithStrings
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.
- Parameters:
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.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
statusWithStrings
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.
- Parameters:
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.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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.
- Parameters:
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.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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.
- Parameters:
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.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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.
- Parameters:
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:
- Returns a reference to this object so that method calls can be chained together.
-
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.
This is a convenience method that creates an instance of theCreatedAt.Builderavoiding the need to create one manually viaCreatedAt.builder().When the
Consumercompletes,SdkBuilder.build()is called immediately and its result is passed tocreatedAt(CreatedAt).- Parameters:
createdAt- a consumer that will call methods onCreatedAt.Builder- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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.- Parameters:
nextToken- ThenextTokenvalue 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:
- Returns a reference to this object so that method calls can be chained together.
-
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.- Parameters:
maxResults- The maximum number of service deployment results thatListServiceDeploymentsreturned 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:
- Returns a reference to this object so that method calls can be chained together.
-
overrideConfiguration
ListServiceDeploymentsRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) Description copied from interface:AwsRequest.BuilderAdd an optional request override configuration.- Specified by:
overrideConfigurationin interfaceAwsRequest.Builder- Parameters:
overrideConfiguration- The override configuration.- Returns:
- This object for method chaining.
-
overrideConfiguration
ListServiceDeploymentsRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Description copied from interface:AwsRequest.BuilderAdd an optional request override configuration.- Specified by:
overrideConfigurationin interfaceAwsRequest.Builder- Parameters:
builderConsumer- AConsumerto which an emptyAwsRequestOverrideConfiguration.Builderwill be given.- Returns:
- This object for method chaining.
-