Class GetSessionResponse

java.lang.Object
software.amazon.awssdk.core.SdkResponse
software.amazon.awssdk.awscore.AwsResponse
software.amazon.awssdk.services.mpa.model.MpaResponse
software.amazon.awssdk.services.mpa.model.GetSessionResponse
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<GetSessionResponse.Builder,GetSessionResponse>
@Generated("software.amazon.awssdk:codegen") public final class GetSessionResponse extends MpaResponse implements ToCopyableBuilder<GetSessionResponse.Builder,GetSessionResponse>

  • Method Details

    • sessionArn

      public final String sessionArn()

      Amazon Resource Name (ARN) for the session.

      Returns:
      Amazon Resource Name (ARN) for the session.

    • approvalTeamArn

      public final String approvalTeamArn()

      Amazon Resource Name (ARN) for the approval team.

      Returns:
      Amazon Resource Name (ARN) for the approval team.

    • approvalTeamName

      public final String approvalTeamName()

      Name of the approval team.

      Returns:
      Name of the approval team.

    • protectedResourceArn

      public final String protectedResourceArn()

      Amazon Resource Name (ARN) for the protected operation.

      Returns:
      Amazon Resource Name (ARN) for the protected operation.

    • approvalStrategy

      public final ApprovalStrategyResponse approvalStrategy()

      An ApprovalStrategyResponse object. Contains details for how the team grants approval

      Returns:
      An ApprovalStrategyResponse object. Contains details for how the team grants approval

    • numberOfApprovers

      public final Integer numberOfApprovers()

      Total number of approvers in the session.

      Returns:
      Total number of approvers in the session.

    • initiationTime

      public final Instant initiationTime()

      Timestamp when the session was initiated.

      Returns:
      Timestamp when the session was initiated.

    • expirationTime

      public final Instant expirationTime()

      Timestamp when the session will expire.

      Returns:
      Timestamp when the session will expire.

    • completionTime

      public final Instant completionTime()

      Timestamp when the session completed.

      Returns:
      Timestamp when the session completed.

    • description

      public final String description()

      Description for the session.

      Returns:
      Description for the session.

    • hasMetadata

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

    • metadata

      public final Map<String,String> metadata()

      Metadata for the session.

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

      Returns:
      Metadata for the session.

    • status

      public final SessionStatus status()

      Status for the session. For example, if the team has approved the requested operation.

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

      Returns:
      Status for the session. For example, if the team has approved the requested operation.
      See Also:

    • statusAsString

      public final String statusAsString()

      Status for the session. For example, if the team has approved the requested operation.

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

      Returns:
      Status for the session. For example, if the team has approved the requested operation.
      See Also:

    • statusCode

      public final SessionStatusCode statusCode()

      Status code of the session.

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

      Returns:
      Status code of the session.
      See Also:

    • statusCodeAsString

      public final String statusCodeAsString()

      Status code of the session.

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

      Returns:
      Status code of the session.
      See Also:

    • statusMessage

      public final String statusMessage()

      Message describing the status for session.

      Returns:
      Message describing the status for session.

    • executionStatus

      public final SessionExecutionStatus executionStatus()

      Status for the protected operation. For example, if the operation is PENDING.

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

      Returns:
      Status for the protected operation. For example, if the operation is PENDING.
      See Also:

    • executionStatusAsString

      public final String executionStatusAsString()

      Status for the protected operation. For example, if the operation is PENDING.

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

      Returns:
      Status for the protected operation. For example, if the operation is PENDING.
      See Also:

    • actionName

      public final String actionName()

      Name of the protected operation.

      Returns:
      Name of the protected operation.

    • requesterServicePrincipal

      public final String requesterServicePrincipal()

      Service principal for the service associated with the protected operation.

      Returns:
      Service principal for the service associated with the protected operation.

    • requesterPrincipalArn

      public final String requesterPrincipalArn()

      IAM principal that made the operation request.

      Returns:
      IAM principal that made the operation request.

    • requesterAccountId

      public final String requesterAccountId()

      ID for the account that made the operation request.

      Returns:
      ID for the account that made the operation request.

    • requesterRegion

      public final String requesterRegion()

      Amazon Web Services Region where the operation request originated.

      Returns:
      Amazon Web Services Region where the operation request originated.

    • requesterComment

      public final String requesterComment()

      Message from the account that made the operation request

      Returns:
      Message from the account that made the operation request

    • actionCompletionStrategy

      public final ActionCompletionStrategy actionCompletionStrategy()

      Strategy for executing the protected operation. AUTO_COMPLETION_UPON_APPROVAL means the operation is automatically executed using the requester's permissions, if approved.

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

      Returns:
      Strategy for executing the protected operation. AUTO_COMPLETION_UPON_APPROVAL means the operation is automatically executed using the requester's permissions, if approved.
      See Also:

    • actionCompletionStrategyAsString

      public final String actionCompletionStrategyAsString()

      Strategy for executing the protected operation. AUTO_COMPLETION_UPON_APPROVAL means the operation is automatically executed using the requester's permissions, if approved.

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

      Returns:
      Strategy for executing the protected operation. AUTO_COMPLETION_UPON_APPROVAL means the operation is automatically executed using the requester's permissions, if approved.
      See Also:

    • hasApproverResponses

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

    • approverResponses

      public final List<GetSessionResponseApproverResponse> approverResponses()

      An array of GetSessionResponseApproverResponse objects. Contains details for approver responses in the session.

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

      Returns:
      An array of GetSessionResponseApproverResponse objects. Contains details for approver responses in the session.

    • toBuilder

      public GetSessionResponse.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<GetSessionResponse.Builder,GetSessionResponse>
      Specified by:
      toBuilder in class AwsResponse
      Returns:
      a builder for type T

    • builder

      public static GetSessionResponse.Builder builder()

    • serializableBuilderClass

      public static Class<? extends GetSessionResponse.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)
      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)
      Description copied from class: SdkResponse
      Used to retrieve the value of a field from any class that extends SdkResponse. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkResponse.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkResponse
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value

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