Interface PutVectorsRequest.Builder
- All Superinterfaces:
AwsRequest.Builder
,Buildable
,CopyableBuilder<PutVectorsRequest.Builder,
,PutVectorsRequest> S3VectorsRequest.Builder
,SdkBuilder<PutVectorsRequest.Builder,
,PutVectorsRequest> SdkPojo
,SdkRequest.Builder
- Enclosing class:
PutVectorsRequest
-
Method Summary
Modifier and TypeMethodDescriptionThe ARN of the vector index where you want to write vectors.The name of the vector index where you want to write vectors.overrideConfiguration
(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.overrideConfiguration
(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.vectorBucketName
(String vectorBucketName) The name of the vector bucket that contains the vector index.vectors
(Collection<PutInputVector> vectors) The vectors to add to a vector index.vectors
(Consumer<PutInputVector.Builder>... vectors) The vectors to add to a vector index.vectors
(PutInputVector... vectors) The vectors to add to a vector index.Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
Methods inherited from interface software.amazon.awssdk.services.s3vectors.model.S3VectorsRequest.Builder
build
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFieldNameToField, sdkFields
-
Method Details
-
vectorBucketName
The name of the vector bucket that contains the vector index.
- Parameters:
vectorBucketName
- The name of the vector bucket that contains the vector index.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
indexName
The name of the vector index where you want to write vectors.
- Parameters:
indexName
- The name of the vector index where you want to write vectors.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
indexArn
The ARN of the vector index where you want to write vectors.
- Parameters:
indexArn
- The ARN of the vector index where you want to write vectors.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
vectors
The vectors to add to a vector index. The number of vectors in a single request must not exceed the resource capacity, otherwise the request will be rejected with the error
ServiceUnavailableException
with the error message "Currently unable to handle the request".- Parameters:
vectors
- The vectors to add to a vector index. The number of vectors in a single request must not exceed the resource capacity, otherwise the request will be rejected with the errorServiceUnavailableException
with the error message "Currently unable to handle the request".- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
vectors
The vectors to add to a vector index. The number of vectors in a single request must not exceed the resource capacity, otherwise the request will be rejected with the error
ServiceUnavailableException
with the error message "Currently unable to handle the request".- Parameters:
vectors
- The vectors to add to a vector index. The number of vectors in a single request must not exceed the resource capacity, otherwise the request will be rejected with the errorServiceUnavailableException
with the error message "Currently unable to handle the request".- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
vectors
The vectors to add to a vector index. The number of vectors in a single request must not exceed the resource capacity, otherwise the request will be rejected with the error
This is a convenience method that creates an instance of theServiceUnavailableException
with the error message "Currently unable to handle the request".PutInputVector.Builder
avoiding the need to create one manually viaPutInputVector.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tovectors(List<PutInputVector>)
.- Parameters:
vectors
- a consumer that will call methods onPutInputVector.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
overrideConfiguration
PutVectorsRequest.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
PutVectorsRequest.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.
-