Package software.amazon.awssdk.services.grafana.model

Class ListPermissionsRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.grafana.model.GrafanaRequest

software.amazon.awssdk.services.grafana.model.ListPermissionsRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<ListPermissionsRequest.Builder,ListPermissionsRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	ListPermissionsRequest.Builder

Method Summary

Modifier and Type	Method	Description
static ListPermissionsRequest.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
String	groupId()	(Optional) Limits the results to only the group that matches this ID.
int	hashCode()
Integer	maxResults()	The maximum number of results to include in the response.
String	nextToken()	The token to use when requesting the next set of results.
List<SdkField<?>>	sdkFields()
static Class<? extends ListPermissionsRequest.Builder>	serializableBuilderClass()
ListPermissionsRequest.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
String	userId()	(Optional) Limits the results to only the user that matches this ID.
UserType	userType()	(Optional) If you specify SSO_USER, then only the permissions of IAM Identity Center users are returned.
String	userTypeAsString()	(Optional) If you specify SSO_USER, then only the permissions of IAM Identity Center users are returned.
String	workspaceId()	The ID of the workspace to list permissions for.

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

groupId

public final String groupId()

(Optional) Limits the results to only the group that matches this ID.

Returns:

(Optional) Limits the results to only the group that matches this ID.

maxResults

public final Integer maxResults()

The maximum number of results to include in the response.

Returns:

The maximum number of results to include in the response.

nextToken

public final String nextToken()

The token to use when requesting the next set of results. You received this token from a previous ListPermissions operation.

Returns:

The token to use when requesting the next set of results. You received this token from a previous ListPermissions operation.

userId

public final String userId()

(Optional) Limits the results to only the user that matches this ID.

Returns:

(Optional) Limits the results to only the user that matches this ID.

userType

public final UserType userType()

(Optional) If you specify SSO_USER, then only the permissions of IAM Identity Center users are returned. If you specify SSO_GROUP, only the permissions of IAM Identity Center groups are returned.

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

Returns:

(Optional) If you specify SSO_USER, then only the permissions of IAM Identity Center users are returned. If you specify SSO_GROUP, only the permissions of IAM Identity Center groups are returned.

See Also:

UserType

userTypeAsString

public final String userTypeAsString()

(Optional) If you specify SSO_USER, then only the permissions of IAM Identity Center users are returned. If you specify SSO_GROUP, only the permissions of IAM Identity Center groups are returned.

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

Returns:

(Optional) If you specify SSO_USER, then only the permissions of IAM Identity Center users are returned. If you specify SSO_GROUP, only the permissions of IAM Identity Center groups are returned.

See Also:

UserType

workspaceId

public final String workspaceId()

The ID of the workspace to list permissions for. This parameter is required.

Returns:

The ID of the workspace to list permissions for. This parameter is required.

toBuilder

public ListPermissionsRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<ListPermissionsRequest.Builder,ListPermissionsRequest>

Specified by:

toBuilder in class GrafanaRequest

builder

public static ListPermissionsRequest.Builder builder()

serializableBuilderClass

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