Package software.amazon.awssdk.services.connect.model

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>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	StartAttachedFileUploadRequest.Builder

Method Summary

Modifier and Type	Method	Description
String	associatedResourceArn()	The resource to which the attached file is (being) uploaded to.
static StartAttachedFileUploadRequest.Builder	builder()
String	clientToken()	A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
CreatedByInfo	createdBy()	Represents the identity that created the file.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
String	fileName()	A case-sensitive name of the attached file being uploaded.
Long	fileSizeInBytes()	The size of the attached file in bytes.
FileUseCaseType	fileUseCaseType()	The use case for the file.
String	fileUseCaseTypeAsString()	The use case for the file.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasTags()	For responses, this returns true if the service returned a value for the Tags property.
String	instanceId()	The unique identifier of the Amazon Connect instance.
List<SdkField<?>>	sdkFields()
static Class<? extends StartAttachedFileUploadRequest.Builder>	serializableBuilderClass()
Map<String,String>	tags()	The tags used to organize, track, or control access for this resource.
StartAttachedFileUploadRequest.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
Integer	urlExpiryInSeconds()	Optional override for the expiry of the pre-signed S3 URL in seconds.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

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:

FileUseCaseType

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:

FileUseCaseType

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

Specified by:

toBuilder in interface ToCopyableBuilder<StartAttachedFileUploadRequest.Builder,StartAttachedFileUploadRequest>

Specified by:

toBuilder in class ConnectRequest

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)

Specified by:

equalsBySdkFields in interface SdkPojo

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)

Overrides:

getValueForField in class SdkRequest

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo