Interface ListDevicesForUserRequest.Builder
- All Superinterfaces:
AwsRequest.Builder,Buildable,CopyableBuilder<ListDevicesForUserRequest.Builder,,ListDevicesForUserRequest> SdkBuilder<ListDevicesForUserRequest.Builder,,ListDevicesForUserRequest> SdkPojo,SdkRequest.Builder,WickrRequest.Builder
- Enclosing class:
ListDevicesForUserRequest
@Mutable
@NotThreadSafe
public static interface ListDevicesForUserRequest.Builder
extends WickrRequest.Builder, SdkPojo, CopyableBuilder<ListDevicesForUserRequest.Builder,ListDevicesForUserRequest>
-
Method Summary
Modifier and TypeMethodDescriptionmaxResults(Integer maxResults) The maximum number of devices to return in a single page.The ID of the Wickr network containing the user.The token for retrieving the next page of results.overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.sortDirection(String sortDirection) The direction to sort results.sortDirection(SortDirection sortDirection) The direction to sort results.sortFields(String sortFields) The fields to sort devices by.The unique identifier of the user whose devices will be listed.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.utils.builder.SdkBuilder
applyMutation, buildMethods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFieldNameToField, sdkFieldsMethods inherited from interface software.amazon.awssdk.services.wickr.model.WickrRequest.Builder
build
-
Method Details
-
networkId
The ID of the Wickr network containing the user.
- Parameters:
networkId- The ID of the Wickr network containing the user.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
userId
The unique identifier of the user whose devices will be listed.
- Parameters:
userId- The unique identifier of the user whose devices will be listed.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
nextToken
The token for retrieving the next page of results. This is returned from a previous request when there are more results available.
- Parameters:
nextToken- The token for retrieving the next page of results. This is returned from a previous request when there are more results available.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
maxResults
The maximum number of devices to return in a single page. Valid range is 1-100. Default is 10.
- Parameters:
maxResults- The maximum number of devices to return in a single page. Valid range is 1-100. Default is 10.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
sortFields
The fields to sort devices by. Multiple fields can be specified by separating them with '+'. Accepted values include 'lastlogin', 'type', 'suspend', and 'created'.
- Parameters:
sortFields- The fields to sort devices by. Multiple fields can be specified by separating them with '+'. Accepted values include 'lastlogin', 'type', 'suspend', and 'created'.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
sortDirection
The direction to sort results. Valid values are 'ASC' (ascending) or 'DESC' (descending). Default is 'DESC'.
- Parameters:
sortDirection- The direction to sort results. Valid values are 'ASC' (ascending) or 'DESC' (descending). Default is 'DESC'.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
sortDirection
The direction to sort results. Valid values are 'ASC' (ascending) or 'DESC' (descending). Default is 'DESC'.
- Parameters:
sortDirection- The direction to sort results. Valid values are 'ASC' (ascending) or 'DESC' (descending). Default is 'DESC'.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
overrideConfiguration
ListDevicesForUserRequest.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
ListDevicesForUserRequest.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.
-