Interface StartAttachedFileUploadRequest.Builder
- All Superinterfaces:
AwsRequest.Builder
,Buildable
,ConnectRequest.Builder
,CopyableBuilder<StartAttachedFileUploadRequest.Builder,
,StartAttachedFileUploadRequest> SdkBuilder<StartAttachedFileUploadRequest.Builder,
,StartAttachedFileUploadRequest> SdkPojo
,SdkRequest.Builder
- Enclosing class:
StartAttachedFileUploadRequest
-
Method Summary
Modifier and TypeMethodDescriptionassociatedResourceArn
(String associatedResourceArn) The resource to which the attached file is (being) uploaded to.clientToken
(String clientToken) A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.createdBy
(Consumer<CreatedByInfo.Builder> createdBy) Represents the identity that created the file.createdBy
(CreatedByInfo createdBy) Represents the identity that created the file.A case-sensitive name of the attached file being uploaded.fileSizeInBytes
(Long fileSizeInBytes) The size of the attached file in bytes.fileUseCaseType
(String fileUseCaseType) The use case for the file.fileUseCaseType
(FileUseCaseType fileUseCaseType) The use case for the file.instanceId
(String instanceId) The unique identifier of the Connect instance.overrideConfiguration
(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.overrideConfiguration
(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.The tags used to organize, track, or control access for this resource.urlExpiryInSeconds
(Integer urlExpiryInSeconds) Optional override for the expiry of the pre-signed S3 URL in seconds.Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.services.connect.model.ConnectRequest.Builder
build
Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
-
Method Details
-
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.
- Parameters:
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:
- Returns a reference to this object so that method calls can be chained together.
-
instanceId
The unique identifier of the Connect instance.
- Parameters:
instanceId
- The unique identifier of the Connect instance.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
fileName
A case-sensitive name of the attached file being uploaded.
- Parameters:
fileName
- A case-sensitive name of the attached file being uploaded.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
fileSizeInBytes
The size of the attached file in bytes.
- Parameters:
fileSizeInBytes
- The size of the attached file in bytes.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
urlExpiryInSeconds
Optional override for the expiry of the pre-signed S3 URL in seconds. The default value is 300.
- Parameters:
urlExpiryInSeconds
- Optional override for the expiry of the pre-signed S3 URL in seconds. The default value is 300.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
fileUseCaseType
The use case for the file.
- Parameters:
fileUseCaseType
- The use case for the file.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
fileUseCaseType
The use case for the file.
- Parameters:
fileUseCaseType
- The use case for the file.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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.
- Parameters:
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:
- Returns a reference to this object so that method calls can be chained together.
-
createdBy
Represents the identity that created the file.
- Parameters:
createdBy
- Represents the identity that created the file.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
createdBy
Represents the identity that created the file.
This is a convenience method that creates an instance of theCreatedByInfo.Builder
avoiding the need to create one manually viaCreatedByInfo.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tocreatedBy(CreatedByInfo)
.- Parameters:
createdBy
- a consumer that will call methods onCreatedByInfo.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
tags
The tags used to organize, track, or control access for this resource. For example,
{ "Tags": {"key1":"value1", "key2":"value2"} }
.- Parameters:
tags
- The tags used to organize, track, or control access for this resource. For example,{ "Tags": {"key1":"value1", "key2":"value2"} }
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
overrideConfiguration
StartAttachedFileUploadRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) Description copied from interface:AwsRequest.Builder
Add an optional request override configuration.- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
- Parameters:
overrideConfiguration
- The override configuration.- Returns:
- This object for method chaining.
-
overrideConfiguration
StartAttachedFileUploadRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Description copied from interface:AwsRequest.Builder
Add an optional request override configuration.- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
- Parameters:
builderConsumer
- AConsumer
to which an emptyAwsRequestOverrideConfiguration.Builder
will be given.- Returns:
- This object for method chaining.
-