Interface IotRoboRunnerClient
- All Superinterfaces:
AutoCloseable
,AwsClient
,SdkAutoCloseable
,SdkClient
builder()
method.
An example service, deployed with the Octane Service creator, which will echo the string
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final String
Value for looking up the service's metadata from theServiceMetadataProvider
.static final String
-
Method Summary
Modifier and TypeMethodDescriptionstatic IotRoboRunnerClientBuilder
builder()
Create a builder that can be used to configure and create aIotRoboRunnerClient
.static IotRoboRunnerClient
create()
Create aIotRoboRunnerClient
with the region loaded from theDefaultAwsRegionProviderChain
and credentials loaded from theDefaultCredentialsProvider
.default CreateDestinationResponse
createDestination
(Consumer<CreateDestinationRequest.Builder> createDestinationRequest) Grants permission to create a destinationdefault CreateDestinationResponse
createDestination
(CreateDestinationRequest createDestinationRequest) Grants permission to create a destinationdefault CreateSiteResponse
createSite
(Consumer<CreateSiteRequest.Builder> createSiteRequest) Grants permission to create a sitedefault CreateSiteResponse
createSite
(CreateSiteRequest createSiteRequest) Grants permission to create a sitedefault CreateWorkerResponse
createWorker
(Consumer<CreateWorkerRequest.Builder> createWorkerRequest) Grants permission to create a workerdefault CreateWorkerResponse
createWorker
(CreateWorkerRequest createWorkerRequest) Grants permission to create a workerdefault CreateWorkerFleetResponse
createWorkerFleet
(Consumer<CreateWorkerFleetRequest.Builder> createWorkerFleetRequest) Grants permission to create a worker fleetdefault CreateWorkerFleetResponse
createWorkerFleet
(CreateWorkerFleetRequest createWorkerFleetRequest) Grants permission to create a worker fleetdefault DeleteDestinationResponse
deleteDestination
(Consumer<DeleteDestinationRequest.Builder> deleteDestinationRequest) Grants permission to delete a destinationdefault DeleteDestinationResponse
deleteDestination
(DeleteDestinationRequest deleteDestinationRequest) Grants permission to delete a destinationdefault DeleteSiteResponse
deleteSite
(Consumer<DeleteSiteRequest.Builder> deleteSiteRequest) Grants permission to delete a sitedefault DeleteSiteResponse
deleteSite
(DeleteSiteRequest deleteSiteRequest) Grants permission to delete a sitedefault DeleteWorkerResponse
deleteWorker
(Consumer<DeleteWorkerRequest.Builder> deleteWorkerRequest) Grants permission to delete a workerdefault DeleteWorkerResponse
deleteWorker
(DeleteWorkerRequest deleteWorkerRequest) Grants permission to delete a workerdefault DeleteWorkerFleetResponse
deleteWorkerFleet
(Consumer<DeleteWorkerFleetRequest.Builder> deleteWorkerFleetRequest) Grants permission to delete a worker fleetdefault DeleteWorkerFleetResponse
deleteWorkerFleet
(DeleteWorkerFleetRequest deleteWorkerFleetRequest) Grants permission to delete a worker fleetdefault GetDestinationResponse
getDestination
(Consumer<GetDestinationRequest.Builder> getDestinationRequest) Grants permission to get a destinationdefault GetDestinationResponse
getDestination
(GetDestinationRequest getDestinationRequest) Grants permission to get a destinationdefault GetSiteResponse
getSite
(Consumer<GetSiteRequest.Builder> getSiteRequest) Grants permission to get a sitedefault GetSiteResponse
getSite
(GetSiteRequest getSiteRequest) Grants permission to get a sitedefault GetWorkerResponse
getWorker
(Consumer<GetWorkerRequest.Builder> getWorkerRequest) Grants permission to get a workerdefault GetWorkerResponse
getWorker
(GetWorkerRequest getWorkerRequest) Grants permission to get a workerdefault GetWorkerFleetResponse
getWorkerFleet
(Consumer<GetWorkerFleetRequest.Builder> getWorkerFleetRequest) Grants permission to get a worker fleetdefault GetWorkerFleetResponse
getWorkerFleet
(GetWorkerFleetRequest getWorkerFleetRequest) Grants permission to get a worker fleetdefault ListDestinationsResponse
listDestinations
(Consumer<ListDestinationsRequest.Builder> listDestinationsRequest) Grants permission to list destinationsdefault ListDestinationsResponse
listDestinations
(ListDestinationsRequest listDestinationsRequest) Grants permission to list destinationsdefault ListDestinationsIterable
listDestinationsPaginator
(Consumer<ListDestinationsRequest.Builder> listDestinationsRequest) Grants permission to list destinationsdefault ListDestinationsIterable
listDestinationsPaginator
(ListDestinationsRequest listDestinationsRequest) Grants permission to list destinationsdefault ListSitesResponse
listSites
(Consumer<ListSitesRequest.Builder> listSitesRequest) Grants permission to list sitesdefault ListSitesResponse
listSites
(ListSitesRequest listSitesRequest) Grants permission to list sitesdefault ListSitesIterable
listSitesPaginator
(Consumer<ListSitesRequest.Builder> listSitesRequest) Grants permission to list sitesdefault ListSitesIterable
listSitesPaginator
(ListSitesRequest listSitesRequest) Grants permission to list sitesdefault ListWorkerFleetsResponse
listWorkerFleets
(Consumer<ListWorkerFleetsRequest.Builder> listWorkerFleetsRequest) Grants permission to list worker fleetsdefault ListWorkerFleetsResponse
listWorkerFleets
(ListWorkerFleetsRequest listWorkerFleetsRequest) Grants permission to list worker fleetsdefault ListWorkerFleetsIterable
listWorkerFleetsPaginator
(Consumer<ListWorkerFleetsRequest.Builder> listWorkerFleetsRequest) Grants permission to list worker fleetsdefault ListWorkerFleetsIterable
listWorkerFleetsPaginator
(ListWorkerFleetsRequest listWorkerFleetsRequest) Grants permission to list worker fleetsdefault ListWorkersResponse
listWorkers
(Consumer<ListWorkersRequest.Builder> listWorkersRequest) Grants permission to list workersdefault ListWorkersResponse
listWorkers
(ListWorkersRequest listWorkersRequest) Grants permission to list workersdefault ListWorkersIterable
listWorkersPaginator
(Consumer<ListWorkersRequest.Builder> listWorkersRequest) Grants permission to list workersdefault ListWorkersIterable
listWorkersPaginator
(ListWorkersRequest listWorkersRequest) Grants permission to list workersThe SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfigurationstatic ServiceMetadata
default UpdateDestinationResponse
updateDestination
(Consumer<UpdateDestinationRequest.Builder> updateDestinationRequest) Grants permission to update a destinationdefault UpdateDestinationResponse
updateDestination
(UpdateDestinationRequest updateDestinationRequest) Grants permission to update a destinationdefault UpdateSiteResponse
updateSite
(Consumer<UpdateSiteRequest.Builder> updateSiteRequest) Grants permission to update a sitedefault UpdateSiteResponse
updateSite
(UpdateSiteRequest updateSiteRequest) Grants permission to update a sitedefault UpdateWorkerResponse
updateWorker
(Consumer<UpdateWorkerRequest.Builder> updateWorkerRequest) Grants permission to update a workerdefault UpdateWorkerResponse
updateWorker
(UpdateWorkerRequest updateWorkerRequest) Grants permission to update a workerdefault UpdateWorkerFleetResponse
updateWorkerFleet
(Consumer<UpdateWorkerFleetRequest.Builder> updateWorkerFleetRequest) Grants permission to update a worker fleetdefault UpdateWorkerFleetResponse
updateWorkerFleet
(UpdateWorkerFleetRequest updateWorkerFleetRequest) Grants permission to update a worker fleetMethods inherited from interface software.amazon.awssdk.utils.SdkAutoCloseable
close
Methods inherited from interface software.amazon.awssdk.core.SdkClient
serviceName
-
Field Details
-
SERVICE_NAME
- See Also:
-
SERVICE_METADATA_ID
Value for looking up the service's metadata from theServiceMetadataProvider
.- See Also:
-
-
Method Details
-
createDestination
default CreateDestinationResponse createDestination(CreateDestinationRequest createDestinationRequest) throws ConflictException, AccessDeniedException, ValidationException, ResourceNotFoundException, ThrottlingException, InternalServerException, ServiceQuotaExceededException, AwsServiceException, SdkClientException, IotRoboRunnerException Grants permission to create a destination
- Parameters:
createDestinationRequest
-- Returns:
- Result of the CreateDestination operation returned by the service.
- See Also:
-
createDestination
default CreateDestinationResponse createDestination(Consumer<CreateDestinationRequest.Builder> createDestinationRequest) throws ConflictException, AccessDeniedException, ValidationException, ResourceNotFoundException, ThrottlingException, InternalServerException, ServiceQuotaExceededException, AwsServiceException, SdkClientException, IotRoboRunnerException Grants permission to create a destination
This is a convenience which creates an instance of the
CreateDestinationRequest.Builder
avoiding the need to create one manually viaCreateDestinationRequest.builder()
- Parameters:
createDestinationRequest
- AConsumer
that will call methods onCreateDestinationRequest.Builder
to create a request.- Returns:
- Result of the CreateDestination operation returned by the service.
- See Also:
-
createSite
default CreateSiteResponse createSite(CreateSiteRequest createSiteRequest) throws ConflictException, AccessDeniedException, ValidationException, ThrottlingException, InternalServerException, ServiceQuotaExceededException, AwsServiceException, SdkClientException, IotRoboRunnerException Grants permission to create a site
- Parameters:
createSiteRequest
-- Returns:
- Result of the CreateSite operation returned by the service.
- See Also:
-
createSite
default CreateSiteResponse createSite(Consumer<CreateSiteRequest.Builder> createSiteRequest) throws ConflictException, AccessDeniedException, ValidationException, ThrottlingException, InternalServerException, ServiceQuotaExceededException, AwsServiceException, SdkClientException, IotRoboRunnerException Grants permission to create a site
This is a convenience which creates an instance of the
CreateSiteRequest.Builder
avoiding the need to create one manually viaCreateSiteRequest.builder()
- Parameters:
createSiteRequest
- AConsumer
that will call methods onCreateSiteRequest.Builder
to create a request.- Returns:
- Result of the CreateSite operation returned by the service.
- See Also:
-
createWorker
default CreateWorkerResponse createWorker(CreateWorkerRequest createWorkerRequest) throws ConflictException, AccessDeniedException, ValidationException, ResourceNotFoundException, ThrottlingException, InternalServerException, ServiceQuotaExceededException, AwsServiceException, SdkClientException, IotRoboRunnerException Grants permission to create a worker
- Parameters:
createWorkerRequest
-- Returns:
- Result of the CreateWorker operation returned by the service.
- See Also:
-
createWorker
default CreateWorkerResponse createWorker(Consumer<CreateWorkerRequest.Builder> createWorkerRequest) throws ConflictException, AccessDeniedException, ValidationException, ResourceNotFoundException, ThrottlingException, InternalServerException, ServiceQuotaExceededException, AwsServiceException, SdkClientException, IotRoboRunnerException Grants permission to create a worker
This is a convenience which creates an instance of the
CreateWorkerRequest.Builder
avoiding the need to create one manually viaCreateWorkerRequest.builder()
- Parameters:
createWorkerRequest
- AConsumer
that will call methods onCreateWorkerRequest.Builder
to create a request.- Returns:
- Result of the CreateWorker operation returned by the service.
- See Also:
-
createWorkerFleet
default CreateWorkerFleetResponse createWorkerFleet(CreateWorkerFleetRequest createWorkerFleetRequest) throws ConflictException, AccessDeniedException, ValidationException, ResourceNotFoundException, ThrottlingException, InternalServerException, ServiceQuotaExceededException, AwsServiceException, SdkClientException, IotRoboRunnerException Grants permission to create a worker fleet
- Parameters:
createWorkerFleetRequest
-- Returns:
- Result of the CreateWorkerFleet operation returned by the service.
- See Also:
-
createWorkerFleet
default CreateWorkerFleetResponse createWorkerFleet(Consumer<CreateWorkerFleetRequest.Builder> createWorkerFleetRequest) throws ConflictException, AccessDeniedException, ValidationException, ResourceNotFoundException, ThrottlingException, InternalServerException, ServiceQuotaExceededException, AwsServiceException, SdkClientException, IotRoboRunnerException Grants permission to create a worker fleet
This is a convenience which creates an instance of the
CreateWorkerFleetRequest.Builder
avoiding the need to create one manually viaCreateWorkerFleetRequest.builder()
- Parameters:
createWorkerFleetRequest
- AConsumer
that will call methods onCreateWorkerFleetRequest.Builder
to create a request.- Returns:
- Result of the CreateWorkerFleet operation returned by the service.
- See Also:
-
deleteDestination
default DeleteDestinationResponse deleteDestination(DeleteDestinationRequest deleteDestinationRequest) throws ConflictException, AccessDeniedException, ValidationException, ResourceNotFoundException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, IotRoboRunnerException Grants permission to delete a destination
- Parameters:
deleteDestinationRequest
-- Returns:
- Result of the DeleteDestination operation returned by the service.
- See Also:
-
deleteDestination
default DeleteDestinationResponse deleteDestination(Consumer<DeleteDestinationRequest.Builder> deleteDestinationRequest) throws ConflictException, AccessDeniedException, ValidationException, ResourceNotFoundException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, IotRoboRunnerException Grants permission to delete a destination
This is a convenience which creates an instance of the
DeleteDestinationRequest.Builder
avoiding the need to create one manually viaDeleteDestinationRequest.builder()
- Parameters:
deleteDestinationRequest
- AConsumer
that will call methods onDeleteDestinationRequest.Builder
to create a request.- Returns:
- Result of the DeleteDestination operation returned by the service.
- See Also:
-
deleteSite
default DeleteSiteResponse deleteSite(DeleteSiteRequest deleteSiteRequest) throws ConflictException, AccessDeniedException, ValidationException, ResourceNotFoundException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, IotRoboRunnerException Grants permission to delete a site
- Parameters:
deleteSiteRequest
-- Returns:
- Result of the DeleteSite operation returned by the service.
- See Also:
-
deleteSite
default DeleteSiteResponse deleteSite(Consumer<DeleteSiteRequest.Builder> deleteSiteRequest) throws ConflictException, AccessDeniedException, ValidationException, ResourceNotFoundException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, IotRoboRunnerException Grants permission to delete a site
This is a convenience which creates an instance of the
DeleteSiteRequest.Builder
avoiding the need to create one manually viaDeleteSiteRequest.builder()
- Parameters:
deleteSiteRequest
- AConsumer
that will call methods onDeleteSiteRequest.Builder
to create a request.- Returns:
- Result of the DeleteSite operation returned by the service.
- See Also:
-
deleteWorker
default DeleteWorkerResponse deleteWorker(DeleteWorkerRequest deleteWorkerRequest) throws ConflictException, AccessDeniedException, ValidationException, ResourceNotFoundException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, IotRoboRunnerException Grants permission to delete a worker
- Parameters:
deleteWorkerRequest
-- Returns:
- Result of the DeleteWorker operation returned by the service.
- See Also:
-
deleteWorker
default DeleteWorkerResponse deleteWorker(Consumer<DeleteWorkerRequest.Builder> deleteWorkerRequest) throws ConflictException, AccessDeniedException, ValidationException, ResourceNotFoundException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, IotRoboRunnerException Grants permission to delete a worker
This is a convenience which creates an instance of the
DeleteWorkerRequest.Builder
avoiding the need to create one manually viaDeleteWorkerRequest.builder()
- Parameters:
deleteWorkerRequest
- AConsumer
that will call methods onDeleteWorkerRequest.Builder
to create a request.- Returns:
- Result of the DeleteWorker operation returned by the service.
- See Also:
-
deleteWorkerFleet
default DeleteWorkerFleetResponse deleteWorkerFleet(DeleteWorkerFleetRequest deleteWorkerFleetRequest) throws ConflictException, AccessDeniedException, ValidationException, ResourceNotFoundException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, IotRoboRunnerException Grants permission to delete a worker fleet
- Parameters:
deleteWorkerFleetRequest
-- Returns:
- Result of the DeleteWorkerFleet operation returned by the service.
- See Also:
-
deleteWorkerFleet
default DeleteWorkerFleetResponse deleteWorkerFleet(Consumer<DeleteWorkerFleetRequest.Builder> deleteWorkerFleetRequest) throws ConflictException, AccessDeniedException, ValidationException, ResourceNotFoundException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, IotRoboRunnerException Grants permission to delete a worker fleet
This is a convenience which creates an instance of the
DeleteWorkerFleetRequest.Builder
avoiding the need to create one manually viaDeleteWorkerFleetRequest.builder()
- Parameters:
deleteWorkerFleetRequest
- AConsumer
that will call methods onDeleteWorkerFleetRequest.Builder
to create a request.- Returns:
- Result of the DeleteWorkerFleet operation returned by the service.
- See Also:
-
getDestination
default GetDestinationResponse getDestination(GetDestinationRequest getDestinationRequest) throws AccessDeniedException, ValidationException, ResourceNotFoundException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, IotRoboRunnerException Grants permission to get a destination
- Parameters:
getDestinationRequest
-- Returns:
- Result of the GetDestination operation returned by the service.
- See Also:
-
getDestination
default GetDestinationResponse getDestination(Consumer<GetDestinationRequest.Builder> getDestinationRequest) throws AccessDeniedException, ValidationException, ResourceNotFoundException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, IotRoboRunnerException Grants permission to get a destination
This is a convenience which creates an instance of the
GetDestinationRequest.Builder
avoiding the need to create one manually viaGetDestinationRequest.builder()
- Parameters:
getDestinationRequest
- AConsumer
that will call methods onGetDestinationRequest.Builder
to create a request.- Returns:
- Result of the GetDestination operation returned by the service.
- See Also:
-
getSite
default GetSiteResponse getSite(GetSiteRequest getSiteRequest) throws AccessDeniedException, ValidationException, ResourceNotFoundException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, IotRoboRunnerException Grants permission to get a site
- Parameters:
getSiteRequest
-- Returns:
- Result of the GetSite operation returned by the service.
- See Also:
-
getSite
default GetSiteResponse getSite(Consumer<GetSiteRequest.Builder> getSiteRequest) throws AccessDeniedException, ValidationException, ResourceNotFoundException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, IotRoboRunnerException Grants permission to get a site
This is a convenience which creates an instance of the
GetSiteRequest.Builder
avoiding the need to create one manually viaGetSiteRequest.builder()
- Parameters:
getSiteRequest
- AConsumer
that will call methods onGetSiteRequest.Builder
to create a request.- Returns:
- Result of the GetSite operation returned by the service.
- See Also:
-
getWorker
default GetWorkerResponse getWorker(GetWorkerRequest getWorkerRequest) throws AccessDeniedException, ValidationException, ResourceNotFoundException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, IotRoboRunnerException Grants permission to get a worker
- Parameters:
getWorkerRequest
-- Returns:
- Result of the GetWorker operation returned by the service.
- See Also:
-
getWorker
default GetWorkerResponse getWorker(Consumer<GetWorkerRequest.Builder> getWorkerRequest) throws AccessDeniedException, ValidationException, ResourceNotFoundException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, IotRoboRunnerException Grants permission to get a worker
This is a convenience which creates an instance of the
GetWorkerRequest.Builder
avoiding the need to create one manually viaGetWorkerRequest.builder()
- Parameters:
getWorkerRequest
- AConsumer
that will call methods onGetWorkerRequest.Builder
to create a request.- Returns:
- Result of the GetWorker operation returned by the service.
- See Also:
-
getWorkerFleet
default GetWorkerFleetResponse getWorkerFleet(GetWorkerFleetRequest getWorkerFleetRequest) throws AccessDeniedException, ValidationException, ResourceNotFoundException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, IotRoboRunnerException Grants permission to get a worker fleet
- Parameters:
getWorkerFleetRequest
-- Returns:
- Result of the GetWorkerFleet operation returned by the service.
- See Also:
-
getWorkerFleet
default GetWorkerFleetResponse getWorkerFleet(Consumer<GetWorkerFleetRequest.Builder> getWorkerFleetRequest) throws AccessDeniedException, ValidationException, ResourceNotFoundException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, IotRoboRunnerException Grants permission to get a worker fleet
This is a convenience which creates an instance of the
GetWorkerFleetRequest.Builder
avoiding the need to create one manually viaGetWorkerFleetRequest.builder()
- Parameters:
getWorkerFleetRequest
- AConsumer
that will call methods onGetWorkerFleetRequest.Builder
to create a request.- Returns:
- Result of the GetWorkerFleet operation returned by the service.
- See Also:
-
listDestinations
default ListDestinationsResponse listDestinations(ListDestinationsRequest listDestinationsRequest) throws AccessDeniedException, ValidationException, ResourceNotFoundException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, IotRoboRunnerException Grants permission to list destinations
- Parameters:
listDestinationsRequest
-- Returns:
- Result of the ListDestinations operation returned by the service.
- See Also:
-
listDestinations
default ListDestinationsResponse listDestinations(Consumer<ListDestinationsRequest.Builder> listDestinationsRequest) throws AccessDeniedException, ValidationException, ResourceNotFoundException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, IotRoboRunnerException Grants permission to list destinations
This is a convenience which creates an instance of the
ListDestinationsRequest.Builder
avoiding the need to create one manually viaListDestinationsRequest.builder()
- Parameters:
listDestinationsRequest
- AConsumer
that will call methods onListDestinationsRequest.Builder
to create a request.- Returns:
- Result of the ListDestinations operation returned by the service.
- See Also:
-
listDestinationsPaginator
default ListDestinationsIterable listDestinationsPaginator(ListDestinationsRequest listDestinationsRequest) throws AccessDeniedException, ValidationException, ResourceNotFoundException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, IotRoboRunnerException Grants permission to list destinations
This is a variant of
listDestinations(software.amazon.awssdk.services.iotroborunner.model.ListDestinationsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.iotroborunner.paginators.ListDestinationsIterable responses = client.listDestinationsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.iotroborunner.paginators.ListDestinationsIterable responses = client .listDestinationsPaginator(request); for (software.amazon.awssdk.services.iotroborunner.model.ListDestinationsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.iotroborunner.paginators.ListDestinationsIterable responses = client.listDestinationsPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listDestinations(software.amazon.awssdk.services.iotroborunner.model.ListDestinationsRequest)
operation.- Parameters:
listDestinationsRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listDestinationsPaginator
default ListDestinationsIterable listDestinationsPaginator(Consumer<ListDestinationsRequest.Builder> listDestinationsRequest) throws AccessDeniedException, ValidationException, ResourceNotFoundException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, IotRoboRunnerException Grants permission to list destinations
This is a variant of
listDestinations(software.amazon.awssdk.services.iotroborunner.model.ListDestinationsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.iotroborunner.paginators.ListDestinationsIterable responses = client.listDestinationsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.iotroborunner.paginators.ListDestinationsIterable responses = client .listDestinationsPaginator(request); for (software.amazon.awssdk.services.iotroborunner.model.ListDestinationsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.iotroborunner.paginators.ListDestinationsIterable responses = client.listDestinationsPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listDestinations(software.amazon.awssdk.services.iotroborunner.model.ListDestinationsRequest)
operation.This is a convenience which creates an instance of the
ListDestinationsRequest.Builder
avoiding the need to create one manually viaListDestinationsRequest.builder()
- Parameters:
listDestinationsRequest
- AConsumer
that will call methods onListDestinationsRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listSites
default ListSitesResponse listSites(ListSitesRequest listSitesRequest) throws AccessDeniedException, ValidationException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, IotRoboRunnerException Grants permission to list sites
- Parameters:
listSitesRequest
-- Returns:
- Result of the ListSites operation returned by the service.
- See Also:
-
listSites
default ListSitesResponse listSites(Consumer<ListSitesRequest.Builder> listSitesRequest) throws AccessDeniedException, ValidationException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, IotRoboRunnerException Grants permission to list sites
This is a convenience which creates an instance of the
ListSitesRequest.Builder
avoiding the need to create one manually viaListSitesRequest.builder()
- Parameters:
listSitesRequest
- AConsumer
that will call methods onListSitesRequest.Builder
to create a request.- Returns:
- Result of the ListSites operation returned by the service.
- See Also:
-
listSitesPaginator
default ListSitesIterable listSitesPaginator(ListSitesRequest listSitesRequest) throws AccessDeniedException, ValidationException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, IotRoboRunnerException Grants permission to list sites
This is a variant of
listSites(software.amazon.awssdk.services.iotroborunner.model.ListSitesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.iotroborunner.paginators.ListSitesIterable responses = client.listSitesPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.iotroborunner.paginators.ListSitesIterable responses = client.listSitesPaginator(request); for (software.amazon.awssdk.services.iotroborunner.model.ListSitesResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.iotroborunner.paginators.ListSitesIterable responses = client.listSitesPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listSites(software.amazon.awssdk.services.iotroborunner.model.ListSitesRequest)
operation.- Parameters:
listSitesRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listSitesPaginator
default ListSitesIterable listSitesPaginator(Consumer<ListSitesRequest.Builder> listSitesRequest) throws AccessDeniedException, ValidationException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, IotRoboRunnerException Grants permission to list sites
This is a variant of
listSites(software.amazon.awssdk.services.iotroborunner.model.ListSitesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.iotroborunner.paginators.ListSitesIterable responses = client.listSitesPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.iotroborunner.paginators.ListSitesIterable responses = client.listSitesPaginator(request); for (software.amazon.awssdk.services.iotroborunner.model.ListSitesResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.iotroborunner.paginators.ListSitesIterable responses = client.listSitesPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listSites(software.amazon.awssdk.services.iotroborunner.model.ListSitesRequest)
operation.This is a convenience which creates an instance of the
ListSitesRequest.Builder
avoiding the need to create one manually viaListSitesRequest.builder()
- Parameters:
listSitesRequest
- AConsumer
that will call methods onListSitesRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listWorkerFleets
default ListWorkerFleetsResponse listWorkerFleets(ListWorkerFleetsRequest listWorkerFleetsRequest) throws AccessDeniedException, ValidationException, ResourceNotFoundException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, IotRoboRunnerException Grants permission to list worker fleets
- Parameters:
listWorkerFleetsRequest
-- Returns:
- Result of the ListWorkerFleets operation returned by the service.
- See Also:
-
listWorkerFleets
default ListWorkerFleetsResponse listWorkerFleets(Consumer<ListWorkerFleetsRequest.Builder> listWorkerFleetsRequest) throws AccessDeniedException, ValidationException, ResourceNotFoundException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, IotRoboRunnerException Grants permission to list worker fleets
This is a convenience which creates an instance of the
ListWorkerFleetsRequest.Builder
avoiding the need to create one manually viaListWorkerFleetsRequest.builder()
- Parameters:
listWorkerFleetsRequest
- AConsumer
that will call methods onListWorkerFleetsRequest.Builder
to create a request.- Returns:
- Result of the ListWorkerFleets operation returned by the service.
- See Also:
-
listWorkerFleetsPaginator
default ListWorkerFleetsIterable listWorkerFleetsPaginator(ListWorkerFleetsRequest listWorkerFleetsRequest) throws AccessDeniedException, ValidationException, ResourceNotFoundException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, IotRoboRunnerException Grants permission to list worker fleets
This is a variant of
listWorkerFleets(software.amazon.awssdk.services.iotroborunner.model.ListWorkerFleetsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.iotroborunner.paginators.ListWorkerFleetsIterable responses = client.listWorkerFleetsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.iotroborunner.paginators.ListWorkerFleetsIterable responses = client .listWorkerFleetsPaginator(request); for (software.amazon.awssdk.services.iotroborunner.model.ListWorkerFleetsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.iotroborunner.paginators.ListWorkerFleetsIterable responses = client.listWorkerFleetsPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listWorkerFleets(software.amazon.awssdk.services.iotroborunner.model.ListWorkerFleetsRequest)
operation.- Parameters:
listWorkerFleetsRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listWorkerFleetsPaginator
default ListWorkerFleetsIterable listWorkerFleetsPaginator(Consumer<ListWorkerFleetsRequest.Builder> listWorkerFleetsRequest) throws AccessDeniedException, ValidationException, ResourceNotFoundException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, IotRoboRunnerException Grants permission to list worker fleets
This is a variant of
listWorkerFleets(software.amazon.awssdk.services.iotroborunner.model.ListWorkerFleetsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.iotroborunner.paginators.ListWorkerFleetsIterable responses = client.listWorkerFleetsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.iotroborunner.paginators.ListWorkerFleetsIterable responses = client .listWorkerFleetsPaginator(request); for (software.amazon.awssdk.services.iotroborunner.model.ListWorkerFleetsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.iotroborunner.paginators.ListWorkerFleetsIterable responses = client.listWorkerFleetsPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listWorkerFleets(software.amazon.awssdk.services.iotroborunner.model.ListWorkerFleetsRequest)
operation.This is a convenience which creates an instance of the
ListWorkerFleetsRequest.Builder
avoiding the need to create one manually viaListWorkerFleetsRequest.builder()
- Parameters:
listWorkerFleetsRequest
- AConsumer
that will call methods onListWorkerFleetsRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listWorkers
default ListWorkersResponse listWorkers(ListWorkersRequest listWorkersRequest) throws AccessDeniedException, ValidationException, ResourceNotFoundException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, IotRoboRunnerException Grants permission to list workers
- Parameters:
listWorkersRequest
-- Returns:
- Result of the ListWorkers operation returned by the service.
- See Also:
-
listWorkers
default ListWorkersResponse listWorkers(Consumer<ListWorkersRequest.Builder> listWorkersRequest) throws AccessDeniedException, ValidationException, ResourceNotFoundException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, IotRoboRunnerException Grants permission to list workers
This is a convenience which creates an instance of the
ListWorkersRequest.Builder
avoiding the need to create one manually viaListWorkersRequest.builder()
- Parameters:
listWorkersRequest
- AConsumer
that will call methods onListWorkersRequest.Builder
to create a request.- Returns:
- Result of the ListWorkers operation returned by the service.
- See Also:
-
listWorkersPaginator
default ListWorkersIterable listWorkersPaginator(ListWorkersRequest listWorkersRequest) throws AccessDeniedException, ValidationException, ResourceNotFoundException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, IotRoboRunnerException Grants permission to list workers
This is a variant of
listWorkers(software.amazon.awssdk.services.iotroborunner.model.ListWorkersRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.iotroborunner.paginators.ListWorkersIterable responses = client.listWorkersPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.iotroborunner.paginators.ListWorkersIterable responses = client.listWorkersPaginator(request); for (software.amazon.awssdk.services.iotroborunner.model.ListWorkersResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.iotroborunner.paginators.ListWorkersIterable responses = client.listWorkersPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listWorkers(software.amazon.awssdk.services.iotroborunner.model.ListWorkersRequest)
operation.- Parameters:
listWorkersRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listWorkersPaginator
default ListWorkersIterable listWorkersPaginator(Consumer<ListWorkersRequest.Builder> listWorkersRequest) throws AccessDeniedException, ValidationException, ResourceNotFoundException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, IotRoboRunnerException Grants permission to list workers
This is a variant of
listWorkers(software.amazon.awssdk.services.iotroborunner.model.ListWorkersRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.iotroborunner.paginators.ListWorkersIterable responses = client.listWorkersPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.iotroborunner.paginators.ListWorkersIterable responses = client.listWorkersPaginator(request); for (software.amazon.awssdk.services.iotroborunner.model.ListWorkersResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.iotroborunner.paginators.ListWorkersIterable responses = client.listWorkersPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listWorkers(software.amazon.awssdk.services.iotroborunner.model.ListWorkersRequest)
operation.This is a convenience which creates an instance of the
ListWorkersRequest.Builder
avoiding the need to create one manually viaListWorkersRequest.builder()
- Parameters:
listWorkersRequest
- AConsumer
that will call methods onListWorkersRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
updateDestination
default UpdateDestinationResponse updateDestination(UpdateDestinationRequest updateDestinationRequest) throws AccessDeniedException, ValidationException, ResourceNotFoundException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, IotRoboRunnerException Grants permission to update a destination
- Parameters:
updateDestinationRequest
-- Returns:
- Result of the UpdateDestination operation returned by the service.
- See Also:
-
updateDestination
default UpdateDestinationResponse updateDestination(Consumer<UpdateDestinationRequest.Builder> updateDestinationRequest) throws AccessDeniedException, ValidationException, ResourceNotFoundException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, IotRoboRunnerException Grants permission to update a destination
This is a convenience which creates an instance of the
UpdateDestinationRequest.Builder
avoiding the need to create one manually viaUpdateDestinationRequest.builder()
- Parameters:
updateDestinationRequest
- AConsumer
that will call methods onUpdateDestinationRequest.Builder
to create a request.- Returns:
- Result of the UpdateDestination operation returned by the service.
- See Also:
-
updateSite
default UpdateSiteResponse updateSite(UpdateSiteRequest updateSiteRequest) throws AccessDeniedException, ValidationException, ResourceNotFoundException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, IotRoboRunnerException Grants permission to update a site
- Parameters:
updateSiteRequest
-- Returns:
- Result of the UpdateSite operation returned by the service.
- See Also:
-
updateSite
default UpdateSiteResponse updateSite(Consumer<UpdateSiteRequest.Builder> updateSiteRequest) throws AccessDeniedException, ValidationException, ResourceNotFoundException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, IotRoboRunnerException Grants permission to update a site
This is a convenience which creates an instance of the
UpdateSiteRequest.Builder
avoiding the need to create one manually viaUpdateSiteRequest.builder()
- Parameters:
updateSiteRequest
- AConsumer
that will call methods onUpdateSiteRequest.Builder
to create a request.- Returns:
- Result of the UpdateSite operation returned by the service.
- See Also:
-
updateWorker
default UpdateWorkerResponse updateWorker(UpdateWorkerRequest updateWorkerRequest) throws AccessDeniedException, ValidationException, ResourceNotFoundException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, IotRoboRunnerException Grants permission to update a worker
- Parameters:
updateWorkerRequest
-- Returns:
- Result of the UpdateWorker operation returned by the service.
- See Also:
-
updateWorker
default UpdateWorkerResponse updateWorker(Consumer<UpdateWorkerRequest.Builder> updateWorkerRequest) throws AccessDeniedException, ValidationException, ResourceNotFoundException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, IotRoboRunnerException Grants permission to update a worker
This is a convenience which creates an instance of the
UpdateWorkerRequest.Builder
avoiding the need to create one manually viaUpdateWorkerRequest.builder()
- Parameters:
updateWorkerRequest
- AConsumer
that will call methods onUpdateWorkerRequest.Builder
to create a request.- Returns:
- Result of the UpdateWorker operation returned by the service.
- See Also:
-
updateWorkerFleet
default UpdateWorkerFleetResponse updateWorkerFleet(UpdateWorkerFleetRequest updateWorkerFleetRequest) throws AccessDeniedException, ValidationException, ResourceNotFoundException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, IotRoboRunnerException Grants permission to update a worker fleet
- Parameters:
updateWorkerFleetRequest
-- Returns:
- Result of the UpdateWorkerFleet operation returned by the service.
- See Also:
-
updateWorkerFleet
default UpdateWorkerFleetResponse updateWorkerFleet(Consumer<UpdateWorkerFleetRequest.Builder> updateWorkerFleetRequest) throws AccessDeniedException, ValidationException, ResourceNotFoundException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, IotRoboRunnerException Grants permission to update a worker fleet
This is a convenience which creates an instance of the
UpdateWorkerFleetRequest.Builder
avoiding the need to create one manually viaUpdateWorkerFleetRequest.builder()
- Parameters:
updateWorkerFleetRequest
- AConsumer
that will call methods onUpdateWorkerFleetRequest.Builder
to create a request.- Returns:
- Result of the UpdateWorkerFleet operation returned by the service.
- See Also:
-
create
Create aIotRoboRunnerClient
with the region loaded from theDefaultAwsRegionProviderChain
and credentials loaded from theDefaultCredentialsProvider
. -
builder
Create a builder that can be used to configure and create aIotRoboRunnerClient
. -
serviceMetadata
-
serviceClientConfiguration
Description copied from interface:SdkClient
The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration- Specified by:
serviceClientConfiguration
in interfaceAwsClient
- Specified by:
serviceClientConfiguration
in interfaceSdkClient
- Returns:
- SdkServiceClientConfiguration
-