Class CreateDataLakeDatasetRequest

java.lang.Object
software.amazon.awssdk.core.SdkRequest
software.amazon.awssdk.awscore.AwsRequest
software.amazon.awssdk.services.supplychain.model.SupplyChainRequest
software.amazon.awssdk.services.supplychain.model.CreateDataLakeDatasetRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<CreateDataLakeDatasetRequest.Builder,CreateDataLakeDatasetRequest>
@Generated("software.amazon.awssdk:codegen") public final class CreateDataLakeDatasetRequest extends SupplyChainRequest implements ToCopyableBuilder<CreateDataLakeDatasetRequest.Builder,CreateDataLakeDatasetRequest>

The request parameters for CreateDataLakeDataset.

  • Method Details

    • instanceId

      public final String instanceId()

      The Amazon Web Services Supply Chain instance identifier.

      Returns:
      The Amazon Web Services Supply Chain instance identifier.

    • namespace

      public final String namespace()

      The namespace of the dataset, besides the custom defined namespace, every instance comes with below pre-defined namespaces:

      Returns:
      The namespace of the dataset, besides the custom defined namespace, every instance comes with below pre-defined namespaces:

    • name

      public final String name()

      The name of the dataset. For asc name space, the name must be one of the supported data entities under https://docs.aws.amazon.com /aws-supply-chain/latest/userguide/data-model-asc.html.

      Returns:
      The name of the dataset. For asc name space, the name must be one of the supported data entities under https:// docs.aws.amazon.com/aws-supply-chain/latest/userguide/data-model-asc.html.

    • schema

      public final DataLakeDatasetSchema schema()

      The custom schema of the data lake dataset and required for dataset in default and custom namespaces.

      Returns:
      The custom schema of the data lake dataset and required for dataset in default and custom namespaces.

    • description

      public final String description()

      The description of the dataset.

      Returns:
      The description of the dataset.

    • partitionSpec

      public final DataLakeDatasetPartitionSpec partitionSpec()

      The partition specification of the dataset. Partitioning can effectively improve the dataset query performance by reducing the amount of data scanned during query execution. But partitioning or not will affect how data get ingested by data ingestion methods, such as SendDataIntegrationEvent's dataset UPSERT will upsert records within partition (instead of within whole dataset). For more details, refer to those data ingestion documentations.

      Returns:
      The partition specification of the dataset. Partitioning can effectively improve the dataset query performance by reducing the amount of data scanned during query execution. But partitioning or not will affect how data get ingested by data ingestion methods, such as SendDataIntegrationEvent's dataset UPSERT will upsert records within partition (instead of within whole dataset). For more details, refer to those data ingestion documentations.

    • hasTags

      public final boolean hasTags()
      For responses, this returns true if the service returned a value for the Tags property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() 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.

    • tags

      public final Map<String,String> tags()

      The tags of the dataset.

      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 hasTags() method.

      Returns:
      The tags of the dataset.

    • toBuilder

      public CreateDataLakeDatasetRequest.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<CreateDataLakeDatasetRequest.Builder,CreateDataLakeDatasetRequest>
      Specified by:
      toBuilder in class SupplyChainRequest
      Returns:
      a builder for type T

    • builder

      public static CreateDataLakeDatasetRequest.Builder builder()

    • serializableBuilderClass

      public static Class<? extends CreateDataLakeDatasetRequest.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class AwsRequest

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class AwsRequest

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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.
      Overrides:
      toString in class Object

    • getValueForField

      public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
      Description copied from class: SdkRequest
      Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkRequest
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.