@Generated(value="software.amazon.awssdk:codegen") public interface Iot1ClickDevicesAsyncClient extends SdkClient
builder()
method.
Stub description
Modifier and Type | Field and Description |
---|---|
static String |
SERVICE_NAME |
Modifier and Type | Method and Description |
---|---|
static Iot1ClickDevicesAsyncClientBuilder |
builder()
Create a builder that can be used to configure and create a
Iot1ClickDevicesAsyncClient . |
default CompletableFuture<ClaimDevicesByClaimCodeResponse> |
claimDevicesByClaimCode(ClaimDevicesByClaimCodeRequest claimDevicesByClaimCodeRequest)
Adds device(s) to your account (i.e., claim one or more devices) if and only if you received a claim code with
the device(s).
|
default CompletableFuture<ClaimDevicesByClaimCodeResponse> |
claimDevicesByClaimCode(Consumer<ClaimDevicesByClaimCodeRequest.Builder> claimDevicesByClaimCodeRequest)
Adds device(s) to your account (i.e., claim one or more devices) if and only if you received a claim code with
the device(s).
|
static Iot1ClickDevicesAsyncClient |
create()
Create a
Iot1ClickDevicesAsyncClient with the region loaded from the
DefaultAwsRegionProviderChain and credentials loaded from the
DefaultCredentialsProvider . |
default CompletableFuture<DescribeDeviceResponse> |
describeDevice(Consumer<DescribeDeviceRequest.Builder> describeDeviceRequest)
Given a device ID, returns a DescribeDeviceResponse object describing the details of the device.
|
default CompletableFuture<DescribeDeviceResponse> |
describeDevice(DescribeDeviceRequest describeDeviceRequest)
Given a device ID, returns a DescribeDeviceResponse object describing the details of the device.
|
default CompletableFuture<FinalizeDeviceClaimResponse> |
finalizeDeviceClaim(Consumer<FinalizeDeviceClaimRequest.Builder> finalizeDeviceClaimRequest)
Given a device ID, finalizes the claim request for the associated device.
|
default CompletableFuture<FinalizeDeviceClaimResponse> |
finalizeDeviceClaim(FinalizeDeviceClaimRequest finalizeDeviceClaimRequest)
Given a device ID, finalizes the claim request for the associated device.
|
default CompletableFuture<GetDeviceMethodsResponse> |
getDeviceMethods(Consumer<GetDeviceMethodsRequest.Builder> getDeviceMethodsRequest)
Given a device ID, returns the invokable methods associated with the device.
|
default CompletableFuture<GetDeviceMethodsResponse> |
getDeviceMethods(GetDeviceMethodsRequest getDeviceMethodsRequest)
Given a device ID, returns the invokable methods associated with the device.
|
default CompletableFuture<InitiateDeviceClaimResponse> |
initiateDeviceClaim(Consumer<InitiateDeviceClaimRequest.Builder> initiateDeviceClaimRequest)
Given a device ID, initiates a claim request for the associated device.
|
default CompletableFuture<InitiateDeviceClaimResponse> |
initiateDeviceClaim(InitiateDeviceClaimRequest initiateDeviceClaimRequest)
Given a device ID, initiates a claim request for the associated device.
|
default CompletableFuture<InvokeDeviceMethodResponse> |
invokeDeviceMethod(Consumer<InvokeDeviceMethodRequest.Builder> invokeDeviceMethodRequest)
Given a device ID, issues a request to invoke a named device method (with possible parameters).
|
default CompletableFuture<InvokeDeviceMethodResponse> |
invokeDeviceMethod(InvokeDeviceMethodRequest invokeDeviceMethodRequest)
Given a device ID, issues a request to invoke a named device method (with possible parameters).
|
default CompletableFuture<ListDeviceEventsResponse> |
listDeviceEvents(Consumer<ListDeviceEventsRequest.Builder> listDeviceEventsRequest)
Using a device ID, returns a DeviceEventsResponse object containing an array of events for the device.
|
default CompletableFuture<ListDeviceEventsResponse> |
listDeviceEvents(ListDeviceEventsRequest listDeviceEventsRequest)
Using a device ID, returns a DeviceEventsResponse object containing an array of events for the device.
|
default CompletableFuture<ListDevicesResponse> |
listDevices(Consumer<ListDevicesRequest.Builder> listDevicesRequest)
Lists the 1-Click compatible devices associated with your AWS account.
|
default CompletableFuture<ListDevicesResponse> |
listDevices(ListDevicesRequest listDevicesRequest)
Lists the 1-Click compatible devices associated with your AWS account.
|
default CompletableFuture<UnclaimDeviceResponse> |
unclaimDevice(Consumer<UnclaimDeviceRequest.Builder> unclaimDeviceRequest)
Disassociates a device from your AWS account using its device ID.
|
default CompletableFuture<UnclaimDeviceResponse> |
unclaimDevice(UnclaimDeviceRequest unclaimDeviceRequest)
Disassociates a device from your AWS account using its device ID.
|
default CompletableFuture<UpdateDeviceStateResponse> |
updateDeviceState(Consumer<UpdateDeviceStateRequest.Builder> updateDeviceStateRequest)
Using a Boolean value (true or false), this operation enables or disables the device given a device ID.
|
default CompletableFuture<UpdateDeviceStateResponse> |
updateDeviceState(UpdateDeviceStateRequest updateDeviceStateRequest)
Using a Boolean value (true or false), this operation enables or disables the device given a device ID.
|
serviceName
close
static final String SERVICE_NAME
static Iot1ClickDevicesAsyncClient create()
Iot1ClickDevicesAsyncClient
with the region loaded from the
DefaultAwsRegionProviderChain
and credentials loaded from the
DefaultCredentialsProvider
.static Iot1ClickDevicesAsyncClientBuilder builder()
Iot1ClickDevicesAsyncClient
.default CompletableFuture<ClaimDevicesByClaimCodeResponse> claimDevicesByClaimCode(ClaimDevicesByClaimCodeRequest claimDevicesByClaimCodeRequest)
Adds device(s) to your account (i.e., claim one or more devices) if and only if you received a claim code with the device(s).
claimDevicesByClaimCodeRequest
- default CompletableFuture<ClaimDevicesByClaimCodeResponse> claimDevicesByClaimCode(Consumer<ClaimDevicesByClaimCodeRequest.Builder> claimDevicesByClaimCodeRequest)
Adds device(s) to your account (i.e., claim one or more devices) if and only if you received a claim code with the device(s).
This is a convenience which creates an instance of the ClaimDevicesByClaimCodeRequest.Builder
avoiding
the need to create one manually via ClaimDevicesByClaimCodeRequest.builder()
claimDevicesByClaimCodeRequest
- A Consumer
that will call methods on ClaimDevicesByClaimCodeRequest.Builder
to create a
request.default CompletableFuture<DescribeDeviceResponse> describeDevice(DescribeDeviceRequest describeDeviceRequest)
Given a device ID, returns a DescribeDeviceResponse object describing the details of the device.
describeDeviceRequest
- default CompletableFuture<DescribeDeviceResponse> describeDevice(Consumer<DescribeDeviceRequest.Builder> describeDeviceRequest)
Given a device ID, returns a DescribeDeviceResponse object describing the details of the device.
This is a convenience which creates an instance of the DescribeDeviceRequest.Builder
avoiding the need to
create one manually via DescribeDeviceRequest.builder()
describeDeviceRequest
- A Consumer
that will call methods on DescribeDeviceRequest.Builder
to create a request.default CompletableFuture<FinalizeDeviceClaimResponse> finalizeDeviceClaim(FinalizeDeviceClaimRequest finalizeDeviceClaimRequest)
Given a device ID, finalizes the claim request for the associated device.
Claiming a device consists of initiating a claim, then publishing a device event, and finalizing the claim. For a device of type button, a device event can be published by simply clicking the device.
finalizeDeviceClaimRequest
- default CompletableFuture<FinalizeDeviceClaimResponse> finalizeDeviceClaim(Consumer<FinalizeDeviceClaimRequest.Builder> finalizeDeviceClaimRequest)
Given a device ID, finalizes the claim request for the associated device.
Claiming a device consists of initiating a claim, then publishing a device event, and finalizing the claim. For a device of type button, a device event can be published by simply clicking the device.
This is a convenience which creates an instance of the FinalizeDeviceClaimRequest.Builder
avoiding the
need to create one manually via FinalizeDeviceClaimRequest.builder()
finalizeDeviceClaimRequest
- A Consumer
that will call methods on FinalizeDeviceClaimRequest.Builder
to create a
request.default CompletableFuture<GetDeviceMethodsResponse> getDeviceMethods(GetDeviceMethodsRequest getDeviceMethodsRequest)
Given a device ID, returns the invokable methods associated with the device.
getDeviceMethodsRequest
- default CompletableFuture<GetDeviceMethodsResponse> getDeviceMethods(Consumer<GetDeviceMethodsRequest.Builder> getDeviceMethodsRequest)
Given a device ID, returns the invokable methods associated with the device.
This is a convenience which creates an instance of the GetDeviceMethodsRequest.Builder
avoiding the need
to create one manually via GetDeviceMethodsRequest.builder()
getDeviceMethodsRequest
- A Consumer
that will call methods on GetDeviceMethodsRequest.Builder
to create a request.default CompletableFuture<InitiateDeviceClaimResponse> initiateDeviceClaim(InitiateDeviceClaimRequest initiateDeviceClaimRequest)
Given a device ID, initiates a claim request for the associated device.
Claiming a device consists of initiating a claim, then publishing a device event, and finalizing the claim. For a device of type button, a device event can be published by simply clicking the device.
initiateDeviceClaimRequest
- default CompletableFuture<InitiateDeviceClaimResponse> initiateDeviceClaim(Consumer<InitiateDeviceClaimRequest.Builder> initiateDeviceClaimRequest)
Given a device ID, initiates a claim request for the associated device.
Claiming a device consists of initiating a claim, then publishing a device event, and finalizing the claim. For a device of type button, a device event can be published by simply clicking the device.
This is a convenience which creates an instance of the InitiateDeviceClaimRequest.Builder
avoiding the
need to create one manually via InitiateDeviceClaimRequest.builder()
initiateDeviceClaimRequest
- A Consumer
that will call methods on InitiateDeviceClaimRequest.Builder
to create a
request.default CompletableFuture<InvokeDeviceMethodResponse> invokeDeviceMethod(InvokeDeviceMethodRequest invokeDeviceMethodRequest)
Given a device ID, issues a request to invoke a named device method (with possible parameters). See the "Example POST" code snippet below.
invokeDeviceMethodRequest
- default CompletableFuture<InvokeDeviceMethodResponse> invokeDeviceMethod(Consumer<InvokeDeviceMethodRequest.Builder> invokeDeviceMethodRequest)
Given a device ID, issues a request to invoke a named device method (with possible parameters). See the "Example POST" code snippet below.
This is a convenience which creates an instance of the InvokeDeviceMethodRequest.Builder
avoiding the
need to create one manually via InvokeDeviceMethodRequest.builder()
invokeDeviceMethodRequest
- A Consumer
that will call methods on InvokeDeviceMethodRequest.Builder
to create a
request.default CompletableFuture<ListDeviceEventsResponse> listDeviceEvents(ListDeviceEventsRequest listDeviceEventsRequest)
Using a device ID, returns a DeviceEventsResponse object containing an array of events for the device.
listDeviceEventsRequest
- default CompletableFuture<ListDeviceEventsResponse> listDeviceEvents(Consumer<ListDeviceEventsRequest.Builder> listDeviceEventsRequest)
Using a device ID, returns a DeviceEventsResponse object containing an array of events for the device.
This is a convenience which creates an instance of the ListDeviceEventsRequest.Builder
avoiding the need
to create one manually via ListDeviceEventsRequest.builder()
listDeviceEventsRequest
- A Consumer
that will call methods on ListDeviceEventsRequest.Builder
to create a request.default CompletableFuture<ListDevicesResponse> listDevices(ListDevicesRequest listDevicesRequest)
Lists the 1-Click compatible devices associated with your AWS account.
listDevicesRequest
- default CompletableFuture<ListDevicesResponse> listDevices(Consumer<ListDevicesRequest.Builder> listDevicesRequest)
Lists the 1-Click compatible devices associated with your AWS account.
This is a convenience which creates an instance of the ListDevicesRequest.Builder
avoiding the need to
create one manually via ListDevicesRequest.builder()
listDevicesRequest
- A Consumer
that will call methods on ListDevicesRequest.Builder
to create a request.default CompletableFuture<UnclaimDeviceResponse> unclaimDevice(UnclaimDeviceRequest unclaimDeviceRequest)
Disassociates a device from your AWS account using its device ID.
unclaimDeviceRequest
- default CompletableFuture<UnclaimDeviceResponse> unclaimDevice(Consumer<UnclaimDeviceRequest.Builder> unclaimDeviceRequest)
Disassociates a device from your AWS account using its device ID.
This is a convenience which creates an instance of the UnclaimDeviceRequest.Builder
avoiding the need to
create one manually via UnclaimDeviceRequest.builder()
unclaimDeviceRequest
- A Consumer
that will call methods on UnclaimDeviceRequest.Builder
to create a request.default CompletableFuture<UpdateDeviceStateResponse> updateDeviceState(UpdateDeviceStateRequest updateDeviceStateRequest)
Using a Boolean value (true or false), this operation enables or disables the device given a device ID.
updateDeviceStateRequest
- default CompletableFuture<UpdateDeviceStateResponse> updateDeviceState(Consumer<UpdateDeviceStateRequest.Builder> updateDeviceStateRequest)
Using a Boolean value (true or false), this operation enables or disables the device given a device ID.
This is a convenience which creates an instance of the UpdateDeviceStateRequest.Builder
avoiding the need
to create one manually via UpdateDeviceStateRequest.builder()
updateDeviceStateRequest
- A Consumer
that will call methods on UpdateDeviceStateRequest.Builder
to create a request.Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.