Package software.amazon.awssdk.services.glacier.model

Class S3Location

    • Method Detail

      • bucketName

        public final String bucketName()

        The name of the Amazon S3 bucket where the job results are stored.

        Returns:
        The name of the Amazon S3 bucket where the job results are stored.

      • prefix

        public final String prefix()

        The prefix that is prepended to the results for this request.

        Returns:
        The prefix that is prepended to the results for this request.

      • encryption

        public final Encryption encryption()

        Contains information about the encryption used to store the job results in Amazon S3.

        Returns:
        Contains information about the encryption used to store the job results in Amazon S3.

      • cannedACL

        public final CannedACL cannedACL()

        The canned access control list (ACL) to apply to the job results.

        If the service returns an enum value that is not available in the current SDK version, cannedACL will return CannedACL.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from cannedACLAsString().

        Returns:
        The canned access control list (ACL) to apply to the job results.
        See Also:
        CannedACL

      • cannedACLAsString

        public final String cannedACLAsString()

        The canned access control list (ACL) to apply to the job results.

        If the service returns an enum value that is not available in the current SDK version, cannedACL will return CannedACL.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from cannedACLAsString().

        Returns:
        The canned access control list (ACL) to apply to the job results.
        See Also:
        CannedACL

      • hasAccessControlList

        public final boolean hasAccessControlList()
        For responses, this returns true if the service returned a value for the AccessControlList 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.

      • accessControlList

        public final List<Grant> accessControlList()

        A list of grants that control access to the staged results.

        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 hasAccessControlList() method.

        Returns:
        A list of grants that control access to the staged results.

      • hasTagging

        public final boolean hasTagging()
        For responses, this returns true if the service returned a value for the Tagging 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.

      • tagging

        public final Map<String,​String> tagging()

        The tag-set that is applied to the job results.

        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 hasTagging() method.

        Returns:
        The tag-set that is applied to the job results.

      • hasUserMetadata

        public final boolean hasUserMetadata()
        For responses, this returns true if the service returned a value for the UserMetadata 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.

      • userMetadata

        public final Map<String,​String> userMetadata()

        A map of metadata to store with the job results in Amazon S3.

        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 hasUserMetadata() method.

        Returns:
        A map of metadata to store with the job results in Amazon S3.

      • storageClass

        public final StorageClass storageClass()

        The storage class used to store the job results.

        If the service returns an enum value that is not available in the current SDK version, storageClass will return StorageClass.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from storageClassAsString().

        Returns:
        The storage class used to store the job results.
        See Also:
        StorageClass

      • storageClassAsString

        public final String storageClassAsString()

        The storage class used to store the job results.

        If the service returns an enum value that is not available in the current SDK version, storageClass will return StorageClass.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from storageClassAsString().

        Returns:
        The storage class used to store the job results.
        See Also:
        StorageClass

      • hashCode

        public final int hashCode()
        Overrides:
        hashCode in class Object

      • equals

        public final boolean equals​(Object obj)
        Overrides:
        equals in class Object

      • 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)