Class AddAttachmentsToSetRequest
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<AddAttachmentsToSetRequest.Builder,
AddAttachmentsToSetRequest>
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionfinal List
<Attachment> One or more attachments to add to the set.final String
The ID of the attachment set.builder()
final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extendsSdkRequest
.final boolean
For responses, this returns true if the service returned a value for the Attachments property.final int
hashCode()
static Class
<? extends AddAttachmentsToSetRequest.Builder> Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
attachmentSetId
The ID of the attachment set. If an
attachmentSetId
is not specified, a new attachment set is created, and the ID of the set is returned in the response. If anattachmentSetId
is specified, the attachments are added to the specified set, if it exists.- Returns:
- The ID of the attachment set. If an
attachmentSetId
is not specified, a new attachment set is created, and the ID of the set is returned in the response. If anattachmentSetId
is specified, the attachments are added to the specified set, if it exists.
-
hasAttachments
public final boolean hasAttachments()For responses, this returns true if the service returned a value for the Attachments property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
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. -
attachments
One or more attachments to add to the set. You can add up to three attachments per set. The size limit is 5 MB per attachment.
In the
Attachment
object, use thedata
parameter to specify the contents of the attachment file. In the previous request syntax, the value fordata
appear asblob
, which is represented as a base64-encoded string. The value forfileName
is the name of the attachment, such astroubleshoot-screenshot.png
.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
hasAttachments()
method.- Returns:
- One or more attachments to add to the set. You can add up to three attachments per set. The size limit is
5 MB per attachment.
In the
Attachment
object, use thedata
parameter to specify the contents of the attachment file. In the previous request syntax, the value fordata
appear asblob
, which is represented as a base64-encoded string. The value forfileName
is the name of the attachment, such astroubleshoot-screenshot.png
.
-
toBuilder
Description copied from interface:ToCopyableBuilder
Take this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilder
in interfaceToCopyableBuilder<AddAttachmentsToSetRequest.Builder,
AddAttachmentsToSetRequest> - Specified by:
toBuilder
in classSupportRequest
- Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode()- Overrides:
hashCode
in classAwsRequest
-
equals
- Overrides:
equals
in classAwsRequest
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
Description copied from class:SdkRequest
Used to retrieve the value of a field from any class that extendsSdkRequest
. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, theSdkRequest.getValueForField(String, Class)
method will again be available.- Overrides:
getValueForField
in classSdkRequest
- Parameters:
fieldName
- The name of the member to be retrieved.clazz
- The class to cast the returned object to.- Returns:
- Optional containing the casted return value
-
sdkFields
-