software.amazon.awssdk.services.quicksight.model

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(value="software.amazon.awssdk:codegen")
public final class UpdateDashboardPermissionsRequest
extends QuickSightRequest
implements ToCopyableBuilder<UpdateDashboardPermissionsRequest.Builder,UpdateDashboardPermissionsRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	UpdateDashboardPermissionsRequest.Builder

Method Summary

Modifier and Type	Method and Description
String	awsAccountId() The ID of the Amazon Web Services account that contains the dashboard whose permissions you're updating.
static UpdateDashboardPermissionsRequest.Builder	builder()
String	dashboardId() The ID for the dashboard.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
List<ResourcePermission>	grantLinkPermissions() Grants link permissions to all users in a defined namespace.
List<ResourcePermission>	grantPermissions() The permissions that you want to grant on this resource.
boolean	hasGrantLinkPermissions() For responses, this returns true if the service returned a value for the GrantLinkPermissions property.
boolean	hasGrantPermissions() For responses, this returns true if the service returned a value for the GrantPermissions property.
int	hashCode()
boolean	hasRevokeLinkPermissions() For responses, this returns true if the service returned a value for the RevokeLinkPermissions property.
boolean	hasRevokePermissions() For responses, this returns true if the service returned a value for the RevokePermissions property.
List<ResourcePermission>	revokeLinkPermissions() Revokes link permissions from all users in a defined namespace.
List<ResourcePermission>	revokePermissions() The permissions that you want to revoke from this resource.
List<SdkField<?>>	sdkFields()
static Class<? extends UpdateDashboardPermissionsRequest.Builder>	serializableBuilderClass()
UpdateDashboardPermissionsRequest.Builder	toBuilder()
String	toString() Returns a string representation of this object.

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

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()

Specified by:

toBuilder in interface ToCopyableBuilder<UpdateDashboardPermissionsRequest.Builder,UpdateDashboardPermissionsRequest>

Specified by:

toBuilder in class QuickSightRequest

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)

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