Class CatalogInput
- java.lang.Object
-
- software.amazon.awssdk.services.glue.model.CatalogInput
-
- All Implemented Interfaces:
Serializable,SdkPojo,ToCopyableBuilder<CatalogInput.Builder,CatalogInput>
@Generated("software.amazon.awssdk:codegen") public final class CatalogInput extends Object implements SdkPojo, Serializable, ToCopyableBuilder<CatalogInput.Builder,CatalogInput>
A structure that describes catalog properties.
- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interfaceCatalogInput.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description AllowFullTableExternalDataAccessEnumallowFullTableExternalDataAccess()Allows third-party engines to access data in Amazon S3 locations that are registered with Lake Formation.StringallowFullTableExternalDataAccessAsString()Allows third-party engines to access data in Amazon S3 locations that are registered with Lake Formation.static CatalogInput.Builderbuilder()CatalogPropertiescatalogProperties()ACatalogPropertiesobject that specifies data lake access properties and other custom properties.List<PrincipalPermissions>createDatabaseDefaultPermissions()An array ofPrincipalPermissionsobjects.List<PrincipalPermissions>createTableDefaultPermissions()An array ofPrincipalPermissionsobjects.Stringdescription()Description string, not more than 2048 bytes long, matching the URI address multi-line string pattern.booleanequals(Object obj)booleanequalsBySdkFields(Object obj)FederatedCatalogfederatedCatalog()AFederatedCatalogobject.<T> Optional<T>getValueForField(String fieldName, Class<T> clazz)booleanhasCreateDatabaseDefaultPermissions()For responses, this returns true if the service returned a value for the CreateDatabaseDefaultPermissions property.booleanhasCreateTableDefaultPermissions()For responses, this returns true if the service returned a value for the CreateTableDefaultPermissions property.inthashCode()booleanhasParameters()For responses, this returns true if the service returned a value for the Parameters property.Map<String,String>parameters()A map array of key-value pairs that define the parameters and properties of the catalog.Map<String,SdkField<?>>sdkFieldNameToField()List<SdkField<?>>sdkFields()static Class<? extends CatalogInput.Builder>serializableBuilderClass()TargetRedshiftCatalogtargetRedshiftCatalog()ATargetRedshiftCatalogobject that describes a target catalog for resource linking.CatalogInput.BuildertoBuilder()StringtoString()Returns a string representation of this object.-
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
-
-
-
Method Detail
-
description
public final String description()
Description string, not more than 2048 bytes long, matching the URI address multi-line string pattern. A description of the catalog.
- Returns:
- Description string, not more than 2048 bytes long, matching the URI address multi-line string pattern. A description of the catalog.
-
federatedCatalog
public final FederatedCatalog federatedCatalog()
A
FederatedCatalogobject. AFederatedCatalogstructure that references an entity outside the Glue Data Catalog, for example a Redshift database.- Returns:
- A
FederatedCatalogobject. AFederatedCatalogstructure that references an entity outside the Glue Data Catalog, for example a Redshift database.
-
hasParameters
public final boolean hasParameters()
For responses, this returns true if the service returned a value for the Parameters property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
-
parameters
public final Map<String,String> parameters()
A map array of key-value pairs that define the parameters and properties of the catalog.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasParameters()method.- Returns:
- A map array of key-value pairs that define the parameters and properties of the catalog.
-
targetRedshiftCatalog
public final TargetRedshiftCatalog targetRedshiftCatalog()
A
TargetRedshiftCatalogobject that describes a target catalog for resource linking.- Returns:
- A
TargetRedshiftCatalogobject that describes a target catalog for resource linking.
-
catalogProperties
public final CatalogProperties catalogProperties()
A
CatalogPropertiesobject that specifies data lake access properties and other custom properties.- Returns:
- A
CatalogPropertiesobject that specifies data lake access properties and other custom properties.
-
hasCreateTableDefaultPermissions
public final boolean hasCreateTableDefaultPermissions()
For responses, this returns true if the service returned a value for the CreateTableDefaultPermissions property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
-
createTableDefaultPermissions
public final List<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.Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasCreateTableDefaultPermissions()method.- Returns:
- 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.
-
hasCreateDatabaseDefaultPermissions
public final boolean hasCreateDatabaseDefaultPermissions()
For responses, this returns true if the service returned a value for the CreateDatabaseDefaultPermissions property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
-
createDatabaseDefaultPermissions
public final List<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.Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasCreateDatabaseDefaultPermissions()method.- Returns:
- 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.
-
allowFullTableExternalDataAccess
public final AllowFullTableExternalDataAccessEnum allowFullTableExternalDataAccess()
Allows third-party engines to access data in Amazon S3 locations that are registered with Lake Formation.
If the service returns an enum value that is not available in the current SDK version,
allowFullTableExternalDataAccesswill returnAllowFullTableExternalDataAccessEnum.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromallowFullTableExternalDataAccessAsString().- Returns:
- Allows third-party engines to access data in Amazon S3 locations that are registered with Lake Formation.
- See Also:
AllowFullTableExternalDataAccessEnum
-
allowFullTableExternalDataAccessAsString
public final String allowFullTableExternalDataAccessAsString()
Allows third-party engines to access data in Amazon S3 locations that are registered with Lake Formation.
If the service returns an enum value that is not available in the current SDK version,
allowFullTableExternalDataAccesswill returnAllowFullTableExternalDataAccessEnum.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromallowFullTableExternalDataAccessAsString().- Returns:
- Allows third-party engines to access data in Amazon S3 locations that are registered with Lake Formation.
- See Also:
AllowFullTableExternalDataAccessEnum
-
toBuilder
public CatalogInput.Builder toBuilder()
- Specified by:
toBuilderin interfaceToCopyableBuilder<CatalogInput.Builder,CatalogInput>
-
builder
public static CatalogInput.Builder builder()
-
serializableBuilderClass
public static Class<? extends CatalogInput.Builder> serializableBuilderClass()
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFieldsin interfaceSdkPojo
-
toString
public final 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.
-
sdkFieldNameToField
public final Map<String,SdkField<?>> sdkFieldNameToField()
- Specified by:
sdkFieldNameToFieldin interfaceSdkPojo
-
-