Package software.amazon.awssdk.services.finspace.model

Class CreateKxVolumeRequest

    • Method Detail

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

      • environmentId

        public final String environmentId()

        A unique identifier for the kdb environment, whose clusters can attach to the volume.

        Returns:
        A unique identifier for the kdb environment, whose clusters can attach to the volume.

      • volumeType

        public final KxVolumeType volumeType()

        The type of file system volume. Currently, FinSpace only supports NAS_1 volume type. When you select NAS_1 volume type, you must also provide nas1Configuration.

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

        Returns:
        The type of file system volume. Currently, FinSpace only supports NAS_1 volume type. When you select NAS_1 volume type, you must also provide nas1Configuration.
        See Also:
        KxVolumeType

      • volumeTypeAsString

        public final String volumeTypeAsString()

        The type of file system volume. Currently, FinSpace only supports NAS_1 volume type. When you select NAS_1 volume type, you must also provide nas1Configuration.

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

        Returns:
        The type of file system volume. Currently, FinSpace only supports NAS_1 volume type. When you select NAS_1 volume type, you must also provide nas1Configuration.
        See Also:
        KxVolumeType

      • volumeName

        public final String volumeName()

        A unique identifier for the volume.

        Returns:
        A unique identifier for the volume.

      • description

        public final String description()

        A description of the volume.

        Returns:
        A description of the volume.

      • nas1Configuration

        public final KxNAS1Configuration nas1Configuration()

        Specifies the configuration for the Network attached storage (NAS_1) file system volume. This parameter is required when you choose volumeType as NAS_1.

        Returns:
        Specifies the configuration for the Network attached storage (NAS_1) file system volume. This parameter is required when you choose volumeType as NAS_1.

      • 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:
        KxAzMode

      • 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:
        KxAzMode

      • hasAvailabilityZoneIds

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

      • availabilityZoneIds

        public final List<String> availabilityZoneIds()

        The identifier of the availability zones.

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

        Returns:
        The identifier of the availability zones.

      • 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 volume. You can add up to 50 tags to a volume.

        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 volume. You can add up to 50 tags to a volume.

      • 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