Class CreateKxDataviewResponse

    • Method Detail

      • dataviewName

        public final String dataviewName()

        A unique identifier for the dataview.

        Returns:
        A unique identifier for 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.
      • 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.
      • azMode

        public final KxAzMode azMode()

        The number of availability zones you want to assign per cluster. This can be one of the following

        • SINGLE – Assigns one availability zone per cluster.

        • MULTI – Assigns all the availability zones per cluster.

        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 cluster. This can be one of the following

        • SINGLE – Assigns one availability zone per cluster.

        • MULTI – Assigns all the availability zones per cluster.

        See Also:
        KxAzMode
      • azModeAsString

        public final String azModeAsString()

        The number of availability zones you want to assign per cluster. This can be one of the following

        • SINGLE – Assigns one availability zone per cluster.

        • MULTI – Assigns all the availability zones per cluster.

        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 cluster. This can be one of the following

        • SINGLE – Assigns one availability zone per cluster.

        • MULTI – Assigns all the availability zones per cluster.

        See Also:
        KxAzMode
      • 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 for the changeset.

        Returns:
        A unique identifier for the changeset.
      • 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.
      • description

        public final String description()

        A description of the dataview.

        Returns:
        A description of the dataview.
      • autoUpdate

        public final Boolean autoUpdate()

        The option to select 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 select 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.
      • createdTimestamp

        public final 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.

        Returns:
        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.
      • lastModifiedTimestamp

        public final 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.

        Returns:
        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.
      • status

        public final KxDataviewStatus 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.

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

        Returns:
        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.

        See Also:
        KxDataviewStatus
      • statusAsString

        public final String statusAsString()

        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.

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

        Returns:
        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.

        See Also:
        KxDataviewStatus
      • 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