Package software.amazon.awssdk.services.quicksight.model

Class UpdateAnalysisPermissionsRequest

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.UpdateAnalysisPermissionsRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<UpdateAnalysisPermissionsRequest.Builder,UpdateAnalysisPermissionsRequest>

@Generated("software.amazon.awssdk:codegen")
public final class UpdateAnalysisPermissionsRequest
extends QuickSightRequest
implements ToCopyableBuilder<UpdateAnalysisPermissionsRequest.Builder,UpdateAnalysisPermissionsRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	UpdateAnalysisPermissionsRequest.Builder

Method Summary

Modifier and Type	Method	Description
String	analysisId()	The ID of the analysis whose permissions you're updating.
String	awsAccountId()	The ID of the Amazon Web Services account that contains the analysis whose permissions you're updating.
static UpdateAnalysisPermissionsRequest.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
List<ResourcePermission>	grantPermissions()	A structure that describes the permissions to add and the principal to add them to.
boolean	hasGrantPermissions()	For responses, this returns true if the service returned a value for the GrantPermissions property.
int	hashCode()
boolean	hasRevokePermissions()	For responses, this returns true if the service returned a value for the RevokePermissions property.
List<ResourcePermission>	revokePermissions()	A structure that describes the permissions to remove and the principal to remove them from.
List<SdkField<?>>	sdkFields()
static Class<? extends UpdateAnalysisPermissionsRequest.Builder>	serializableBuilderClass()
UpdateAnalysisPermissionsRequest.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 analysis whose permissions you're updating. You must be using the Amazon Web Services account that the analysis is in.

Returns:

The ID of the Amazon Web Services account that contains the analysis whose permissions you're updating. You must be using the Amazon Web Services account that the analysis is in.

analysisId

public final String analysisId()

The ID of the analysis whose permissions you're updating. The ID is part of the analysis URL.

Returns:

The ID of the analysis whose permissions you're updating. The ID is part of the analysis URL.

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

A structure that describes the permissions to add and the principal to add them to.

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:

A structure that describes the permissions to add and the principal to add them to.

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

A structure that describes the permissions to remove and the principal to remove them from.

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:

A structure that describes the permissions to remove and the principal to remove them from.

toBuilder

public UpdateAnalysisPermissionsRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<UpdateAnalysisPermissionsRequest.Builder,UpdateAnalysisPermissionsRequest>

Specified by:

toBuilder in class QuickSightRequest

builder

public static UpdateAnalysisPermissionsRequest.Builder builder()

serializableBuilderClass

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