S3Target (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.glue.model.S3Target

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class S3Target
extends Object
implements Serializable, Cloneable, StructuredPojo
```
Specifies a data store in Amazon Simple Storage Service (Amazon S3).

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

S3Target()

Constructors
Constructor and Description
`S3Target()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`S3Target`	`clone()`
`boolean`	`equals(Object obj)`
`String`	`getConnectionName()` The name of a connection which allows a job or crawler to access data in Amazon S3 within an Amazon Virtual Private Cloud environment (Amazon VPC).
`String`	`getDlqEventQueueArn()` A valid Amazon dead-letter SQS ARN.
`String`	`getEventQueueArn()` A valid Amazon SQS ARN.
`List<String>`	`getExclusions()` A list of glob patterns used to exclude from the crawl.
`String`	`getPath()` The path to the Amazon S3 target.
`Integer`	`getSampleSize()` Sets the number of files in each leaf folder to be crawled when crawling sample files in a dataset.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setConnectionName(String connectionName)` The name of a connection which allows a job or crawler to access data in Amazon S3 within an Amazon Virtual Private Cloud environment (Amazon VPC).
`void`	`setDlqEventQueueArn(String dlqEventQueueArn)` A valid Amazon dead-letter SQS ARN.
`void`	`setEventQueueArn(String eventQueueArn)` A valid Amazon SQS ARN.
`void`	`setExclusions(Collection<String> exclusions)` A list of glob patterns used to exclude from the crawl.
`void`	`setPath(String path)` The path to the Amazon S3 target.
`void`	`setSampleSize(Integer sampleSize)` Sets the number of files in each leaf folder to be crawled when crawling sample files in a dataset.
`String`	`toString()` Returns a string representation of this object.
`S3Target`	`withConnectionName(String connectionName)` The name of a connection which allows a job or crawler to access data in Amazon S3 within an Amazon Virtual Private Cloud environment (Amazon VPC).
`S3Target`	`withDlqEventQueueArn(String dlqEventQueueArn)` A valid Amazon dead-letter SQS ARN.
`S3Target`	`withEventQueueArn(String eventQueueArn)` A valid Amazon SQS ARN.
`S3Target`	`withExclusions(Collection<String> exclusions)` A list of glob patterns used to exclude from the crawl.
`S3Target`	`withExclusions(String... exclusions)` A list of glob patterns used to exclude from the crawl.
`S3Target`	`withPath(String path)` The path to the Amazon S3 target.
`S3Target`	`withSampleSize(Integer sampleSize)` Sets the number of files in each leaf folder to be crawled when crawling sample files in a dataset.

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

- Constructor Detail
  - S3Target
```
public S3Target()
```
- Method Detail
  - setPath
```
public void setPath(String path)
```
    The path to the Amazon S3 target.
    
    Parameters:
    
    path - The path to the Amazon S3 target.
  - getPath
```
public String getPath()
```
    The path to the Amazon S3 target.
    
    Returns:
    
    The path to the Amazon S3 target.
  - withPath
```
public S3Target withPath(String path)
```
    The path to the Amazon S3 target.
    
    Parameters:
    
    path - The path to the Amazon S3 target.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getExclusions
```
public List<String> getExclusions()
```
    A list of glob patterns used to exclude from the crawl. For more information, see Catalog Tables with a Crawler.
    
    Returns:
    
    A list of glob patterns used to exclude from the crawl. For more information, see Catalog Tables with a Crawler.
  - setExclusions
```
public void setExclusions(Collection<String> exclusions)
```
    A list of glob patterns used to exclude from the crawl. For more information, see Catalog Tables with a Crawler.
    
    Parameters:
    
    exclusions - A list of glob patterns used to exclude from the crawl. For more information, see Catalog Tables with a Crawler.
  - withExclusions
```
public S3Target withExclusions(String... exclusions)
```
    A list of glob patterns used to exclude from the crawl. For more information, see Catalog Tables with a Crawler.
    
    NOTE: This method appends the values to the existing list (if any). Use setExclusions(java.util.Collection) or withExclusions(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    exclusions - A list of glob patterns used to exclude from the crawl. For more information, see Catalog Tables with a Crawler.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withExclusions
```
public S3Target withExclusions(Collection<String> exclusions)
```
    A list of glob patterns used to exclude from the crawl. For more information, see Catalog Tables with a Crawler.
    
    Parameters:
    
    exclusions - A list of glob patterns used to exclude from the crawl. For more information, see Catalog Tables with a Crawler.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setConnectionName
```
public void setConnectionName(String connectionName)
```
    The name of a connection which allows a job or crawler to access data in Amazon S3 within an Amazon Virtual Private Cloud environment (Amazon VPC).
    
    Parameters:
    
    connectionName - The name of a connection which allows a job or crawler to access data in Amazon S3 within an Amazon Virtual Private Cloud environment (Amazon VPC).
  - getConnectionName
```
public String getConnectionName()
```
    The name of a connection which allows a job or crawler to access data in Amazon S3 within an Amazon Virtual Private Cloud environment (Amazon VPC).
    
    Returns:
    
    The name of a connection which allows a job or crawler to access data in Amazon S3 within an Amazon Virtual Private Cloud environment (Amazon VPC).
  - withConnectionName
```
public S3Target withConnectionName(String connectionName)
```
    The name of a connection which allows a job or crawler to access data in Amazon S3 within an Amazon Virtual Private Cloud environment (Amazon VPC).
    
    Parameters:
    
    connectionName - The name of a connection which allows a job or crawler to access data in Amazon S3 within an Amazon Virtual Private Cloud environment (Amazon VPC).
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setSampleSize
```
public void setSampleSize(Integer sampleSize)
```
    Sets the number of files in each leaf folder to be crawled when crawling sample files in a dataset. If not set, all the files are crawled. A valid value is an integer between 1 and 249.
    
    Parameters:
    
    sampleSize - Sets the number of files in each leaf folder to be crawled when crawling sample files in a dataset. If not set, all the files are crawled. A valid value is an integer between 1 and 249.
  - getSampleSize
```
public Integer getSampleSize()
```
    Sets the number of files in each leaf folder to be crawled when crawling sample files in a dataset. If not set, all the files are crawled. A valid value is an integer between 1 and 249.
    
    Returns:
    
    Sets the number of files in each leaf folder to be crawled when crawling sample files in a dataset. If not set, all the files are crawled. A valid value is an integer between 1 and 249.
  - withSampleSize
```
public S3Target withSampleSize(Integer sampleSize)
```
    Sets the number of files in each leaf folder to be crawled when crawling sample files in a dataset. If not set, all the files are crawled. A valid value is an integer between 1 and 249.
    
    Parameters:
    
    sampleSize - Sets the number of files in each leaf folder to be crawled when crawling sample files in a dataset. If not set, all the files are crawled. A valid value is an integer between 1 and 249.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setEventQueueArn
```
public void setEventQueueArn(String eventQueueArn)
```
    A valid Amazon SQS ARN. For example, arn:aws:sqs:region:account:sqs.
    
    Parameters:
    
    eventQueueArn - A valid Amazon SQS ARN. For example, arn:aws:sqs:region:account:sqs.
  - getEventQueueArn
```
public String getEventQueueArn()
```
    A valid Amazon SQS ARN. For example, arn:aws:sqs:region:account:sqs.
    
    Returns:
    
    A valid Amazon SQS ARN. For example, arn:aws:sqs:region:account:sqs.
  - withEventQueueArn
```
public S3Target withEventQueueArn(String eventQueueArn)
```
    A valid Amazon SQS ARN. For example, arn:aws:sqs:region:account:sqs.
    
    Parameters:
    
    eventQueueArn - A valid Amazon SQS ARN. For example, arn:aws:sqs:region:account:sqs.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setDlqEventQueueArn
```
public void setDlqEventQueueArn(String dlqEventQueueArn)
```
    A valid Amazon dead-letter SQS ARN. For example, arn:aws:sqs:region:account:deadLetterQueue.
    
    Parameters:
    
    dlqEventQueueArn - A valid Amazon dead-letter SQS ARN. For example, arn:aws:sqs:region:account:deadLetterQueue.
  - getDlqEventQueueArn
```
public String getDlqEventQueueArn()
```
    A valid Amazon dead-letter SQS ARN. For example, arn:aws:sqs:region:account:deadLetterQueue.
    
    Returns:
    
    A valid Amazon dead-letter SQS ARN. For example, arn:aws:sqs:region:account:deadLetterQueue.
  - withDlqEventQueueArn
```
public S3Target withDlqEventQueueArn(String dlqEventQueueArn)
```
    A valid Amazon dead-letter SQS ARN. For example, arn:aws:sqs:region:account:deadLetterQueue.
    
    Parameters:
    
    dlqEventQueueArn - A valid Amazon dead-letter SQS ARN. For example, arn:aws:sqs:region:account:deadLetterQueue.
    
    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 S3Target 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.

Did this page help you?

Class S3Target

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

S3Target

Method Detail

setPath

getPath

withPath

getExclusions

setExclusions

withExclusions

withExclusions

setConnectionName

getConnectionName

withConnectionName

setSampleSize

getSampleSize

withSampleSize

setEventQueueArn

getEventQueueArn

withEventQueueArn

setDlqEventQueueArn

getDlqEventQueueArn

withDlqEventQueueArn

toString

equals

hashCode

clone

marshall