CollectionDetail (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.opensearchserverless.model.CollectionDetail

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class CollectionDetail
extends Object
implements Serializable, Cloneable, StructuredPojo
```
Details about each OpenSearch Serverless collection, including the collection endpoint and the OpenSearch Dashboards endpoint.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

CollectionDetail()

Constructors
Constructor and Description
`CollectionDetail()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`CollectionDetail`	`clone()`
`boolean`	`equals(Object obj)`
`String`	`getArn()` The Amazon Resource Name (ARN) of the collection.
`String`	`getCollectionEndpoint()` Collection-specific endpoint used to submit index, search, and data upload requests to an OpenSearch Serverless collection.
`Long`	`getCreatedDate()` The Epoch time when the collection was created.
`String`	`getDashboardEndpoint()` Collection-specific endpoint used to access OpenSearch Dashboards.
`String`	`getDescription()` A description of the collection.
`String`	`getId()` A unique identifier for the collection.
`String`	`getKmsKeyArn()` The ARN of the Amazon Web Services KMS key used to encrypt the collection.
`Long`	`getLastModifiedDate()` The date and time when the collection was last modified.
`String`	`getName()` The name of the collection.
`String`	`getStandbyReplicas()` Details about an OpenSearch Serverless collection.
`String`	`getStatus()` The current status of the collection.
`String`	`getType()` The type of collection.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setArn(String arn)` The Amazon Resource Name (ARN) of the collection.
`void`	`setCollectionEndpoint(String collectionEndpoint)` Collection-specific endpoint used to submit index, search, and data upload requests to an OpenSearch Serverless collection.
`void`	`setCreatedDate(Long createdDate)` The Epoch time when the collection was created.
`void`	`setDashboardEndpoint(String dashboardEndpoint)` Collection-specific endpoint used to access OpenSearch Dashboards.
`void`	`setDescription(String description)` A description of the collection.
`void`	`setId(String id)` A unique identifier for the collection.
`void`	`setKmsKeyArn(String kmsKeyArn)` The ARN of the Amazon Web Services KMS key used to encrypt the collection.
`void`	`setLastModifiedDate(Long lastModifiedDate)` The date and time when the collection was last modified.
`void`	`setName(String name)` The name of the collection.
`void`	`setStandbyReplicas(String standbyReplicas)` Details about an OpenSearch Serverless collection.
`void`	`setStatus(String status)` The current status of the collection.
`void`	`setType(String type)` The type of collection.
`String`	`toString()` Returns a string representation of this object.
`CollectionDetail`	`withArn(String arn)` The Amazon Resource Name (ARN) of the collection.
`CollectionDetail`	`withCollectionEndpoint(String collectionEndpoint)` Collection-specific endpoint used to submit index, search, and data upload requests to an OpenSearch Serverless collection.
`CollectionDetail`	`withCreatedDate(Long createdDate)` The Epoch time when the collection was created.
`CollectionDetail`	`withDashboardEndpoint(String dashboardEndpoint)` Collection-specific endpoint used to access OpenSearch Dashboards.
`CollectionDetail`	`withDescription(String description)` A description of the collection.
`CollectionDetail`	`withId(String id)` A unique identifier for the collection.
`CollectionDetail`	`withKmsKeyArn(String kmsKeyArn)` The ARN of the Amazon Web Services KMS key used to encrypt the collection.
`CollectionDetail`	`withLastModifiedDate(Long lastModifiedDate)` The date and time when the collection was last modified.
`CollectionDetail`	`withName(String name)` The name of the collection.
`CollectionDetail`	`withStandbyReplicas(StandbyReplicas standbyReplicas)` Details about an OpenSearch Serverless collection.
`CollectionDetail`	`withStandbyReplicas(String standbyReplicas)` Details about an OpenSearch Serverless collection.
`CollectionDetail`	`withStatus(CollectionStatus status)` The current status of the collection.
`CollectionDetail`	`withStatus(String status)` The current status of the collection.
`CollectionDetail`	`withType(CollectionType type)` The type of collection.
`CollectionDetail`	`withType(String type)` The type of collection.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - CollectionDetail
```
public CollectionDetail()
```
- Method Detail
  - setArn
```
public void setArn(String arn)
```
    The Amazon Resource Name (ARN) of the collection.
    
    Parameters:
    
    arn - The Amazon Resource Name (ARN) of the collection.
  - getArn
```
public String getArn()
```
    The Amazon Resource Name (ARN) of the collection.
    
    Returns:
    
    The Amazon Resource Name (ARN) of the collection.
  - withArn
```
public CollectionDetail withArn(String arn)
```
    The Amazon Resource Name (ARN) of the collection.
    
    Parameters:
    
    arn - The Amazon Resource Name (ARN) of the collection.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setCollectionEndpoint
```
public void setCollectionEndpoint(String collectionEndpoint)
```
    Collection-specific endpoint used to submit index, search, and data upload requests to an OpenSearch Serverless collection.
    
    Parameters:
    
    collectionEndpoint - Collection-specific endpoint used to submit index, search, and data upload requests to an OpenSearch Serverless collection.
  - getCollectionEndpoint
```
public String getCollectionEndpoint()
```
    Collection-specific endpoint used to submit index, search, and data upload requests to an OpenSearch Serverless collection.
    
    Returns:
    
    Collection-specific endpoint used to submit index, search, and data upload requests to an OpenSearch Serverless collection.
  - withCollectionEndpoint
```
public CollectionDetail withCollectionEndpoint(String collectionEndpoint)
```
    Collection-specific endpoint used to submit index, search, and data upload requests to an OpenSearch Serverless collection.
    
    Parameters:
    
    collectionEndpoint - Collection-specific endpoint used to submit index, search, and data upload requests to an OpenSearch Serverless collection.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setCreatedDate
```
public void setCreatedDate(Long createdDate)
```
    The Epoch time when the collection was created.
    
    Parameters:
    
    createdDate - The Epoch time when the collection was created.
  - getCreatedDate
```
public Long getCreatedDate()
```
    The Epoch time when the collection was created.
    
    Returns:
    
    The Epoch time when the collection was created.
  - withCreatedDate
```
public CollectionDetail withCreatedDate(Long createdDate)
```
    The Epoch time when the collection was created.
    
    Parameters:
    
    createdDate - The Epoch time when the collection was created.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setDashboardEndpoint
```
public void setDashboardEndpoint(String dashboardEndpoint)
```
    Collection-specific endpoint used to access OpenSearch Dashboards.
    
    Parameters:
    
    dashboardEndpoint - Collection-specific endpoint used to access OpenSearch Dashboards.
  - getDashboardEndpoint
```
public String getDashboardEndpoint()
```
    Collection-specific endpoint used to access OpenSearch Dashboards.
    
    Returns:
    
    Collection-specific endpoint used to access OpenSearch Dashboards.
  - withDashboardEndpoint
```
public CollectionDetail withDashboardEndpoint(String dashboardEndpoint)
```
    Collection-specific endpoint used to access OpenSearch Dashboards.
    
    Parameters:
    
    dashboardEndpoint - Collection-specific endpoint used to access OpenSearch Dashboards.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setDescription
```
public void setDescription(String description)
```
    A description of the collection.
    
    Parameters:
    
    description - A description of the collection.
  - getDescription
```
public String getDescription()
```
    A description of the collection.
    
    Returns:
    
    A description of the collection.
  - withDescription
```
public CollectionDetail withDescription(String description)
```
    A description of the collection.
    
    Parameters:
    
    description - A description of the collection.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setId
```
public void setId(String id)
```
    A unique identifier for the collection.
    
    Parameters:
    
    id - A unique identifier for the collection.
  - getId
```
public String getId()
```
    A unique identifier for the collection.
    
    Returns:
    
    A unique identifier for the collection.
  - withId
```
public CollectionDetail withId(String id)
```
    A unique identifier for the collection.
    
    Parameters:
    
    id - A unique identifier for the collection.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setKmsKeyArn
```
public void setKmsKeyArn(String kmsKeyArn)
```
    The ARN of the Amazon Web Services KMS key used to encrypt the collection.
    
    Parameters:
    
    kmsKeyArn - The ARN of the Amazon Web Services KMS key used to encrypt the collection.
  - getKmsKeyArn
```
public String getKmsKeyArn()
```
    The ARN of the Amazon Web Services KMS key used to encrypt the collection.
    
    Returns:
    
    The ARN of the Amazon Web Services KMS key used to encrypt the collection.
  - withKmsKeyArn
```
public CollectionDetail withKmsKeyArn(String kmsKeyArn)
```
    The ARN of the Amazon Web Services KMS key used to encrypt the collection.
    
    Parameters:
    
    kmsKeyArn - The ARN of the Amazon Web Services KMS key used to encrypt the collection.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setLastModifiedDate
```
public void setLastModifiedDate(Long lastModifiedDate)
```
    The date and time when the collection was last modified.
    
    Parameters:
    
    lastModifiedDate - The date and time when the collection was last modified.
  - getLastModifiedDate
```
public Long getLastModifiedDate()
```
    The date and time when the collection was last modified.
    
    Returns:
    
    The date and time when the collection was last modified.
  - withLastModifiedDate
```
public CollectionDetail withLastModifiedDate(Long lastModifiedDate)
```
    The date and time when the collection was last modified.
    
    Parameters:
    
    lastModifiedDate - The date and time when the collection was last modified.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setName
```
public void setName(String name)
```
    The name of the collection.
    
    Parameters:
    
    name - The name of the collection.
  - getName
```
public String getName()
```
    The name of the collection.
    
    Returns:
    
    The name of the collection.
  - withName
```
public CollectionDetail withName(String name)
```
    The name of the collection.
    
    Parameters:
    
    name - The 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)
```
    Details about an OpenSearch Serverless collection.
    
    Parameters:
    
    standbyReplicas - Details about an OpenSearch Serverless collection.
    
    See Also:
    
    StandbyReplicas
  - getStandbyReplicas
```
public String getStandbyReplicas()
```
    Details about an OpenSearch Serverless collection.
    
    Returns:
    
    Details about an OpenSearch Serverless collection.
    
    See Also:
    
    StandbyReplicas
  - withStandbyReplicas
```
public CollectionDetail withStandbyReplicas(String standbyReplicas)
```
    Details about an OpenSearch Serverless collection.
    
    Parameters:
    
    standbyReplicas - Details about an OpenSearch Serverless collection.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    StandbyReplicas
  - withStandbyReplicas
```
public CollectionDetail withStandbyReplicas(StandbyReplicas standbyReplicas)
```
    Details about an OpenSearch Serverless collection.
    
    Parameters:
    
    standbyReplicas - Details about an OpenSearch Serverless collection.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    StandbyReplicas
  - setStatus
```
public void setStatus(String status)
```
    The current status of the collection.
    
    Parameters:
    
    status - The current status of the collection.
    
    See Also:
    
    CollectionStatus
  - getStatus
```
public String getStatus()
```
    The current status of the collection.
    
    Returns:
    
    The current status of the collection.
    
    See Also:
    
    CollectionStatus
  - withStatus
```
public CollectionDetail withStatus(String status)
```
    The current status of the collection.
    
    Parameters:
    
    status - The current status of the collection.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    CollectionStatus
  - withStatus
```
public CollectionDetail withStatus(CollectionStatus status)
```
    The current status of the collection.
    
    Parameters:
    
    status - The current status of the collection.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    CollectionStatus
  - 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 CollectionDetail 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 CollectionDetail 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 CollectionDetail clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

AWS SDK for Java 1.x API Reference - 1.12.772

Class CollectionDetail

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

CollectionDetail

Method Detail

setArn

getArn

withArn

setCollectionEndpoint

getCollectionEndpoint

withCollectionEndpoint

setCreatedDate

getCreatedDate

withCreatedDate

setDashboardEndpoint

getDashboardEndpoint

withDashboardEndpoint

setDescription

getDescription

withDescription

setId

getId

withId

setKmsKeyArn

getKmsKeyArn

withKmsKeyArn

setLastModifiedDate

getLastModifiedDate

withLastModifiedDate

setName

getName

withName

setStandbyReplicas

getStandbyReplicas

withStandbyReplicas

withStandbyReplicas

setStatus

getStatus

withStatus

withStatus

setType

getType

withType

withType

toString

equals

hashCode

clone

marshall