UpdateAccessPolicyRequest (AWS SDK for Java

java.lang.Object
- com.amazonaws.AmazonWebServiceRequest
- - com.amazonaws.services.opensearchserverless.model.UpdateAccessPolicyRequest

All Implemented Interfaces:: HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class UpdateAccessPolicyRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

See Also:: AWS API Documentation, Serialized Form

Field Summary
- Fields inherited from class com.amazonaws.AmazonWebServiceRequest
  NOOP

Constructor Summary

Constructors
Constructor and Description

UpdateAccessPolicyRequest()

Constructors
Constructor and Description
`UpdateAccessPolicyRequest()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`UpdateAccessPolicyRequest`	`clone()` Creates a shallow clone of this object for all fields except the handler context.
`boolean`	`equals(Object obj)`
`String`	`getClientToken()` Unique, case-sensitive identifier to ensure idempotency of the request.
`String`	`getDescription()` A description of the policy.
`String`	`getName()` The name of the policy.
`String`	`getPolicy()` The JSON policy document to use as the content for the policy.
`String`	`getPolicyVersion()` The version of the policy being updated.
`String`	`getType()` The type of policy.
`int`	`hashCode()`
`void`	`setClientToken(String clientToken)` Unique, case-sensitive identifier to ensure idempotency of the request.
`void`	`setDescription(String description)` A description of the policy.
`void`	`setName(String name)` The name of the policy.
`void`	`setPolicy(String policy)` The JSON policy document to use as the content for the policy.
`void`	`setPolicyVersion(String policyVersion)` The version of the policy being updated.
`void`	`setType(String type)` The type of policy.
`String`	`toString()` Returns a string representation of this object.
`UpdateAccessPolicyRequest`	`withClientToken(String clientToken)` Unique, case-sensitive identifier to ensure idempotency of the request.
`UpdateAccessPolicyRequest`	`withDescription(String description)` A description of the policy.
`UpdateAccessPolicyRequest`	`withName(String name)` The name of the policy.
`UpdateAccessPolicyRequest`	`withPolicy(String policy)` The JSON policy document to use as the content for the policy.
`UpdateAccessPolicyRequest`	`withPolicyVersion(String policyVersion)` The version of the policy being updated.
`UpdateAccessPolicyRequest`	`withType(AccessPolicyType type)` The type of policy.
`UpdateAccessPolicyRequest`	`withType(String type)` The type of policy.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - UpdateAccessPolicyRequest
```
public UpdateAccessPolicyRequest()
```
- Method Detail
  - setClientToken
```
public void setClientToken(String clientToken)
```
    Unique, case-sensitive identifier to ensure idempotency of the request.
    
    Parameters:
    
    clientToken - Unique, case-sensitive identifier to ensure idempotency of the request.
  - getClientToken
```
public String getClientToken()
```
    Unique, case-sensitive identifier to ensure idempotency of the request.
    
    Returns:
    
    Unique, case-sensitive identifier to ensure idempotency of the request.
  - withClientToken
```
public UpdateAccessPolicyRequest withClientToken(String clientToken)
```
    Unique, case-sensitive identifier to ensure idempotency of the request.
    
    Parameters:
    
    clientToken - Unique, case-sensitive identifier to ensure idempotency of the request.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setDescription
```
public void setDescription(String description)
```
    A description of the policy. Typically used to store information about the permissions defined in the policy.
    
    Parameters:
    
    description - A description of the policy. Typically used to store information about the permissions defined in the policy.
  - getDescription
```
public String getDescription()
```
    A description of the policy. Typically used to store information about the permissions defined in the policy.
    
    Returns:
    
    A description of the policy. Typically used to store information about the permissions defined in the policy.
  - withDescription
```
public UpdateAccessPolicyRequest withDescription(String description)
```
    A description of the policy. Typically used to store information about the permissions defined in the policy.
    
    Parameters:
    
    description - A description of the policy. Typically used to store information about the permissions defined in the policy.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setName
```
public void setName(String name)
```
    The name of the policy.
    
    Parameters:
    
    name - The name of the policy.
  - getName
```
public String getName()
```
    The name of the policy.
    
    Returns:
    
    The name of the policy.
  - withName
```
public UpdateAccessPolicyRequest withName(String name)
```
    The name of the policy.
    
    Parameters:
    
    name - The name of the policy.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setPolicy
```
public void setPolicy(String policy)
```
    The JSON policy document to use as the content for the policy.
    
    Parameters:
    
    policy - The JSON policy document to use as the content for the policy.
  - getPolicy
```
public String getPolicy()
```
    The JSON policy document to use as the content for the policy.
    
    Returns:
    
    The JSON policy document to use as the content for the policy.
  - withPolicy
```
public UpdateAccessPolicyRequest withPolicy(String policy)
```
    The JSON policy document to use as the content for the policy.
    
    Parameters:
    
    policy - The JSON policy document to use as the content for the policy.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setPolicyVersion
```
public void setPolicyVersion(String policyVersion)
```
    The version of the policy being updated.
    
    Parameters:
    
    policyVersion - The version of the policy being updated.
  - getPolicyVersion
```
public String getPolicyVersion()
```
    The version of the policy being updated.
    
    Returns:
    
    The version of the policy being updated.
  - withPolicyVersion
```
public UpdateAccessPolicyRequest withPolicyVersion(String policyVersion)
```
    The version of the policy being updated.
    
    Parameters:
    
    policyVersion - The version of the policy being updated.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setType
```
public void setType(String type)
```
    The type of policy.
    
    Parameters:
    
    type - The type of policy.
    
    See Also:
    
    AccessPolicyType
  - getType
```
public String getType()
```
    The type of policy.
    
    Returns:
    
    The type of policy.
    
    See Also:
    
    AccessPolicyType
  - withType
```
public UpdateAccessPolicyRequest withType(String type)
```
    The type of policy.
    
    Parameters:
    
    type - The type of policy.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    AccessPolicyType
  - withType
```
public UpdateAccessPolicyRequest withType(AccessPolicyType type)
```
    The type of policy.
    
    Parameters:
    
    type - The type of policy.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    AccessPolicyType
  - toString
```
public 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
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public UpdateAccessPolicyRequest clone()
```
    Description copied from class: AmazonWebServiceRequest
    
    Creates a shallow clone of this object for all fields except the handler context. Explicitly does not clone the deep structure of the other fields in the message.
    
    Overrides:
    
    clone in class AmazonWebServiceRequest
    
    See Also:
    
    Object.clone()

AWS SDK for Java 1.x API Reference - 1.12.546

Class UpdateAccessPolicyRequest

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

Constructor Summary

Method Summary

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

Methods inherited from class java.lang.Object

Constructor Detail

UpdateAccessPolicyRequest

Method Detail

setClientToken

getClientToken

withClientToken

setDescription

getDescription

withDescription

setName

getName

withName

setPolicy

getPolicy

withPolicy

setPolicyVersion

getPolicyVersion

withPolicyVersion

setType

getType

withType

withType

toString

equals

hashCode

clone