Class CreateKxDataviewRequest

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

  • Method Details

    • environmentId

      public final String environmentId()

      A unique identifier for the kdb environment, where you want to create the dataview.

      Returns:
      A unique identifier for the kdb environment, where you want to create the dataview.

    • databaseName

      public final String databaseName()

      The name of the database where you want to create a dataview.

      Returns:
      The name of the database where you want to create a dataview.

    • dataviewName

      public final String dataviewName()

      A unique identifier for the dataview.

      Returns:
      A unique identifier for the dataview.

    • azMode

      public final KxAzMode azMode()

      The number of availability zones you want to assign per volume. Currently, FinSpace only supports SINGLE for volumes. This places dataview in a single AZ.

      If the service returns an enum value that is not available in the current SDK version, azMode will return KxAzMode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from azModeAsString().

      Returns:
      The number of availability zones you want to assign per volume. Currently, FinSpace only supports SINGLE for volumes. This places dataview in a single AZ.
      See Also:

    • azModeAsString

      public final String azModeAsString()

      The number of availability zones you want to assign per volume. Currently, FinSpace only supports SINGLE for volumes. This places dataview in a single AZ.

      If the service returns an enum value that is not available in the current SDK version, azMode will return KxAzMode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from azModeAsString().

      Returns:
      The number of availability zones you want to assign per volume. Currently, FinSpace only supports SINGLE for volumes. This places dataview in a single AZ.
      See Also:

    • availabilityZoneId

      public final String availabilityZoneId()

      The identifier of the availability zones.

      Returns:
      The identifier of the availability zones.

    • changesetId

      public final String changesetId()

      A unique identifier of the changeset that you want to use to ingest data.

      Returns:
      A unique identifier of the changeset that you want to use to ingest data.

    • hasSegmentConfigurations

      public final boolean hasSegmentConfigurations()
      For responses, this returns true if the service returned a value for the SegmentConfigurations 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.

    • segmentConfigurations

      public final List<KxDataviewSegmentConfiguration> segmentConfigurations()

      The configuration that contains the database path of the data that you want to place on each selected volume. Each segment must have a unique database path for each volume. If you do not explicitly specify any database path for a volume, they are accessible from the cluster through the default S3/object store segment.

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

      Returns:
      The configuration that contains the database path of the data that you want to place on each selected volume. Each segment must have a unique database path for each volume. If you do not explicitly specify any database path for a volume, they are accessible from the cluster through the default S3/object store segment.

    • autoUpdate

      public final Boolean autoUpdate()

      The option to specify whether you want to apply all the future additions and corrections automatically to the dataview, when you ingest new changesets. The default value is false.

      Returns:
      The option to specify whether you want to apply all the future additions and corrections automatically to the dataview, when you ingest new changesets. The default value is false.

    • readWrite

      public final Boolean readWrite()

      The option to specify whether you want to make the dataview writable to perform database maintenance. The following are some considerations related to writable dataviews.



      • You cannot create partial writable dataviews. When you create writeable dataviews you must provide the entire database path.

      • You cannot perform updates on a writeable dataview. Hence, autoUpdate must be set as False if readWrite is True for a dataview.

      • You must also use a unique volume for creating a writeable dataview. So, if you choose a volume that is already in use by another dataview, the dataview creation fails.

      • Once you create a dataview as writeable, you cannot change it to read-only. So, you cannot update the readWrite parameter later.

      Returns:
      The option to specify whether you want to make the dataview writable to perform database maintenance. The following are some considerations related to writable dataviews.



      • You cannot create partial writable dataviews. When you create writeable dataviews you must provide the entire database path.

      • You cannot perform updates on a writeable dataview. Hence, autoUpdate must be set as False if readWrite is True for a dataview.

      • You must also use a unique volume for creating a writeable dataview. So, if you choose a volume that is already in use by another dataview, the dataview creation fails.

      • Once you create a dataview as writeable, you cannot change it to read-only. So, you cannot update the readWrite parameter later.

    • description

      public final String description()

      A description of the dataview.

      Returns:
      A description of the dataview.

    • 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()

      A list of key-value pairs to label the dataview. You can add up to 50 tags to a dataview.

      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:
      A list of key-value pairs to label the dataview. You can add up to 50 tags to a dataview.

    • clientToken

      public final String clientToken()

      A token that ensures idempotency. This token expires in 10 minutes.

      Returns:
      A token that ensures idempotency. This token expires in 10 minutes.

    • toBuilder

      public CreateKxDataviewRequest.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<CreateKxDataviewRequest.Builder,CreateKxDataviewRequest>
      Specified by:
      toBuilder in class FinspaceRequest
      Returns:
      a builder for type T

    • builder

      public static CreateKxDataviewRequest.Builder builder()

    • serializableBuilderClass

      public static Class<? extends CreateKxDataviewRequest.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.