com.amazonaws.services.finspace.model

Class CreateKxChangesetRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.finspace.model.CreateKxChangesetRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

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

Method Summary

Modifier and Type	Method and Description
CreateKxChangesetRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
List<ChangeRequest>	getChangeRequests() A list of change request objects that are run in order.
String	getClientToken() A token that ensures idempotency.
String	getDatabaseName() The name of the kdb database.
String	getEnvironmentId() A unique identifier of the kdb environment.
int	hashCode()
void	setChangeRequests(Collection<ChangeRequest> changeRequests) A list of change request objects that are run in order.
void	setClientToken(String clientToken) A token that ensures idempotency.
void	setDatabaseName(String databaseName) The name of the kdb database.
void	setEnvironmentId(String environmentId) A unique identifier of the kdb environment.
String	toString() Returns a string representation of this object.
CreateKxChangesetRequest	withChangeRequests(ChangeRequest... changeRequests) A list of change request objects that are run in order.
CreateKxChangesetRequest	withChangeRequests(Collection<ChangeRequest> changeRequests) A list of change request objects that are run in order.
CreateKxChangesetRequest	withClientToken(String clientToken) A token that ensures idempotency.
CreateKxChangesetRequest	withDatabaseName(String databaseName) The name of the kdb database.
CreateKxChangesetRequest	withEnvironmentId(String environmentId) A unique identifier of the kdb environment.

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

CreateKxChangesetRequest

public CreateKxChangesetRequest()

Method Detail

setEnvironmentId

public void setEnvironmentId(String environmentId)

A unique identifier of the kdb environment.

Parameters:

environmentId - A unique identifier of the kdb environment.

getEnvironmentId

public String getEnvironmentId()

A unique identifier of the kdb environment.

Returns:

A unique identifier of the kdb environment.

withEnvironmentId

public CreateKxChangesetRequest withEnvironmentId(String environmentId)

A unique identifier of the kdb environment.

Parameters:

environmentId - A unique identifier of the kdb environment.

Returns:

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

setDatabaseName

public void setDatabaseName(String databaseName)

The name of the kdb database.

Parameters:

databaseName - The name of the kdb database.

getDatabaseName

public String getDatabaseName()

The name of the kdb database.

Returns:

The name of the kdb database.

withDatabaseName

public CreateKxChangesetRequest withDatabaseName(String databaseName)

The name of the kdb database.

Parameters:

databaseName - The name of the kdb database.

Returns:

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

getChangeRequests

public List<ChangeRequest> getChangeRequests()

A list of change request objects that are run in order. A change request object consists of changeType , s3Path, and a dbPath. A changeType can has the following values:

• PUT – Adds or updates files in a database.

• DELETE – Deletes files in a database.

All the change requests require a mandatory dbPath attribute that defines the path within the database directory. The s3Path attribute defines the s3 source file path and is required for a PUT change type.

Here is an example of how you can use the change request object:

[ { "changeType": "PUT", "s3Path":"s3://bucket/db/2020.01.02/", "dbPath":"/2020.01.02/"}, { "changeType": "PUT", "s3Path":"s3://bucket/db/sym", "dbPath":"/"}, { "changeType": "DELETE", "dbPath": "/2020.01.01/"} ]

In this example, the first request with PUT change type allows you to add files in the given s3Path under the 2020.01.02 partition of the database. The second request with PUT change type allows you to add a single sym file at database root location. The last request with DELETE change type allows you to delete the files under the 2020.01.01 partition of the database.

Returns:

A list of change request objects that are run in order. A change request object consists of changeType , s3Path, and a dbPath. A changeType can has the following values:

• PUT – Adds or updates files in a database.

• DELETE – Deletes files in a database.

All the change requests require a mandatory dbPath attribute that defines the path within the database directory. The s3Path attribute defines the s3 source file path and is required for a PUT change type.

Here is an example of how you can use the change request object:

[ { "changeType": "PUT", "s3Path":"s3://bucket/db/2020.01.02/", "dbPath":"/2020.01.02/"}, { "changeType": "PUT", "s3Path":"s3://bucket/db/sym", "dbPath":"/"}, { "changeType": "DELETE", "dbPath": "/2020.01.01/"} ]

In this example, the first request with PUT change type allows you to add files in the given s3Path under the 2020.01.02 partition of the database. The second request with PUT change type allows you to add a single sym file at database root location. The last request with DELETE change type allows you to delete the files under the 2020.01.01 partition of the database.

setChangeRequests

public void setChangeRequests(Collection<ChangeRequest> changeRequests)

A list of change request objects that are run in order. A change request object consists of changeType , s3Path, and a dbPath. A changeType can has the following values:

• PUT – Adds or updates files in a database.

• DELETE – Deletes files in a database.

All the change requests require a mandatory dbPath attribute that defines the path within the database directory. The s3Path attribute defines the s3 source file path and is required for a PUT change type.

Here is an example of how you can use the change request object:

[ { "changeType": "PUT", "s3Path":"s3://bucket/db/2020.01.02/", "dbPath":"/2020.01.02/"}, { "changeType": "PUT", "s3Path":"s3://bucket/db/sym", "dbPath":"/"}, { "changeType": "DELETE", "dbPath": "/2020.01.01/"} ]

In this example, the first request with PUT change type allows you to add files in the given s3Path under the 2020.01.02 partition of the database. The second request with PUT change type allows you to add a single sym file at database root location. The last request with DELETE change type allows you to delete the files under the 2020.01.01 partition of the database.

Parameters:

changeRequests - A list of change request objects that are run in order. A change request object consists of changeType , s3Path, and a dbPath. A changeType can has the following values:

• PUT – Adds or updates files in a database.

• DELETE – Deletes files in a database.

All the change requests require a mandatory dbPath attribute that defines the path within the database directory. The s3Path attribute defines the s3 source file path and is required for a PUT change type.

Here is an example of how you can use the change request object:

[ { "changeType": "PUT", "s3Path":"s3://bucket/db/2020.01.02/", "dbPath":"/2020.01.02/"}, { "changeType": "PUT", "s3Path":"s3://bucket/db/sym", "dbPath":"/"}, { "changeType": "DELETE", "dbPath": "/2020.01.01/"} ]

In this example, the first request with PUT change type allows you to add files in the given s3Path under the 2020.01.02 partition of the database. The second request with PUT change type allows you to add a single sym file at database root location. The last request with DELETE change type allows you to delete the files under the 2020.01.01 partition of the database.

withChangeRequests

public CreateKxChangesetRequest withChangeRequests(ChangeRequest... changeRequests)

A list of change request objects that are run in order. A change request object consists of changeType , s3Path, and a dbPath. A changeType can has the following values:

• PUT – Adds or updates files in a database.

• DELETE – Deletes files in a database.

All the change requests require a mandatory dbPath attribute that defines the path within the database directory. The s3Path attribute defines the s3 source file path and is required for a PUT change type.

Here is an example of how you can use the change request object:

[ { "changeType": "PUT", "s3Path":"s3://bucket/db/2020.01.02/", "dbPath":"/2020.01.02/"}, { "changeType": "PUT", "s3Path":"s3://bucket/db/sym", "dbPath":"/"}, { "changeType": "DELETE", "dbPath": "/2020.01.01/"} ]

In this example, the first request with PUT change type allows you to add files in the given s3Path under the 2020.01.02 partition of the database. The second request with PUT change type allows you to add a single sym file at database root location. The last request with DELETE change type allows you to delete the files under the 2020.01.01 partition of the database.

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

Parameters:

changeRequests - A list of change request objects that are run in order. A change request object consists of changeType , s3Path, and a dbPath. A changeType can has the following values:

• PUT – Adds or updates files in a database.

• DELETE – Deletes files in a database.

All the change requests require a mandatory dbPath attribute that defines the path within the database directory. The s3Path attribute defines the s3 source file path and is required for a PUT change type.

Here is an example of how you can use the change request object:

[ { "changeType": "PUT", "s3Path":"s3://bucket/db/2020.01.02/", "dbPath":"/2020.01.02/"}, { "changeType": "PUT", "s3Path":"s3://bucket/db/sym", "dbPath":"/"}, { "changeType": "DELETE", "dbPath": "/2020.01.01/"} ]

In this example, the first request with PUT change type allows you to add files in the given s3Path under the 2020.01.02 partition of the database. The second request with PUT change type allows you to add a single sym file at database root location. The last request with DELETE change type allows you to delete the files under the 2020.01.01 partition of the database.

Returns:

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

withChangeRequests

public CreateKxChangesetRequest withChangeRequests(Collection<ChangeRequest> changeRequests)

A list of change request objects that are run in order. A change request object consists of changeType , s3Path, and a dbPath. A changeType can has the following values:

• PUT – Adds or updates files in a database.

• DELETE – Deletes files in a database.

All the change requests require a mandatory dbPath attribute that defines the path within the database directory. The s3Path attribute defines the s3 source file path and is required for a PUT change type.

Here is an example of how you can use the change request object:

[ { "changeType": "PUT", "s3Path":"s3://bucket/db/2020.01.02/", "dbPath":"/2020.01.02/"}, { "changeType": "PUT", "s3Path":"s3://bucket/db/sym", "dbPath":"/"}, { "changeType": "DELETE", "dbPath": "/2020.01.01/"} ]

In this example, the first request with PUT change type allows you to add files in the given s3Path under the 2020.01.02 partition of the database. The second request with PUT change type allows you to add a single sym file at database root location. The last request with DELETE change type allows you to delete the files under the 2020.01.01 partition of the database.

Parameters:

changeRequests - A list of change request objects that are run in order. A change request object consists of changeType , s3Path, and a dbPath. A changeType can has the following values:

• PUT – Adds or updates files in a database.

• DELETE – Deletes files in a database.

All the change requests require a mandatory dbPath attribute that defines the path within the database directory. The s3Path attribute defines the s3 source file path and is required for a PUT change type.

Here is an example of how you can use the change request object:

[ { "changeType": "PUT", "s3Path":"s3://bucket/db/2020.01.02/", "dbPath":"/2020.01.02/"}, { "changeType": "PUT", "s3Path":"s3://bucket/db/sym", "dbPath":"/"}, { "changeType": "DELETE", "dbPath": "/2020.01.01/"} ]

In this example, the first request with PUT change type allows you to add files in the given s3Path under the 2020.01.02 partition of the database. The second request with PUT change type allows you to add a single sym file at database root location. The last request with DELETE change type allows you to delete the files under the 2020.01.01 partition of the database.

Returns:

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

setClientToken

public void setClientToken(String clientToken)

A token that ensures idempotency. This token expires in 10 minutes.

Parameters:

clientToken - A token that ensures idempotency. This token expires in 10 minutes.

getClientToken

public String getClientToken()

A token that ensures idempotency. This token expires in 10 minutes.

Returns:

A token that ensures idempotency. This token expires in 10 minutes.

withClientToken

public CreateKxChangesetRequest withClientToken(String clientToken)

A token that ensures idempotency. This token expires in 10 minutes.

Parameters:

clientToken - A token that ensures idempotency. This token expires in 10 minutes.

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