com.amazonaws.services.opensearchserverless.model

Class CreateCollectionRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.opensearchserverless.model.CreateCollectionRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class CreateCollectionRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

See Also:

AWS API Documentation, Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
CreateCollectionRequest()

Method Summary

Modifier and Type	Method and Description
CreateCollectionRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
String	getClientToken() Unique, case-sensitive identifier to ensure idempotency of the request.
String	getDescription() Description of the collection.
String	getName() Name of the collection.
String	getStandbyReplicas() Indicates whether standby replicas should be used for a collection.
List<Tag>	getTags() An arbitrary set of tags (key–value pairs) to associate with the OpenSearch Serverless collection.
String	getType() The type of collection.
int	hashCode()
void	setClientToken(String clientToken) Unique, case-sensitive identifier to ensure idempotency of the request.
void	setDescription(String description) Description of the collection.
void	setName(String name) Name of the collection.
void	setStandbyReplicas(String standbyReplicas) Indicates whether standby replicas should be used for a collection.
void	setTags(Collection<Tag> tags) An arbitrary set of tags (key–value pairs) to associate with the OpenSearch Serverless collection.
void	setType(String type) The type of collection.
String	toString() Returns a string representation of this object.
CreateCollectionRequest	withClientToken(String clientToken) Unique, case-sensitive identifier to ensure idempotency of the request.
CreateCollectionRequest	withDescription(String description) Description of the collection.
CreateCollectionRequest	withName(String name) Name of the collection.
CreateCollectionRequest	withStandbyReplicas(StandbyReplicas standbyReplicas) Indicates whether standby replicas should be used for a collection.
CreateCollectionRequest	withStandbyReplicas(String standbyReplicas) Indicates whether standby replicas should be used for a collection.
CreateCollectionRequest	withTags(Collection<Tag> tags) An arbitrary set of tags (key–value pairs) to associate with the OpenSearch Serverless collection.
CreateCollectionRequest	withTags(Tag... tags) An arbitrary set of tags (key–value pairs) to associate with the OpenSearch Serverless collection.
CreateCollectionRequest	withType(CollectionType type) The type of collection.
CreateCollectionRequest	withType(String type) The type of collection.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

CreateCollectionRequest

public CreateCollectionRequest()

Method Detail

setClientToken

public void setClientToken(String clientToken)

Unique, case-sensitive identifier to ensure idempotency of the request.

Parameters:

clientToken - Unique, case-sensitive identifier to ensure idempotency of the request.

getClientToken

public String getClientToken()

Unique, case-sensitive identifier to ensure idempotency of the request.

Returns:

Unique, case-sensitive identifier to ensure idempotency of the request.

withClientToken

public CreateCollectionRequest withClientToken(String clientToken)

Unique, case-sensitive identifier to ensure idempotency of the request.

Parameters:

clientToken - Unique, case-sensitive identifier to ensure idempotency of the request.

Returns:

Returns a reference to this object so that method calls can be chained together.

setDescription

public void setDescription(String description)

Description of the collection.

Parameters:

description - Description of the collection.

getDescription

public String getDescription()

Description of the collection.

Returns:

Description of the collection.

withDescription

public CreateCollectionRequest withDescription(String description)

Description of the collection.

Parameters:

description - Description of the collection.

Returns:

Returns a reference to this object so that method calls can be chained together.

setName

public void setName(String name)

Name of the collection.

Parameters:

name - Name of the collection.

getName

public String getName()

Name of the collection.

Returns:

Name of the collection.

withName

public CreateCollectionRequest withName(String name)

Name of the collection.

Parameters:

name - Name of the collection.

Returns:

Returns a reference to this object so that method calls can be chained together.

setStandbyReplicas

public void setStandbyReplicas(String standbyReplicas)

Indicates whether standby replicas should be used for a collection.

Parameters:

standbyReplicas - Indicates whether standby replicas should be used for a collection.

See Also:

StandbyReplicas

getStandbyReplicas

public String getStandbyReplicas()

Indicates whether standby replicas should be used for a collection.

Returns:

Indicates whether standby replicas should be used for a collection.

See Also:

StandbyReplicas

withStandbyReplicas

public CreateCollectionRequest withStandbyReplicas(String standbyReplicas)

Indicates whether standby replicas should be used for a collection.

Parameters:

standbyReplicas - Indicates whether standby replicas should be used for a collection.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

StandbyReplicas

withStandbyReplicas

public CreateCollectionRequest withStandbyReplicas(StandbyReplicas standbyReplicas)

Indicates whether standby replicas should be used for a collection.

Parameters:

standbyReplicas - Indicates whether standby replicas should be used for a collection.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

StandbyReplicas

getTags

public List<Tag> getTags()

An arbitrary set of tags (key–value pairs) to associate with the OpenSearch Serverless collection.

Returns:

An arbitrary set of tags (key–value pairs) to associate with the OpenSearch Serverless collection.

setTags

public void setTags(Collection<Tag> tags)

An arbitrary set of tags (key–value pairs) to associate with the OpenSearch Serverless collection.

Parameters:

tags - An arbitrary set of tags (key–value pairs) to associate with the OpenSearch Serverless collection.

withTags

public CreateCollectionRequest withTags(Tag... tags)

An arbitrary set of tags (key–value pairs) to associate with the OpenSearch Serverless collection.

NOTE: This method appends the values to the existing list (if any). Use setTags(java.util.Collection) or withTags(java.util.Collection) if you want to override the existing values.

Parameters:

tags - An arbitrary set of tags (key–value pairs) to associate with the OpenSearch Serverless collection.

Returns:

Returns a reference to this object so that method calls can be chained together.

withTags

public CreateCollectionRequest withTags(Collection<Tag> tags)

An arbitrary set of tags (key–value pairs) to associate with the OpenSearch Serverless collection.

Parameters:

tags - An arbitrary set of tags (key–value pairs) to associate with the OpenSearch Serverless collection.

Returns:

Returns a reference to this object so that method calls can be chained together.

setType

public void setType(String type)

The type of collection.

Parameters:

type - The type of collection.

See Also:

CollectionType

getType

public String getType()

The type of collection.

Returns:

The type of collection.

See Also:

CollectionType

withType

public CreateCollectionRequest withType(String type)

The type of collection.

Parameters:

type - The type of collection.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

CollectionType

withType

public CreateCollectionRequest withType(CollectionType type)

The type of collection.

Parameters:

type - The type of collection.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

CollectionType

toString

public 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

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public CreateCollectionRequest clone()

Description copied from class: AmazonWebServiceRequest

Creates a shallow clone of this object for all fields except the handler context. Explicitly does not clone the deep structure of the other fields in the message.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

Object.clone()