Class UpdateDataCatalogRequest
- java.lang.Object
-
- software.amazon.awssdk.core.SdkRequest
-
- software.amazon.awssdk.awscore.AwsRequest
-
- software.amazon.awssdk.services.athena.model.AthenaRequest
-
- software.amazon.awssdk.services.athena.model.UpdateDataCatalogRequest
-
- All Implemented Interfaces:
SdkPojo,ToCopyableBuilder<UpdateDataCatalogRequest.Builder,UpdateDataCatalogRequest>
@Generated("software.amazon.awssdk:codegen") public final class UpdateDataCatalogRequest extends AthenaRequest implements ToCopyableBuilder<UpdateDataCatalogRequest.Builder,UpdateDataCatalogRequest>
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interfaceUpdateDataCatalogRequest.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static UpdateDataCatalogRequest.Builderbuilder()Stringdescription()New or modified text that describes the data catalog.booleanequals(Object obj)booleanequalsBySdkFields(Object obj)<T> Optional<T>getValueForField(String fieldName, Class<T> clazz)inthashCode()booleanhasParameters()For responses, this returns true if the service returned a value for the Parameters property.Stringname()The name of the data catalog to update.Map<String,String>parameters()Specifies the Lambda function or functions to use for updating the data catalog.Map<String,SdkField<?>>sdkFieldNameToField()List<SdkField<?>>sdkFields()static Class<? extends UpdateDataCatalogRequest.Builder>serializableBuilderClass()UpdateDataCatalogRequest.BuildertoBuilder()StringtoString()Returns a string representation of this object.DataCatalogTypetype()Specifies the type of data catalog to update.StringtypeAsString()Specifies the type of data catalog to update.-
Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration
-
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
-
name
public final String name()
The name of the data catalog to update. The catalog name must be 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:
- The name of the data catalog to update. The catalog name must be 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.
-
type
public final DataCatalogType type()
Specifies the type of data catalog to update. Specify
LAMBDAfor a federated catalog,HIVEfor an external hive metastore, orGLUEfor an Glue Data Catalog.If the service returns an enum value that is not available in the current SDK version,
typewill returnDataCatalogType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromtypeAsString().- Returns:
- Specifies the type of data catalog to update. Specify
LAMBDAfor a federated catalog,HIVEfor an external hive metastore, orGLUEfor an Glue Data Catalog. - See Also:
DataCatalogType
-
typeAsString
public final String typeAsString()
Specifies the type of data catalog to update. Specify
LAMBDAfor a federated catalog,HIVEfor an external hive metastore, orGLUEfor an Glue Data Catalog.If the service returns an enum value that is not available in the current SDK version,
typewill returnDataCatalogType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromtypeAsString().- Returns:
- Specifies the type of data catalog to update. Specify
LAMBDAfor a federated catalog,HIVEfor an external hive metastore, orGLUEfor an Glue Data Catalog. - See Also:
DataCatalogType
-
description
public final String description()
New or modified text that describes the data catalog.
- Returns:
- New or modified text that describes the data catalog.
-
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()
Specifies the Lambda function or functions to use for updating the data catalog. This is a mapping whose values depend on the catalog type.
-
For the
HIVEdata catalog type, use the following syntax. Themetadata-functionparameter is required.The sdk-versionparameter is optional and defaults to the currently supported version.metadata-function=lambda_arn, sdk-version=version_number -
For the
LAMBDAdata catalog type, use one of the following sets of required parameters, but not both.-
If you have one Lambda function that processes metadata and another for reading the actual data, use the following syntax. Both parameters are required.
metadata-function=lambda_arn, record-function=lambda_arn -
If you have a composite Lambda function that processes both metadata and data, use the following syntax to specify your Lambda function.
function=lambda_arn
-
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:
- Specifies the Lambda function or functions to use for updating the data catalog. This is a mapping whose
values depend on the catalog type.
-
For the
HIVEdata catalog type, use the following syntax. Themetadata-functionparameter is required.The sdk-versionparameter is optional and defaults to the currently supported version.metadata-function=lambda_arn, sdk-version=version_number -
For the
LAMBDAdata catalog type, use one of the following sets of required parameters, but not both.-
If you have one Lambda function that processes metadata and another for reading the actual data, use the following syntax. Both parameters are required.
metadata-function=lambda_arn, record-function=lambda_arn -
If you have a composite Lambda function that processes both metadata and data, use the following syntax to specify your Lambda function.
function=lambda_arn
-
-
-
-
toBuilder
public UpdateDataCatalogRequest.Builder toBuilder()
- Specified by:
toBuilderin interfaceToCopyableBuilder<UpdateDataCatalogRequest.Builder,UpdateDataCatalogRequest>- Specified by:
toBuilderin classAthenaRequest
-
builder
public static UpdateDataCatalogRequest.Builder builder()
-
serializableBuilderClass
public static Class<? extends UpdateDataCatalogRequest.Builder> serializableBuilderClass()
-
hashCode
public final int hashCode()
- Overrides:
hashCodein classAwsRequest
-
equals
public final boolean equals(Object obj)
- Overrides:
equalsin classAwsRequest
-
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.
-
getValueForField
public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
- Overrides:
getValueForFieldin classSdkRequest
-
sdkFieldNameToField
public final Map<String,SdkField<?>> sdkFieldNameToField()
- Specified by:
sdkFieldNameToFieldin interfaceSdkPojo
-
-