com.amazonaws.services.verifiedpermissions.model.BatchIsAuthorizedWithTokenRequest Maven / Gradle / Ivy
/*
* Copyright 2019-2024 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 com.amazonaws.services.verifiedpermissions.model;
import java.io.Serializable;
import javax.annotation.Generated;
import com.amazonaws.AmazonWebServiceRequest;
/**
*
* @see AWS API Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class BatchIsAuthorizedWithTokenRequest extends com.amazonaws.AmazonWebServiceRequest implements Serializable, Cloneable {
/**
*
* Specifies the ID of the policy store. Policies in this policy store will be used to make an authorization
* decision for the input.
*
*/
private 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.
*
*/
private 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.
*
*/
private 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.
*
*
*
*
*/
private EntitiesDefinition entities;
/**
*
* An array of up to 30 requests that you want Verified Permissions to evaluate.
*
*/
private java.util.List requests;
/**
*
* 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.
*/
public void setPolicyStoreId(String policyStoreId) {
this.policyStoreId = 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 Specifies the ID of the policy store. Policies in this policy store will be used to make an authorization
* decision for the input.
*/
public String getPolicyStoreId() {
return this.policyStoreId;
}
/**
*
* 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.
*/
public BatchIsAuthorizedWithTokenRequest withPolicyStoreId(String policyStoreId) {
setPolicyStoreId(policyStoreId);
return this;
}
/**
*
* 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.
*/
public void setIdentityToken(String identityToken) {
this.identityToken = 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 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 String getIdentityToken() {
return this.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.
*
*
* @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.
*/
public BatchIsAuthorizedWithTokenRequest withIdentityToken(String identityToken) {
setIdentityToken(identityToken);
return this;
}
/**
*
* 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.
*/
public void setAccessToken(String accessToken) {
this.accessToken = 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 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 String getAccessToken() {
return this.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.
*
*
* @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.
*/
public BatchIsAuthorizedWithTokenRequest withAccessToken(String accessToken) {
setAccessToken(accessToken);
return this;
}
/**
*
* 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.
*
*
*
*/
public void setEntities(EntitiesDefinition entities) {
this.entities = 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 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 EntitiesDefinition getEntities() {
return this.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.
*
*
*
*
*
* @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.
*/
public BatchIsAuthorizedWithTokenRequest withEntities(EntitiesDefinition entities) {
setEntities(entities);
return this;
}
/**
*
* An array of up to 30 requests that you want Verified Permissions to evaluate.
*
*
* @return An array of up to 30 requests that you want Verified Permissions to evaluate.
*/
public java.util.List getRequests() {
return 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.
*/
public void setRequests(java.util.Collection requests) {
if (requests == null) {
this.requests = null;
return;
}
this.requests = new java.util.ArrayList(requests);
}
/**
*
* An array of up to 30 requests that you want Verified Permissions to evaluate.
*
*
* NOTE: This method appends the values to the existing list (if any). Use
* {@link #setRequests(java.util.Collection)} or {@link #withRequests(java.util.Collection)} if you want to override
* the existing values.
*
*
* @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.
*/
public BatchIsAuthorizedWithTokenRequest withRequests(BatchIsAuthorizedWithTokenInputItem... requests) {
if (this.requests == null) {
setRequests(new java.util.ArrayList(requests.length));
}
for (BatchIsAuthorizedWithTokenInputItem ele : requests) {
this.requests.add(ele);
}
return this;
}
/**
*
* 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.
*/
public BatchIsAuthorizedWithTokenRequest withRequests(java.util.Collection requests) {
setRequests(requests);
return this;
}
/**
* 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.
*
* @return A string representation of this object.
*
* @see java.lang.Object#toString()
*/
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("{");
if (getPolicyStoreId() != null)
sb.append("PolicyStoreId: ").append(getPolicyStoreId()).append(",");
if (getIdentityToken() != null)
sb.append("IdentityToken: ").append("***Sensitive Data Redacted***").append(",");
if (getAccessToken() != null)
sb.append("AccessToken: ").append("***Sensitive Data Redacted***").append(",");
if (getEntities() != null)
sb.append("Entities: ").append(getEntities()).append(",");
if (getRequests() != null)
sb.append("Requests: ").append(getRequests());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof BatchIsAuthorizedWithTokenRequest == false)
return false;
BatchIsAuthorizedWithTokenRequest other = (BatchIsAuthorizedWithTokenRequest) obj;
if (other.getPolicyStoreId() == null ^ this.getPolicyStoreId() == null)
return false;
if (other.getPolicyStoreId() != null && other.getPolicyStoreId().equals(this.getPolicyStoreId()) == false)
return false;
if (other.getIdentityToken() == null ^ this.getIdentityToken() == null)
return false;
if (other.getIdentityToken() != null && other.getIdentityToken().equals(this.getIdentityToken()) == false)
return false;
if (other.getAccessToken() == null ^ this.getAccessToken() == null)
return false;
if (other.getAccessToken() != null && other.getAccessToken().equals(this.getAccessToken()) == false)
return false;
if (other.getEntities() == null ^ this.getEntities() == null)
return false;
if (other.getEntities() != null && other.getEntities().equals(this.getEntities()) == false)
return false;
if (other.getRequests() == null ^ this.getRequests() == null)
return false;
if (other.getRequests() != null && other.getRequests().equals(this.getRequests()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getPolicyStoreId() == null) ? 0 : getPolicyStoreId().hashCode());
hashCode = prime * hashCode + ((getIdentityToken() == null) ? 0 : getIdentityToken().hashCode());
hashCode = prime * hashCode + ((getAccessToken() == null) ? 0 : getAccessToken().hashCode());
hashCode = prime * hashCode + ((getEntities() == null) ? 0 : getEntities().hashCode());
hashCode = prime * hashCode + ((getRequests() == null) ? 0 : getRequests().hashCode());
return hashCode;
}
@Override
public BatchIsAuthorizedWithTokenRequest clone() {
return (BatchIsAuthorizedWithTokenRequest) super.clone();
}
}