Interface GetAttachmentUploadLinksRequest.Builder

All Superinterfaces:
AwsRequest.Builder, Buildable, CopyableBuilder<GetAttachmentUploadLinksRequest.Builder,GetAttachmentUploadLinksRequest>, SdkBuilder<GetAttachmentUploadLinksRequest.Builder,GetAttachmentUploadLinksRequest>, SdkPojo, SdkRequest.Builder, SupportRequest.Builder
Enclosing class:
GetAttachmentUploadLinksRequest
@Mutable @NotThreadSafe public static interface GetAttachmentUploadLinksRequest.Builder extends SupportRequest.Builder, SdkPojo, CopyableBuilder<GetAttachmentUploadLinksRequest.Builder,GetAttachmentUploadLinksRequest>

  • Method Details

    • fileName

      GetAttachmentUploadLinksRequest.Builder fileName(String fileName)

      The name of the file to upload, including the file extension. This value is required when you initiate a new upload.

      Parameters:
      fileName - The name of the file to upload, including the file extension. This value is required when you initiate a new upload.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • fileSizeBytes

      GetAttachmentUploadLinksRequest.Builder fileSizeBytes(Long fileSizeBytes)

      The total size of the file in bytes. The service uses this value to calculate the total number of parts and the size of each part. Required when you initiate a new upload (when uploadId isn't provided). Valid range: 1 to 157,286,400 bytes (approximately 150 MB).

      Parameters:
      fileSizeBytes - The total size of the file in bytes. The service uses this value to calculate the total number of parts and the size of each part. Required when you initiate a new upload (when uploadId isn't provided). Valid range: 1 to 157,286,400 bytes (approximately 150 MB).
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • uploadId

      GetAttachmentUploadLinksRequest.Builder uploadId(String uploadId)

      The unique identifier of an in-progress multipart upload, returned by a previous call to GetAttachmentUploadLinks. Specify uploadId to retrieve additional presigned upload URLs for an upload that has already been initiated. Required when fileSizeBytes isn't provided. Length: 1 to 2,048 characters.

      Parameters:
      uploadId - The unique identifier of an in-progress multipart upload, returned by a previous call to GetAttachmentUploadLinks. Specify uploadId to retrieve additional presigned upload URLs for an upload that has already been initiated. Required when fileSizeBytes isn't provided. Length: 1 to 2,048 characters.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • uploadRange

      GetAttachmentUploadLinksRequest.Builder uploadRange(UploadRange uploadRange)

      The range of part indexes for which to return presigned upload URLs. Use this parameter to page through the upload URLs for a large file across multiple calls. If you omit this parameter, the service determines the range to return.

      Parameters:
      uploadRange - The range of part indexes for which to return presigned upload URLs. Use this parameter to page through the upload URLs for a large file across multiple calls. If you omit this parameter, the service determines the range to return.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • uploadRange

      default GetAttachmentUploadLinksRequest.Builder uploadRange(Consumer<UploadRange.Builder> uploadRange)

      The range of part indexes for which to return presigned upload URLs. Use this parameter to page through the upload URLs for a large file across multiple calls. If you omit this parameter, the service determines the range to return.

      This is a convenience method that creates an instance of the UploadRange.Builder avoiding the need to create one manually via UploadRange.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to uploadRange(UploadRange).

      Parameters:
      uploadRange - a consumer that will call methods on UploadRange.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • dryRun

      GetAttachmentUploadLinksRequest.Builder dryRun(Boolean dryRun)

      Specifies whether to validate the request without actually generating upload URLs. When set to true, the request is validated but no URLs are returned, and the operation returns a DryRunOperationException. When omitted or set to false, the request runs normally.

      Parameters:
      dryRun - Specifies whether to validate the request without actually generating upload URLs. When set to true, the request is validated but no URLs are returned, and the operation returns a DryRunOperationException. When omitted or set to false, the request runs normally.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • overrideConfiguration

      GetAttachmentUploadLinksRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      overrideConfiguration - The override configuration.
      Returns:
      This object for method chaining.

    • overrideConfiguration

      GetAttachmentUploadLinksRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.
      Returns:
      This object for method chaining.