/* * Copyright 2010-2023 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.comprehend.model; import java.io.Serializable; import com.amazonaws.AmazonWebServiceRequest; /** *

* Attaches a resource-based policy to a custom model. You can use this policy * to authorize an entity in another Amazon Web Services account to import the * custom model, which replicates it in Amazon Comprehend in their account. *

*/ public class PutResourcePolicyRequest extends AmazonWebServiceRequest implements Serializable { /** *

* The Amazon Resource Name (ARN) of the custom model to attach the policy * to. *

*

* Constraints:
* Length: - 256
* Pattern: * arn:aws(-[^:]+)?:comprehend:[a-zA-Z0-9-]*:[0-9]{12}:(document * -classifier * |entity-recognizer)/[a-zA-Z0-9](-*[a-zA-Z0-9])*(/version/[a-zA- * Z0-9](-*[a-zA-Z0-9])*)?
*/ private String resourceArn; /** *

* The JSON resource-based policy to attach to your custom model. Provide * your JSON as a UTF-8 encoded string without line breaks. To provide valid * JSON for your policy, enclose the attribute names and values in double * quotes. If the JSON body is also enclosed in double quotes, then you must * escape the double quotes that are inside the policy: *

*

* "{\"attribute\": \"value\", \"attribute\": [\"value\"]}" *

*

* To avoid escaping quotes, you can use single quotes to enclose the policy * and double quotes to enclose the JSON names and values: *

*

* '{"attribute": "value", "attribute": ["value"]}' *

*

* Constraints:
* Length: 1 - 20000
* Pattern: [ -\u00FF]+
*/ private String resourcePolicy; /** *

* The revision ID that Amazon Comprehend assigned to the policy that you * are updating. If you are creating a new policy that has no prior version, * don't use this parameter. Amazon Comprehend creates the revision ID for * you. *

*

* Constraints:
* Length: - 64
* Pattern: [0-9A-Fa-f]+
*/ private String policyRevisionId; /** *

* The Amazon Resource Name (ARN) of the custom model to attach the policy * to. *

*

* Constraints:
* Length: - 256
* Pattern: * arn:aws(-[^:]+)?:comprehend:[a-zA-Z0-9-]*:[0-9]{12}:(document * -classifier * |entity-recognizer)/[a-zA-Z0-9](-*[a-zA-Z0-9])*(/version/[a-zA- * Z0-9](-*[a-zA-Z0-9])*)?
* * @return

* The Amazon Resource Name (ARN) of the custom model to attach the * policy to. *

*/ public String getResourceArn() { return resourceArn; } /** *

* The Amazon Resource Name (ARN) of the custom model to attach the policy * to. *

*

* Constraints:
* Length: - 256
* Pattern: * arn:aws(-[^:]+)?:comprehend:[a-zA-Z0-9-]*:[0-9]{12}:(document * -classifier * |entity-recognizer)/[a-zA-Z0-9](-*[a-zA-Z0-9])*(/version/[a-zA- * Z0-9](-*[a-zA-Z0-9])*)?
* * @param resourceArn

* The Amazon Resource Name (ARN) of the custom model to attach * the policy to. *

*/ public void setResourceArn(String resourceArn) { this.resourceArn = resourceArn; } /** *

* The Amazon Resource Name (ARN) of the custom model to attach the policy * to. *

*

* Returns a reference to this object so that method calls can be chained * together. *

* Constraints:
* Length: - 256
* Pattern: * arn:aws(-[^:]+)?:comprehend:[a-zA-Z0-9-]*:[0-9]{12}:(document * -classifier * |entity-recognizer)/[a-zA-Z0-9](-*[a-zA-Z0-9])*(/version/[a-zA- * Z0-9](-*[a-zA-Z0-9])*)?
* * @param resourceArn

* The Amazon Resource Name (ARN) of the custom model to attach * the policy to. *

* @return A reference to this updated object so that method calls can be * chained together. */ public PutResourcePolicyRequest withResourceArn(String resourceArn) { this.resourceArn = resourceArn; return this; } /** *

* The JSON resource-based policy to attach to your custom model. Provide * your JSON as a UTF-8 encoded string without line breaks. To provide valid * JSON for your policy, enclose the attribute names and values in double * quotes. If the JSON body is also enclosed in double quotes, then you must * escape the double quotes that are inside the policy: *

*

* "{\"attribute\": \"value\", \"attribute\": [\"value\"]}" *

*

* To avoid escaping quotes, you can use single quotes to enclose the policy * and double quotes to enclose the JSON names and values: *

*

* '{"attribute": "value", "attribute": ["value"]}' *

*

* Constraints:
* Length: 1 - 20000
* Pattern: [ -\u00FF]+
* * @return

* The JSON resource-based policy to attach to your custom model. * Provide your JSON as a UTF-8 encoded string without line breaks. * To provide valid JSON for your policy, enclose the attribute * names and values in double quotes. If the JSON body is also * enclosed in double quotes, then you must escape the double quotes * that are inside the policy: *

*

* "{\"attribute\": \"value\", \"attribute\": [\"value\"]}" *

*

* To avoid escaping quotes, you can use single quotes to enclose * the policy and double quotes to enclose the JSON names and * values: *

*

* '{"attribute": "value", "attribute": ["value"]}' *

*/ public String getResourcePolicy() { return resourcePolicy; } /** *

* The JSON resource-based policy to attach to your custom model. Provide * your JSON as a UTF-8 encoded string without line breaks. To provide valid * JSON for your policy, enclose the attribute names and values in double * quotes. If the JSON body is also enclosed in double quotes, then you must * escape the double quotes that are inside the policy: *

*

* "{\"attribute\": \"value\", \"attribute\": [\"value\"]}" *

*

* To avoid escaping quotes, you can use single quotes to enclose the policy * and double quotes to enclose the JSON names and values: *

*

* '{"attribute": "value", "attribute": ["value"]}' *

*

* Constraints:
* Length: 1 - 20000
* Pattern: [ -\u00FF]+
* * @param resourcePolicy

* The JSON resource-based policy to attach to your custom model. * Provide your JSON as a UTF-8 encoded string without line * breaks. To provide valid JSON for your policy, enclose the * attribute names and values in double quotes. If the JSON body * is also enclosed in double quotes, then you must escape the * double quotes that are inside the policy: *

*

* "{\"attribute\": \"value\", \"attribute\": [\"value\"]}" *

*

* To avoid escaping quotes, you can use single quotes to enclose * the policy and double quotes to enclose the JSON names and * values: *

*

* '{"attribute": "value", "attribute": ["value"]}' *

*/ public void setResourcePolicy(String resourcePolicy) { this.resourcePolicy = resourcePolicy; } /** *

* The JSON resource-based policy to attach to your custom model. Provide * your JSON as a UTF-8 encoded string without line breaks. To provide valid * JSON for your policy, enclose the attribute names and values in double * quotes. If the JSON body is also enclosed in double quotes, then you must * escape the double quotes that are inside the policy: *

*

* "{\"attribute\": \"value\", \"attribute\": [\"value\"]}" *

*

* To avoid escaping quotes, you can use single quotes to enclose the policy * and double quotes to enclose the JSON names and values: *

*

* '{"attribute": "value", "attribute": ["value"]}' *

*

* Returns a reference to this object so that method calls can be chained * together. *

* Constraints:
* Length: 1 - 20000
* Pattern: [ -\u00FF]+
* * @param resourcePolicy

* The JSON resource-based policy to attach to your custom model. * Provide your JSON as a UTF-8 encoded string without line * breaks. To provide valid JSON for your policy, enclose the * attribute names and values in double quotes. If the JSON body * is also enclosed in double quotes, then you must escape the * double quotes that are inside the policy: *

*

* "{\"attribute\": \"value\", \"attribute\": [\"value\"]}" *

*

* To avoid escaping quotes, you can use single quotes to enclose * the policy and double quotes to enclose the JSON names and * values: *

*

* '{"attribute": "value", "attribute": ["value"]}' *

* @return A reference to this updated object so that method calls can be * chained together. */ public PutResourcePolicyRequest withResourcePolicy(String resourcePolicy) { this.resourcePolicy = resourcePolicy; return this; } /** *

* The revision ID that Amazon Comprehend assigned to the policy that you * are updating. If you are creating a new policy that has no prior version, * don't use this parameter. Amazon Comprehend creates the revision ID for * you. *

*

* Constraints:
* Length: - 64
* Pattern: [0-9A-Fa-f]+
* * @return

* The revision ID that Amazon Comprehend assigned to the policy * that you are updating. If you are creating a new policy that has * no prior version, don't use this parameter. Amazon Comprehend * creates the revision ID for you. *

*/ public String getPolicyRevisionId() { return policyRevisionId; } /** *

* The revision ID that Amazon Comprehend assigned to the policy that you * are updating. If you are creating a new policy that has no prior version, * don't use this parameter. Amazon Comprehend creates the revision ID for * you. *

*

* Constraints:
* Length: - 64
* Pattern: [0-9A-Fa-f]+
* * @param policyRevisionId

* The revision ID that Amazon Comprehend assigned to the policy * that you are updating. If you are creating a new policy that * has no prior version, don't use this parameter. Amazon * Comprehend creates the revision ID for you. *

*/ public void setPolicyRevisionId(String policyRevisionId) { this.policyRevisionId = policyRevisionId; } /** *

* The revision ID that Amazon Comprehend assigned to the policy that you * are updating. If you are creating a new policy that has no prior version, * don't use this parameter. Amazon Comprehend creates the revision ID for * you. *

*

* Returns a reference to this object so that method calls can be chained * together. *

* Constraints:
* Length: - 64
* Pattern: [0-9A-Fa-f]+
* * @param policyRevisionId

* The revision ID that Amazon Comprehend assigned to the policy * that you are updating. If you are creating a new policy that * has no prior version, don't use this parameter. Amazon * Comprehend creates the revision ID for you. *

* @return A reference to this updated object so that method calls can be * chained together. */ public PutResourcePolicyRequest withPolicyRevisionId(String policyRevisionId) { this.policyRevisionId = policyRevisionId; return this; } /** * Returns a string representation of this object; useful for testing and * debugging. * * @return A string representation of this object. * @see java.lang.Object#toString() */ @Override public String toString() { StringBuilder sb = new StringBuilder(); sb.append("{"); if (getResourceArn() != null) sb.append("ResourceArn: " + getResourceArn() + ","); if (getResourcePolicy() != null) sb.append("ResourcePolicy: " + getResourcePolicy() + ","); if (getPolicyRevisionId() != null) sb.append("PolicyRevisionId: " + getPolicyRevisionId()); sb.append("}"); return sb.toString(); } @Override public int hashCode() { final int prime = 31; int hashCode = 1; hashCode = prime * hashCode + ((getResourceArn() == null) ? 0 : getResourceArn().hashCode()); hashCode = prime * hashCode + ((getResourcePolicy() == null) ? 0 : getResourcePolicy().hashCode()); hashCode = prime * hashCode + ((getPolicyRevisionId() == null) ? 0 : getPolicyRevisionId().hashCode()); return hashCode; } @Override public boolean equals(Object obj) { if (this == obj) return true; if (obj == null) return false; if (obj instanceof PutResourcePolicyRequest == false) return false; PutResourcePolicyRequest other = (PutResourcePolicyRequest) obj; if (other.getResourceArn() == null ^ this.getResourceArn() == null) return false; if (other.getResourceArn() != null && other.getResourceArn().equals(this.getResourceArn()) == false) return false; if (other.getResourcePolicy() == null ^ this.getResourcePolicy() == null) return false; if (other.getResourcePolicy() != null && other.getResourcePolicy().equals(this.getResourcePolicy()) == false) return false; if (other.getPolicyRevisionId() == null ^ this.getPolicyRevisionId() == null) return false; if (other.getPolicyRevisionId() != null && other.getPolicyRevisionId().equals(this.getPolicyRevisionId()) == false) return false; return true; } }