Interface CatalogInput.Builder
- All Superinterfaces:
Buildable,CopyableBuilder<CatalogInput.Builder,,CatalogInput> SdkBuilder<CatalogInput.Builder,,CatalogInput> SdkPojo
- Enclosing class:
CatalogInput
-
Method Summary
Modifier and TypeMethodDescriptionallowFullTableExternalDataAccess(String allowFullTableExternalDataAccess) Allows third-party engines to access data in Amazon S3 locations that are registered with Lake Formation.allowFullTableExternalDataAccess(AllowFullTableExternalDataAccessEnum allowFullTableExternalDataAccess) Allows third-party engines to access data in Amazon S3 locations that are registered with Lake Formation.default CatalogInput.BuildercatalogProperties(Consumer<CatalogProperties.Builder> catalogProperties) ACatalogPropertiesobject that specifies data lake access properties and other custom properties.catalogProperties(CatalogProperties catalogProperties) ACatalogPropertiesobject that specifies data lake access properties and other custom properties.createDatabaseDefaultPermissions(Collection<PrincipalPermissions> createDatabaseDefaultPermissions) An array ofPrincipalPermissionsobjects.createDatabaseDefaultPermissions(Consumer<PrincipalPermissions.Builder>... createDatabaseDefaultPermissions) An array ofPrincipalPermissionsobjects.createDatabaseDefaultPermissions(PrincipalPermissions... createDatabaseDefaultPermissions) An array ofPrincipalPermissionsobjects.createTableDefaultPermissions(Collection<PrincipalPermissions> createTableDefaultPermissions) An array ofPrincipalPermissionsobjects.createTableDefaultPermissions(Consumer<PrincipalPermissions.Builder>... createTableDefaultPermissions) An array ofPrincipalPermissionsobjects.createTableDefaultPermissions(PrincipalPermissions... createTableDefaultPermissions) An array ofPrincipalPermissionsobjects.description(String description) Description string, not more than 2048 bytes long, matching the URI address multi-line string pattern.default CatalogInput.BuilderfederatedCatalog(Consumer<FederatedCatalog.Builder> federatedCatalog) AFederatedCatalogobject.federatedCatalog(FederatedCatalog federatedCatalog) AFederatedCatalogobject.parameters(Map<String, String> parameters) A map array of key-value pairs that define the parameters and properties of the catalog.default CatalogInput.BuildertargetRedshiftCatalog(Consumer<TargetRedshiftCatalog.Builder> targetRedshiftCatalog) ATargetRedshiftCatalogobject that describes a target catalog for resource linking.targetRedshiftCatalog(TargetRedshiftCatalog targetRedshiftCatalog) ATargetRedshiftCatalogobject that describes a target catalog for resource linking.Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copyMethods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, buildMethods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFieldNameToField, sdkFields
-
Method Details
-
description
Description string, not more than 2048 bytes long, matching the URI address multi-line string pattern. A description of the catalog.
- Parameters:
description- Description string, not more than 2048 bytes long, matching the URI address multi-line string pattern. A description of the catalog.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
federatedCatalog
A
FederatedCatalogobject. AFederatedCatalogstructure that references an entity outside the Glue Data Catalog, for example a Redshift database.- Parameters:
federatedCatalog- AFederatedCatalogobject. AFederatedCatalogstructure that references an entity outside the Glue Data Catalog, for example a Redshift database.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
federatedCatalog
A
This is a convenience method that creates an instance of theFederatedCatalogobject. AFederatedCatalogstructure that references an entity outside the Glue Data Catalog, for example a Redshift database.FederatedCatalog.Builderavoiding the need to create one manually viaFederatedCatalog.builder().When the
Consumercompletes,SdkBuilder.build()is called immediately and its result is passed tofederatedCatalog(FederatedCatalog).- Parameters:
federatedCatalog- a consumer that will call methods onFederatedCatalog.Builder- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
parameters
A map array of key-value pairs that define the parameters and properties of the catalog.
- Parameters:
parameters- A map array of key-value pairs that define the parameters and properties of the catalog.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
targetRedshiftCatalog
A
TargetRedshiftCatalogobject that describes a target catalog for resource linking.- Parameters:
targetRedshiftCatalog- ATargetRedshiftCatalogobject that describes a target catalog for resource linking.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
targetRedshiftCatalog
default CatalogInput.Builder targetRedshiftCatalog(Consumer<TargetRedshiftCatalog.Builder> targetRedshiftCatalog) A
This is a convenience method that creates an instance of theTargetRedshiftCatalogobject that describes a target catalog for resource linking.TargetRedshiftCatalog.Builderavoiding the need to create one manually viaTargetRedshiftCatalog.builder().When the
Consumercompletes,SdkBuilder.build()is called immediately and its result is passed totargetRedshiftCatalog(TargetRedshiftCatalog).- Parameters:
targetRedshiftCatalog- a consumer that will call methods onTargetRedshiftCatalog.Builder- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
catalogProperties
A
CatalogPropertiesobject that specifies data lake access properties and other custom properties.- Parameters:
catalogProperties- ACatalogPropertiesobject that specifies data lake access properties and other custom properties.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
catalogProperties
default CatalogInput.Builder catalogProperties(Consumer<CatalogProperties.Builder> catalogProperties) A
This is a convenience method that creates an instance of theCatalogPropertiesobject that specifies data lake access properties and other custom properties.CatalogProperties.Builderavoiding the need to create one manually viaCatalogProperties.builder().When the
Consumercompletes,SdkBuilder.build()is called immediately and its result is passed tocatalogProperties(CatalogProperties).- Parameters:
catalogProperties- a consumer that will call methods onCatalogProperties.Builder- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
createTableDefaultPermissions
CatalogInput.Builder createTableDefaultPermissions(Collection<PrincipalPermissions> createTableDefaultPermissions) An array of
PrincipalPermissionsobjects. Creates a set of default permissions on the table(s) for principals. Used by Amazon Web Services Lake Formation. Typically should be explicitly set as an empty list.- Parameters:
createTableDefaultPermissions- An array ofPrincipalPermissionsobjects. Creates a set of default permissions on the table(s) for principals. Used by Amazon Web Services Lake Formation. Typically should be explicitly set as an empty list.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
createTableDefaultPermissions
CatalogInput.Builder createTableDefaultPermissions(PrincipalPermissions... createTableDefaultPermissions) An array of
PrincipalPermissionsobjects. Creates a set of default permissions on the table(s) for principals. Used by Amazon Web Services Lake Formation. Typically should be explicitly set as an empty list.- Parameters:
createTableDefaultPermissions- An array ofPrincipalPermissionsobjects. Creates a set of default permissions on the table(s) for principals. Used by Amazon Web Services Lake Formation. Typically should be explicitly set as an empty list.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
createTableDefaultPermissions
CatalogInput.Builder createTableDefaultPermissions(Consumer<PrincipalPermissions.Builder>... createTableDefaultPermissions) An array of
This is a convenience method that creates an instance of thePrincipalPermissionsobjects. Creates a set of default permissions on the table(s) for principals. Used by Amazon Web Services Lake Formation. Typically should be explicitly set as an empty list.PrincipalPermissions.Builderavoiding the need to create one manually viaPrincipalPermissions.builder().When the
Consumercompletes,SdkBuilder.build()is called immediately and its result is passed tocreateTableDefaultPermissions(List<PrincipalPermissions>).- Parameters:
createTableDefaultPermissions- a consumer that will call methods onPrincipalPermissions.Builder- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
createDatabaseDefaultPermissions
CatalogInput.Builder createDatabaseDefaultPermissions(Collection<PrincipalPermissions> createDatabaseDefaultPermissions) An array of
PrincipalPermissionsobjects. Creates a set of default permissions on the database(s) for principals. Used by Amazon Web Services Lake Formation. Typically should be explicitly set as an empty list.- Parameters:
createDatabaseDefaultPermissions- An array ofPrincipalPermissionsobjects. Creates a set of default permissions on the database(s) for principals. Used by Amazon Web Services Lake Formation. Typically should be explicitly set as an empty list.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
createDatabaseDefaultPermissions
CatalogInput.Builder createDatabaseDefaultPermissions(PrincipalPermissions... createDatabaseDefaultPermissions) An array of
PrincipalPermissionsobjects. Creates a set of default permissions on the database(s) for principals. Used by Amazon Web Services Lake Formation. Typically should be explicitly set as an empty list.- Parameters:
createDatabaseDefaultPermissions- An array ofPrincipalPermissionsobjects. Creates a set of default permissions on the database(s) for principals. Used by Amazon Web Services Lake Formation. Typically should be explicitly set as an empty list.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
createDatabaseDefaultPermissions
CatalogInput.Builder createDatabaseDefaultPermissions(Consumer<PrincipalPermissions.Builder>... createDatabaseDefaultPermissions) An array of
This is a convenience method that creates an instance of thePrincipalPermissionsobjects. Creates a set of default permissions on the database(s) for principals. Used by Amazon Web Services Lake Formation. Typically should be explicitly set as an empty list.PrincipalPermissions.Builderavoiding the need to create one manually viaPrincipalPermissions.builder().When the
Consumercompletes,SdkBuilder.build()is called immediately and its result is passed tocreateDatabaseDefaultPermissions(List<PrincipalPermissions>).- Parameters:
createDatabaseDefaultPermissions- a consumer that will call methods onPrincipalPermissions.Builder- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
allowFullTableExternalDataAccess
Allows third-party engines to access data in Amazon S3 locations that are registered with Lake Formation.
- Parameters:
allowFullTableExternalDataAccess- Allows third-party engines to access data in Amazon S3 locations that are registered with Lake Formation.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
allowFullTableExternalDataAccess
CatalogInput.Builder allowFullTableExternalDataAccess(AllowFullTableExternalDataAccessEnum allowFullTableExternalDataAccess) Allows third-party engines to access data in Amazon S3 locations that are registered with Lake Formation.
- Parameters:
allowFullTableExternalDataAccess- Allows third-party engines to access data in Amazon S3 locations that are registered with Lake Formation.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-