com.amazonaws.services.quicksight.model

Class CreateDataSourceRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.quicksight.model.CreateDataSourceRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class CreateDataSourceRequest
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
CreateDataSourceRequest()

Method Summary

Modifier and Type	Method and Description
CreateDataSourceRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
String	getAwsAccountId() The Amazon Web Services account ID.
DataSourceCredentials	getCredentials() The credentials Amazon QuickSight that uses to connect to your underlying source.
String	getDataSourceId() An ID for the data source.
DataSourceParameters	getDataSourceParameters() The parameters that Amazon QuickSight uses to connect to your underlying source.
List<String>	getFolderArns() When you create the data source, Amazon QuickSight adds the data source to these folders.
String	getName() A display name for the data source.
List<ResourcePermission>	getPermissions() A list of resource permissions on the data source.
SslProperties	getSslProperties() Secure Socket Layer (SSL) properties that apply when Amazon QuickSight connects to your underlying source.
List<Tag>	getTags() Contains a map of the key-value pairs for the resource tag or tags assigned to the data source.
String	getType() The type of the data source.
VpcConnectionProperties	getVpcConnectionProperties() Use this parameter only when you want Amazon QuickSight to use a VPC connection when connecting to your underlying source.
int	hashCode()
void	setAwsAccountId(String awsAccountId) The Amazon Web Services account ID.
void	setCredentials(DataSourceCredentials credentials) The credentials Amazon QuickSight that uses to connect to your underlying source.
void	setDataSourceId(String dataSourceId) An ID for the data source.
void	setDataSourceParameters(DataSourceParameters dataSourceParameters) The parameters that Amazon QuickSight uses to connect to your underlying source.
void	setFolderArns(Collection<String> folderArns) When you create the data source, Amazon QuickSight adds the data source to these folders.
void	setName(String name) A display name for the data source.
void	setPermissions(Collection<ResourcePermission> permissions) A list of resource permissions on the data source.
void	setSslProperties(SslProperties sslProperties) Secure Socket Layer (SSL) properties that apply when Amazon QuickSight connects to your underlying source.
void	setTags(Collection<Tag> tags) Contains a map of the key-value pairs for the resource tag or tags assigned to the data source.
void	setType(String type) The type of the data source.
void	setVpcConnectionProperties(VpcConnectionProperties vpcConnectionProperties) Use this parameter only when you want Amazon QuickSight to use a VPC connection when connecting to your underlying source.
String	toString() Returns a string representation of this object.
CreateDataSourceRequest	withAwsAccountId(String awsAccountId) The Amazon Web Services account ID.
CreateDataSourceRequest	withCredentials(DataSourceCredentials credentials) The credentials Amazon QuickSight that uses to connect to your underlying source.
CreateDataSourceRequest	withDataSourceId(String dataSourceId) An ID for the data source.
CreateDataSourceRequest	withDataSourceParameters(DataSourceParameters dataSourceParameters) The parameters that Amazon QuickSight uses to connect to your underlying source.
CreateDataSourceRequest	withFolderArns(Collection<String> folderArns) When you create the data source, Amazon QuickSight adds the data source to these folders.
CreateDataSourceRequest	withFolderArns(String... folderArns) When you create the data source, Amazon QuickSight adds the data source to these folders.
CreateDataSourceRequest	withName(String name) A display name for the data source.
CreateDataSourceRequest	withPermissions(Collection<ResourcePermission> permissions) A list of resource permissions on the data source.
CreateDataSourceRequest	withPermissions(ResourcePermission... permissions) A list of resource permissions on the data source.
CreateDataSourceRequest	withSslProperties(SslProperties sslProperties) Secure Socket Layer (SSL) properties that apply when Amazon QuickSight connects to your underlying source.
CreateDataSourceRequest	withTags(Collection<Tag> tags) Contains a map of the key-value pairs for the resource tag or tags assigned to the data source.
CreateDataSourceRequest	withTags(Tag... tags) Contains a map of the key-value pairs for the resource tag or tags assigned to the data source.
CreateDataSourceRequest	withType(DataSourceType type) The type of the data source.
CreateDataSourceRequest	withType(String type) The type of the data source.
CreateDataSourceRequest	withVpcConnectionProperties(VpcConnectionProperties vpcConnectionProperties) Use this parameter only when you want Amazon QuickSight to use a VPC connection when connecting to your underlying source.

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

CreateDataSourceRequest

public CreateDataSourceRequest()

Method Detail

setAwsAccountId

public void setAwsAccountId(String awsAccountId)

The Amazon Web Services account ID.

Parameters:

awsAccountId - The Amazon Web Services account ID.

getAwsAccountId

public String getAwsAccountId()

The Amazon Web Services account ID.

Returns:

The Amazon Web Services account ID.

withAwsAccountId

public CreateDataSourceRequest withAwsAccountId(String awsAccountId)

The Amazon Web Services account ID.

Parameters:

awsAccountId - The Amazon Web Services account ID.

Returns:

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

setDataSourceId

public void setDataSourceId(String dataSourceId)

An ID for the data source. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

Parameters:

dataSourceId - An ID for the data source. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

getDataSourceId

public String getDataSourceId()

An ID for the data source. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

Returns:

An ID for the data source. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

withDataSourceId

public CreateDataSourceRequest withDataSourceId(String dataSourceId)

An ID for the data source. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

Parameters:

dataSourceId - An ID for the data source. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

Returns:

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

setName

public void setName(String name)

A display name for the data source.

Parameters:

name - A display name for the data source.

getName

public String getName()

A display name for the data source.

Returns:

A display name for the data source.

withName

public CreateDataSourceRequest withName(String name)

A display name for the data source.

Parameters:

name - A display name for the data source.

Returns:

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

setType

public void setType(String type)

The type of the data source. To return a list of all data sources, use ListDataSources.

Use AMAZON_ELASTICSEARCH for Amazon OpenSearch Service.

Parameters:

type - The type of the data source. To return a list of all data sources, use ListDataSources.

Use AMAZON_ELASTICSEARCH for Amazon OpenSearch Service.

See Also:

DataSourceType

getType

public String getType()

The type of the data source. To return a list of all data sources, use ListDataSources.

Use AMAZON_ELASTICSEARCH for Amazon OpenSearch Service.

Returns:

The type of the data source. To return a list of all data sources, use ListDataSources.

Use AMAZON_ELASTICSEARCH for Amazon OpenSearch Service.

See Also:

DataSourceType

withType

public CreateDataSourceRequest withType(String type)

The type of the data source. To return a list of all data sources, use ListDataSources.

Use AMAZON_ELASTICSEARCH for Amazon OpenSearch Service.

Parameters:

type - The type of the data source. To return a list of all data sources, use ListDataSources.

Use AMAZON_ELASTICSEARCH for Amazon OpenSearch Service.

Returns:

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

See Also:

DataSourceType

withType

public CreateDataSourceRequest withType(DataSourceType type)

The type of the data source. To return a list of all data sources, use ListDataSources.

Use AMAZON_ELASTICSEARCH for Amazon OpenSearch Service.

Parameters:

type - The type of the data source. To return a list of all data sources, use ListDataSources.

Use AMAZON_ELASTICSEARCH for Amazon OpenSearch Service.

Returns:

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

See Also:

DataSourceType

setDataSourceParameters

public void setDataSourceParameters(DataSourceParameters dataSourceParameters)

The parameters that Amazon QuickSight uses to connect to your underlying source.

Parameters:

dataSourceParameters - The parameters that Amazon QuickSight uses to connect to your underlying source.

getDataSourceParameters

public DataSourceParameters getDataSourceParameters()

The parameters that Amazon QuickSight uses to connect to your underlying source.

Returns:

The parameters that Amazon QuickSight uses to connect to your underlying source.

withDataSourceParameters

public CreateDataSourceRequest withDataSourceParameters(DataSourceParameters dataSourceParameters)

The parameters that Amazon QuickSight uses to connect to your underlying source.

Parameters:

dataSourceParameters - The parameters that Amazon QuickSight uses to connect to your underlying source.

Returns:

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

setCredentials

public void setCredentials(DataSourceCredentials credentials)

The credentials Amazon QuickSight that uses to connect to your underlying source. Currently, only credentials based on user name and password are supported.

Parameters:

credentials - The credentials Amazon QuickSight that uses to connect to your underlying source. Currently, only credentials based on user name and password are supported.

getCredentials

public DataSourceCredentials getCredentials()

The credentials Amazon QuickSight that uses to connect to your underlying source. Currently, only credentials based on user name and password are supported.

Returns:

The credentials Amazon QuickSight that uses to connect to your underlying source. Currently, only credentials based on user name and password are supported.

withCredentials

public CreateDataSourceRequest withCredentials(DataSourceCredentials credentials)

The credentials Amazon QuickSight that uses to connect to your underlying source. Currently, only credentials based on user name and password are supported.

Parameters:

credentials - The credentials Amazon QuickSight that uses to connect to your underlying source. Currently, only credentials based on user name and password are supported.

Returns:

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

getPermissions

public List<ResourcePermission> getPermissions()

A list of resource permissions on the data source.

Returns:

A list of resource permissions on the data source.

setPermissions

public void setPermissions(Collection<ResourcePermission> permissions)

A list of resource permissions on the data source.

Parameters:

permissions - A list of resource permissions on the data source.

withPermissions

public CreateDataSourceRequest withPermissions(ResourcePermission... permissions)

A list of resource permissions on the data source.

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

Parameters:

permissions - A list of resource permissions on the data source.

Returns:

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

withPermissions

public CreateDataSourceRequest withPermissions(Collection<ResourcePermission> permissions)

A list of resource permissions on the data source.

Parameters:

permissions - A list of resource permissions on the data source.

Returns:

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

setVpcConnectionProperties

public void setVpcConnectionProperties(VpcConnectionProperties vpcConnectionProperties)

Use this parameter only when you want Amazon QuickSight to use a VPC connection when connecting to your underlying source.

Parameters:

vpcConnectionProperties - Use this parameter only when you want Amazon QuickSight to use a VPC connection when connecting to your underlying source.

getVpcConnectionProperties

public VpcConnectionProperties getVpcConnectionProperties()

Use this parameter only when you want Amazon QuickSight to use a VPC connection when connecting to your underlying source.

Returns:

Use this parameter only when you want Amazon QuickSight to use a VPC connection when connecting to your underlying source.

withVpcConnectionProperties

public CreateDataSourceRequest withVpcConnectionProperties(VpcConnectionProperties vpcConnectionProperties)

Use this parameter only when you want Amazon QuickSight to use a VPC connection when connecting to your underlying source.

Parameters:

vpcConnectionProperties - Use this parameter only when you want Amazon QuickSight to use a VPC connection when connecting to your underlying source.

Returns:

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

setSslProperties

public void setSslProperties(SslProperties sslProperties)

Secure Socket Layer (SSL) properties that apply when Amazon QuickSight connects to your underlying source.

Parameters:

sslProperties - Secure Socket Layer (SSL) properties that apply when Amazon QuickSight connects to your underlying source.

getSslProperties

public SslProperties getSslProperties()

Secure Socket Layer (SSL) properties that apply when Amazon QuickSight connects to your underlying source.

Returns:

Secure Socket Layer (SSL) properties that apply when Amazon QuickSight connects to your underlying source.

withSslProperties

public CreateDataSourceRequest withSslProperties(SslProperties sslProperties)

Secure Socket Layer (SSL) properties that apply when Amazon QuickSight connects to your underlying source.

Parameters:

sslProperties - Secure Socket Layer (SSL) properties that apply when Amazon QuickSight connects to your underlying source.

Returns:

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

getTags

public List<Tag> getTags()

Contains a map of the key-value pairs for the resource tag or tags assigned to the data source.

Returns:

Contains a map of the key-value pairs for the resource tag or tags assigned to the data source.

setTags

public void setTags(Collection<Tag> tags)

Contains a map of the key-value pairs for the resource tag or tags assigned to the data source.

Parameters:

tags - Contains a map of the key-value pairs for the resource tag or tags assigned to the data source.

withTags

public CreateDataSourceRequest withTags(Tag... tags)

Contains a map of the key-value pairs for the resource tag or tags assigned to the data source.

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 - Contains a map of the key-value pairs for the resource tag or tags assigned to the data source.

Returns:

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

withTags

public CreateDataSourceRequest withTags(Collection<Tag> tags)

Contains a map of the key-value pairs for the resource tag or tags assigned to the data source.

Parameters:

tags - Contains a map of the key-value pairs for the resource tag or tags assigned to the data source.

Returns:

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

getFolderArns

public List<String> getFolderArns()

When you create the data source, Amazon QuickSight adds the data source to these folders.

Returns:

When you create the data source, Amazon QuickSight adds the data source to these folders.

setFolderArns

public void setFolderArns(Collection<String> folderArns)

When you create the data source, Amazon QuickSight adds the data source to these folders.

Parameters:

folderArns - When you create the data source, Amazon QuickSight adds the data source to these folders.

withFolderArns

public CreateDataSourceRequest withFolderArns(String... folderArns)

When you create the data source, Amazon QuickSight adds the data source to these folders.

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

Parameters:

folderArns - When you create the data source, Amazon QuickSight adds the data source to these folders.

Returns:

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

withFolderArns

public CreateDataSourceRequest withFolderArns(Collection<String> folderArns)

When you create the data source, Amazon QuickSight adds the data source to these folders.

Parameters:

folderArns - When you create the data source, Amazon QuickSight adds the data source to these folders.

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 CreateDataSourceRequest 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()