Class GetPolicyResponse

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

  • Method Details

    • policyStoreId

      public final String policyStoreId()

      The ID of the policy store that contains the policy that you want information about.

      Returns:
      The ID of the policy store that contains the policy that you want information about.

    • policyId

      public final String policyId()

      The unique ID of the policy that you want information about.

      Returns:
      The unique ID of the policy that you want information about.

    • policyType

      public final PolicyType policyType()

      The type of the policy.

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

      Returns:
      The type of the policy.
      See Also:

    • policyTypeAsString

      public final String policyTypeAsString()

      The type of the policy.

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

      Returns:
      The type of the policy.
      See Also:

    • principal

      public final EntityIdentifier principal()

      The principal specified in the policy's scope. This element isn't included in the response when Principal isn't present in the policy content.

      Returns:
      The principal specified in the policy's scope. This element isn't included in the response when Principal isn't present in the policy content.

    • resource

      public final EntityIdentifier resource()

      The resource specified in the policy's scope. This element isn't included in the response when Resource isn't present in the policy content.

      Returns:
      The resource specified in the policy's scope. This element isn't included in the response when Resource isn't present in the policy content.

    • hasActions

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

    • actions

      public final List<ActionIdentifier> actions()

      The action that a policy permits or forbids. For example, {"actions": [{"actionId": "ViewPhoto", "actionType": "PhotoFlash::Action"}, {"entityID": "SharePhoto", "entityType": "PhotoFlash::Action"}]} .

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

      Returns:
      The action that a policy permits or forbids. For example, {"actions": [{"actionId": "ViewPhoto", "actionType": "PhotoFlash::Action"}, {"entityID": "SharePhoto", "entityType": "PhotoFlash::Action"}]} .

    • definition

      public final PolicyDefinitionDetail definition()

      The definition of the requested policy.

      Returns:
      The definition of the requested policy.

    • createdDate

      public final Instant createdDate()

      The date and time that the policy was originally created.

      Returns:
      The date and time that the policy was originally created.

    • lastUpdatedDate

      public final Instant lastUpdatedDate()

      The date and time that the policy was last updated.

      Returns:
      The date and time that the policy was last updated.

    • effect

      public final PolicyEffect effect()

      The effect of the decision that a policy returns to an authorization request. For example, "effect": "Permit".

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

      Returns:
      The effect of the decision that a policy returns to an authorization request. For example, "effect": "Permit".
      See Also:

    • effectAsString

      public final String effectAsString()

      The effect of the decision that a policy returns to an authorization request. For example, "effect": "Permit".

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

      Returns:
      The effect of the decision that a policy returns to an authorization request. For example, "effect": "Permit".
      See Also:

    • toBuilder

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

    • builder

      public static GetPolicyResponse.Builder builder()

    • serializableBuilderClass

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