Class StartAttachedFileUploadRequest

java.lang.Object
software.amazon.awssdk.core.SdkRequest
software.amazon.awssdk.awscore.AwsRequest
software.amazon.awssdk.services.connect.model.ConnectRequest
software.amazon.awssdk.services.connect.model.StartAttachedFileUploadRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<StartAttachedFileUploadRequest.Builder,StartAttachedFileUploadRequest>
@Generated("software.amazon.awssdk:codegen") public final class StartAttachedFileUploadRequest extends ConnectRequest implements ToCopyableBuilder<StartAttachedFileUploadRequest.Builder,StartAttachedFileUploadRequest>

  • Method Details

    • clientToken

      public final String clientToken()

      A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.

      Returns:
      A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.

    • instanceId

      public final String instanceId()

      The unique identifier of the Amazon Connect instance.

      Returns:
      The unique identifier of the Amazon Connect instance.

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

    • urlExpiryInSeconds

      public final Integer urlExpiryInSeconds()

      Optional override for the expiry of the pre-signed S3 URL in seconds. The default value is 300.

      Returns:
      Optional override for the expiry of the pre-signed S3 URL in seconds. The default value is 300.

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

    • associatedResourceArn

      public final String associatedResourceArn()

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

      This value must be a valid ARN.

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

      This value must be a valid ARN.

    • createdBy

      public final CreatedByInfo createdBy()

      Represents the identity that created the file.

      Returns:
      Represents the identity that created the 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 StartAttachedFileUploadRequest.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<StartAttachedFileUploadRequest.Builder,StartAttachedFileUploadRequest>
      Specified by:
      toBuilder in class ConnectRequest
      Returns:
      a builder for type T

    • builder

      public static StartAttachedFileUploadRequest.Builder builder()

    • serializableBuilderClass

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

    • hashCode

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

    • equals

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

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