Class FileRef

java.lang.Object
software.amazon.awssdk.services.partnercentralmarketing.model.FileRef
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<FileRef.Builder,FileRef>

@Generated("software.amazon.awssdk:codegen") public final class FileRef extends Object implements SdkPojo, Serializable, ToCopyableBuilder<FileRef.Builder,FileRef>

A reference to a partner-supplied file in the Partner Central file staging bucket.

The URI must be `s3://{stagingBucket}/{callerAccountId}/…`, where the account id segment equals the caller's session-derived account — never an account named in the request body. A mismatch is refused `FILE_REFERENCE_NOT_OWNED`; any other bucket, `FILE_REFERENCE_INVALID`.

`VersionId` is required: the staging bucket is versioned, and the service takes exactly the version the upload returned, so a later upload to the same key cannot change what was referenced. The service copies that version into storage it controls and pins the copy for scanning and processing.

See Also:
  • Method Details

    • s3Uri

      public final String s3Uri()

      The s3:// location of the file.

      Returns:
      The s3:// location of the file.
    • versionId

      public final String versionId()

      The version of the object to take: the VersionId the staging upload returned.

      Returns:
      The version of the object to take: the VersionId the staging upload returned.
    • toBuilder

      public FileRef.Builder 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 interface ToCopyableBuilder<FileRef.Builder,FileRef>
      Returns:
      a builder for type T
    • builder

      public static FileRef.Builder builder()
    • serializableBuilderClass

      public static Class<? extends FileRef.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)
      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 an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.
    • 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
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.
    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.