Class AttachmentsSource
- All Implemented Interfaces:
Serializable
,SdkPojo
,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:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionstatic AttachmentsSource.Builder
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) final int
hashCode()
final boolean
For responses, this returns true if the service returned a value for the Values property.final AttachmentsSourceKey
key()
The key of a key-value pair that identifies the location of an attachment to a document.final String
The key of a key-value pair that identifies the location of an attachment to a document.final String
name()
The name of the document attachment file.static Class
<? extends AttachmentsSource.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.values()
The value of a key-value pair that identifies the location of an attachment to a document.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
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 returnAttachmentsSourceKey.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromkeyAsString()
.- Returns:
- The key of a key-value pair that identifies the location of an attachment to a document.
- See Also:
-
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 returnAttachmentsSourceKey.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromkeyAsString()
.- Returns:
- The key of a key-value pair that identifies the location of an attachment to a document.
- See Also:
-
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 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. -
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
The name of the document attachment file.
- Returns:
- The name of the document attachment file.
-
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<AttachmentsSource.Builder,
AttachmentsSource> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
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
-
sdkFields
-