PermissionGroup (AWS Java SDK :: Services :: Finspace Data 2.17.292 API)

java.lang.Object
- software.amazon.awssdk.services.finspacedata.model.PermissionGroup

All Implemented Interfaces:: Serializable, SdkPojo, ToCopyableBuilder<PermissionGroup.Builder,PermissionGroup>

@Generated(value="software.amazon.awssdk:codegen")
public final class PermissionGroup
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<PermissionGroup.Builder,PermissionGroup>

The structure for a permission group.

See Also:: Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface PermissionGroup.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`PermissionGroup.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`List<ApplicationPermission>`	`applicationPermissions()` Indicates the permissions that are granted to a specific group for accessing the FinSpace application.
`List<String>`	`applicationPermissionsAsStrings()` Indicates the permissions that are granted to a specific group for accessing the FinSpace application.
`static PermissionGroup.Builder`	`builder()`
`Long`	`createTime()` The timestamp at which the group was created in FinSpace.
`String`	`description()` A brief description for the permission group.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`boolean`	`hasApplicationPermissions()` For responses, this returns true if the service returned a value for the ApplicationPermissions property.
`int`	`hashCode()`
`Long`	`lastModifiedTime()` Describes the last time the permission group was updated.
`PermissionGroupMembershipStatus`	`membershipStatus()` Indicates the status of the user account within a permission group.
`String`	`membershipStatusAsString()` Indicates the status of the user account within a permission group.
`String`	`name()` The name of the permission group.
`String`	`permissionGroupId()` The unique identifier for the permission group.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends PermissionGroup.Builder>`	`serializableBuilderClass()`
`PermissionGroup.Builder`	`toBuilder()`
`String`	`toString()` Returns a string representation of this object.

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
  - permissionGroupId
```
public final String permissionGroupId()
```
    The unique identifier for the permission group.
    
    Returns:
    
    The unique identifier for the permission group.
  - name
```
public final String name()
```
    The name of the permission group.
    
    Returns:
    
    The name of the permission group.
  - description
```
public final String description()
```
    A brief description for the permission group.
    
    Returns:
    
    A brief description for the permission group.
  - applicationPermissions
```
public final List<ApplicationPermission> applicationPermissions()
```
    Indicates the permissions that are granted to a specific group for accessing the FinSpace application.
    
    When assigning application permissions, be aware that the permission ManageUsersAndGroups allows users to grant themselves or others access to any functionality in their FinSpace environment's application. It should only be granted to trusted users.
    - CreateDataset – Group members can create new datasets.
    - ManageClusters – Group members can manage Apache Spark clusters from FinSpace notebooks.
    - ManageUsersAndGroups – Group members can manage users and permission groups. This is a privileged permission that allows users to grant themselves or others access to any functionality in the application. It should only be granted to trusted users.
    - ManageAttributeSets – Group members can manage attribute sets.
    - ViewAuditData – Group members can view audit data.
    - AccessNotebooks – Group members will have access to FinSpace notebooks.
    - GetTemporaryCredentials – Group members can get temporary API credentials.
    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 hasApplicationPermissions() method.
    Returns:
    Indicates the permissions that are granted to a specific group for accessing the FinSpace application.
    
    When assigning application permissions, be aware that the permission ManageUsersAndGroups allows users to grant themselves or others access to any functionality in their FinSpace environment's application. It should only be granted to trusted users.
    
    CreateDataset – Group members can create new datasets.
    
    ManageClusters – Group members can manage Apache Spark clusters from FinSpace notebooks.
    
    ManageUsersAndGroups – Group members can manage users and permission groups. This is a privileged permission that allows users to grant themselves or others access to any functionality in the application. It should only be granted to trusted users.
    
    ManageAttributeSets – Group members can manage attribute sets.
    
    ViewAuditData – Group members can view audit data.
    
    AccessNotebooks – Group members will have access to FinSpace notebooks.
    
    GetTemporaryCredentials – Group members can get temporary API credentials.
  - hasApplicationPermissions
```
public final boolean hasApplicationPermissions()
```
    For responses, this returns true if the service returned a value for the ApplicationPermissions 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.
  - applicationPermissionsAsStrings
```
public final List<String> applicationPermissionsAsStrings()
```
    Indicates the permissions that are granted to a specific group for accessing the FinSpace application.
    
    When assigning application permissions, be aware that the permission ManageUsersAndGroups allows users to grant themselves or others access to any functionality in their FinSpace environment's application. It should only be granted to trusted users.
    - CreateDataset – Group members can create new datasets.
    - ManageClusters – Group members can manage Apache Spark clusters from FinSpace notebooks.
    - ManageUsersAndGroups – Group members can manage users and permission groups. This is a privileged permission that allows users to grant themselves or others access to any functionality in the application. It should only be granted to trusted users.
    - ManageAttributeSets – Group members can manage attribute sets.
    - ViewAuditData – Group members can view audit data.
    - AccessNotebooks – Group members will have access to FinSpace notebooks.
    - GetTemporaryCredentials – Group members can get temporary API credentials.
    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 hasApplicationPermissions() method.
    Returns:
    Indicates the permissions that are granted to a specific group for accessing the FinSpace application.
    
    When assigning application permissions, be aware that the permission ManageUsersAndGroups allows users to grant themselves or others access to any functionality in their FinSpace environment's application. It should only be granted to trusted users.
    
    CreateDataset – Group members can create new datasets.
    
    ManageClusters – Group members can manage Apache Spark clusters from FinSpace notebooks.
    
    ManageUsersAndGroups – Group members can manage users and permission groups. This is a privileged permission that allows users to grant themselves or others access to any functionality in the application. It should only be granted to trusted users.
    
    ManageAttributeSets – Group members can manage attribute sets.
    
    ViewAuditData – Group members can view audit data.
    
    AccessNotebooks – Group members will have access to FinSpace notebooks.
    
    GetTemporaryCredentials – Group members can get temporary API credentials.
  - createTime
```
public final Long createTime()
```
    The timestamp at which the group was created in FinSpace. The value is determined as epoch time in milliseconds.
    
    Returns:
    
    The timestamp at which the group was created in FinSpace. The value is determined as epoch time in milliseconds.
  - lastModifiedTime
```
public final Long lastModifiedTime()
```
    Describes the last time the permission group was updated. The value is determined as epoch time in milliseconds.
    
    Returns:
    
    Describes the last time the permission group was updated. The value is determined as epoch time in milliseconds.
  - membershipStatus
```
public final PermissionGroupMembershipStatus membershipStatus()
```
    Indicates the status of the user account within a permission group.
    - ADDITION_IN_PROGRESS – The user account is currently being added to the permission group.
    - ADDITION_SUCCESS – The user account is successfully added to the permission group.
    - REMOVAL_IN_PROGRESS – The user is currently being removed from the permission group.
    If the service returns an enum value that is not available in the current SDK version, membershipStatus will return PermissionGroupMembershipStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from membershipStatusAsString().
    Returns:
    Indicates the status of the user account within a permission group.
    
    ADDITION_IN_PROGRESS – The user account is currently being added to the permission group.
    
    ADDITION_SUCCESS – The user account is successfully added to the permission group.
    
    REMOVAL_IN_PROGRESS – The user is currently being removed from the permission group.
    See Also:
    
    PermissionGroupMembershipStatus
  - membershipStatusAsString
```
public final String membershipStatusAsString()
```
    Indicates the status of the user account within a permission group.
    - ADDITION_IN_PROGRESS – The user account is currently being added to the permission group.
    - ADDITION_SUCCESS – The user account is successfully added to the permission group.
    - REMOVAL_IN_PROGRESS – The user is currently being removed from the permission group.
    If the service returns an enum value that is not available in the current SDK version, membershipStatus will return PermissionGroupMembershipStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from membershipStatusAsString().
    Returns:
    Indicates the status of the user account within a permission group.
    
    ADDITION_IN_PROGRESS – The user account is currently being added to the permission group.
    
    ADDITION_SUCCESS – The user account is successfully added to the permission group.
    
    REMOVAL_IN_PROGRESS – The user is currently being removed from the permission group.
    See Also:
    
    PermissionGroupMembershipStatus
  - toBuilder
```
public PermissionGroup.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<PermissionGroup.Builder,PermissionGroup>
  - builder
```
public static PermissionGroup.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends PermissionGroup.Builder> serializableBuilderClass()
```
  - hashCode
```
public final int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public final boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - 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)
```
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo

Class PermissionGroup

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

permissionGroupId

name

description

applicationPermissions

hasApplicationPermissions

applicationPermissionsAsStrings

createTime

lastModifiedTime

membershipStatus

membershipStatusAsString

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields