ModifyImageAttributeRequest (AWS Java SDK :: Services

java.lang.Object
- software.amazon.awssdk.core.SdkRequest
- - software.amazon.awssdk.awscore.AwsRequest
  - - software.amazon.awssdk.services.ec2.model.Ec2Request
    - - software.amazon.awssdk.services.ec2.model.ModifyImageAttributeRequest

All Implemented Interfaces:: SdkPojo, ToCopyableBuilder<ModifyImageAttributeRequest.Builder,ModifyImageAttributeRequest>

@Generated(value="software.amazon.awssdk:codegen")
public final class ModifyImageAttributeRequest
extends Ec2Request
implements ToCopyableBuilder<ModifyImageAttributeRequest.Builder,ModifyImageAttributeRequest>

Contains the parameters for ModifyImageAttribute.

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface ModifyImageAttributeRequest.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`ModifyImageAttributeRequest.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`attribute()` The name of the attribute to modify.
`static ModifyImageAttributeRequest.Builder`	`builder()`
`AttributeValue`	`description()` A new description for the AMI.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`boolean`	`hasProductCodes()` Returns true if the ProductCodes property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
`boolean`	`hasUserGroups()` Returns true if the UserGroups property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
`boolean`	`hasUserIds()` Returns true if the UserIds property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
`String`	`imageId()` The ID of the AMI.
`LaunchPermissionModifications`	`launchPermission()` A new launch permission for the AMI.
`OperationType`	`operationType()` The operation type.
`String`	`operationTypeAsString()` The operation type.
`List<String>`	`productCodes()` The DevPay product codes.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends ModifyImageAttributeRequest.Builder>`	`serializableBuilderClass()`
`ModifyImageAttributeRequest.Builder`	`toBuilder()`
`String`	`toString()` Returns a string representation of this object.
`List<String>`	`userGroups()` The user groups.
`List<String>`	`userIds()` The AWS account IDs.
`String`	`value()` The value of the attribute being modified.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration

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

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy

- Method Detail
  - attribute
```
public String attribute()
```
    The name of the attribute to modify. The valid values are description, launchPermission , and productCodes.
    
    Returns:
    
    The name of the attribute to modify. The valid values are description, launchPermission, and productCodes.
  - description
```
public AttributeValue description()
```
    A new description for the AMI.
    
    Returns:
    
    A new description for the AMI.
  - imageId
```
public String imageId()
```
    The ID of the AMI.
    
    Returns:
    
    The ID of the AMI.
  - launchPermission
```
public LaunchPermissionModifications launchPermission()
```
    A new launch permission for the AMI.
    
    Returns:
    
    A new launch permission for the AMI.
  - operationType
```
public OperationType operationType()
```
    The operation type. This parameter can be used only when the Attribute parameter is launchPermission.
    
    If the service returns an enum value that is not available in the current SDK version, operationType will return OperationType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from operationTypeAsString().
    
    Returns:
    
    The operation type. This parameter can be used only when the Attribute parameter is launchPermission.
    
    See Also:
    
    OperationType
  - operationTypeAsString
```
public String operationTypeAsString()
```
    The operation type. This parameter can be used only when the Attribute parameter is launchPermission.
    
    If the service returns an enum value that is not available in the current SDK version, operationType will return OperationType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from operationTypeAsString().
    
    Returns:
    
    The operation type. This parameter can be used only when the Attribute parameter is launchPermission.
    
    See Also:
    
    OperationType
  - hasProductCodes
```
public boolean hasProductCodes()
```
    Returns true if the ProductCodes property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
  - productCodes
```
public List<String> productCodes()
```
    The DevPay product codes. After you add a product code to an AMI, it can't be removed.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    You can use hasProductCodes() to see if a value was sent in this field.
    
    Returns:
    
    The DevPay product codes. After you add a product code to an AMI, it can't be removed.
  - hasUserGroups
```
public boolean hasUserGroups()
```
    Returns true if the UserGroups property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
  - userGroups
```
public List<String> userGroups()
```
    The user groups. This parameter can be used only when the Attribute parameter is launchPermission.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    You can use hasUserGroups() to see if a value was sent in this field.
    
    Returns:
    
    The user groups. This parameter can be used only when the Attribute parameter is launchPermission.
  - hasUserIds
```
public boolean hasUserIds()
```
    Returns true if the UserIds property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
  - userIds
```
public List<String> userIds()
```
    The AWS account IDs. This parameter can be used only when the Attribute parameter is launchPermission.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    You can use hasUserIds() to see if a value was sent in this field.
    
    Returns:
    
    The AWS account IDs. This parameter can be used only when the Attribute parameter is launchPermission.
  - value
```
public String value()
```
    The value of the attribute being modified. This parameter can be used only when the Attribute parameter is description or productCodes.
    
    Returns:
    
    The value of the attribute being modified. This parameter can be used only when the Attribute parameter is description or productCodes.
  - toBuilder
```
public ModifyImageAttributeRequest.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<ModifyImageAttributeRequest.Builder,ModifyImageAttributeRequest>
    
    Specified by:
    
    toBuilder in class Ec2Request
  - builder
```
public static ModifyImageAttributeRequest.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends ModifyImageAttributeRequest.Builder> serializableBuilderClass()
```
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class AwsRequest
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class AwsRequest
  - equalsBySdkFields
```
public boolean equalsBySdkFields(Object obj)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - 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
  - getValueForField
```
public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)
```
    Overrides:
    
    getValueForField in class SdkRequest
  - sdkFields
```
public List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo

Class ModifyImageAttributeRequest

Nested Class Summary

Method Summary

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

attribute

description

imageId

launchPermission

operationType

operationTypeAsString

hasProductCodes

productCodes

hasUserGroups

userGroups

hasUserIds

userIds

value

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields