software.amazon.awssdk.services.verifiedpermissions.model.BatchIsAuthorizedWithTokenRequest Maven / Gradle / Ivy
Show all versions of verifiedpermissions Show documentation
/*
* Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
* the License. A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
* CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
* and limitations under the License.
*/
package software.amazon.awssdk.services.verifiedpermissions.model;
import java.util.Arrays;
import java.util.Collection;
import java.util.Collections;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import java.util.Objects;
import java.util.Optional;
import java.util.function.BiConsumer;
import java.util.function.Consumer;
import java.util.function.Function;
import java.util.stream.Collectors;
import java.util.stream.Stream;
import software.amazon.awssdk.annotations.Generated;
import software.amazon.awssdk.awscore.AwsRequestOverrideConfiguration;
import software.amazon.awssdk.core.SdkField;
import software.amazon.awssdk.core.SdkPojo;
import software.amazon.awssdk.core.protocol.MarshallLocation;
import software.amazon.awssdk.core.protocol.MarshallingType;
import software.amazon.awssdk.core.traits.ListTrait;
import software.amazon.awssdk.core.traits.LocationTrait;
import software.amazon.awssdk.core.util.DefaultSdkAutoConstructList;
import software.amazon.awssdk.core.util.SdkAutoConstructList;
import software.amazon.awssdk.utils.ToString;
import software.amazon.awssdk.utils.builder.CopyableBuilder;
import software.amazon.awssdk.utils.builder.ToCopyableBuilder;
/**
*/
@Generated("software.amazon.awssdk:codegen")
public final class BatchIsAuthorizedWithTokenRequest extends VerifiedPermissionsRequest implements
ToCopyableBuilder {
private static final SdkField POLICY_STORE_ID_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("policyStoreId").getter(getter(BatchIsAuthorizedWithTokenRequest::policyStoreId))
.setter(setter(Builder::policyStoreId))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("policyStoreId").build()).build();
private static final SdkField IDENTITY_TOKEN_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("identityToken").getter(getter(BatchIsAuthorizedWithTokenRequest::identityToken))
.setter(setter(Builder::identityToken))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("identityToken").build()).build();
private static final SdkField ACCESS_TOKEN_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("accessToken").getter(getter(BatchIsAuthorizedWithTokenRequest::accessToken))
.setter(setter(Builder::accessToken))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("accessToken").build()).build();
private static final SdkField ENTITIES_FIELD = SdkField
. builder(MarshallingType.SDK_POJO).memberName("entities")
.getter(getter(BatchIsAuthorizedWithTokenRequest::entities)).setter(setter(Builder::entities))
.constructor(EntitiesDefinition::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("entities").build()).build();
private static final SdkField> REQUESTS_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("requests")
.getter(getter(BatchIsAuthorizedWithTokenRequest::requests))
.setter(setter(Builder::requests))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("requests").build(),
ListTrait
.builder()
.memberLocationName(null)
.memberFieldInfo(
SdkField. builder(MarshallingType.SDK_POJO)
.constructor(BatchIsAuthorizedWithTokenInputItem::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("member").build()).build()).build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(POLICY_STORE_ID_FIELD,
IDENTITY_TOKEN_FIELD, ACCESS_TOKEN_FIELD, ENTITIES_FIELD, REQUESTS_FIELD));
private static final Map> SDK_NAME_TO_FIELD = memberNameToFieldInitializer();
private final String policyStoreId;
private final String identityToken;
private final String accessToken;
private final EntitiesDefinition entities;
private final List requests;
private BatchIsAuthorizedWithTokenRequest(BuilderImpl builder) {
super(builder);
this.policyStoreId = builder.policyStoreId;
this.identityToken = builder.identityToken;
this.accessToken = builder.accessToken;
this.entities = builder.entities;
this.requests = builder.requests;
}
/**
*
* Specifies the ID of the policy store. Policies in this policy store will be used to make an authorization
* decision for the input.
*
*
* @return Specifies the ID of the policy store. Policies in this policy store will be used to make an authorization
* decision for the input.
*/
public final String policyStoreId() {
return policyStoreId;
}
/**
*
* 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.
*
*
* @return 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.
*/
public final String identityToken() {
return identityToken;
}
/**
*
* 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.
*
*
* @return 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.
*/
public final String accessToken() {
return accessToken;
}
/**
*
* Specifies the list of resources and their associated attributes that Verified Permissions can examine when
* evaluating the policies.
*
*
*
* 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.
*
*
*
*
*
* @return Specifies the list of resources and their associated attributes that Verified Permissions can examine
* when evaluating the policies.
*
* 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.
*
*
*
*/
public final EntitiesDefinition entities() {
return entities;
}
/**
* 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 {@code 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.
*/
public final boolean hasRequests() {
return requests != null && !(requests instanceof SdkAutoConstructList);
}
/**
*
* 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 {@link #hasRequests} method.
*
*
* @return An array of up to 30 requests that you want Verified Permissions to evaluate.
*/
public final List requests() {
return requests;
}
@Override
public Builder toBuilder() {
return new BuilderImpl(this);
}
public static Builder builder() {
return new BuilderImpl();
}
public static Class serializableBuilderClass() {
return BuilderImpl.class;
}
@Override
public final int hashCode() {
int hashCode = 1;
hashCode = 31 * hashCode + super.hashCode();
hashCode = 31 * hashCode + Objects.hashCode(policyStoreId());
hashCode = 31 * hashCode + Objects.hashCode(identityToken());
hashCode = 31 * hashCode + Objects.hashCode(accessToken());
hashCode = 31 * hashCode + Objects.hashCode(entities());
hashCode = 31 * hashCode + Objects.hashCode(hasRequests() ? requests() : null);
return hashCode;
}
@Override
public final boolean equals(Object obj) {
return super.equals(obj) && equalsBySdkFields(obj);
}
@Override
public final boolean equalsBySdkFields(Object obj) {
if (this == obj) {
return true;
}
if (obj == null) {
return false;
}
if (!(obj instanceof BatchIsAuthorizedWithTokenRequest)) {
return false;
}
BatchIsAuthorizedWithTokenRequest other = (BatchIsAuthorizedWithTokenRequest) obj;
return Objects.equals(policyStoreId(), other.policyStoreId()) && Objects.equals(identityToken(), other.identityToken())
&& Objects.equals(accessToken(), other.accessToken()) && Objects.equals(entities(), other.entities())
&& hasRequests() == other.hasRequests() && Objects.equals(requests(), other.requests());
}
/**
* 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.
*/
@Override
public final String toString() {
return ToString.builder("BatchIsAuthorizedWithTokenRequest").add("PolicyStoreId", policyStoreId())
.add("IdentityToken", identityToken() == null ? null : "*** Sensitive Data Redacted ***")
.add("AccessToken", accessToken() == null ? null : "*** Sensitive Data Redacted ***").add("Entities", entities())
.add("Requests", hasRequests() ? requests() : null).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "policyStoreId":
return Optional.ofNullable(clazz.cast(policyStoreId()));
case "identityToken":
return Optional.ofNullable(clazz.cast(identityToken()));
case "accessToken":
return Optional.ofNullable(clazz.cast(accessToken()));
case "entities":
return Optional.ofNullable(clazz.cast(entities()));
case "requests":
return Optional.ofNullable(clazz.cast(requests()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
@Override
public final Map> sdkFieldNameToField() {
return SDK_NAME_TO_FIELD;
}
private static Map> memberNameToFieldInitializer() {
Map> map = new HashMap<>();
map.put("policyStoreId", POLICY_STORE_ID_FIELD);
map.put("identityToken", IDENTITY_TOKEN_FIELD);
map.put("accessToken", ACCESS_TOKEN_FIELD);
map.put("entities", ENTITIES_FIELD);
map.put("requests", REQUESTS_FIELD);
return Collections.unmodifiableMap(map);
}
private static Function getter(Function g) {
return obj -> g.apply((BatchIsAuthorizedWithTokenRequest) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends VerifiedPermissionsRequest.Builder, SdkPojo,
CopyableBuilder {
/**
*
* Specifies the ID of the policy store. Policies in this policy store will be used to make an authorization
* decision for the input.
*
*
* @param policyStoreId
* Specifies the ID of the policy store. Policies in this policy store will be used to make an
* authorization decision for the input.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder policyStoreId(String policyStoreId);
/**
*
* 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.
*
*
* @param 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.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder identityToken(String identityToken);
/**
*
* 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.
*
*
* @param 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.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder accessToken(String accessToken);
/**
*
* Specifies the list of resources and their associated attributes that Verified Permissions can examine when
* evaluating the policies.
*
*
*
* 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.
*
*
*
*
*
* @param entities
* Specifies the list of resources and their associated attributes that Verified Permissions can examine
* when evaluating the policies.
*
* 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.
*
*
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder entities(EntitiesDefinition entities);
/**
*
* Specifies the list of resources and their associated attributes that Verified Permissions can examine when
* evaluating the policies.
*
*
*
* 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.
*
*
*
* This is a convenience method that creates an instance of the {@link EntitiesDefinition.Builder}
* avoiding the need to create one manually via {@link EntitiesDefinition#builder()}.
*
*
* When the {@link Consumer} completes, {@link EntitiesDefinition.Builder#build()} is called immediately and its
* result is passed to {@link #entities(EntitiesDefinition)}.
*
* @param entities
* a consumer that will call methods on {@link EntitiesDefinition.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #entities(EntitiesDefinition)
*/
default Builder entities(Consumer entities) {
return entities(EntitiesDefinition.builder().applyMutation(entities).build());
}
/**
*
* An array of up to 30 requests that you want Verified Permissions to evaluate.
*
*
* @param requests
* An array of up to 30 requests that you want Verified Permissions to evaluate.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder requests(Collection requests);
/**
*
* An array of up to 30 requests that you want Verified Permissions to evaluate.
*
*
* @param requests
* An array of up to 30 requests that you want Verified Permissions to evaluate.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder requests(BatchIsAuthorizedWithTokenInputItem... requests);
/**
*
* An array of up to 30 requests that you want Verified Permissions to evaluate.
*
* This is a convenience method that creates an instance of the
* {@link software.amazon.awssdk.services.verifiedpermissions.model.BatchIsAuthorizedWithTokenInputItem.Builder}
* avoiding the need to create one manually via
* {@link software.amazon.awssdk.services.verifiedpermissions.model.BatchIsAuthorizedWithTokenInputItem#builder()}
* .
*
*
* When the {@link Consumer} completes,
* {@link software.amazon.awssdk.services.verifiedpermissions.model.BatchIsAuthorizedWithTokenInputItem.Builder#build()}
* is called immediately and its result is passed to {@link
* #requests(List)}.
*
* @param requests
* a consumer that will call methods on
* {@link software.amazon.awssdk.services.verifiedpermissions.model.BatchIsAuthorizedWithTokenInputItem.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #requests(java.util.Collection)
*/
Builder requests(Consumer... requests);
@Override
Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration);
@Override
Builder overrideConfiguration(Consumer builderConsumer);
}
static final class BuilderImpl extends VerifiedPermissionsRequest.BuilderImpl implements Builder {
private String policyStoreId;
private String identityToken;
private String accessToken;
private EntitiesDefinition entities;
private List requests = DefaultSdkAutoConstructList.getInstance();
private BuilderImpl() {
}
private BuilderImpl(BatchIsAuthorizedWithTokenRequest model) {
super(model);
policyStoreId(model.policyStoreId);
identityToken(model.identityToken);
accessToken(model.accessToken);
entities(model.entities);
requests(model.requests);
}
public final String getPolicyStoreId() {
return policyStoreId;
}
public final void setPolicyStoreId(String policyStoreId) {
this.policyStoreId = policyStoreId;
}
@Override
public final Builder policyStoreId(String policyStoreId) {
this.policyStoreId = policyStoreId;
return this;
}
public final String getIdentityToken() {
return identityToken;
}
public final void setIdentityToken(String identityToken) {
this.identityToken = identityToken;
}
@Override
public final Builder identityToken(String identityToken) {
this.identityToken = identityToken;
return this;
}
public final String getAccessToken() {
return accessToken;
}
public final void setAccessToken(String accessToken) {
this.accessToken = accessToken;
}
@Override
public final Builder accessToken(String accessToken) {
this.accessToken = accessToken;
return this;
}
public final EntitiesDefinition.Builder getEntities() {
return entities != null ? entities.toBuilder() : null;
}
public final void setEntities(EntitiesDefinition.BuilderImpl entities) {
this.entities = entities != null ? entities.build() : null;
}
@Override
public final Builder entities(EntitiesDefinition entities) {
this.entities = entities;
return this;
}
public final List getRequests() {
List result = BatchIsAuthorizedWithTokenInputListCopier
.copyToBuilder(this.requests);
if (result instanceof SdkAutoConstructList) {
return null;
}
return result;
}
public final void setRequests(Collection requests) {
this.requests = BatchIsAuthorizedWithTokenInputListCopier.copyFromBuilder(requests);
}
@Override
public final Builder requests(Collection requests) {
this.requests = BatchIsAuthorizedWithTokenInputListCopier.copy(requests);
return this;
}
@Override
@SafeVarargs
public final Builder requests(BatchIsAuthorizedWithTokenInputItem... requests) {
requests(Arrays.asList(requests));
return this;
}
@Override
@SafeVarargs
public final Builder requests(Consumer... requests) {
requests(Stream.of(requests).map(c -> BatchIsAuthorizedWithTokenInputItem.builder().applyMutation(c).build())
.collect(Collectors.toList()));
return this;
}
@Override
public Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) {
super.overrideConfiguration(overrideConfiguration);
return this;
}
@Override
public Builder overrideConfiguration(Consumer builderConsumer) {
super.overrideConfiguration(builderConsumer);
return this;
}
@Override
public BatchIsAuthorizedWithTokenRequest build() {
return new BatchIsAuthorizedWithTokenRequest(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
@Override
public Map> sdkFieldNameToField() {
return SDK_NAME_TO_FIELD;
}
}
}