Class UpdatePackageVersionRequest
- java.lang.Object
-
- software.amazon.awssdk.core.SdkRequest
-
- software.amazon.awssdk.awscore.AwsRequest
-
- software.amazon.awssdk.services.iot.model.IotRequest
-
- software.amazon.awssdk.services.iot.model.UpdatePackageVersionRequest
-
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<UpdatePackageVersionRequest.Builder,UpdatePackageVersionRequest>
@Generated("software.amazon.awssdk:codegen") public final class UpdatePackageVersionRequest extends IotRequest implements ToCopyableBuilder<UpdatePackageVersionRequest.Builder,UpdatePackageVersionRequest>
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interface
UpdatePackageVersionRequest.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description PackageVersionAction
action()
The status that the package version should be assigned.String
actionAsString()
The status that the package version should be assigned.Map<String,String>
attributes()
Metadata that can be used to define a package version’s configuration.static UpdatePackageVersionRequest.Builder
builder()
String
clientToken()
A unique case-sensitive identifier that you can provide to ensure the idempotency of the request.String
description()
The package version description.boolean
equals(Object obj)
boolean
equalsBySdkFields(Object obj)
<T> Optional<T>
getValueForField(String fieldName, Class<T> clazz)
boolean
hasAttributes()
For responses, this returns true if the service returned a value for the Attributes property.int
hashCode()
String
packageName()
The name of the associated software package.List<SdkField<?>>
sdkFields()
static Class<? extends UpdatePackageVersionRequest.Builder>
serializableBuilderClass()
UpdatePackageVersionRequest.Builder
toBuilder()
String
toString()
Returns a string representation of this object.String
versionName()
The name of the target package version.-
Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration
-
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
-
-
-
Method Detail
-
packageName
public final String packageName()
The name of the associated software package.
- Returns:
- The name of the associated software package.
-
versionName
public final String versionName()
The name of the target package version.
- Returns:
- The name of the target package version.
-
description
public final String description()
The package version description.
- Returns:
- The package version description.
-
hasAttributes
public final boolean hasAttributes()
For responses, this returns true if the service returned a value for the Attributes property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
-
attributes
public final Map<String,String> attributes()
Metadata that can be used to define a package version’s configuration. For example, the Amazon S3 file location, configuration options that are being sent to the device or fleet.
Note: Attributes can be updated only when the package version is in a draft state.
The combined size of all the attributes on a package version is limited to 3KB.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasAttributes()
method.- Returns:
- Metadata that can be used to define a package version’s configuration. For example, the Amazon S3 file
location, configuration options that are being sent to the device or fleet.
Note: Attributes can be updated only when the package version is in a draft state.
The combined size of all the attributes on a package version is limited to 3KB.
-
action
public final PackageVersionAction action()
The status that the package version should be assigned. For more information, see Package version lifecycle.
If the service returns an enum value that is not available in the current SDK version,
action
will returnPackageVersionAction.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromactionAsString()
.- Returns:
- The status that the package version should be assigned. For more information, see Package version lifecycle.
- See Also:
PackageVersionAction
-
actionAsString
public final String actionAsString()
The status that the package version should be assigned. For more information, see Package version lifecycle.
If the service returns an enum value that is not available in the current SDK version,
action
will returnPackageVersionAction.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromactionAsString()
.- Returns:
- The status that the package version should be assigned. For more information, see Package version lifecycle.
- See Also:
PackageVersionAction
-
clientToken
public final String clientToken()
A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new idempotent request is required.
- Returns:
- A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new idempotent request is required.
-
toBuilder
public UpdatePackageVersionRequest.Builder toBuilder()
- Specified by:
toBuilder
in interfaceToCopyableBuilder<UpdatePackageVersionRequest.Builder,UpdatePackageVersionRequest>
- Specified by:
toBuilder
in classIotRequest
-
builder
public static UpdatePackageVersionRequest.Builder builder()
-
serializableBuilderClass
public static Class<? extends UpdatePackageVersionRequest.Builder> serializableBuilderClass()
-
hashCode
public final int hashCode()
- Overrides:
hashCode
in classAwsRequest
-
equals
public final boolean equals(Object obj)
- Overrides:
equals
in classAwsRequest
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFields
in interfaceSdkPojo
-
toString
public final String 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
public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
- Overrides:
getValueForField
in classSdkRequest
-
-