Class ListDeploymentsRequest
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<ListDeploymentsRequest.Builder,
ListDeploymentsRequest>
-
Nested Class Summary
-
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 DeploymentHistoryFilter
The filter for the list of deployments.final String
The filter for the list of deployments.final Integer
The maximum number of results to be returned per paginated request.final String
The token to be used for the next set of paginated results.final String
The parent deployment's target ARN within a subdeployment.static Class
<? extends ListDeploymentsRequest.Builder> final String
The ARN of the target IoT thing or thing group.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
-
targetArn
The ARN of the target IoT thing or thing group.
- Returns:
- The ARN of the target IoT thing or thing group.
-
historyFilter
The filter for the list of deployments. Choose one of the following options:
-
ALL
– The list includes all deployments. -
LATEST_ONLY
– The list includes only the latest revision of each deployment.
Default:
LATEST_ONLY
If the service returns an enum value that is not available in the current SDK version,
historyFilter
will returnDeploymentHistoryFilter.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromhistoryFilterAsString()
.- Returns:
- The filter for the list of deployments. Choose one of the following options:
-
ALL
– The list includes all deployments. -
LATEST_ONLY
– The list includes only the latest revision of each deployment.
Default:
LATEST_ONLY
-
- See Also:
-
-
historyFilterAsString
The filter for the list of deployments. Choose one of the following options:
-
ALL
– The list includes all deployments. -
LATEST_ONLY
– The list includes only the latest revision of each deployment.
Default:
LATEST_ONLY
If the service returns an enum value that is not available in the current SDK version,
historyFilter
will returnDeploymentHistoryFilter.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromhistoryFilterAsString()
.- Returns:
- The filter for the list of deployments. Choose one of the following options:
-
ALL
– The list includes all deployments. -
LATEST_ONLY
– The list includes only the latest revision of each deployment.
Default:
LATEST_ONLY
-
- See Also:
-
-
parentTargetArn
The parent deployment's target ARN within a subdeployment.
- Returns:
- The parent deployment's target ARN within a subdeployment.
-
maxResults
The maximum number of results to be returned per paginated request.
- Returns:
- The maximum number of results to be returned per paginated request.
-
nextToken
The token to be used for the next set of paginated results.
- Returns:
- The token to be used for the next set of paginated results.
-
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<ListDeploymentsRequest.Builder,
ListDeploymentsRequest> - Specified by:
toBuilder
in classGreengrassV2Request
- 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
Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value. -
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
-