Class ModifyDocumentPermissionRequest

java.lang.Object
software.amazon.awssdk.core.SdkRequest
software.amazon.awssdk.awscore.AwsRequest
software.amazon.awssdk.services.ssm.model.SsmRequest
software.amazon.awssdk.services.ssm.model.ModifyDocumentPermissionRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<ModifyDocumentPermissionRequest.Builder,ModifyDocumentPermissionRequest>
@Generated("software.amazon.awssdk:codegen") public final class ModifyDocumentPermissionRequest extends SsmRequest implements ToCopyableBuilder<ModifyDocumentPermissionRequest.Builder,ModifyDocumentPermissionRequest>

  • Method Details

    • name

      public final String name()

      The name of the document that you want to share.

      Returns:
      The name of the document that you want to share.

    • permissionType

      public final DocumentPermissionType permissionType()

      The permission type for the document. The permission type can be Share.

      If the service returns an enum value that is not available in the current SDK version, permissionType will return DocumentPermissionType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from permissionTypeAsString().

      Returns:
      The permission type for the document. The permission type can be Share.
      See Also:

    • permissionTypeAsString

      public final String permissionTypeAsString()

      The permission type for the document. The permission type can be Share.

      If the service returns an enum value that is not available in the current SDK version, permissionType will return DocumentPermissionType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from permissionTypeAsString().

      Returns:
      The permission type for the document. The permission type can be Share.
      See Also:

    • hasAccountIdsToAdd

      public final boolean hasAccountIdsToAdd()
      For responses, this returns true if the service returned a value for the AccountIdsToAdd 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.

    • accountIdsToAdd

      public final List<String> accountIdsToAdd()

      The Amazon Web Services users that should have access to the document. The account IDs can either be a group of account IDs or All. You must specify a value for this parameter or the AccountIdsToRemove parameter.

      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 hasAccountIdsToAdd() method.

      Returns:
      The Amazon Web Services users that should have access to the document. The account IDs can either be a group of account IDs or All. You must specify a value for this parameter or the AccountIdsToRemove parameter.

    • hasAccountIdsToRemove

      public final boolean hasAccountIdsToRemove()
      For responses, this returns true if the service returned a value for the AccountIdsToRemove 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.

    • accountIdsToRemove

      public final List<String> accountIdsToRemove()

      The Amazon Web Services users that should no longer have access to the document. The Amazon Web Services user can either be a group of account IDs or All. This action has a higher priority than AccountIdsToAdd. If you specify an ID to add and the same ID to remove, the system removes access to the document. You must specify a value for this parameter or the AccountIdsToAdd parameter.

      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 hasAccountIdsToRemove() method.

      Returns:
      The Amazon Web Services users that should no longer have access to the document. The Amazon Web Services user can either be a group of account IDs or All. This action has a higher priority than AccountIdsToAdd. If you specify an ID to add and the same ID to remove, the system removes access to the document. You must specify a value for this parameter or the AccountIdsToAdd parameter.

    • sharedDocumentVersion

      public final String sharedDocumentVersion()

      (Optional) The version of the document to share. If it isn't specified, the system choose the Default version to share.

      Returns:
      (Optional) The version of the document to share. If it isn't specified, the system choose the Default version to share.

    • toBuilder

      public ModifyDocumentPermissionRequest.Builder 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 interface ToCopyableBuilder<ModifyDocumentPermissionRequest.Builder,ModifyDocumentPermissionRequest>
      Specified by:
      toBuilder in class SsmRequest
      Returns:
      a builder for type T

    • builder

      public static ModifyDocumentPermissionRequest.Builder builder()

    • serializableBuilderClass

      public static Class<? extends ModifyDocumentPermissionRequest.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)
      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 an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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)
      Description copied from class: SdkRequest
      Used to retrieve the value of a field from any class that extends SdkRequest. 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, the SdkRequest.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkRequest
      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

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.