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

Class DescribeDashboardPermissionsResponse

java.lang.Object

software.amazon.awssdk.core.SdkResponse

software.amazon.awssdk.awscore.AwsResponse

software.amazon.awssdk.services.quicksight.model.QuickSightResponse

software.amazon.awssdk.services.quicksight.model.DescribeDashboardPermissionsResponse

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<DescribeDashboardPermissionsResponse.Builder,DescribeDashboardPermissionsResponse>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	DescribeDashboardPermissionsResponse.Builder

Method Summary

Modifier and Type	Method	Description
static DescribeDashboardPermissionsResponse.Builder	builder()
String	dashboardArn()	The Amazon Resource Name (ARN) of the dashboard.
String	dashboardId()	The ID for the dashboard.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasPermissions()	For responses, this returns true if the service returned a value for the Permissions property.
LinkSharingConfiguration	linkSharingConfiguration()	A structure that contains the configuration of a shareable link that grants access to the dashboard.
List<ResourcePermission>	permissions()	A structure that contains the permissions for the dashboard.
String	requestId()	The Amazon Web Services request ID for this operation.
List<SdkField<?>>	sdkFields()
static Class<? extends DescribeDashboardPermissionsResponse.Builder>	serializableBuilderClass()
Integer	status()	The HTTP status of the request.
DescribeDashboardPermissionsResponse.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.services.quicksight.model.QuickSightResponse

responseMetadata

Methods inherited from class software.amazon.awssdk.core.SdkResponse

sdkHttpResponse

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

dashboardId

public final String dashboardId()

The ID for the dashboard.

Returns:

The ID for the dashboard.

dashboardArn

public final String dashboardArn()

The Amazon Resource Name (ARN) of the dashboard.

Returns:

The Amazon Resource Name (ARN) of the dashboard.

hasPermissions

public final boolean hasPermissions()

For responses, this returns true if the service returned a value for the Permissions 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.

permissions

public final List<ResourcePermission> permissions()

A structure that contains the permissions for the dashboard.

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

Returns:

A structure that contains the permissions for the dashboard.

status

public final Integer status()

The HTTP status of the request.

Returns:

The HTTP status of the request.

requestId

public final String requestId()

The Amazon Web Services request ID for this operation.

Returns:

The Amazon Web Services request ID for this operation.

linkSharingConfiguration

public final LinkSharingConfiguration linkSharingConfiguration()

A structure that contains the configuration of a shareable link that grants access to the dashboard. Your users can use the link to view and interact with the dashboard, if the dashboard has been shared with them. For more information about sharing dashboards, see Sharing Dashboards.

Returns:

A structure that contains the configuration of a shareable link that grants access to the dashboard. Your users can use the link to view and interact with the dashboard, if the dashboard has been shared with them. For more information about sharing dashboards, see Sharing Dashboards.

toBuilder

public DescribeDashboardPermissionsResponse.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<DescribeDashboardPermissionsResponse.Builder,DescribeDashboardPermissionsResponse>

Specified by:

toBuilder in class AwsResponse

builder

public static DescribeDashboardPermissionsResponse.Builder builder()

serializableBuilderClass

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

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsResponse

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsResponse

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 SdkResponse

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo