Class ModifySnapshotAttributeRequest
- java.lang.Object
-
- software.amazon.awssdk.core.SdkRequest
-
- software.amazon.awssdk.awscore.AwsRequest
-
- software.amazon.awssdk.services.ec2.model.Ec2Request
-
- software.amazon.awssdk.services.ec2.model.ModifySnapshotAttributeRequest
-
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<ModifySnapshotAttributeRequest.Builder,ModifySnapshotAttributeRequest>
@Generated("software.amazon.awssdk:codegen") public final class ModifySnapshotAttributeRequest extends Ec2Request implements ToCopyableBuilder<ModifySnapshotAttributeRequest.Builder,ModifySnapshotAttributeRequest>
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interface
ModifySnapshotAttributeRequest.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description SnapshotAttributeName
attribute()
The snapshot attribute to modify.String
attributeAsString()
The snapshot attribute to modify.static ModifySnapshotAttributeRequest.Builder
builder()
CreateVolumePermissionModifications
createVolumePermission()
A JSON representation of the snapshot attribute modification.Boolean
dryRun()
Checks whether you have the required permissions for the action, without actually making the request, and provides an error response.boolean
equals(Object obj)
boolean
equalsBySdkFields(Object obj)
<T> Optional<T>
getValueForField(String fieldName, Class<T> clazz)
List<String>
groupNames()
The group to modify for the snapshot.boolean
hasGroupNames()
For responses, this returns true if the service returned a value for the GroupNames property.int
hashCode()
boolean
hasUserIds()
For responses, this returns true if the service returned a value for the UserIds property.OperationType
operationType()
The type of operation to perform to the attribute.String
operationTypeAsString()
The type of operation to perform to the attribute.List<SdkField<?>>
sdkFields()
static Class<? extends ModifySnapshotAttributeRequest.Builder>
serializableBuilderClass()
String
snapshotId()
The ID of the snapshot.ModifySnapshotAttributeRequest.Builder
toBuilder()
String
toString()
Returns a string representation of this object.List<String>
userIds()
The account ID to modify for the snapshot.-
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
-
attribute
public final SnapshotAttributeName 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:
SnapshotAttributeName
-
attributeAsString
public final String 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:
SnapshotAttributeName
-
createVolumePermission
public final CreateVolumePermissionModifications 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
public final List<String> 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
public final OperationType 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:
OperationType
-
operationTypeAsString
public final String 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:
OperationType
-
snapshotId
public final String 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
public final List<String> 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
public final Boolean 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
public ModifySnapshotAttributeRequest.Builder toBuilder()
- Specified by:
toBuilder
in interfaceToCopyableBuilder<ModifySnapshotAttributeRequest.Builder,ModifySnapshotAttributeRequest>
- Specified by:
toBuilder
in classEc2Request
-
builder
public static ModifySnapshotAttributeRequest.Builder builder()
-
serializableBuilderClass
public static Class<? extends ModifySnapshotAttributeRequest.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
-
-