Class ListJobExecutionsForThingRequest
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<ListJobExecutionsForThingRequest.Builder,
ListJobExecutionsForThingRequest>
-
Nested Class Summary
Nested Classes -
Method Summary
Modifier and TypeMethodDescriptionbuilder()
final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extendsSdkRequest
.final int
hashCode()
final String
jobId()
The unique identifier you assigned to this job when it was created.final Integer
The maximum number of results to be returned per request.final String
The namespace used to indicate that a job is a customer-managed job.final String
The token to retrieve the next set of results.static Class
<? extends ListJobExecutionsForThingRequest.Builder> final JobExecutionStatus
status()
An optional filter that lets you search for jobs that have the specified status.final String
An optional filter that lets you search for jobs that have the specified status.final String
The thing name.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
thingName
-
status
An optional filter that lets you search for jobs that have the specified status.
If the service returns an enum value that is not available in the current SDK version,
status
will returnJobExecutionStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstatusAsString()
.- Returns:
- An optional filter that lets you search for jobs that have the specified status.
- See Also:
-
statusAsString
An optional filter that lets you search for jobs that have the specified status.
If the service returns an enum value that is not available in the current SDK version,
status
will returnJobExecutionStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstatusAsString()
.- Returns:
- An optional filter that lets you search for jobs that have the specified status.
- See Also:
-
namespaceId
The namespace used to indicate that a job is a customer-managed job.
When you specify a value for this parameter, Amazon Web Services IoT Core sends jobs notifications to MQTT topics that contain the value in the following format.
$aws/things/THING_NAME/jobs/JOB_ID/notify-namespace-NAMESPACE_ID/
The
namespaceId
feature is only supported by IoT Greengrass at this time. For more information, see Setting up IoT Greengrass core devices.- Returns:
- The namespace used to indicate that a job is a customer-managed job.
When you specify a value for this parameter, Amazon Web Services IoT Core sends jobs notifications to MQTT topics that contain the value in the following format.
$aws/things/THING_NAME/jobs/JOB_ID/notify-namespace-NAMESPACE_ID/
The
namespaceId
feature is only supported by IoT Greengrass at this time. For more information, see Setting up IoT Greengrass core devices.
-
maxResults
The maximum number of results to be returned per request.
- Returns:
- The maximum number of results to be returned per request.
-
nextToken
The token to retrieve the next set of results.
- Returns:
- The token to retrieve the next set of results.
-
jobId
The unique identifier you assigned to this job when it was created.
- Returns:
- The unique identifier you assigned to this job when it was created.
-
toBuilder
Description copied from interface:ToCopyableBuilder
Take this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilder
in interfaceToCopyableBuilder<ListJobExecutionsForThingRequest.Builder,
ListJobExecutionsForThingRequest> - Specified by:
toBuilder
in classIotRequest
- Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode()- Overrides:
hashCode
in classAwsRequest
-
equals
- Overrides:
equals
in classAwsRequest
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
toString
-
getValueForField
Description copied from class:SdkRequest
Used to retrieve the value of a field from any class that extendsSdkRequest
. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, theSdkRequest.getValueForField(String, Class)
method will again be available.- Overrides:
getValueForField
in classSdkRequest
- Parameters:
fieldName
- The name of the member to be retrieved.clazz
- The class to cast the returned object to.- Returns:
- Optional containing the casted return value
-
sdkFields
-