Class BatchIsAuthorizedWithTokenRequest

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

  • Method Details

    • policyStoreId

      public final String policyStoreId()

      Specifies the ID of the policy store. Policies in this policy store will be used to make an authorization decision for the input.

      Returns:
      Specifies the ID of the policy store. Policies in this policy store will be used to make an authorization decision for the input.

    • identityToken

      public final String identityToken()

      Specifies an identity (ID) token for the principal that you want to authorize in each request. This token is provided to you by the identity provider (IdP) associated with the specified identity source. You must specify either an accessToken, an identityToken, or both.

      Must be an ID token. Verified Permissions returns an error if the token_use claim in the submitted token isn't id.

      Returns:
      Specifies an identity (ID) token for the principal that you want to authorize in each request. This token is provided to you by the identity provider (IdP) associated with the specified identity source. You must specify either an accessToken, an identityToken, or both.

      Must be an ID token. Verified Permissions returns an error if the token_use claim in the submitted token isn't id.

    • accessToken

      public final String accessToken()

      Specifies an access token for the principal that you want to authorize in each request. This token is provided to you by the identity provider (IdP) associated with the specified identity source. You must specify either an accessToken, an identityToken, or both.

      Must be an access token. Verified Permissions returns an error if the token_use claim in the submitted token isn't access.

      Returns:
      Specifies an access token for the principal that you want to authorize in each request. This token is provided to you by the identity provider (IdP) associated with the specified identity source. You must specify either an accessToken, an identityToken, or both.

      Must be an access token. Verified Permissions returns an error if the token_use claim in the submitted token isn't access.

    • entities

      public final EntitiesDefinition entities()

      (Optional) Specifies the list of resources and their associated attributes that Verified Permissions can examine when evaluating the policies. These additional entities and their attributes can be referenced and checked by conditional elements in the policies in the specified policy store.

      You can't include principals in this parameter, only resource and action entities. This parameter can't include any entities of a type that matches the user or group entity types that you defined in your identity source.

      • The BatchIsAuthorizedWithToken operation takes principal attributes from only the identityToken or accessToken passed to the operation.

      • For action entities, you can include only their Identifier and EntityType.

      Returns:
      (Optional) Specifies the list of resources and their associated attributes that Verified Permissions can examine when evaluating the policies. These additional entities and their attributes can be referenced and checked by conditional elements in the policies in the specified policy store.

      You can't include principals in this parameter, only resource and action entities. This parameter can't include any entities of a type that matches the user or group entity types that you defined in your identity source.

      • The BatchIsAuthorizedWithToken operation takes principal attributes from only the identityToken or accessToken passed to the operation.

      • For action entities, you can include only their Identifier and EntityType.

    • hasRequests

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

    • requests

      public final List<BatchIsAuthorizedWithTokenInputItem> requests()

      An array of up to 30 requests that you want Verified Permissions to evaluate.

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

      Returns:
      An array of up to 30 requests that you want Verified Permissions to evaluate.

    • toBuilder

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

    • builder

      public static BatchIsAuthorizedWithTokenRequest.Builder builder()

    • serializableBuilderClass

      public static Class<? extends BatchIsAuthorizedWithTokenRequest.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)
      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: SdkRequest
      Used to retrieve the value of a field from any class that extends SdkRequest. 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 SdkRequest.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkRequest
      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.