AttachmentsSource (AWS Java SDK :: Services :: AWS Simple Systems Management (SSM) 2.20.50 API)

java.lang.Object
- software.amazon.awssdk.services.ssm.model.AttachmentsSource

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<AttachmentsSource.Builder,AttachmentsSource>
```
@Generated(value="software.amazon.awssdk:codegen")
public final class AttachmentsSource
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<AttachmentsSource.Builder,AttachmentsSource>
```
Identifying information about a document attachment, including the file name and a key-value pair that identifies the location of an attachment to a document.

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface AttachmentsSource.Builder

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

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static AttachmentsSource.Builder`	`builder()`
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`boolean`	`hasValues()` For responses, this returns true if the service returned a value for the Values property.
`AttachmentsSourceKey`	`key()` The key of a key-value pair that identifies the location of an attachment to a document.
`String`	`keyAsString()` The key of a key-value pair that identifies the location of an attachment to a document.
`String`	`name()` The name of the document attachment file.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends AttachmentsSource.Builder>`	`serializableBuilderClass()`
`AttachmentsSource.Builder`	`toBuilder()`
`String`	`toString()` Returns a string representation of this object.
`List<String>`	`values()` The value of a key-value pair that identifies the location of an attachment to a document.

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
  - key
```
public final AttachmentsSourceKey key()
```
    The key of a key-value pair that identifies the location of an attachment to a document.
    
    If the service returns an enum value that is not available in the current SDK version, key will return AttachmentsSourceKey.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from keyAsString().
    
    Returns:
    
    The key of a key-value pair that identifies the location of an attachment to a document.
    
    See Also:
    
    AttachmentsSourceKey
  - keyAsString
```
public final String keyAsString()
```
    The key of a key-value pair that identifies the location of an attachment to a document.
    
    If the service returns an enum value that is not available in the current SDK version, key will return AttachmentsSourceKey.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from keyAsString().
    
    Returns:
    
    The key of a key-value pair that identifies the location of an attachment to a document.
    
    See Also:
    
    AttachmentsSourceKey
  - hasValues
```
public final boolean hasValues()
```
    For responses, this returns true if the service returned a value for the Values property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() 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.
  - values
```
public final List<String> values()
```
    The value of a key-value pair that identifies the location of an attachment to a document. The format for Value depends on the type of key you specify.
    - For the key SourceUrl, the value is an S3 bucket location. For example:
      
      "Values": [ "s3://doc-example-bucket/my-folder" ]
    - For the key S3FileUrl, the value is a file in an S3 bucket. For example:
      
      "Values": [ "s3://doc-example-bucket/my-folder/my-file.py" ]
    - For the key AttachmentReference, the value is constructed from the name of another SSM document in your account, a version number of that document, and a file attached to that document version that you want to reuse. For example:
      
      "Values": [ "MyOtherDocument/3/my-other-file.py" ]
      
      However, if the SSM document is shared with you from another account, the full SSM document ARN must be specified instead of the document name only. For example:
      
      "Values": [ "arn:aws:ssm:us-east-2:111122223333:document/OtherAccountDocument/3/their-file.py" ]
    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 hasValues() method.
    Returns:
    The value of a key-value pair that identifies the location of an attachment to a document. The format for Value depends on the type of key you specify.
    
    For the key SourceUrl, the value is an S3 bucket location. For example:
    
    "Values": [ "s3://doc-example-bucket/my-folder" ]
    
    For the key S3FileUrl, the value is a file in an S3 bucket. For example:
    
    "Values": [ "s3://doc-example-bucket/my-folder/my-file.py" ]
    
    For the key AttachmentReference, the value is constructed from the name of another SSM document in your account, a version number of that document, and a file attached to that document version that you want to reuse. For example:
    
    "Values": [ "MyOtherDocument/3/my-other-file.py" ]
    
    However, if the SSM document is shared with you from another account, the full SSM document ARN must be specified instead of the document name only. For example:
    
    "Values": [ "arn:aws:ssm:us-east-2:111122223333:document/OtherAccountDocument/3/their-file.py" ]
  - name
```
public final String name()
```
    The name of the document attachment file.
    
    Returns:
    
    The name of the document attachment file.
  - toBuilder
```
public AttachmentsSource.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<AttachmentsSource.Builder,AttachmentsSource>
  - builder
```
public static AttachmentsSource.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends AttachmentsSource.Builder> serializableBuilderClass()
```
  - hashCode
```
public final int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public final boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - equalsBySdkFields
```
public final boolean equalsBySdkFields(Object obj)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - toString
```
public final 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 final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)
```
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo

Class AttachmentsSource

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

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

Method Detail

key

keyAsString

hasValues

values

name

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields