Class UpdateDashboardPermissionsRequest

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

  • Method Details

    • awsAccountId

      public final String awsAccountId()

      The ID of the Amazon Web Services account that contains the dashboard whose permissions you're updating.

      Returns:
      The ID of the Amazon Web Services account that contains the dashboard whose permissions you're updating.

    • dashboardId

      public final String dashboardId()

      The ID for the dashboard.

      Returns:
      The ID for the dashboard.

    • hasGrantPermissions

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

    • grantPermissions

      public final List<ResourcePermission> grantPermissions()

      The permissions that you want to grant on this resource.

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

      Returns:
      The permissions that you want to grant on this resource.

    • hasRevokePermissions

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

    • revokePermissions

      public final List<ResourcePermission> revokePermissions()

      The permissions that you want to revoke from this resource.

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

      Returns:
      The permissions that you want to revoke from this resource.

    • hasGrantLinkPermissions

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

    • grantLinkPermissions

      public final List<ResourcePermission> grantLinkPermissions()

      Grants link permissions to all users in a defined namespace.

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

      Returns:
      Grants link permissions to all users in a defined namespace.

    • hasRevokeLinkPermissions

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

    • revokeLinkPermissions

      public final List<ResourcePermission> revokeLinkPermissions()

      Revokes link permissions from all users in a defined namespace.

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

      Returns:
      Revokes link permissions from all users in a defined namespace.

    • toBuilder

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

    • builder

      public static UpdateDashboardPermissionsRequest.Builder builder()

    • serializableBuilderClass

      public static Class<? extends UpdateDashboardPermissionsRequest.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.