Interface CreateKxDataviewRequest.Builder

All Superinterfaces:
AwsRequest.Builder, Buildable, CopyableBuilder<CreateKxDataviewRequest.Builder,CreateKxDataviewRequest>, FinspaceRequest.Builder, SdkBuilder<CreateKxDataviewRequest.Builder,CreateKxDataviewRequest>, SdkPojo, SdkRequest.Builder
Enclosing class:
CreateKxDataviewRequest
@Mutable @NotThreadSafe public static interface CreateKxDataviewRequest.Builder extends FinspaceRequest.Builder, SdkPojo, CopyableBuilder<CreateKxDataviewRequest.Builder,CreateKxDataviewRequest>

  • Method Details

    • environmentId

      CreateKxDataviewRequest.Builder environmentId(String environmentId)

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

      Parameters:
      environmentId - A unique identifier for the kdb environment, where you want to create the dataview.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • databaseName

      CreateKxDataviewRequest.Builder databaseName(String databaseName)

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

      Parameters:
      databaseName - The name of the database where you want to create a dataview.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • dataviewName

      CreateKxDataviewRequest.Builder dataviewName(String dataviewName)

      A unique identifier for the dataview.

      Parameters:
      dataviewName - A unique identifier for the dataview.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • azMode

      CreateKxDataviewRequest.Builder azMode(String 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.

      Parameters:
      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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • azMode

      CreateKxDataviewRequest.Builder azMode(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.

      Parameters:
      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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • availabilityZoneId

      CreateKxDataviewRequest.Builder availabilityZoneId(String availabilityZoneId)

      The identifier of the availability zones.

      Parameters:
      availabilityZoneId - The identifier of the availability zones.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • changesetId

      CreateKxDataviewRequest.Builder changesetId(String changesetId)

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

      Parameters:
      changesetId - A unique identifier of the changeset that you want to use to ingest data.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • segmentConfigurations

      CreateKxDataviewRequest.Builder segmentConfigurations(Collection<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.

      Parameters:
      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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • segmentConfigurations

      CreateKxDataviewRequest.Builder segmentConfigurations(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.

      Parameters:
      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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • segmentConfigurations

      CreateKxDataviewRequest.Builder segmentConfigurations(Consumer<KxDataviewSegmentConfiguration.Builder>... 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.

      This is a convenience method that creates an instance of the KxDataviewSegmentConfiguration.Builder avoiding the need to create one manually via KxDataviewSegmentConfiguration.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to segmentConfigurations(List<KxDataviewSegmentConfiguration>).

      Parameters:
      segmentConfigurations - a consumer that will call methods on KxDataviewSegmentConfiguration.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • autoUpdate

      CreateKxDataviewRequest.Builder autoUpdate(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.

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • readWrite

      CreateKxDataviewRequest.Builder readWrite(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.

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • description

      CreateKxDataviewRequest.Builder description(String description)

      A description of the dataview.

      Parameters:
      description - A description of the dataview.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • tags

      CreateKxDataviewRequest.Builder tags(Map<String,String> tags)

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

      Parameters:
      tags - A list of key-value pairs to label the dataview. You can add up to 50 tags to a dataview.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • clientToken

      CreateKxDataviewRequest.Builder clientToken(String clientToken)

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

      Parameters:
      clientToken - A token that ensures idempotency. This token expires in 10 minutes.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • overrideConfiguration

      CreateKxDataviewRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      overrideConfiguration - The override configuration.
      Returns:
      This object for method chaining.

    • overrideConfiguration

      CreateKxDataviewRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.
      Returns:
      This object for method chaining.