Package software.amazon.awssdk.services.ec2.model

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>

  • Method Details

    • 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 return SnapshotAttributeName.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from attributeAsString().

      Returns:
      The snapshot attribute to modify. Only volume creation permissions can be modified.
      See Also:

    • 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 return SnapshotAttributeName.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from attributeAsString().

      Returns:
      The snapshot attribute to modify. Only volume creation permissions can be modified.
      See Also:

    • 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 the isEmpty() 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 return OperationType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from operationTypeAsString().

      Returns:
      The type of operation to perform to the attribute.
      See Also:

    • 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 return OperationType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from operationTypeAsString().

      Returns:
      The type of operation to perform to the attribute.
      See Also:

    • 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 the isEmpty() 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 is UnauthorizedOperation.

      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 is UnauthorizedOperation.

    • toBuilder

      public ModifySnapshotAttributeRequest.Builder toBuilder()
      Specified by:
      toBuilder in interface ToCopyableBuilder<ModifySnapshotAttributeRequest.Builder,ModifySnapshotAttributeRequest>
      Specified by:
      toBuilder in class Ec2Request

    • builder

      public static ModifySnapshotAttributeRequest.Builder builder()

    • serializableBuilderClass

      public static Class<? extends ModifySnapshotAttributeRequest.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class AwsRequest

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class AwsRequest

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Specified by:
      equalsBySdkFields in interface SdkPojo

    • 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.
      Overrides:
      toString in class Object

    • getValueForField

      public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
      Overrides:
      getValueForField in class SdkRequest

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo