@Generated(value="software.amazon.awssdk:codegen") @ThreadSafe public interface IoTTwinMakerAsyncClient extends SdkClient
builder() method.
IoT TwinMaker is a service that enables you to build operational digital twins of physical systems. IoT TwinMaker overlays measurements and analysis from real-world sensors, cameras, and enterprise applications so you can create data visualizations to monitor your physical factory, building, or industrial plant. You can use this real-world data to monitor operations and diagnose and repair errors.
| Modifier and Type | Field and Description |
|---|---|
static String |
SERVICE_METADATA_ID
Value for looking up the service's metadata from the
ServiceMetadataProvider. |
static String |
SERVICE_NAME |
serviceNameclosestatic final String SERVICE_NAME
static final String SERVICE_METADATA_ID
ServiceMetadataProvider.static IoTTwinMakerAsyncClient create()
IoTTwinMakerAsyncClient with the region loaded from the
DefaultAwsRegionProviderChain and credentials loaded from the
DefaultCredentialsProvider.static IoTTwinMakerAsyncClientBuilder builder()
IoTTwinMakerAsyncClient.default CompletableFuture<BatchPutPropertyValuesResponse> batchPutPropertyValues(BatchPutPropertyValuesRequest batchPutPropertyValuesRequest)
Sets values for multiple time series properties.
batchPutPropertyValuesRequest - default CompletableFuture<BatchPutPropertyValuesResponse> batchPutPropertyValues(Consumer<BatchPutPropertyValuesRequest.Builder> batchPutPropertyValuesRequest)
Sets values for multiple time series properties.
This is a convenience which creates an instance of the BatchPutPropertyValuesRequest.Builder avoiding the
need to create one manually via BatchPutPropertyValuesRequest.builder()
batchPutPropertyValuesRequest - A Consumer that will call methods on BatchPutPropertyValuesRequest.Builder to create a
request.default CompletableFuture<CreateComponentTypeResponse> createComponentType(CreateComponentTypeRequest createComponentTypeRequest)
Creates a component type.
createComponentTypeRequest - default CompletableFuture<CreateComponentTypeResponse> createComponentType(Consumer<CreateComponentTypeRequest.Builder> createComponentTypeRequest)
Creates a component type.
This is a convenience which creates an instance of the CreateComponentTypeRequest.Builder avoiding the
need to create one manually via CreateComponentTypeRequest.builder()
createComponentTypeRequest - A Consumer that will call methods on CreateComponentTypeRequest.Builder to create a
request.default CompletableFuture<CreateEntityResponse> createEntity(CreateEntityRequest createEntityRequest)
Creates an entity.
createEntityRequest - default CompletableFuture<CreateEntityResponse> createEntity(Consumer<CreateEntityRequest.Builder> createEntityRequest)
Creates an entity.
This is a convenience which creates an instance of the CreateEntityRequest.Builder avoiding the need to
create one manually via CreateEntityRequest.builder()
createEntityRequest - A Consumer that will call methods on CreateEntityRequest.Builder to create a request.default CompletableFuture<CreateSceneResponse> createScene(CreateSceneRequest createSceneRequest)
Creates a scene.
createSceneRequest - default CompletableFuture<CreateSceneResponse> createScene(Consumer<CreateSceneRequest.Builder> createSceneRequest)
Creates a scene.
This is a convenience which creates an instance of the CreateSceneRequest.Builder avoiding the need to
create one manually via CreateSceneRequest.builder()
createSceneRequest - A Consumer that will call methods on CreateSceneRequest.Builder to create a request.default CompletableFuture<CreateWorkspaceResponse> createWorkspace(CreateWorkspaceRequest createWorkspaceRequest)
Creates a workplace.
createWorkspaceRequest - default CompletableFuture<CreateWorkspaceResponse> createWorkspace(Consumer<CreateWorkspaceRequest.Builder> createWorkspaceRequest)
Creates a workplace.
This is a convenience which creates an instance of the CreateWorkspaceRequest.Builder avoiding the need
to create one manually via CreateWorkspaceRequest.builder()
createWorkspaceRequest - A Consumer that will call methods on CreateWorkspaceRequest.Builder to create a request.default CompletableFuture<DeleteComponentTypeResponse> deleteComponentType(DeleteComponentTypeRequest deleteComponentTypeRequest)
Deletes a component type.
deleteComponentTypeRequest - default CompletableFuture<DeleteComponentTypeResponse> deleteComponentType(Consumer<DeleteComponentTypeRequest.Builder> deleteComponentTypeRequest)
Deletes a component type.
This is a convenience which creates an instance of the DeleteComponentTypeRequest.Builder avoiding the
need to create one manually via DeleteComponentTypeRequest.builder()
deleteComponentTypeRequest - A Consumer that will call methods on DeleteComponentTypeRequest.Builder to create a
request.default CompletableFuture<DeleteEntityResponse> deleteEntity(DeleteEntityRequest deleteEntityRequest)
Deletes an entity.
deleteEntityRequest - default CompletableFuture<DeleteEntityResponse> deleteEntity(Consumer<DeleteEntityRequest.Builder> deleteEntityRequest)
Deletes an entity.
This is a convenience which creates an instance of the DeleteEntityRequest.Builder avoiding the need to
create one manually via DeleteEntityRequest.builder()
deleteEntityRequest - A Consumer that will call methods on DeleteEntityRequest.Builder to create a request.default CompletableFuture<DeleteSceneResponse> deleteScene(DeleteSceneRequest deleteSceneRequest)
Deletes a scene.
deleteSceneRequest - default CompletableFuture<DeleteSceneResponse> deleteScene(Consumer<DeleteSceneRequest.Builder> deleteSceneRequest)
Deletes a scene.
This is a convenience which creates an instance of the DeleteSceneRequest.Builder avoiding the need to
create one manually via DeleteSceneRequest.builder()
deleteSceneRequest - A Consumer that will call methods on DeleteSceneRequest.Builder to create a request.default CompletableFuture<DeleteWorkspaceResponse> deleteWorkspace(DeleteWorkspaceRequest deleteWorkspaceRequest)
Deletes a workspace.
deleteWorkspaceRequest - default CompletableFuture<DeleteWorkspaceResponse> deleteWorkspace(Consumer<DeleteWorkspaceRequest.Builder> deleteWorkspaceRequest)
Deletes a workspace.
This is a convenience which creates an instance of the DeleteWorkspaceRequest.Builder avoiding the need
to create one manually via DeleteWorkspaceRequest.builder()
deleteWorkspaceRequest - A Consumer that will call methods on DeleteWorkspaceRequest.Builder to create a request.default CompletableFuture<GetComponentTypeResponse> getComponentType(GetComponentTypeRequest getComponentTypeRequest)
Retrieves information about a component type.
getComponentTypeRequest - default CompletableFuture<GetComponentTypeResponse> getComponentType(Consumer<GetComponentTypeRequest.Builder> getComponentTypeRequest)
Retrieves information about a component type.
This is a convenience which creates an instance of the GetComponentTypeRequest.Builder avoiding the need
to create one manually via GetComponentTypeRequest.builder()
getComponentTypeRequest - A Consumer that will call methods on GetComponentTypeRequest.Builder to create a request.default CompletableFuture<GetEntityResponse> getEntity(GetEntityRequest getEntityRequest)
Retrieves information about an entity.
getEntityRequest - default CompletableFuture<GetEntityResponse> getEntity(Consumer<GetEntityRequest.Builder> getEntityRequest)
Retrieves information about an entity.
This is a convenience which creates an instance of the GetEntityRequest.Builder avoiding the need to
create one manually via GetEntityRequest.builder()
getEntityRequest - A Consumer that will call methods on GetEntityRequest.Builder to create a request.default CompletableFuture<GetPropertyValueResponse> getPropertyValue(GetPropertyValueRequest getPropertyValueRequest)
Gets the property values for a component, component type, entity, or workspace.
You must specify a value for either componentName, componentTypeId,
entityId, or workspaceId.
getPropertyValueRequest - default CompletableFuture<GetPropertyValueResponse> getPropertyValue(Consumer<GetPropertyValueRequest.Builder> getPropertyValueRequest)
Gets the property values for a component, component type, entity, or workspace.
You must specify a value for either componentName, componentTypeId,
entityId, or workspaceId.
This is a convenience which creates an instance of the GetPropertyValueRequest.Builder avoiding the need
to create one manually via GetPropertyValueRequest.builder()
getPropertyValueRequest - A Consumer that will call methods on GetPropertyValueRequest.Builder to create a request.default CompletableFuture<GetPropertyValueHistoryResponse> getPropertyValueHistory(GetPropertyValueHistoryRequest getPropertyValueHistoryRequest)
Retrieves information about the history of a time series property value for a component, component type, entity, or workspace.
You must specify a value for workspaceId. For entity-specific queries, specify values for
componentName and entityId. For cross-entity quries, specify a value for
componentTypeId.
getPropertyValueHistoryRequest - default CompletableFuture<GetPropertyValueHistoryResponse> getPropertyValueHistory(Consumer<GetPropertyValueHistoryRequest.Builder> getPropertyValueHistoryRequest)
Retrieves information about the history of a time series property value for a component, component type, entity, or workspace.
You must specify a value for workspaceId. For entity-specific queries, specify values for
componentName and entityId. For cross-entity quries, specify a value for
componentTypeId.
This is a convenience which creates an instance of the GetPropertyValueHistoryRequest.Builder avoiding
the need to create one manually via GetPropertyValueHistoryRequest.builder()
getPropertyValueHistoryRequest - A Consumer that will call methods on GetPropertyValueHistoryRequest.Builder to create a
request.default GetPropertyValueHistoryPublisher getPropertyValueHistoryPaginator(GetPropertyValueHistoryRequest getPropertyValueHistoryRequest)
Retrieves information about the history of a time series property value for a component, component type, entity, or workspace.
You must specify a value for workspaceId. For entity-specific queries, specify values for
componentName and entityId. For cross-entity quries, specify a value for
componentTypeId.
This is a variant of
getPropertyValueHistory(software.amazon.awssdk.services.iottwinmaker.model.GetPropertyValueHistoryRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.iottwinmaker.paginators.GetPropertyValueHistoryPublisher publisher = client.getPropertyValueHistoryPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.iottwinmaker.paginators.GetPropertyValueHistoryPublisher publisher = client.getPropertyValueHistoryPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.iottwinmaker.model.GetPropertyValueHistoryResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.iottwinmaker.model.GetPropertyValueHistoryResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
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
getPropertyValueHistory(software.amazon.awssdk.services.iottwinmaker.model.GetPropertyValueHistoryRequest)
operation.
getPropertyValueHistoryRequest - default GetPropertyValueHistoryPublisher getPropertyValueHistoryPaginator(Consumer<GetPropertyValueHistoryRequest.Builder> getPropertyValueHistoryRequest)
Retrieves information about the history of a time series property value for a component, component type, entity, or workspace.
You must specify a value for workspaceId. For entity-specific queries, specify values for
componentName and entityId. For cross-entity quries, specify a value for
componentTypeId.
This is a variant of
getPropertyValueHistory(software.amazon.awssdk.services.iottwinmaker.model.GetPropertyValueHistoryRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.iottwinmaker.paginators.GetPropertyValueHistoryPublisher publisher = client.getPropertyValueHistoryPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.iottwinmaker.paginators.GetPropertyValueHistoryPublisher publisher = client.getPropertyValueHistoryPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.iottwinmaker.model.GetPropertyValueHistoryResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.iottwinmaker.model.GetPropertyValueHistoryResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
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
getPropertyValueHistory(software.amazon.awssdk.services.iottwinmaker.model.GetPropertyValueHistoryRequest)
operation.
This is a convenience which creates an instance of the GetPropertyValueHistoryRequest.Builder avoiding
the need to create one manually via GetPropertyValueHistoryRequest.builder()
getPropertyValueHistoryRequest - A Consumer that will call methods on GetPropertyValueHistoryRequest.Builder to create a
request.default CompletableFuture<GetSceneResponse> getScene(GetSceneRequest getSceneRequest)
Retrieves information about a scene.
getSceneRequest - default CompletableFuture<GetSceneResponse> getScene(Consumer<GetSceneRequest.Builder> getSceneRequest)
Retrieves information about a scene.
This is a convenience which creates an instance of the GetSceneRequest.Builder avoiding the need to
create one manually via GetSceneRequest.builder()
getSceneRequest - A Consumer that will call methods on GetSceneRequest.Builder to create a request.default CompletableFuture<GetWorkspaceResponse> getWorkspace(GetWorkspaceRequest getWorkspaceRequest)
Retrieves information about a workspace.
getWorkspaceRequest - default CompletableFuture<GetWorkspaceResponse> getWorkspace(Consumer<GetWorkspaceRequest.Builder> getWorkspaceRequest)
Retrieves information about a workspace.
This is a convenience which creates an instance of the GetWorkspaceRequest.Builder avoiding the need to
create one manually via GetWorkspaceRequest.builder()
getWorkspaceRequest - A Consumer that will call methods on GetWorkspaceRequest.Builder to create a request.default CompletableFuture<ListComponentTypesResponse> listComponentTypes(ListComponentTypesRequest listComponentTypesRequest)
Lists all component types in a workspace.
listComponentTypesRequest - default CompletableFuture<ListComponentTypesResponse> listComponentTypes(Consumer<ListComponentTypesRequest.Builder> listComponentTypesRequest)
Lists all component types in a workspace.
This is a convenience which creates an instance of the ListComponentTypesRequest.Builder avoiding the
need to create one manually via ListComponentTypesRequest.builder()
listComponentTypesRequest - A Consumer that will call methods on ListComponentTypesRequest.Builder to create a
request.default ListComponentTypesPublisher listComponentTypesPaginator(ListComponentTypesRequest listComponentTypesRequest)
Lists all component types in a workspace.
This is a variant of
listComponentTypes(software.amazon.awssdk.services.iottwinmaker.model.ListComponentTypesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.iottwinmaker.paginators.ListComponentTypesPublisher publisher = client.listComponentTypesPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.iottwinmaker.paginators.ListComponentTypesPublisher publisher = client.listComponentTypesPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.iottwinmaker.model.ListComponentTypesResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.iottwinmaker.model.ListComponentTypesResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
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
listComponentTypes(software.amazon.awssdk.services.iottwinmaker.model.ListComponentTypesRequest)
operation.
listComponentTypesRequest - default ListComponentTypesPublisher listComponentTypesPaginator(Consumer<ListComponentTypesRequest.Builder> listComponentTypesRequest)
Lists all component types in a workspace.
This is a variant of
listComponentTypes(software.amazon.awssdk.services.iottwinmaker.model.ListComponentTypesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.iottwinmaker.paginators.ListComponentTypesPublisher publisher = client.listComponentTypesPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.iottwinmaker.paginators.ListComponentTypesPublisher publisher = client.listComponentTypesPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.iottwinmaker.model.ListComponentTypesResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.iottwinmaker.model.ListComponentTypesResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
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
listComponentTypes(software.amazon.awssdk.services.iottwinmaker.model.ListComponentTypesRequest)
operation.
This is a convenience which creates an instance of the ListComponentTypesRequest.Builder avoiding the
need to create one manually via ListComponentTypesRequest.builder()
listComponentTypesRequest - A Consumer that will call methods on ListComponentTypesRequest.Builder to create a
request.default CompletableFuture<ListEntitiesResponse> listEntities(ListEntitiesRequest listEntitiesRequest)
Lists all entities in a workspace.
listEntitiesRequest - default CompletableFuture<ListEntitiesResponse> listEntities(Consumer<ListEntitiesRequest.Builder> listEntitiesRequest)
Lists all entities in a workspace.
This is a convenience which creates an instance of the ListEntitiesRequest.Builder avoiding the need to
create one manually via ListEntitiesRequest.builder()
listEntitiesRequest - A Consumer that will call methods on ListEntitiesRequest.Builder to create a request.default ListEntitiesPublisher listEntitiesPaginator(ListEntitiesRequest listEntitiesRequest)
Lists all entities in a workspace.
This is a variant of
listEntities(software.amazon.awssdk.services.iottwinmaker.model.ListEntitiesRequest) operation. The
return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will
internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.iottwinmaker.paginators.ListEntitiesPublisher publisher = client.listEntitiesPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.iottwinmaker.paginators.ListEntitiesPublisher publisher = client.listEntitiesPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.iottwinmaker.model.ListEntitiesResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.iottwinmaker.model.ListEntitiesResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
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
listEntities(software.amazon.awssdk.services.iottwinmaker.model.ListEntitiesRequest) operation.
listEntitiesRequest - default ListEntitiesPublisher listEntitiesPaginator(Consumer<ListEntitiesRequest.Builder> listEntitiesRequest)
Lists all entities in a workspace.
This is a variant of
listEntities(software.amazon.awssdk.services.iottwinmaker.model.ListEntitiesRequest) operation. The
return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will
internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.iottwinmaker.paginators.ListEntitiesPublisher publisher = client.listEntitiesPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.iottwinmaker.paginators.ListEntitiesPublisher publisher = client.listEntitiesPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.iottwinmaker.model.ListEntitiesResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.iottwinmaker.model.ListEntitiesResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
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
listEntities(software.amazon.awssdk.services.iottwinmaker.model.ListEntitiesRequest) operation.
This is a convenience which creates an instance of the ListEntitiesRequest.Builder avoiding the need to
create one manually via ListEntitiesRequest.builder()
listEntitiesRequest - A Consumer that will call methods on ListEntitiesRequest.Builder to create a request.default CompletableFuture<ListScenesResponse> listScenes(ListScenesRequest listScenesRequest)
Lists all scenes in a workspace.
listScenesRequest - default CompletableFuture<ListScenesResponse> listScenes(Consumer<ListScenesRequest.Builder> listScenesRequest)
Lists all scenes in a workspace.
This is a convenience which creates an instance of the ListScenesRequest.Builder avoiding the need to
create one manually via ListScenesRequest.builder()
listScenesRequest - A Consumer that will call methods on ListScenesRequest.Builder to create a request.default ListScenesPublisher listScenesPaginator(ListScenesRequest listScenesRequest)
Lists all scenes in a workspace.
This is a variant of listScenes(software.amazon.awssdk.services.iottwinmaker.model.ListScenesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.iottwinmaker.paginators.ListScenesPublisher publisher = client.listScenesPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.iottwinmaker.paginators.ListScenesPublisher publisher = client.listScenesPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.iottwinmaker.model.ListScenesResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.iottwinmaker.model.ListScenesResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
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
listScenes(software.amazon.awssdk.services.iottwinmaker.model.ListScenesRequest) operation.
listScenesRequest - default ListScenesPublisher listScenesPaginator(Consumer<ListScenesRequest.Builder> listScenesRequest)
Lists all scenes in a workspace.
This is a variant of listScenes(software.amazon.awssdk.services.iottwinmaker.model.ListScenesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.iottwinmaker.paginators.ListScenesPublisher publisher = client.listScenesPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.iottwinmaker.paginators.ListScenesPublisher publisher = client.listScenesPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.iottwinmaker.model.ListScenesResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.iottwinmaker.model.ListScenesResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
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
listScenes(software.amazon.awssdk.services.iottwinmaker.model.ListScenesRequest) operation.
This is a convenience which creates an instance of the ListScenesRequest.Builder avoiding the need to
create one manually via ListScenesRequest.builder()
listScenesRequest - A Consumer that will call methods on ListScenesRequest.Builder to create a request.default CompletableFuture<ListTagsForResourceResponse> listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
Lists all tags associated with a resource.
listTagsForResourceRequest - default CompletableFuture<ListTagsForResourceResponse> listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest)
Lists all tags associated with a resource.
This is a convenience which creates an instance of the ListTagsForResourceRequest.Builder avoiding the
need to create one manually via ListTagsForResourceRequest.builder()
listTagsForResourceRequest - A Consumer that will call methods on ListTagsForResourceRequest.Builder to create a
request.default CompletableFuture<ListWorkspacesResponse> listWorkspaces(ListWorkspacesRequest listWorkspacesRequest)
Retrieves information about workspaces in the current account.
listWorkspacesRequest - default CompletableFuture<ListWorkspacesResponse> listWorkspaces(Consumer<ListWorkspacesRequest.Builder> listWorkspacesRequest)
Retrieves information about workspaces in the current account.
This is a convenience which creates an instance of the ListWorkspacesRequest.Builder avoiding the need to
create one manually via ListWorkspacesRequest.builder()
listWorkspacesRequest - A Consumer that will call methods on ListWorkspacesRequest.Builder to create a request.default ListWorkspacesPublisher listWorkspacesPaginator(ListWorkspacesRequest listWorkspacesRequest)
Retrieves information about workspaces in the current account.
This is a variant of
listWorkspaces(software.amazon.awssdk.services.iottwinmaker.model.ListWorkspacesRequest) operation. The
return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will
internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.iottwinmaker.paginators.ListWorkspacesPublisher publisher = client.listWorkspacesPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.iottwinmaker.paginators.ListWorkspacesPublisher publisher = client.listWorkspacesPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.iottwinmaker.model.ListWorkspacesResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.iottwinmaker.model.ListWorkspacesResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
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
listWorkspaces(software.amazon.awssdk.services.iottwinmaker.model.ListWorkspacesRequest) operation.
listWorkspacesRequest - default ListWorkspacesPublisher listWorkspacesPaginator(Consumer<ListWorkspacesRequest.Builder> listWorkspacesRequest)
Retrieves information about workspaces in the current account.
This is a variant of
listWorkspaces(software.amazon.awssdk.services.iottwinmaker.model.ListWorkspacesRequest) operation. The
return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will
internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.iottwinmaker.paginators.ListWorkspacesPublisher publisher = client.listWorkspacesPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.iottwinmaker.paginators.ListWorkspacesPublisher publisher = client.listWorkspacesPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.iottwinmaker.model.ListWorkspacesResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.iottwinmaker.model.ListWorkspacesResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
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
listWorkspaces(software.amazon.awssdk.services.iottwinmaker.model.ListWorkspacesRequest) operation.
This is a convenience which creates an instance of the ListWorkspacesRequest.Builder avoiding the need to
create one manually via ListWorkspacesRequest.builder()
listWorkspacesRequest - A Consumer that will call methods on ListWorkspacesRequest.Builder to create a request.default CompletableFuture<TagResourceResponse> tagResource(TagResourceRequest tagResourceRequest)
Adds tags to a resource.
tagResourceRequest - default CompletableFuture<TagResourceResponse> tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest)
Adds tags to a resource.
This is a convenience which creates an instance of the TagResourceRequest.Builder avoiding the need to
create one manually via TagResourceRequest.builder()
tagResourceRequest - A Consumer that will call methods on TagResourceRequest.Builder to create a request.default CompletableFuture<UntagResourceResponse> untagResource(UntagResourceRequest untagResourceRequest)
Removes tags from a resource.
untagResourceRequest - default CompletableFuture<UntagResourceResponse> untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest)
Removes tags from a resource.
This is a convenience which creates an instance of the UntagResourceRequest.Builder avoiding the need to
create one manually via UntagResourceRequest.builder()
untagResourceRequest - A Consumer that will call methods on UntagResourceRequest.Builder to create a request.default CompletableFuture<UpdateComponentTypeResponse> updateComponentType(UpdateComponentTypeRequest updateComponentTypeRequest)
Updates information in a component type.
updateComponentTypeRequest - default CompletableFuture<UpdateComponentTypeResponse> updateComponentType(Consumer<UpdateComponentTypeRequest.Builder> updateComponentTypeRequest)
Updates information in a component type.
This is a convenience which creates an instance of the UpdateComponentTypeRequest.Builder avoiding the
need to create one manually via UpdateComponentTypeRequest.builder()
updateComponentTypeRequest - A Consumer that will call methods on UpdateComponentTypeRequest.Builder to create a
request.default CompletableFuture<UpdateEntityResponse> updateEntity(UpdateEntityRequest updateEntityRequest)
Updates an entity.
updateEntityRequest - default CompletableFuture<UpdateEntityResponse> updateEntity(Consumer<UpdateEntityRequest.Builder> updateEntityRequest)
Updates an entity.
This is a convenience which creates an instance of the UpdateEntityRequest.Builder avoiding the need to
create one manually via UpdateEntityRequest.builder()
updateEntityRequest - A Consumer that will call methods on UpdateEntityRequest.Builder to create a request.default CompletableFuture<UpdateSceneResponse> updateScene(UpdateSceneRequest updateSceneRequest)
Updates a scene.
updateSceneRequest - default CompletableFuture<UpdateSceneResponse> updateScene(Consumer<UpdateSceneRequest.Builder> updateSceneRequest)
Updates a scene.
This is a convenience which creates an instance of the UpdateSceneRequest.Builder avoiding the need to
create one manually via UpdateSceneRequest.builder()
updateSceneRequest - A Consumer that will call methods on UpdateSceneRequest.Builder to create a request.default CompletableFuture<UpdateWorkspaceResponse> updateWorkspace(UpdateWorkspaceRequest updateWorkspaceRequest)
Updates a workspace.
updateWorkspaceRequest - default CompletableFuture<UpdateWorkspaceResponse> updateWorkspace(Consumer<UpdateWorkspaceRequest.Builder> updateWorkspaceRequest)
Updates a workspace.
This is a convenience which creates an instance of the UpdateWorkspaceRequest.Builder avoiding the need
to create one manually via UpdateWorkspaceRequest.builder()
updateWorkspaceRequest - A Consumer that will call methods on UpdateWorkspaceRequest.Builder to create a request.Copyright © 2022. All rights reserved.