Adapter (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.textract.model.Adapter

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class Adapter
extends Object
implements Serializable, Cloneable, StructuredPojo
```
An adapter selected for use when analyzing documents. Contains an adapter ID and a version number. Contains information on pages selected for analysis when analyzing documents asychronously.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

Adapter()

Constructors
Constructor and Description
`Adapter()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Adapter`	`clone()`
`boolean`	`equals(Object obj)`
`String`	`getAdapterId()` A unique identifier for the adapter resource.
`List<String>`	`getPages()` Pages is a parameter that the user inputs to specify which pages to apply an adapter to.
`String`	`getVersion()` A string that identifies the version of the adapter.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setAdapterId(String adapterId)` A unique identifier for the adapter resource.
`void`	`setPages(Collection<String> pages)` Pages is a parameter that the user inputs to specify which pages to apply an adapter to.
`void`	`setVersion(String version)` A string that identifies the version of the adapter.
`String`	`toString()` Returns a string representation of this object.
`Adapter`	`withAdapterId(String adapterId)` A unique identifier for the adapter resource.
`Adapter`	`withPages(Collection<String> pages)` Pages is a parameter that the user inputs to specify which pages to apply an adapter to.
`Adapter`	`withPages(String... pages)` Pages is a parameter that the user inputs to specify which pages to apply an adapter to.
`Adapter`	`withVersion(String version)` A string that identifies the version of the adapter.

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

- Constructor Detail
  - Adapter
```
public Adapter()
```
- Method Detail
  - setAdapterId
```
public void setAdapterId(String adapterId)
```
    A unique identifier for the adapter resource.
    
    Parameters:
    
    adapterId - A unique identifier for the adapter resource.
  - getAdapterId
```
public String getAdapterId()
```
    A unique identifier for the adapter resource.
    
    Returns:
    
    A unique identifier for the adapter resource.
  - withAdapterId
```
public Adapter withAdapterId(String adapterId)
```
    A unique identifier for the adapter resource.
    
    Parameters:
    
    adapterId - A unique identifier for the adapter resource.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getPages
```
public List<String> getPages()
```
    Pages is a parameter that the user inputs to specify which pages to apply an adapter to. The following is a list of rules for using this parameter.
    - If a page is not specified, it is set to ["1"] by default.
    - The following characters are allowed in the parameter's string: 0 1 2 3 4 5 6 7 8 9 - *. No whitespace is allowed.
    - When using * to indicate all pages, it must be the only element in the list.
    - You can use page intervals, such as ["1-3", "1-1", "4-*"]. Where * indicates last page of document.
    - Specified pages must be greater than 0 and less than or equal to the number of pages in the document.
    Returns:
    Pages is a parameter that the user inputs to specify which pages to apply an adapter to. The following is a list of rules for using this parameter.
    
    If a page is not specified, it is set to ["1"] by default.
    
    The following characters are allowed in the parameter's string: 0 1 2 3 4 5 6 7 8 9 - *. No whitespace is allowed.
    
    When using * to indicate all pages, it must be the only element in the list.
    
    You can use page intervals, such as ["1-3", "1-1", "4-*"]. Where * indicates last page of document.
    
    Specified pages must be greater than 0 and less than or equal to the number of pages in the document.
  - setPages
```
public void setPages(Collection<String> pages)
```
    Pages is a parameter that the user inputs to specify which pages to apply an adapter to. The following is a list of rules for using this parameter.
    - If a page is not specified, it is set to ["1"] by default.
    - The following characters are allowed in the parameter's string: 0 1 2 3 4 5 6 7 8 9 - *. No whitespace is allowed.
    - When using * to indicate all pages, it must be the only element in the list.
    - You can use page intervals, such as ["1-3", "1-1", "4-*"]. Where * indicates last page of document.
    - Specified pages must be greater than 0 and less than or equal to the number of pages in the document.
    Parameters:
    pages - Pages is a parameter that the user inputs to specify which pages to apply an adapter to. The following is a list of rules for using this parameter.
    
    If a page is not specified, it is set to ["1"] by default.
    
    The following characters are allowed in the parameter's string: 0 1 2 3 4 5 6 7 8 9 - *. No whitespace is allowed.
    
    When using * to indicate all pages, it must be the only element in the list.
    
    You can use page intervals, such as ["1-3", "1-1", "4-*"]. Where * indicates last page of document.
    
    Specified pages must be greater than 0 and less than or equal to the number of pages in the document.
  - withPages
```
public Adapter withPages(String... pages)
```
    Pages is a parameter that the user inputs to specify which pages to apply an adapter to. The following is a list of rules for using this parameter.
    - If a page is not specified, it is set to ["1"] by default.
    - The following characters are allowed in the parameter's string: 0 1 2 3 4 5 6 7 8 9 - *. No whitespace is allowed.
    - When using * to indicate all pages, it must be the only element in the list.
    - You can use page intervals, such as ["1-3", "1-1", "4-*"]. Where * indicates last page of document.
    - Specified pages must be greater than 0 and less than or equal to the number of pages in the document.
    NOTE: This method appends the values to the existing list (if any). Use setPages(java.util.Collection) or withPages(java.util.Collection) if you want to override the existing values.
    Parameters:
    pages - Pages is a parameter that the user inputs to specify which pages to apply an adapter to. The following is a list of rules for using this parameter.
    
    If a page is not specified, it is set to ["1"] by default.
    
    The following characters are allowed in the parameter's string: 0 1 2 3 4 5 6 7 8 9 - *. No whitespace is allowed.
    
    When using * to indicate all pages, it must be the only element in the list.
    
    You can use page intervals, such as ["1-3", "1-1", "4-*"]. Where * indicates last page of document.
    
    Specified pages must be greater than 0 and less than or equal to the number of pages in the document.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withPages
```
public Adapter withPages(Collection<String> pages)
```
    Pages is a parameter that the user inputs to specify which pages to apply an adapter to. The following is a list of rules for using this parameter.
    - If a page is not specified, it is set to ["1"] by default.
    - The following characters are allowed in the parameter's string: 0 1 2 3 4 5 6 7 8 9 - *. No whitespace is allowed.
    - When using * to indicate all pages, it must be the only element in the list.
    - You can use page intervals, such as ["1-3", "1-1", "4-*"]. Where * indicates last page of document.
    - Specified pages must be greater than 0 and less than or equal to the number of pages in the document.
    Parameters:
    pages - Pages is a parameter that the user inputs to specify which pages to apply an adapter to. The following is a list of rules for using this parameter.
    
    If a page is not specified, it is set to ["1"] by default.
    
    The following characters are allowed in the parameter's string: 0 1 2 3 4 5 6 7 8 9 - *. No whitespace is allowed.
    
    When using * to indicate all pages, it must be the only element in the list.
    
    You can use page intervals, such as ["1-3", "1-1", "4-*"]. Where * indicates last page of document.
    
    Specified pages must be greater than 0 and less than or equal to the number of pages in the document.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setVersion
```
public void setVersion(String version)
```
    A string that identifies the version of the adapter.
    
    Parameters:
    
    version - A string that identifies the version of the adapter.
  - getVersion
```
public String getVersion()
```
    A string that identifies the version of the adapter.
    
    Returns:
    
    A string that identifies the version of the adapter.
  - withVersion
```
public Adapter withVersion(String version)
```
    A string that identifies the version of the adapter.
    
    Parameters:
    
    version - A string that identifies the version of the adapter.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - 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 Adapter 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.792

Class Adapter

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Adapter

Method Detail

setAdapterId

getAdapterId

withAdapterId

getPages

setPages

withPages

withPages

setVersion

getVersion

withVersion

toString

equals

hashCode

clone

marshall