Class ImageBuilderAgentAccessConfigForUpdate

java.lang.Object
software.amazon.awssdk.services.appstream.model.ImageBuilderAgentAccessConfigForUpdate
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<ImageBuilderAgentAccessConfigForUpdate.Builder,ImageBuilderAgentAccessConfigForUpdate>
@Generated("software.amazon.awssdk:codegen") public final class ImageBuilderAgentAccessConfigForUpdate extends Object implements SdkPojo, Serializable, ToCopyableBuilder<ImageBuilderAgentAccessConfigForUpdate.Builder,ImageBuilderAgentAccessConfigForUpdate>

The configuration for updating agent access on an image builder. This type supports partial updates, so you only need to specify the fields you want to change. Fields that you omit keep their stored values.

See Also:

  • Method Details

    • hasSettings

      public final boolean hasSettings()
      For responses, this returns true if the service returned a value for the Settings 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.

    • settings

      public final List<AgentAccessSetting> settings()

      The list of agent access settings that define permissions for each agent action. These settings are merged with the stored settings by agent action. A setting that you specify replaces the stored setting for the same agent action. The merged settings must have at least one agent action enabled.

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

      Returns:
      The list of agent access settings that define permissions for each agent action. These settings are merged with the stored settings by agent action. A setting that you specify replaces the stored setting for the same agent action. The merged settings must have at least one agent action enabled.

    • s3BucketArn

      public final String s3BucketArn()

      The Amazon Resource Name (ARN) of the Amazon S3 bucket where agent screenshots are stored. If ScreenshotsUploadEnabled is false after the merge, the stored bucket ARN is removed.

      Returns:
      The Amazon Resource Name (ARN) of the Amazon S3 bucket where agent screenshots are stored. If ScreenshotsUploadEnabled is false after the merge, the stored bucket ARN is removed.

    • screenshotsUploadEnabled

      public final Boolean screenshotsUploadEnabled()

      Specifies whether screenshot uploads to Amazon S3 are enabled for agent sessions.

      Returns:
      Specifies whether screenshot uploads to Amazon S3 are enabled for agent sessions.

    • screenResolution

      public final ScreenResolution screenResolution()

      The screen resolution for the agent streaming environment.

      • W_1280xH_720 - 1280 x 720 pixels.

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

      Returns:
      The screen resolution for the agent streaming environment.

      • W_1280xH_720 - 1280 x 720 pixels.

      See Also:

    • screenResolutionAsString

      public final String screenResolutionAsString()

      The screen resolution for the agent streaming environment.

      • W_1280xH_720 - 1280 x 720 pixels.

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

      Returns:
      The screen resolution for the agent streaming environment.

      • W_1280xH_720 - 1280 x 720 pixels.

      See Also:

    • screenImageFormat

      public final ScreenImageFormat screenImageFormat()

      The image format for agent screen captures.

      • PNG - PNG format.

      • JPEG - JPEG format.

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

      Returns:
      The image format for agent screen captures.

      • PNG - PNG format.

      • JPEG - JPEG format.

      See Also:

    • screenImageFormatAsString

      public final String screenImageFormatAsString()

      The image format for agent screen captures.

      • PNG - PNG format.

      • JPEG - JPEG format.

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

      Returns:
      The image format for agent screen captures.

      • PNG - PNG format.

      • JPEG - JPEG format.

      See Also:

    • userControlMode

      public final UserControlMode userControlMode()

      The user control mode for agent sessions. This setting determines how users can interact with agent sessions.

      • VIEW_ONLY - Users can view and observe agent actions as they happen.

      • VIEW_STOP - Users can view agent actions and stop the agent if needed.

      • DISABLED - Users cannot view or stop the agent session.

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

      Returns:
      The user control mode for agent sessions. This setting determines how users can interact with agent sessions.

      • VIEW_ONLY - Users can view and observe agent actions as they happen.

      • VIEW_STOP - Users can view agent actions and stop the agent if needed.

      • DISABLED - Users cannot view or stop the agent session.

      See Also:

    • userControlModeAsString

      public final String userControlModeAsString()

      The user control mode for agent sessions. This setting determines how users can interact with agent sessions.

      • VIEW_ONLY - Users can view and observe agent actions as they happen.

      • VIEW_STOP - Users can view agent actions and stop the agent if needed.

      • DISABLED - Users cannot view or stop the agent session.

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

      Returns:
      The user control mode for agent sessions. This setting determines how users can interact with agent sessions.

      • VIEW_ONLY - Users can view and observe agent actions as they happen.

      • VIEW_STOP - Users can view agent actions and stop the agent if needed.

      • DISABLED - Users cannot view or stop the agent session.

      See Also:

    • toBuilder

      public ImageBuilderAgentAccessConfigForUpdate.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<ImageBuilderAgentAccessConfigForUpdate.Builder,ImageBuilderAgentAccessConfigForUpdate>
      Returns:
      a builder for type T

    • builder

      public static ImageBuilderAgentAccessConfigForUpdate.Builder builder()

    • serializableBuilderClass

      public static Class<? extends ImageBuilderAgentAccessConfigForUpdate.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)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.