Class GetAttachedFileResponse

java.lang.Object
software.amazon.awssdk.core.SdkResponse
software.amazon.awssdk.awscore.AwsResponse
software.amazon.awssdk.services.connect.model.ConnectResponse
software.amazon.awssdk.services.connect.model.GetAttachedFileResponse
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<GetAttachedFileResponse.Builder,GetAttachedFileResponse>
@Generated("software.amazon.awssdk:codegen") public final class GetAttachedFileResponse extends ConnectResponse implements ToCopyableBuilder<GetAttachedFileResponse.Builder,GetAttachedFileResponse>
Response from GetAttachedFile API.

  • Method Details

    • fileArn

      public final String fileArn()

      The unique identifier of the attached file resource (ARN).

      Returns:
      The unique identifier of the attached file resource (ARN).

    • fileId

      public final String fileId()

      The unique identifier of the attached file resource.

      Returns:
      The unique identifier of the attached file resource.

    • creationTime

      public final String creationTime()

      The time of Creation of the file resource as an ISO timestamp. It's specified in ISO 8601 format: yyyy-MM-ddThh:mm:ss.SSSZ. For example, 2024-05-03T02:41:28.172Z.

      Returns:
      The time of Creation of the file resource as an ISO timestamp. It's specified in ISO 8601 format: yyyy-MM-ddThh:mm:ss.SSSZ. For example, 2024-05-03T02:41:28.172Z.

    • fileStatus

      public final FileStatusType fileStatus()

      The current status of the attached file.

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

      Returns:
      The current status of the attached file.
      See Also:

    • fileStatusAsString

      public final String fileStatusAsString()

      The current status of the attached file.

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

      Returns:
      The current status of the attached file.
      See Also:

    • fileName

      public final String fileName()

      A case-sensitive name of the attached file being uploaded.

      Returns:
      A case-sensitive name of the attached file being uploaded.

    • fileSizeInBytes

      public final Long fileSizeInBytes()

      The size of the attached file in bytes.

      Returns:
      The size of the attached file in bytes.

    • associatedResourceArn

      public final String associatedResourceArn()

      The resource to which the attached file is (being) uploaded to. Cases are the only current supported resource.

      Returns:
      The resource to which the attached file is (being) uploaded to. Cases are the only current supported resource.

    • fileUseCaseType

      public final FileUseCaseType fileUseCaseType()

      The use case for the file.

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

      Returns:
      The use case for the file.
      See Also:

    • fileUseCaseTypeAsString

      public final String fileUseCaseTypeAsString()

      The use case for the file.

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

      Returns:
      The use case for the file.
      See Also:

    • createdBy

      public final CreatedByInfo createdBy()

      Represents the identity that created the file.

      Returns:
      Represents the identity that created the file.

    • downloadUrlMetadata

      public final DownloadUrlMetadata downloadUrlMetadata()

      URL and expiry to be used when downloading the attached file.

      Returns:
      URL and expiry to be used when downloading the attached file.

    • hasTags

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

    • tags

      public final Map<String,String> tags()

      The tags used to organize, track, or control access for this resource. For example, { "Tags": {"key1":"value1", "key2":"value2"} }.

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

      Returns:
      The tags used to organize, track, or control access for this resource. For example, { "Tags": {"key1":"value1", "key2":"value2"} }.

    • toBuilder

      public GetAttachedFileResponse.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<GetAttachedFileResponse.Builder,GetAttachedFileResponse>
      Specified by:
      toBuilder in class AwsResponse
      Returns:
      a builder for type T

    • builder

      public static GetAttachedFileResponse.Builder builder()

    • serializableBuilderClass

      public static Class<? extends GetAttachedFileResponse.Builder> serializableBuilderClass()

    • hashCode

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

    • equals

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

    • 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)
      Description copied from class: SdkResponse
      Used to retrieve the value of a field from any class that extends SdkResponse. 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, the SdkResponse.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkResponse
      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

      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.