Class ModifySnapshotAttributeRequest
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<ModifySnapshotAttributeRequest.Builder,
ModifySnapshotAttributeRequest>
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionfinal SnapshotAttributeName
The snapshot attribute to modify.final String
The snapshot attribute to modify.builder()
A JSON representation of the snapshot attribute modification.final Boolean
dryRun()
Checks whether you have the required permissions for the action, without actually making the request, and provides an error response.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
.The group to modify for the snapshot.final boolean
For responses, this returns true if the service returned a value for the GroupNames property.final int
hashCode()
final boolean
For responses, this returns true if the service returned a value for the UserIds property.final OperationType
The type of operation to perform to the attribute.final String
The type of operation to perform to the attribute.static Class
<? extends ModifySnapshotAttributeRequest.Builder> final String
The ID of the snapshot.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.userIds()
The account ID to modify for the snapshot.Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
attribute
The snapshot attribute to modify. Only volume creation permissions can be modified.
If the service returns an enum value that is not available in the current SDK version,
attribute
will returnSnapshotAttributeName.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromattributeAsString()
.- Returns:
- The snapshot attribute to modify. Only volume creation permissions can be modified.
- See Also:
-
attributeAsString
The snapshot attribute to modify. Only volume creation permissions can be modified.
If the service returns an enum value that is not available in the current SDK version,
attribute
will returnSnapshotAttributeName.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromattributeAsString()
.- Returns:
- The snapshot attribute to modify. Only volume creation permissions can be modified.
- See Also:
-
createVolumePermission
A JSON representation of the snapshot attribute modification.
- Returns:
- A JSON representation of the snapshot attribute modification.
-
hasGroupNames
public final boolean hasGroupNames()For responses, this returns true if the service returned a value for the GroupNames 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. -
groupNames
The group to modify for the snapshot.
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
hasGroupNames()
method.- Returns:
- The group to modify for the snapshot.
-
operationType
The type of operation to perform to the attribute.
If the service returns an enum value that is not available in the current SDK version,
operationType
will returnOperationType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromoperationTypeAsString()
.- Returns:
- The type of operation to perform to the attribute.
- See Also:
-
operationTypeAsString
The type of operation to perform to the attribute.
If the service returns an enum value that is not available in the current SDK version,
operationType
will returnOperationType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromoperationTypeAsString()
.- Returns:
- The type of operation to perform to the attribute.
- See Also:
-
snapshotId
The ID of the snapshot.
- Returns:
- The ID of the snapshot.
-
hasUserIds
public final boolean hasUserIds()For responses, this returns true if the service returned a value for the UserIds 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. -
userIds
The account ID to modify for the snapshot.
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
hasUserIds()
method.- Returns:
- The account ID to modify for the snapshot.
-
dryRun
Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is
DryRunOperation
. Otherwise, it isUnauthorizedOperation
.- Returns:
- Checks whether you have the required permissions for the action, without actually making the request, and
provides an error response. If you have the required permissions, the error response is
DryRunOperation
. Otherwise, it isUnauthorizedOperation
.
-
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<ModifySnapshotAttributeRequest.Builder,
ModifySnapshotAttributeRequest> - Specified by:
toBuilder
in classEc2Request
- 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
-