Interface GetKxDataviewResponse.Builder

All Superinterfaces:
AwsResponse.Builder, Buildable, CopyableBuilder<GetKxDataviewResponse.Builder,GetKxDataviewResponse>, FinspaceResponse.Builder, SdkBuilder<GetKxDataviewResponse.Builder,GetKxDataviewResponse>, SdkPojo, SdkResponse.Builder
Enclosing class:
GetKxDataviewResponse

public static interface GetKxDataviewResponse.Builder extends FinspaceResponse.Builder, SdkPojo, CopyableBuilder<GetKxDataviewResponse.Builder,GetKxDataviewResponse>
  • Method Details

    • databaseName

      GetKxDataviewResponse.Builder databaseName(String databaseName)

      The name of the database where you created the dataview.

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

      GetKxDataviewResponse.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

      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

      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

      GetKxDataviewResponse.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

      GetKxDataviewResponse.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

      GetKxDataviewResponse.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

      GetKxDataviewResponse.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

      GetKxDataviewResponse.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:
    • activeVersions

      The current active changeset versions of the database on the given dataview.

      Parameters:
      activeVersions - The current active changeset versions of the database on the given dataview.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • activeVersions

      GetKxDataviewResponse.Builder activeVersions(KxDataviewActiveVersion... activeVersions)

      The current active changeset versions of the database on the given dataview.

      Parameters:
      activeVersions - The current active changeset versions of the database on the given dataview.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • activeVersions

      The current active changeset versions of the database on the given dataview.

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

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

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

      GetKxDataviewResponse.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.
    • autoUpdate

      GetKxDataviewResponse.Builder autoUpdate(Boolean autoUpdate)

      The option to specify whether you want to apply all the future additions and corrections automatically to the dataview when new changesets are ingested. 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 new changesets are ingested. The default value is false.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • readWrite

      GetKxDataviewResponse.Builder readWrite(Boolean readWrite)

      Returns True if the dataview is created as writeable and False otherwise.

      Parameters:
      readWrite - Returns True if the dataview is created as writeable and False otherwise.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • environmentId

      GetKxDataviewResponse.Builder environmentId(String environmentId)

      A unique identifier for the kdb environment, from where you want to retrieve the dataview details.

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

      GetKxDataviewResponse.Builder createdTimestamp(Instant createdTimestamp)

      The timestamp at which the dataview was created in FinSpace. The value is determined as epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.

      Parameters:
      createdTimestamp - The timestamp at which the dataview was created in FinSpace. The value is determined as epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • lastModifiedTimestamp

      GetKxDataviewResponse.Builder lastModifiedTimestamp(Instant lastModifiedTimestamp)

      The last time that the dataview was updated in FinSpace. The value is determined as epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.

      Parameters:
      lastModifiedTimestamp - The last time that the dataview was updated in FinSpace. The value is determined as epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • status

      The status of dataview creation.

      • CREATING – The dataview creation is in progress.

      • UPDATING – The dataview is in the process of being updated.

      • ACTIVE – The dataview is active.

      Parameters:
      status - The status of dataview creation.

      • CREATING – The dataview creation is in progress.

      • UPDATING – The dataview is in the process of being updated.

      • ACTIVE – The dataview is active.

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • status

      The status of dataview creation.

      • CREATING – The dataview creation is in progress.

      • UPDATING – The dataview is in the process of being updated.

      • ACTIVE – The dataview is active.

      Parameters:
      status - The status of dataview creation.

      • CREATING – The dataview creation is in progress.

      • UPDATING – The dataview is in the process of being updated.

      • ACTIVE – The dataview is active.

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • statusReason

      GetKxDataviewResponse.Builder statusReason(String statusReason)

      The error message when a failed state occurs.

      Parameters:
      statusReason - The error message when a failed state occurs.
      Returns:
      Returns a reference to this object so that method calls can be chained together.