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 thatListServiceDeployments
returned in paginated output.ThenextToken
value returned from aListServiceDeployments
request 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
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
Methods inherited from interface software.amazon.awssdk.services.ecs.model.EcsRequest.Builder
build
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
Methods 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,
default
is 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,default
is 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.Builder
avoiding the need to create one manually viaCreatedAt.builder()
.When the
Consumer
completes,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
nextToken
value returned from aListServiceDeployments
request 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
- ThenextToken
value returned from aListServiceDeployments
request 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
ListServiceDeployments
returned in paginated output. When this parameter is used,ListServiceDeployments
only returnsmaxResults
results in a single page along with anextToken
response element. The remaining results of the initial request can be seen by sending anotherListServiceDeployments
request with the returnednextToken
value. This value can be between 1 and 100. If this parameter isn't used, thenListServiceDeployments
returns up to 20 results and anextToken
value if applicable.- Parameters:
maxResults
- The maximum number of service deployment results thatListServiceDeployments
returned in paginated output. When this parameter is used,ListServiceDeployments
only returnsmaxResults
results in a single page along with anextToken
response element. The remaining results of the initial request can be seen by sending anotherListServiceDeployments
request with the returnednextToken
value. This value can be between 1 and 100. If this parameter isn't used, thenListServiceDeployments
returns up to 20 results and anextToken
value 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.Builder
Add an optional request override configuration.- Specified by:
overrideConfiguration
in 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.Builder
Add an optional request override configuration.- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
- Parameters:
builderConsumer
- AConsumer
to which an emptyAwsRequestOverrideConfiguration.Builder
will be given.- Returns:
- This object for method chaining.
-