ReferenceDataSourceDescription (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.kinesisanalytics.model.ReferenceDataSourceDescription

All Implemented Interfaces:: StructuredPojo, Serializable, Cloneable

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

Describes the reference data source configured for an application.

See Also:: AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

ReferenceDataSourceDescription()

Constructors
Constructor and Description
`ReferenceDataSourceDescription()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`ReferenceDataSourceDescription`	`clone()`
`boolean`	`equals(Object obj)`
`String`	`getReferenceId()` ID of the reference data source.
`SourceSchema`	`getReferenceSchema()`
`S3ReferenceDataSourceDescription`	`getS3ReferenceDataSourceDescription()` Provides the S3 bucket name, the object key name that contains the reference data.
`String`	`getTableName()` The in-application table name created by the specific reference data source configuration.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setReferenceId(String referenceId)` ID of the reference data source.
`void`	`setReferenceSchema(SourceSchema referenceSchema)`
`void`	`setS3ReferenceDataSourceDescription(S3ReferenceDataSourceDescription s3ReferenceDataSourceDescription)` Provides the S3 bucket name, the object key name that contains the reference data.
`void`	`setTableName(String tableName)` The in-application table name created by the specific reference data source configuration.
`String`	`toString()` Returns a string representation of this object; useful for testing and debugging.
`ReferenceDataSourceDescription`	`withReferenceId(String referenceId)` ID of the reference data source.
`ReferenceDataSourceDescription`	`withReferenceSchema(SourceSchema referenceSchema)`
`ReferenceDataSourceDescription`	`withS3ReferenceDataSourceDescription(S3ReferenceDataSourceDescription s3ReferenceDataSourceDescription)` Provides the S3 bucket name, the object key name that contains the reference data.
`ReferenceDataSourceDescription`	`withTableName(String tableName)` The in-application table name created by the specific reference data source configuration.

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

- Constructor Detail
  - ReferenceDataSourceDescription
```
public ReferenceDataSourceDescription()
```
- Method Detail
  - setReferenceId
```
public void setReferenceId(String referenceId)
```
    ID of the reference data source. This is the ID that Amazon Kinesis Analytics assigns when you add the reference data source to your application using the AddApplicationReferenceDataSource operation.
    
    Parameters:
    
    referenceId - ID of the reference data source. This is the ID that Amazon Kinesis Analytics assigns when you add the reference data source to your application using the AddApplicationReferenceDataSource operation.
  - getReferenceId
```
public String getReferenceId()
```
    ID of the reference data source. This is the ID that Amazon Kinesis Analytics assigns when you add the reference data source to your application using the AddApplicationReferenceDataSource operation.
    
    Returns:
    
    ID of the reference data source. This is the ID that Amazon Kinesis Analytics assigns when you add the reference data source to your application using the AddApplicationReferenceDataSource operation.
  - withReferenceId
```
public ReferenceDataSourceDescription withReferenceId(String referenceId)
```
    ID of the reference data source. This is the ID that Amazon Kinesis Analytics assigns when you add the reference data source to your application using the AddApplicationReferenceDataSource operation.
    
    Parameters:
    
    referenceId - ID of the reference data source. This is the ID that Amazon Kinesis Analytics assigns when you add the reference data source to your application using the AddApplicationReferenceDataSource operation.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setTableName
```
public void setTableName(String tableName)
```
    The in-application table name created by the specific reference data source configuration.
    
    Parameters:
    
    tableName - The in-application table name created by the specific reference data source configuration.
  - getTableName
```
public String getTableName()
```
    The in-application table name created by the specific reference data source configuration.
    
    Returns:
    
    The in-application table name created by the specific reference data source configuration.
  - withTableName
```
public ReferenceDataSourceDescription withTableName(String tableName)
```
    The in-application table name created by the specific reference data source configuration.
    
    Parameters:
    
    tableName - The in-application table name created by the specific reference data source configuration.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setS3ReferenceDataSourceDescription
```
public void setS3ReferenceDataSourceDescription(S3ReferenceDataSourceDescription s3ReferenceDataSourceDescription)
```
    Provides the S3 bucket name, the object key name that contains the reference data. It also provides the Amazon Resource Name (ARN) of the IAM role that Amazon Kinesis Analytics can assume to read the Amazon S3 object and populate the in-application reference table.
    
    Parameters:
    
    s3ReferenceDataSourceDescription - Provides the S3 bucket name, the object key name that contains the reference data. It also provides the Amazon Resource Name (ARN) of the IAM role that Amazon Kinesis Analytics can assume to read the Amazon S3 object and populate the in-application reference table.
  - getS3ReferenceDataSourceDescription
```
public S3ReferenceDataSourceDescription getS3ReferenceDataSourceDescription()
```
    Provides the S3 bucket name, the object key name that contains the reference data. It also provides the Amazon Resource Name (ARN) of the IAM role that Amazon Kinesis Analytics can assume to read the Amazon S3 object and populate the in-application reference table.
    
    Returns:
    
    Provides the S3 bucket name, the object key name that contains the reference data. It also provides the Amazon Resource Name (ARN) of the IAM role that Amazon Kinesis Analytics can assume to read the Amazon S3 object and populate the in-application reference table.
  - withS3ReferenceDataSourceDescription
```
public ReferenceDataSourceDescription withS3ReferenceDataSourceDescription(S3ReferenceDataSourceDescription s3ReferenceDataSourceDescription)
```
    Provides the S3 bucket name, the object key name that contains the reference data. It also provides the Amazon Resource Name (ARN) of the IAM role that Amazon Kinesis Analytics can assume to read the Amazon S3 object and populate the in-application reference table.
    
    Parameters:
    
    s3ReferenceDataSourceDescription - Provides the S3 bucket name, the object key name that contains the reference data. It also provides the Amazon Resource Name (ARN) of the IAM role that Amazon Kinesis Analytics can assume to read the Amazon S3 object and populate the in-application reference table.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setReferenceSchema
```
public void setReferenceSchema(SourceSchema referenceSchema)
```
    Parameters:
    
    referenceSchema -
  - getReferenceSchema
```
public SourceSchema getReferenceSchema()
```
    Returns:
  - withReferenceSchema
```
public ReferenceDataSourceDescription withReferenceSchema(SourceSchema referenceSchema)
```
    Parameters:
    
    referenceSchema -
    
    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; useful for testing and debugging.
    
    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 ReferenceDataSourceDescription 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 ReferenceDataSourceDescription

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ReferenceDataSourceDescription

Method Detail

setReferenceId

getReferenceId

withReferenceId

setTableName

getTableName

withTableName

setS3ReferenceDataSourceDescription

getS3ReferenceDataSourceDescription

withS3ReferenceDataSourceDescription

setReferenceSchema

getReferenceSchema

withReferenceSchema

toString

equals

hashCode

clone

marshall