Interface DataCatalogSummary.Builder
-
- All Superinterfaces:
Buildable,CopyableBuilder<DataCatalogSummary.Builder,DataCatalogSummary>,SdkBuilder<DataCatalogSummary.Builder,DataCatalogSummary>,SdkPojo
- Enclosing class:
- DataCatalogSummary
public static interface DataCatalogSummary.Builder extends SdkPojo, CopyableBuilder<DataCatalogSummary.Builder,DataCatalogSummary>
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description DataCatalogSummary.BuildercatalogName(String catalogName)The name of the data catalog.DataCatalogSummary.BuilderconnectionType(String connectionType)The type of connection for aFEDERATEDdata catalog (for example,REDSHIFT,MYSQL, orSQLSERVER).DataCatalogSummary.BuilderconnectionType(ConnectionType connectionType)The type of connection for aFEDERATEDdata catalog (for example,REDSHIFT,MYSQL, orSQLSERVER).DataCatalogSummary.Buildererror(String error)Text of the error that occurred during data catalog creation or deletion.DataCatalogSummary.Builderstatus(String status)The status of the creation or deletion of the data catalog.DataCatalogSummary.Builderstatus(DataCatalogStatus status)The status of the creation or deletion of the data catalog.DataCatalogSummary.Buildertype(String type)The data catalog type.DataCatalogSummary.Buildertype(DataCatalogType type)The data catalog type.-
Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
-
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
-
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFieldNameToField, sdkFields
-
-
-
-
Method Detail
-
catalogName
DataCatalogSummary.Builder catalogName(String catalogName)
The name of the data catalog. The catalog name is unique for the Amazon Web Services account and can use a maximum of 127 alphanumeric, underscore, at sign, or hyphen characters. The remainder of the length constraint of 256 is reserved for use by Athena.
- Parameters:
catalogName- The name of the data catalog. The catalog name is unique for the Amazon Web Services account and can use a maximum of 127 alphanumeric, underscore, at sign, or hyphen characters. The remainder of the length constraint of 256 is reserved for use by Athena.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
type
DataCatalogSummary.Builder type(String type)
The data catalog type.
- Parameters:
type- The data catalog type.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
DataCatalogType,DataCatalogType
-
type
DataCatalogSummary.Builder type(DataCatalogType type)
The data catalog type.
- Parameters:
type- The data catalog type.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
DataCatalogType,DataCatalogType
-
status
DataCatalogSummary.Builder status(String status)
The status of the creation or deletion of the data catalog.
-
The
LAMBDA,GLUE, andHIVEdata catalog types are created synchronously. Their status is eitherCREATE_COMPLETEorCREATE_FAILED. -
The
FEDERATEDdata catalog type is created asynchronously.
Data catalog creation status:
-
CREATE_IN_PROGRESS: Federated data catalog creation in progress. -
CREATE_COMPLETE: Data catalog creation complete. -
CREATE_FAILED: Data catalog could not be created. -
CREATE_FAILED_CLEANUP_IN_PROGRESS: Federated data catalog creation failed and is being removed. -
CREATE_FAILED_CLEANUP_COMPLETE: Federated data catalog creation failed and was removed. -
CREATE_FAILED_CLEANUP_FAILED: Federated data catalog creation failed but could not be removed.
Data catalog deletion status:
-
DELETE_IN_PROGRESS: Federated data catalog deletion in progress. -
DELETE_COMPLETE: Federated data catalog deleted. -
DELETE_FAILED: Federated data catalog could not be deleted.
- Parameters:
status- The status of the creation or deletion of the data catalog.-
The
LAMBDA,GLUE, andHIVEdata catalog types are created synchronously. Their status is eitherCREATE_COMPLETEorCREATE_FAILED. -
The
FEDERATEDdata catalog type is created asynchronously.
Data catalog creation status:
-
CREATE_IN_PROGRESS: Federated data catalog creation in progress. -
CREATE_COMPLETE: Data catalog creation complete. -
CREATE_FAILED: Data catalog could not be created. -
CREATE_FAILED_CLEANUP_IN_PROGRESS: Federated data catalog creation failed and is being removed. -
CREATE_FAILED_CLEANUP_COMPLETE: Federated data catalog creation failed and was removed. -
CREATE_FAILED_CLEANUP_FAILED: Federated data catalog creation failed but could not be removed.
Data catalog deletion status:
-
DELETE_IN_PROGRESS: Federated data catalog deletion in progress. -
DELETE_COMPLETE: Federated data catalog deleted. -
DELETE_FAILED: Federated data catalog could not be deleted.
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
DataCatalogStatus,DataCatalogStatus
-
-
status
DataCatalogSummary.Builder status(DataCatalogStatus status)
The status of the creation or deletion of the data catalog.
-
The
LAMBDA,GLUE, andHIVEdata catalog types are created synchronously. Their status is eitherCREATE_COMPLETEorCREATE_FAILED. -
The
FEDERATEDdata catalog type is created asynchronously.
Data catalog creation status:
-
CREATE_IN_PROGRESS: Federated data catalog creation in progress. -
CREATE_COMPLETE: Data catalog creation complete. -
CREATE_FAILED: Data catalog could not be created. -
CREATE_FAILED_CLEANUP_IN_PROGRESS: Federated data catalog creation failed and is being removed. -
CREATE_FAILED_CLEANUP_COMPLETE: Federated data catalog creation failed and was removed. -
CREATE_FAILED_CLEANUP_FAILED: Federated data catalog creation failed but could not be removed.
Data catalog deletion status:
-
DELETE_IN_PROGRESS: Federated data catalog deletion in progress. -
DELETE_COMPLETE: Federated data catalog deleted. -
DELETE_FAILED: Federated data catalog could not be deleted.
- Parameters:
status- The status of the creation or deletion of the data catalog.-
The
LAMBDA,GLUE, andHIVEdata catalog types are created synchronously. Their status is eitherCREATE_COMPLETEorCREATE_FAILED. -
The
FEDERATEDdata catalog type is created asynchronously.
Data catalog creation status:
-
CREATE_IN_PROGRESS: Federated data catalog creation in progress. -
CREATE_COMPLETE: Data catalog creation complete. -
CREATE_FAILED: Data catalog could not be created. -
CREATE_FAILED_CLEANUP_IN_PROGRESS: Federated data catalog creation failed and is being removed. -
CREATE_FAILED_CLEANUP_COMPLETE: Federated data catalog creation failed and was removed. -
CREATE_FAILED_CLEANUP_FAILED: Federated data catalog creation failed but could not be removed.
Data catalog deletion status:
-
DELETE_IN_PROGRESS: Federated data catalog deletion in progress. -
DELETE_COMPLETE: Federated data catalog deleted. -
DELETE_FAILED: Federated data catalog could not be deleted.
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
DataCatalogStatus,DataCatalogStatus
-
-
connectionType
DataCatalogSummary.Builder connectionType(String connectionType)
The type of connection for a
FEDERATEDdata catalog (for example,REDSHIFT,MYSQL, orSQLSERVER). For information about individual connectors, see Available data source connectors.- Parameters:
connectionType- The type of connection for aFEDERATEDdata catalog (for example,REDSHIFT,MYSQL, orSQLSERVER). For information about individual connectors, see Available data source connectors.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
ConnectionType,ConnectionType
-
connectionType
DataCatalogSummary.Builder connectionType(ConnectionType connectionType)
The type of connection for a
FEDERATEDdata catalog (for example,REDSHIFT,MYSQL, orSQLSERVER). For information about individual connectors, see Available data source connectors.- Parameters:
connectionType- The type of connection for aFEDERATEDdata catalog (for example,REDSHIFT,MYSQL, orSQLSERVER). For information about individual connectors, see Available data source connectors.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
ConnectionType,ConnectionType
-
error
DataCatalogSummary.Builder error(String error)
Text of the error that occurred during data catalog creation or deletion.
- Parameters:
error- Text of the error that occurred during data catalog creation or deletion.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
-